ecs_compose 0.1.0.pre23 → 0.1.0.pre26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44652fed3e1b8e9b49392f9d042291e8cbc9ed67
-  data.tar.gz: 017482c7d7f0937820b20e243562de13e4a742be
+  metadata.gz: be50de9cd4fa54757a557a57ad8f30a6e600acc1
+  data.tar.gz: 5b0ddfed2870445d82fee42e8ab325f7c4ee0f4e
 SHA512:
-  metadata.gz: 38cf507deb32f24f41bde413dde811af98dac5e82bd58cb8b955d4483f65ec9da18399ae7cad0823c5c12e033cd9a2c91f1ded5d5268ed4eb1f3cc4fde6d70c2
-  data.tar.gz: 48962ba33465cecbd19e8bb01bc1c767c202b3a51da743296751eb15b74cdf9a684534f753699f4c915f4c7805143551da18620e52fb1c8a0103d4ffbfa05a41
+  metadata.gz: 98fed5d3058dd67d385426ff19c10425ee2b99ec4239ab99ceaee3f38695409cff0a0c7695776a4554fe99fe67de031d57391bf6988b98b9c08ebfac206de57f
+  data.tar.gz: b58f20d5927e3c4092b338ab931f257046ce47286ebcb28e839fdbc7cbb3f740eb20049d02180cdc916742b6c8f5bd46e35797d03bb7a4271247884427738f31

data/ecs_compose.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "docopt", "~> 0.5.0"
   spec.add_dependency "colorize", "~> 0.7.7"
 
+  spec.add_development_dependency "vault", "~> 0.1.5"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/ecs_compose/compare.rb

@@ -38,6 +38,7 @@ module EcsCompose
       td = sort_recursively(td)
       td.delete("taskDefinitionArn")
       td.delete("revision")
+      Plugins.plugins.each {|p| p.normalize_task_definition!(td) }
       td
     end
   end

data/lib/ecs_compose/plugins/plugin.rb

@@ -0,0 +1,26 @@
+module EcsCompose
+  module Plugins
+    # A list of all available plugins.
+    AVAILABLE_PLUGINS = []
+
+    # Subclass this class and add it to `AVAILABLE_PLUGINS` to extend
+    # `ecs_compose`.
+    class Plugin
+      # Does this plugin apply 
+      def self.enabled?
+        false
+      end
+
+      # Normalize a task definition for comparison.  This may remove
+      # certain environment variables, for example, that are allowed to
+      # vary from one deploy to the next.
+      def normalize_task_definition!(taskdef)
+      end
+
+      # Called when we decide to skip a deploy because the previous version
+      # of the software appears to still be valid.
+      def notify_skipping_deploy(old, new)
+      end
+    end
+  end
+end

data/lib/ecs_compose/plugins/vault_plugin.rb

@@ -0,0 +1,48 @@
+module EcsCompose
+  module Plugins
+
+    class VaultPlugin
+      # We're enabled if we know about a vault server.
+      def self.enabled?
+        ENV.has_key?('VAULT_ADDR') && ENV.has_key?('VAULT_MASTER_TOKEN')
+      end
+
+      # Make sure that vault is loaded and configured.
+      def initialize
+        begin
+          require 'vault' unless defined?(Vault)
+        rescue
+          STDERR.puts("VAULT_ADDR defined, but `vault` gem not available")
+          exit(1)
+        end
+        Vault.address = ENV.fetch('VAULT_ADDR')
+        Vault.token = ENV.fetch('VAULT_MASTER_TOKEN')
+      end
+
+      # Normalize a task definition for comparison by removing VAULT_TOKEN
+      # from each of the containers' environments.
+      def normalize_task_definition!(taskdef)
+        containers = taskdef.fetch("containerDefinitions", [])
+        containers.each do |container|
+          env = container.fetch("environment", [])
+          env.reject! {|v| v.fetch("name") == "VAULT_TOKEN" }
+        end
+      end
+
+      # Called when we decide to skip a deploy because the previous version
+      # of the software appears to still be valid.
+      def notify_skipping_deploy(old, new)
+        tokens = old
+          .fetch("containerDefinitions", [])
+          .map {|c| c.fetch("environment", []) }
+          .flatten
+          .select {|var| var.fetch("name") == "VAULT_TOKEN" }
+          .map {|var| var.fetch("value") }
+        puts "Renewing #{tokens.length} vault tokens"
+        tokens.each {|tok| Vault.auth_token.renew(tok) }
+      end
+    end
+
+    AVAILABLE_PLUGINS << VaultPlugin
+  end
+end

data/lib/ecs_compose/plugins.rb

@@ -0,0 +1,15 @@
+require "ecs_compose/plugins/plugin"
+require "ecs_compose/plugins/vault_plugin"
+
+module EcsCompose
+  # Plugins which allow ecs-compose to work better with various third-party
+  # tools.
+  module Plugins
+    # A list of all enabled plugins.  Generated on demand to make it easier
+    # to work with test suites.
+    def self.plugins
+      AVAILABLE_PLUGINS.select {|p| p.enabled? }.map {|p| p.new }
+    end
+  end
+end
+

data/lib/ecs_compose/task_definition.rb

@@ -21,22 +21,69 @@ module EcsCompose
     # add a new version of the task.  Returns a string of the form
     # `"name:revision"` identifying the task we registered, or an existing
     # task with the same properties.
-    def register
-      existing = Ecs.describe_task_definition(@name).fetch("taskDefinition")
+    def register(deployed=nil)
+      # Describe the version we're currently running.
+      if deployed
+        existing = Ecs.describe_task_definition(deployed)
+          .fetch("taskDefinition")
+      else
+        existing = nil
+      end
+
+      # Register the new version.  We always need to do this, so that we
+      # can compare two officially normalized versions of the same task,
+      # including any fields added by Amazon.
       new = register_new.fetch("taskDefinition")
-      use =
-        if Compare.task_definitions_match?(existing, new)
-          existing
-        else
-          new
-        end
-      "#{use.fetch('family')}:#{use.fetch('revision')}"
+
+      # Decide whether we can re-use the existing registration.
+      if existing && Compare.task_definitions_match?(existing, new)
+        rev1 = "#{existing.fetch('family')}:#{existing.fetch('revision')}"
+        rev2 = "#{new.fetch('family')}:#{new.fetch('revision')}"
+        puts "Running copy of #{rev1} looks good; not updating to #{rev2}."
+        Plugins.plugins.each {|p| p.notify_skipping_deploy(existing, new) }
+        wanted = existing
+      else
+        wanted = new
+      end
+      "#{wanted.fetch('family')}:#{wanted.fetch('revision')}"
+    end
+
+    # Get the existing "PRIMARY" deployment for the ECS service
+    # corresponding to this task definition, and return it in
+    # `name:revision` format.  Returns `nil` if it can't find a primary
+    # deployment.
+    def primary_deployment(cluster)
+      # Try to describe the existing service.
+      begin
+        service = Ecs.describe_services(cluster.name, [@name])
+          .fetch("services")[0]
+      rescue => e
+        puts <<EOD
+Error: #{e}
+
+Can't find an existing service '#{name}'.  You'll probably need to
+register one manually using the AWS console and set up any load balancers
+you might need.
+EOD
+        return nil
+      end
+
+      # Find the primary deployment.
+      deployment = service.fetch("deployments").find do |d|
+        d["status"] == "PRIMARY"
+      end
+      return nil if deployment.nil?
+
+      # Extract a task definition `name:revision`.
+      arn = deployment.fetch("taskDefinition")
+      arn.split('/').last
     end
 
     # Register this task definition with ECS, and update the corresponding
     # service.
     def update(cluster)
-      Ecs.update_service(cluster.name, name, register)
+      deployed = primary_deployment(cluster)
+      Ecs.update_service(cluster.name, name, register(deployed))
       name
     end
 

data/lib/ecs_compose.rb

@@ -7,6 +7,7 @@ require "ecs_compose/task_error"
 require "ecs_compose/cluster"
 require "ecs_compose/task_definition"
 require "ecs_compose/manifest"
+require "ecs_compose/plugins"
 require "ecs_compose/compare"
 
 module EcsCompose

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_compose
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre23
+  version: 0.1.0.pre26
 platform: ruby
 authors:
 - Eric Kidd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +124,9 @@ files:
 - lib/ecs_compose/ecs.rb
 - lib/ecs_compose/json_generator.rb
 - lib/ecs_compose/manifest.rb
+- lib/ecs_compose/plugins.rb
+- lib/ecs_compose/plugins/plugin.rb
+- lib/ecs_compose/plugins/vault_plugin.rb
 - lib/ecs_compose/service_error.rb
 - lib/ecs_compose/task_definition.rb
 - lib/ecs_compose/task_error.rb