|
| 1 | +package engine |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "fmt" |
| 6 | + "strings" |
| 7 | + |
| 8 | + "github.com/aws/aws-sdk-go-v2/aws" |
| 9 | + "github.com/aws/aws-sdk-go-v2/service/ecs" |
| 10 | + "github.com/aws/aws-sdk-go-v2/service/eventbridge" |
| 11 | + eventbridgetypes "github.com/aws/aws-sdk-go-v2/service/eventbridge/types" |
| 12 | +) |
| 13 | + |
| 14 | +type EcsScheduledTaskDeployment struct { |
| 15 | + BaseDeploymentConfig `mapstructure:",squash"` |
| 16 | + Rule string `mapstructure:"rule"` |
| 17 | + EventBusName string `mapstructure:"event-bus-name,omitempty"` |
| 18 | + VersionEnvironmentKey string `mapstructure:"version-environment-key,omitempty"` |
| 19 | +} |
| 20 | + |
| 21 | +type ECSScheduledTaskDeploymentEngine struct { |
| 22 | + ECSClient *ecs.Client |
| 23 | + EventBridgeClient *eventbridge.Client |
| 24 | +} |
| 25 | + |
| 26 | +func (engine *ECSScheduledTaskDeploymentEngine) Type() string { |
| 27 | + return "ecs-scheduled-task" |
| 28 | +} |
| 29 | + |
| 30 | +func (engine *ECSScheduledTaskDeploymentEngine) ResolveConfigStruct() Deployment { |
| 31 | + return &EcsScheduledTaskDeployment{} |
| 32 | +} |
| 33 | + |
| 34 | +func (engine *ECSScheduledTaskDeploymentEngine) Deploy(config Deployment, p func(string, ...any)) error { |
| 35 | + taskConfig := config.(*EcsScheduledTaskDeployment) |
| 36 | + |
| 37 | + if taskConfig.Rule == "" { |
| 38 | + return fmt.Errorf("ecs-scheduled-task '%s': 'rule' must be set", taskConfig.Id()) |
| 39 | + } |
| 40 | + |
| 41 | + targets, err := engine.findMatchingTargets(taskConfig) |
| 42 | + if err != nil { |
| 43 | + return err |
| 44 | + } |
| 45 | + |
| 46 | + taskDefinitionOutput, err := engine.ECSClient.DescribeTaskDefinition(context.Background(), &ecs.DescribeTaskDefinitionInput{ |
| 47 | + TaskDefinition: targets[0].EcsParameters.TaskDefinitionArn, |
| 48 | + }) |
| 49 | + if err != nil { |
| 50 | + return err |
| 51 | + } |
| 52 | + |
| 53 | + p("Registering new task definition for '%s' with version '%s'...", *taskDefinitionOutput.TaskDefinition.Family, taskConfig.Version()) |
| 54 | + registerOutput, err := engine.ECSClient.RegisterTaskDefinition( |
| 55 | + context.Background(), |
| 56 | + generateRegisterTaskDefinitionInput(taskDefinitionOutput.TaskDefinition, taskConfig.Version(), taskConfig.VersionEnvironmentKey), |
| 57 | + ) |
| 58 | + if err != nil { |
| 59 | + return err |
| 60 | + } |
| 61 | + |
| 62 | + newTaskDefArn := registerOutput.TaskDefinition.TaskDefinitionArn |
| 63 | + p("Updating %d ECS target(s) on EventBridge rule '%s' with new task definition '%s'...", len(targets), taskConfig.Rule, *newTaskDefArn) |
| 64 | + |
| 65 | + updatedTargets := make([]eventbridgetypes.Target, len(targets)) |
| 66 | + for i, target := range targets { |
| 67 | + updated := target |
| 68 | + updatedEcsParams := *target.EcsParameters |
| 69 | + updatedEcsParams.TaskDefinitionArn = newTaskDefArn |
| 70 | + updated.EcsParameters = &updatedEcsParams |
| 71 | + updatedTargets[i] = updated |
| 72 | + } |
| 73 | + |
| 74 | + putOutput, err := engine.EventBridgeClient.PutTargets(context.Background(), &eventbridge.PutTargetsInput{ |
| 75 | + Rule: aws.String(taskConfig.Rule), |
| 76 | + EventBusName: aws.String(engine.resolveEventBusName(taskConfig)), |
| 77 | + Targets: updatedTargets, |
| 78 | + }) |
| 79 | + if err != nil { |
| 80 | + return err |
| 81 | + } |
| 82 | + if putOutput.FailedEntryCount > 0 { |
| 83 | + return fmt.Errorf( |
| 84 | + "failed to update %d target(s) on EventBridge rule '%s': %s", |
| 85 | + putOutput.FailedEntryCount, |
| 86 | + taskConfig.Rule, |
| 87 | + *putOutput.FailedEntries[0].ErrorMessage, |
| 88 | + ) |
| 89 | + } |
| 90 | + return nil |
| 91 | +} |
| 92 | + |
| 93 | +func (engine *ECSScheduledTaskDeploymentEngine) CheckVersion(config Deployment) (string, error) { |
| 94 | + taskConfig := config.(*EcsScheduledTaskDeployment) |
| 95 | + |
| 96 | + if taskConfig.Rule == "" { |
| 97 | + return "", fmt.Errorf("ecs-scheduled-task '%s': 'rule' must be set", taskConfig.Id()) |
| 98 | + } |
| 99 | + |
| 100 | + targets, err := engine.findMatchingTargets(taskConfig) |
| 101 | + if err != nil { |
| 102 | + return "", err |
| 103 | + } |
| 104 | + |
| 105 | + taskDefinitionOutput, err := engine.ECSClient.DescribeTaskDefinition(context.Background(), &ecs.DescribeTaskDefinitionInput{ |
| 106 | + TaskDefinition: targets[0].EcsParameters.TaskDefinitionArn, |
| 107 | + }) |
| 108 | + if err != nil { |
| 109 | + return "", err |
| 110 | + } |
| 111 | + |
| 112 | + return strings.Split(*taskDefinitionOutput.TaskDefinition.ContainerDefinitions[0].Image, ":")[1], nil |
| 113 | +} |
| 114 | + |
| 115 | +// findMatchingTargets returns all targets on the configured rule whose task definition family |
| 116 | +// matches the deployment id. |
| 117 | +func (engine *ECSScheduledTaskDeploymentEngine) findMatchingTargets(taskConfig *EcsScheduledTaskDeployment) ([]eventbridgetypes.Target, error) { |
| 118 | + allTargets, err := engine.listAllTargets(taskConfig.Rule, engine.resolveEventBusName(taskConfig)) |
| 119 | + if err != nil { |
| 120 | + return nil, err |
| 121 | + } |
| 122 | + |
| 123 | + var matching []eventbridgetypes.Target |
| 124 | + for _, target := range allTargets { |
| 125 | + if target.EcsParameters != nil && |
| 126 | + target.EcsParameters.TaskDefinitionArn != nil && |
| 127 | + taskDefinitionFamily(*target.EcsParameters.TaskDefinitionArn) == taskConfig.Id() { |
| 128 | + matching = append(matching, target) |
| 129 | + } |
| 130 | + } |
| 131 | + |
| 132 | + if len(matching) == 0 { |
| 133 | + return nil, fmt.Errorf("no targets for task definition family '%s' found on EventBridge rule '%s'", taskConfig.Id(), taskConfig.Rule) |
| 134 | + } |
| 135 | + |
| 136 | + return matching, nil |
| 137 | +} |
| 138 | + |
| 139 | +func (engine *ECSScheduledTaskDeploymentEngine) listAllTargets(ruleName, eventBusName string) ([]eventbridgetypes.Target, error) { |
| 140 | + var targets []eventbridgetypes.Target |
| 141 | + var nextToken *string |
| 142 | + for { |
| 143 | + output, err := engine.EventBridgeClient.ListTargetsByRule(context.Background(), &eventbridge.ListTargetsByRuleInput{ |
| 144 | + Rule: aws.String(ruleName), |
| 145 | + EventBusName: aws.String(eventBusName), |
| 146 | + NextToken: nextToken, |
| 147 | + }) |
| 148 | + if err != nil { |
| 149 | + return nil, err |
| 150 | + } |
| 151 | + targets = append(targets, output.Targets...) |
| 152 | + if output.NextToken == nil { |
| 153 | + break |
| 154 | + } |
| 155 | + nextToken = output.NextToken |
| 156 | + } |
| 157 | + return targets, nil |
| 158 | +} |
| 159 | + |
| 160 | +// taskDefinitionFamily extracts the family name from a task definition ARN or "family:revision" string. |
| 161 | +// e.g. "arn:aws:ecs:us-east-1:123456789012:task-definition/my-task:5" → "my-task" |
| 162 | +// e.g. "my-task:5" → "my-task" |
| 163 | +func taskDefinitionFamily(arnOrName string) string { |
| 164 | + s := arnOrName |
| 165 | + if idx := strings.LastIndex(s, "/"); idx >= 0 { |
| 166 | + s = s[idx+1:] |
| 167 | + } |
| 168 | + return strings.Split(s, ":")[0] |
| 169 | +} |
| 170 | + |
| 171 | +func (engine *ECSScheduledTaskDeploymentEngine) resolveEventBusName(taskConfig *EcsScheduledTaskDeployment) string { |
| 172 | + if taskConfig.EventBusName != "" { |
| 173 | + return taskConfig.EventBusName |
| 174 | + } |
| 175 | + return "default" |
| 176 | +} |
| 177 | + |
| 178 | +func init() { |
| 179 | + RegisterDeploymentEngine("ecs-scheduled-task", func(awsConfig aws.Config) DeploymentEngine { |
| 180 | + return &ECSScheduledTaskDeploymentEngine{ |
| 181 | + ECSClient: ecs.NewFromConfig(awsConfig), |
| 182 | + EventBridgeClient: eventbridge.NewFromConfig(awsConfig), |
| 183 | + } |
| 184 | + }) |
| 185 | +} |
0 commit comments