hako 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d76103b970308d4f028189a3ec7bade0959330f3f8540ecd5a8df40a2263c753
-  data.tar.gz: 1dee2f57732bc15d5125e8baf5edb88202db0cbfa3308051bec4acdb29a10966
+  metadata.gz: 126110ac130316221e7ac640144170031d9efceb2cf81f89c1c22525d2be6275
+  data.tar.gz: dd1934716a185d3e653b6d0343424b72a3afd62207ad566568b7ea19218d997d
 SHA512:
-  metadata.gz: 876336df0208426be1f00e8f6a0097eddaf59508c8149c24533de70d3a22444393b5f9d42b5fc9537c3a0f41b96d2ed6e4101722a06a69f0f75a334e281fd0b9
-  data.tar.gz: fd9debc540cebf63304917b64c87a51a7579216998ecd5ff2098353a48edf1f9459c82f1c6df8aba69757f656b452fe648a97631c6c77aa3f057a56856acf403
+  metadata.gz: ce6f9bba7385b6cdba908d70e268a299e24db76a63276cc96ae774f7d699ac830acce6224eaabf08caae2dc7d50d7df9a76b2dbcb206438e3920b97d6f84a182
+  data.tar.gz: 6954189052e21677c5cda4dab43b438b88287ae6975160a82bdd8c7350d2a3eb5630411f6e798a756cb9f53bd46b91ade81e04cd9e7e5eabcb81034972183bb2

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.3.1 (2018-09-26)
+## Changes
+- Change show-definition output from YAML to JSON
+  - The show-definition output is still persable as YAML
+
+## Bug fixes
+- Set `deployment_configuration` to nil when absent
+
 # 2.3.0 (2018-08-30)
 ## New features
 - Support `health_check` parameter

data/docs/ecs-task-notification.md

@@ -13,12 +13,15 @@ Amazon S3 is a good storage for polling, so connecting CloudWatch Events to AWS
 
 The example implementation of AWS Lambda can be found in [../examples/put-ecs-container-status-to-s3](../examples/put-ecs-container-status-to-s3) directory.
 
-To enable task notification with S3, you have to configure scheduler in YAML.
+To enable task notification with S3, you have to configure scheduler in definition file.
 
-```yaml
-scheduler:
-  type: ecs
-  oneshot_notification_prefix: 's3://ecs-task-notifications/task_statuses?region=ap-northeast-1'
+```js
+{
+  scheduler: {
+    type: 'ecs',
+    oneshot_notification_prefix: 's3://ecs-task-notifications/task_statuses?region=ap-northeast-1',
+  },
+}
 ```
 
 It uses ecs-task-notifications bucket in ap-northeast-1 region.

data/lib/hako/application.rb

@@ -15,8 +15,8 @@ module Hako
     #   @return [Hash]
     attr_reader :id, :root_path, :definition
 
-    def initialize(yaml_path, expand_variables: true, ask_keys: false)
-      path = Pathname.new(yaml_path)
+    def initialize(definition_path, expand_variables: true, ask_keys: false)
+      path = Pathname.new(definition_path)
       @id = path.basename.sub_ext('').to_s
       @root_path = path.parent
       @definition =

data/lib/hako/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'hako'
+require 'json'
 require 'optparse'
 require 'pathname'
 
@@ -72,7 +73,7 @@ module Hako
           else
             {}
           end
-        Commander.new(Application.new(@yaml_path, options)).deploy(force: @force, tag: @tag, dry_run: @dry_run, timeout: @timeout)
+        Commander.new(Application.new(@definition_path, options)).deploy(force: @force, tag: @tag, dry_run: @dry_run, timeout: @timeout)
       end
 
       DEFAULT_TIMEOUT = 1200 # 20 minutes
@@ -84,9 +85,9 @@ module Hako
         @verbose = false
         @timeout = DEFAULT_TIMEOUT
         parser.parse!(argv)
-        @yaml_path = argv.first
+        @definition_path = argv.first
 
-        if @yaml_path.nil?
+        if @definition_path.nil?
           puts parser.help
           exit 1
         end
@@ -121,16 +122,16 @@ module Hako
           else
             {}
           end
-        Commander.new(Application.new(@yaml_path, options)).rollback(dry_run: @dry_run)
+        Commander.new(Application.new(@definition_path, options)).rollback(dry_run: @dry_run)
       end
 
       def parse!(argv)
         @dry_run = false
         @verbose = false
         parser.parse!(argv)
-        @yaml_path = argv.first
+        @definition_path = argv.first
 
-        if @yaml_path.nil?
+        if @definition_path.nil?
           puts parser.help
           exit 1
         end
@@ -162,7 +163,7 @@ module Hako
           else
             {}
           end
-        Commander.new(Application.new(@yaml_path, options)).oneshot(@argv, tag: @tag, containers: @containers, env: @env, dry_run: @dry_run, no_wait: @no_wait)
+        Commander.new(Application.new(@definition_path, options)).oneshot(@argv, tag: @tag, containers: @containers, env: @env, dry_run: @dry_run, no_wait: @no_wait)
       end
 
       def parse!(argv)
@@ -173,10 +174,10 @@ module Hako
         @verbose = false
         @no_wait = false
         parser.parse!(argv)
-        @yaml_path = argv.shift
+        @definition_path = argv.shift
         @argv = argv
 
-        if @yaml_path.nil? || @argv.empty?
+        if @definition_path.nil? || @argv.empty?
           puts parser.help
           exit 1
         end
@@ -204,7 +205,7 @@ module Hako
         parse!(argv)
         require 'hako/application'
         app = Application.new(@path, expand_variables: @expand_variables)
-        puts app.definition.to_yaml
+        puts JSON.pretty_generate(app.definition)
       end
 
       def parse!(argv)
@@ -231,14 +232,14 @@ module Hako
         parse!(argv)
         require 'hako/application'
         require 'hako/commander'
-        Commander.new(Application.new(@yaml_path, expand_variables: false)).status
+        Commander.new(Application.new(@definition_path, expand_variables: false)).status
       end
 
       def parse!(argv)
         parser.parse!(argv)
-        @yaml_path = argv.first
+        @definition_path = argv.first
 
-        if @yaml_path.nil?
+        if @definition_path.nil?
           puts parser.help
           exit 1
         end
@@ -258,15 +259,15 @@ module Hako
         require 'hako/application'
         require 'hako/commander'
 
-        Commander.new(Application.new(@yaml_path, expand_variables: false)).remove(dry_run: @dry_run)
+        Commander.new(Application.new(@definition_path, expand_variables: false)).remove(dry_run: @dry_run)
       end
 
       def parse!(argv)
         @dry_run = false
         parser.parse!(argv)
-        @yaml_path = argv.first
+        @definition_path = argv.first
 
-        if @yaml_path.nil?
+        if @definition_path.nil?
           puts parser.help
           exit 1
         end
@@ -287,15 +288,15 @@ module Hako
         require 'hako/application'
         require 'hako/commander'
 
-        Commander.new(Application.new(@yaml_path, expand_variables: false)).stop(dry_run: @dry_run)
+        Commander.new(Application.new(@definition_path, expand_variables: false)).stop(dry_run: @dry_run)
       end
 
       def parse!(argv)
         @dry_run = false
         parser.parse!(argv)
-        @yaml_path = argv.first
+        @definition_path = argv.first
 
-        if @yaml_path.nil?
+        if @definition_path.nil?
           puts parser.help
           exit 1
         end

data/lib/hako/commander.rb

@@ -118,21 +118,21 @@ module Hako
       DefinitionLoader.new(@app, dry_run: dry_run).load(tag, with: with)
     end
 
-    # @param [Hash] yaml
+    # @param [Hash] scheduler_definition
     # @param [Hash] volumes
     # @param [Boolean] force
     # @param [Boolean] dry_run
     # @param [Integer] timeout
     # @return [Scheduler]
-    def load_scheduler(yaml, scripts, volumes: {}, force: false, dry_run:, timeout: nil)
-      Loader.new(Hako::Schedulers, 'hako/schedulers').load(yaml.fetch('type')).new(@app.id, yaml, volumes: volumes, scripts: scripts, force: force, dry_run: dry_run, timeout: timeout)
+    def load_scheduler(scheduler_definition, scripts, volumes: {}, force: false, dry_run:, timeout: nil)
+      Loader.new(Hako::Schedulers, 'hako/schedulers').load(scheduler_definition.fetch('type')).new(@app.id, scheduler_definition, volumes: volumes, scripts: scripts, force: force, dry_run: dry_run, timeout: timeout)
     end
 
-    # @param [Hash] yaml
+    # @param [Hash] script_definition
     # @param [Boolean] dry_run
     # @return [Script]
-    def load_script(yaml, dry_run:)
-      Loader.new(Hako::Scripts, 'hako/scripts').load(yaml.fetch('type')).new(@app, yaml, dry_run: dry_run)
+    def load_script(script_definition, dry_run:)
+      Loader.new(Hako::Scripts, 'hako/scripts').load(script_definition.fetch('type')).new(@app, script_definition, dry_run: dry_run)
     end
   end
 end

data/lib/hako/container.rb

@@ -195,8 +195,8 @@ module Hako
     # @param [Array<Hash>] provider_configs
     # @return [Array<EnvProvider>]
     def load_providers(provider_configs)
-      provider_configs.map do |yaml|
-        Loader.new(Hako::EnvProviders, 'hako/env_providers').load(yaml.fetch('type')).new(@app.root_path, yaml)
+      provider_configs.map do |provider_config|
+        Loader.new(Hako::EnvProviders, 'hako/env_providers').load(provider_config.fetch('type')).new(@app.root_path, provider_config)
       end
     end
 

data/lib/hako/env_expander.rb

@@ -36,6 +36,7 @@ module Hako
         if variables.empty?
           break
         end
+
         provider.ask(variables.to_a).each do |var, val|
           values[var] = val
           variables.delete(var)
@@ -69,6 +70,7 @@ module Hako
         if variables.empty?
           break
         end
+
         if provider.can_ask_keys?
           provider.ask_keys(variables.to_a).each do |var|
             variables.delete(var)
@@ -81,6 +83,7 @@ module Hako
       unless variables.empty?
         raise ExpansionError.new("Could not find embedded variables from $providers=#{@providers}: #{variables.to_a}")
       end
+
       true
     end
 
@@ -94,6 +97,7 @@ module Hako
         unless val.is_a?(String)
           raise ExpansionError.new("#{key} must be a String but got #{val.class}: #{val.inspect}")
         end
+
         parsed_env[key] = parse(val)
       end
       parsed_env
@@ -116,6 +120,7 @@ module Hako
         else
           tokens << Variable.new(var)
         end
+
         pos = s.pos
       end
       unless s.rest.empty?

data/lib/hako/env_providers/file.rb

@@ -57,6 +57,7 @@ module Hako
               # line comment
               next
             end
+
             key, val = line.split('=', 2)
             if val
               block.call(key, val)

data/lib/hako/schedulers/ecs.rb

@@ -54,9 +54,13 @@ module Hako
           validation_error!('autoscaling_group_for_oneshot must be set when autoscaling_topic_for_oneshot is set')
         end
         @oneshot_notification_prefix = options.fetch('oneshot_notification_prefix', nil)
-        @deployment_configuration = {}
-        %i[maximum_percent minimum_healthy_percent].each do |key|
-          @deployment_configuration[key] = options.dig('deployment_configuration', key.to_s)
+        if options.key?('deployment_configuration')
+          @deployment_configuration = {}
+          %i[maximum_percent minimum_healthy_percent].each do |key|
+            @deployment_configuration[key] = options.fetch('deployment_configuration')[key.to_s]
+          end
+        else
+          @deployment_configuration = nil
         end
         @placement_constraints = options.fetch('placement_constraints', [])
         @placement_strategy = options.fetch('placement_strategy', [])
@@ -358,6 +362,7 @@ module Hako
         if @dry_run
           return DEFAULT_FRONT_PORT
         end
+
         service = describe_service
         if service
           find_front_port(service)
@@ -412,6 +417,7 @@ module Hako
           # Initial deployment
           return true
         end
+
         actual_volume_definitions = {}
         actual_definition.volumes.each do |v|
           actual_volume_definitions[v.name] = v
@@ -628,6 +634,7 @@ module Hako
         if result.tasks.empty?
           raise NoTasksStarted.new('No tasks started')
         end
+
         result.tasks[0]
       rescue Aws::ECS::Errors::InvalidParameterException => e
         if e.message == 'No Container Instances were found in your cluster.' && on_no_tasks_started(task_definition)
@@ -874,6 +881,7 @@ module Hako
             if e.id == latest_event_id
               break
             end
+
             Hako.logger.info "#{e.created_at}: #{e.message}"
             task_id = extract_task_id(e.message)
             if task_id && e.message.include?(' has started ')
@@ -1114,6 +1122,7 @@ module Hako
           source_volume = mount_point.fetch(:source_volume)
           v = volumes_definition.find { |d| d[:name] == source_volume }
           raise "Could not find volume #{source_volume}" unless v
+
           source = v.dig(:host, :source_path) || source_volume
           cmd << '--volume' << "#{source}:#{mount_point.fetch(:container_path)}#{mount_point[:read_only] ? ':ro' : ''}"
         end
@@ -1171,7 +1180,7 @@ module Hako
         definition.fetch(:environment).each do |env|
           name = env.fetch(:name)
           value = env.fetch(:value)
-          # additional_env (given in command line) has priority over env (declared in YAML)
+          # additional_env (given in command line) has priority over env (declared in definition file)
           unless additional_env.key?(name)
             cmd << '--env' << "#{name}=#{value}"
             cmd << "\\\n  "

data/lib/hako/schedulers/ecs_autoscaling.rb

@@ -80,10 +80,12 @@ module Hako
                 if service.load_balancers.empty? || service.load_balancers[0].target_group_arn.nil?
                   raise Error.new('Target group must be attached to the ECS service for predefined metric type ALBRequestCountPerTarget')
                 end
+
                 resource_label = target_group_resource_label
                 unless resource_label.start_with?('app/')
                   raise Error.new("Load balancer type must be 'application' for predefined metric type ALBRequestCountPerTarget")
                 end
+
                 predefined_metric_specification[:resource_label] = resource_label
               end
               policy_params[:target_tracking_scaling_policy_configuration] = {

data/lib/hako/schedulers/ecs_elb_v2.rb

@@ -208,6 +208,7 @@ module Hako
             unless deleted
               raise Error.new("Cannot delete target group #{target_group.target_group_arn}")
             end
+
             Hako.logger.info "Deleted target group #{target_group.target_group_arn}"
           end
         end

data/lib/hako/schema/structure.rb

@@ -11,6 +11,7 @@ module Hako
         unless object.is_a?(::Hash)
           return false
         end
+
         @members.each do |key, val_schema|
           unless val_schema.valid?(object[key])
             return false

data/lib/hako/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hako
-  VERSION = '2.3.0'
+  VERSION = '2.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hako
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-applicationautoscaling