putpaws 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0adf3a9b8987d214af5c9a2c8348554ef7a34a47bc4ff55a1ea677c628d3fa2
-  data.tar.gz: 15edd0ace3e1eeded5bc3687fc0f7b02e3189f50bf78255d708308818e861fa1
+  metadata.gz: 6b0c08e32fd66d0f401c637c162bb7d2e408beb0110e433fec09d2a5853e0372
+  data.tar.gz: faeacb4b1476fd8247f627e32640ddaaac55e906754bba8e0155adc35a624225
 SHA512:
-  metadata.gz: 124c94a1b9b20738b48a2de2fe124847930d7ac4fdc921ae7519fa3b8bbe678a5743514258bbffabb3815aa933377f21ea388ee31600a8e211be49ad76af147c
-  data.tar.gz: afabd0af48a055ddd0ee8a7e4604700d0fc9b810978a181e6513569d53d9f410ee62cf83e05d34f5ffdb1fdb3c2d42e8c03ded2815316e529df4f568b48d9744
+  metadata.gz: 8f43a0329c4b6705b72c235687f0ba9f3a038a1314c32dca0dcfb83f26f28326b0e7ae7d2d1cb13267674626ccd47786100b574b17fa95119606ebcf960b1193
+  data.tar.gz: 3488ea35bc10ce0ed4449ed0ca1ec97836f22535d246662f3d3f729779fc12d1e67b5a231cc28acc7fa9c816c369a59a37e6f5a9d5bda45c97fa9e9e70fc0291

data/README.md

@@ -55,6 +55,14 @@ or a new one is created for the service when left empty on `ready`.
 When the service step completes, the new service is reflected into
 `.putpaws/application.json` and `.putpaws/infra.json` (diff is shown and confirmed),
 so `ecs:attach`, `ecs:shell`, `ecs:run` and `log:*` work immediately.
+One entry is written per task definition of the preset, keyed by the task definition
+family `{service_name}-{suffix}` (Ex: `awesome-api-staging-app` / `awesome-api-staging-web`),
+each pointing at the `infra.target` of the same name. Only the entry of the preset's
+`service_task_definition` carries `service` (for `ecs:deploy` / `ecs:attach`); the others have
+`service: null` and are meant for one-off tasks (`ecs:run` / `ecs:shell` / scheduler),
+so `db:migrate` keeps running on the plain `app` task definition even when the service
+runs `web` (nginx + app). `infra.network` is written once as `{service_name}`.
+Existing keys are never deleted; remove stale ones by hand.
 Secrets are handled by reference only: task definitions point to existing
 SSM parameters (Ex: `/{service_name}/RAILS_MASTER_KEY`) and putpaws never touches the values.
 
@@ -182,6 +190,15 @@ so you can identify them on the AWS console and on the task list of `ecs:attach`
 `ecs:run` and `ecs:shell` require `network` and `target` in `.putpaws/application.json`,
 which refer to the `network` / `target` sections of `.putpaws/infra.json` (the same ones used by scheduler).
 
+### CodeBuild
+
+Start the CI build. By default it is fire-and-forget; pass `wait=true` to wait
+until the build completes (phases are printed) and exit non-zero on failure.
+
+```
+bundle exec putpaws awesome-api-staging code_build:build branch=main wait=true
+```
+
 ### CloudWatch Logs
 
 `tail -f`
@@ -216,19 +233,35 @@ gem 'putpaws'
 
 `.putpaws/application.json`
 
+Keys are free-form names you pass to the CLI. The ones written by `putpaws up` follow
+`{service_name}-{suffix}`: `-app` for one-off tasks (`service: null`), `-web` for the
+long-running service.
+
 ```
 {
-  "awesome-api-staging": {
+  "awesome-api-staging-app": {
     "region": "ap-northeast-1",
     "cluster": "cluster-staging",
     "service": null,
-    "task_name_prefix": "awesome-api",
-    "log_group_prefix": "/ecs/awesome/awesome-api-staging",
+    "task_name_prefix": "awesome-api-staging-app",
+    "log_group_prefix": "/ecs/awesome-api-staging",
+    "log_region": null,
+    "build_log_group_prefix": "/aws/codebuild/awesome-api-staging",
+    "build_project_name_prefix": "awesome-api-staging",
+    "network": "awesome-api-staging",
+    "target": "awesome-api-staging-app"
+  },
+  "awesome-api-staging-web": {
+    "region": "ap-northeast-1",
+    "cluster": "cluster-staging",
+    "service": "awesome-api-staging",
+    "task_name_prefix": "awesome-api-staging-web",
+    "log_group_prefix": "/ecs/awesome-api-staging",
     "log_region": null,
     "build_log_group_prefix": "/aws/codebuild/awesome-api-staging",
     "build_project_name_prefix": "awesome-api-staging",
-    "network": "awesome-private-staging",
-    "target": "awesome-staging"
+    "network": "awesome-api-staging",
+    "target": "awesome-api-staging-web"
   },
   "awesome-api-production": {
     "region": "ap-northeast-1",

data/lib/putpaws/code_build/project_command.rb

@@ -41,6 +41,23 @@ module Putpaws::CodeBuild
       codebuild_client.start_build(**params)
     end
 
+    def wait_until_build_complete(build_id, timeout: 3600, interval: 10)
+      deadline = Time.now + timeout
+      last_phase = nil
+      loop do
+        res = codebuild_client.batch_get_builds(ids: [build_id])
+        build = res.builds.first
+        raise "Build not found: #{build_id}" unless build
+        if build.current_phase != last_phase
+          last_phase = build.current_phase
+          puts "  phase: #{last_phase}"
+        end
+        return build if build.build_status != 'IN_PROGRESS'
+        raise "Timed out waiting for build to complete: #{build_id}" if Time.now > deadline
+        sleep interval
+      end
+    end
+
     def build_source_version(type:, version:)
       type = type.to_sym
       if type == :branch

data/lib/putpaws/code_build/tasks/build_task.rake

@@ -15,7 +15,7 @@ namespace :code_build do
     set :codebuild_project, codebuild_project
   end
 
-  desc "Start build."
+  desc "Start build. Pass wait=true to wait until the build completes and fail on error. (Ex) branch=main wait=true"
   task build: :set_project do
     aws = Putpaws::CodeBuild::ProjectCommand.config(fetch(:app))
 
@@ -30,10 +30,22 @@ namespace :code_build do
     end
     codebuild_project = fetch(:codebuild_project)
     aws.codebuild_project = codebuild_project
-    aws.start_build_with_specific_version(
-      source_version: source_version, 
-      environment_variables: ENV['env'] ? JSON.parse(ENV['env']) : {}, 
+    res = aws.start_build_with_specific_version(
+      source_version: source_version,
+      environment_variables: ENV['env'] ? JSON.parse(ENV['env']) : {},
       buildspec_override: ENV['buildspec']
     )
+    build = res.build
+    puts "Build started: #{build.id}"
+
+    if ENV['wait']
+      puts "Waiting for the build to complete..."
+      build = aws.wait_until_build_complete(build.id)
+      if build.build_status == 'SUCCEEDED'
+        puts "Build succeeded: #{build.id}"
+      else
+        raise "Build #{build.build_status.downcase}: #{build.id}"
+      end
+    end
   end
 end

data/lib/putpaws/provision/config_writer.rb

@@ -8,6 +8,15 @@ module Putpaws
     # Reflects provisioned resources into .putpaws/application.json and
     # .putpaws/infra.json. Only the keys of the target service are touched.
     # Shows a diff and asks for confirmation before writing.
+    #
+    # One application entry and one infra.target entry are written per task
+    # definition of the preset, keyed by the task definition family
+    # (`<service_name>-<suffix>`). The entry whose suffix is the preset's
+    # `service_task_definition` carries `service` so that ecs:deploy /
+    # ecs:attach address the long-running service; the others are for
+    # one-off tasks (ecs:run / ecs:shell / scheduler) and have `service: null`.
+    # infra.network is written once per service as it does not depend on the
+    # task definition.
     class ConfigWriter
       attr_reader :config, :state, :prompt, :io
       def initialize(config:, state:, prompt:, io: $stdout)
@@ -17,17 +26,18 @@ module Putpaws
         @io = io
       end
 
-      def application_entry
+      def application_entry(entry)
+        family = config.task_definition_family(entry[:suffix])
         {
           region: config.region,
           cluster: config.cluster_name,
-          service: config.service_name,
-          task_name_prefix: config.service_name,
+          service: service_entry?(entry) ? config.service_name : nil,
+          task_name_prefix: family,
           log_group_prefix: config.log_group,
           build_log_group_prefix: config.build_log_group,
           build_project_name_prefix: config.build_project_name,
           network: config.service_name,
-          target: config.service_name,
+          target: family,
         }
       end
 
@@ -39,25 +49,32 @@ module Putpaws
         }
       end
 
-      def target_entry
+      def target_entry(entry)
         {
           # Used by EventBridge Scheduler (scheduler:deploy).
           scheduler_role: config.roles[:scheduler_role_arn],
           cluster: state.resources[:cluster_arn],
           # Revision-less on purpose: always run the latest ACTIVE revision.
-          task_definition: config.service_task_definition_family,
-          container_name: config.service_container_name,
+          task_definition: config.task_definition_family(entry[:suffix]),
+          container_name: entry[:container_name] || 'app',
         }
       end
 
       def apply!
-        write_key(path('application.json'), [config.service_name.to_sym], application_entry)
         write_key(path('infra.json'), [:network, config.service_name.to_sym], network_entry)
-        write_key(path('infra.json'), [:target, config.service_name.to_sym], target_entry)
+        config.preset.task_definitions.each do |entry|
+          key = config.task_definition_family(entry[:suffix]).to_sym
+          write_key(path('application.json'), [key], application_entry(entry))
+          write_key(path('infra.json'), [:target, key], target_entry(entry))
+        end
       end
 
       private
 
+      def service_entry?(entry)
+        entry[:suffix] == config.preset.service_task_definition
+      end
+
       def path(basename)
         Pathname.new(config.path_prefix).join(basename)
       end

data/lib/putpaws/version.rb

@@ -1,3 +1,3 @@
 module Putpaws
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: putpaws
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - metheglin