fix: API Controller CommentCommand.Name defaults to Apply instead of Plan

[rjmsilveira]

What

Fixed a bug in the API controller where CommentCommand.Name was not being set when creating commands, causing the command type to default to Apply (value 0) instead of the intended command type (Plan or Apply).

Changes:

• Added cmdName command.Name parameter to the getCommands() function
• Set Name: cmdName on each CommentCommand struct created for projects and paths
• Updated apiPlan() to pass command.Plan to getCommands()
• Updated apiApply() to pass command.Apply to getCommands()

Why

The command.Name type is defined using iota:

const (
    Apply Name = iota  // = 0
    Plan               // = 1
    // ...
)

When the API controller created CommentCommand structs, the Name field was never set:

cc = append(cc, &events.CommentCommand{
    ProjectName: project,  // Name field missing!
})

Since Go initializes unset fields to their zero value, Name defaulted to 0, which is Apply. This caused:

• API plan requests to have their CommentCommand.Name incorrectly set to Apply
• The downstream BuildPlanCommands() function received the wrong command name via cmd.CommandName()
• Pre-workflow hooks and other logic that depends on the command name would behave incorrectly

How the issue was detected

The bug was discovered when using pre_workflow_hooks with the commands filter set to plan:

repos:
  - id: /.*/
    pre_workflow_hooks:
      - run: bash /path/to/script.sh
        description: Running script for plan only
        commands: plan

When calling the API /api/plan endpoint, the pre-workflow hook was not executing even though it should only run for plan commands. Investigation revealed that the CommentCommand.Name was incorrectly set to Apply (the zero value) instead of Plan, causing the commands: plan filter to skip the hook.

Tests

Existing tests in server/controllers/api_controller_test.go cover this functionality:

• TestAPIController_Plan - verifies BuildPlanCommands is called correctly
• TestAPIController_Apply - verifies BuildApplyCommands is called correctly
• Both tests verify the correct number of calls and successful responses

New tests added to specifically verify the CommentCommand.Name is correctly set for pre-workflow hooks:

• TestAPIController_Plan_PreWorkflowHooksReceiveCorrectCommand - verifies that when calling the Plan API endpoint, the pre-workflow hooks receive a CommentCommand with Name set to command.Plan
• TestAPIController_Apply_PreWorkflowHooksReceiveCorrectCommand - verifies that when calling the Apply API endpoint, the pre-workflow hooks receive the correct CommentCommand.Name for each phase (command.Plan for the plan phase, command.Apply for the apply phase)

These tests use pegomock's GetCapturedArguments() to capture the actual CommentCommand passed to RunPreHooks() and assert that the Name field is correctly set.

To run the tests:

go test ./server/controllers/... -run "TestAPIController" -v

References

• command.Name iota definition: server/events/command/name.go
• CommentCommand struct: server/events/comment_command.go
• BuildPlanCommands uses cmd.CommandName(): server/events/project_command_builder.go:279
• getCommands() function: server/controllers/api_controller.go:59
• Pre-workflow hooks commands filter: server/events/pre_workflow_hooks_command_runner.go

[jamengual]

Thanks @rjmsilveira for the contribution