marathon_deploy 0.1.50 → 0.1.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f756c9936eefbd912e30c63e7d6f92ced9cbd878
-  data.tar.gz: 9850ae0570fa9cd09334bf443ecf1ac2aac5f39a
+  metadata.gz: c8ec0de90dd1044ab3fb6c745573bd7c581b05cf
+  data.tar.gz: 9acb752923bc76613fb52dc434321ca91e59a131
 SHA512:
-  metadata.gz: 45284e7b60f096f5de4ee4cd7c50717fa7f4080766cba750914033998458642e0451b7968c1f9dee4e82fc08b07ad941327d20473b5f7b392645a4a32bd3e225
-  data.tar.gz: 4b19afdcd201eca3d20926532098b2c595d95572c102cd9fe569eb324c2984c821bd97b514974d2c412124bb60c1228c27da75da52cb61297171abd9fd8bb84e
+  metadata.gz: 6fe017f45a353d2facdeb6be31d6242c236cdb4eca9c6dc50774f168a046a42e94bb52f2568cfe2ba828a8e510391fa2ca24fcd7d5e87d89f541463babd68c99
+  data.tar.gz: ed35c7dece6853974fcb02017d3f0264495c488fb807e85f607b535691db3eb18d22ea4856c1973469c237dfd3d4161beb67bf0487460f1df8294c513704aac5

data/README.md

@@ -51,6 +51,14 @@ Usage: bin/marathon_deploy [options]
     -e, --environment ENVIRONMENT    Default: PREPRODUC
 ```
 
+### Overriding configuration based on environment
+By using the `-e <ENVIRONMENT>` switch you can specify a custom environment which can overwrite the settings in the deploy file.
+For example, setting `-e STAGING` and creating a STAGING.yml or STAGING.json file in the same folder with the deploy file
+will trigger the overwriting process.
+
+See `examples/run-with-env-overrides.sh` for a demo of this feature. Here we are specifying different
+memory settings and appending a custom health-check based on environment.
+
 ### Example Deployfile
 By default, a file called 'deploy.yml' is searched for in the current directory where deploy.rb is run from.  An alternative file name can be provided with the -f parameter.
 

data/bin/marathon_deploy

@@ -133,7 +133,11 @@ remove_elements = Array.new
   end
  
 begin
-  application = MarathonDeploy::Application.new(:deployfile => deployfile, :force => options[:force], :remove_elements => remove_elements)
+  application = MarathonDeploy::Application.new(
+      :deployfile => deployfile,
+      :environment => environment,
+      :force => options[:force],
+      :remove_elements => remove_elements)
 rescue MarathonDeploy::Error::IOError, MarathonDeploy::Error::UndefinedMacroError,MarathonDeploy::Error::MissingMarathonAttributesError,MarathonDeploy::Error::UnsupportedFileExtension  => e
   $LOG.debug(e)
   $LOG.error(e.message)

data/examples/CUSTOM_ENV.yml

@@ -0,0 +1,13 @@
+---
+mem: 4096
+env:
+  JAVA_XMX: 2048m
+healthChecks:
+- gracePeriodSeconds: 30
+  path: "/prod/health"
+  intervalSeconds: 10
+  maxConsecutiveFailures: 3
+  portIndex: 0
+  protocol: HTTP
+  timeoutSeconds: 30
+

data/examples/run-with-env-overrides.sh

@@ -0,0 +1,2 @@
+echo The settings in deploy.yml will be overwritten/enhanced by CUSTOM_ENV.yml file
+bundle exec marathon_deploy --debug --noop deploy.yml --environment CUSTOM_ENV

data/lib/marathon_deploy/application.rb

@@ -2,6 +2,7 @@ require 'marathon_deploy/marathon_defaults'
 require 'marathon_deploy/yaml_json'
 require 'marathon_deploy/error'
 require 'marathon_deploy/utils'
+require 'deep_merge'
 
 module MarathonDeploy
   
@@ -13,35 +14,25 @@ module MarathonDeploy
   # @param [Hash] options hash for the application object
   # @option options [Boolean] :force force a deployment by including an environment variable containing a random string value in the json marathon payload
   # @option options [String] :deployfile file template and path. default deploy.yml in current directory
-  def initialize(options={ :force => false, :deployfile => 'deploy.yml', :remove_elements => []})
+  # @option options [MarathonDeploy::Environment] :environment environment specified with -e parameter
+  def initialize(options={
+      :force => false,
+      :deployfile => 'deploy.yml',
+      :remove_elements => [],
+      :environment => nil,
+  })
 
     deployfile = options[:deployfile]
-    
-    if (!File.exist?(deployfile))
-      message = "\'#{File.expand_path(deployfile)}\' not found."
-      raise Error::IOError, message, caller
-    end
+    @json = readFile(deployfile)
 
-    extension = File.extname(deployfile)
-    
-    case extension
-      when '.json'
-        @json = YamlJson.read_json_w_macros(deployfile)
-      when '.yaml','.yml'
-        @json = YamlJson.yaml2json(deployfile)
-      else
-        message = "File extension #{extension} is not supported for deployment file #{deployfile}"
-        raise Error::UnsupportedFileExtension, message, caller
-    end 
+    if (!options[:environment].nil?)
+      overrides = env_overrides(
+        File.dirname(deployfile),
+        options[:environment].name)
 
-    # JSON fix for marathon
-    # marathon require ENV variables to be quoted
-    @json['env'].each do |key, value|
-      if (value.is_a? Numeric)
-        @json['env'][key] = value.to_json
-      end
+      @json = @json.deep_merge!(overrides)
     end
-    
+
     missing_attributes = MarathonDefaults.missing_attributes(@json) 
     
     if(!missing_attributes.empty?)
@@ -69,7 +60,8 @@ module MarathonDeploy
   def overlay_preproduction_settings
     @json = MarathonDefaults.overlay_preproduction_settings(@json)
   end
-  
+
+  # @return [Array]
   def health_checks
     @json[:healthChecks]
   end
@@ -120,7 +112,51 @@ module MarathonDeploy
     
   def instances
     @json[:instances]  
-  end  
-     
+  end
+
+  private
+  def readFile(f)
+    $LOG.debug "Reading file #{f}"
+    if (!File.exist?(f))
+      message = "\'#{File.expand_path(f)}\' not found."
+      raise Error::IOError, message, caller
+    end
+
+    extension = File.extname(f)
+
+    case extension
+      when '.json'
+        json = YamlJson.read_json_w_macros(f)
+      when '.yaml','.yml'
+        json = YamlJson.yaml2json(f)
+      else
+        message = "File extension #{extension} is not supported for deployment file #{f}"
+        raise Error::UnsupportedFileExtension, message, caller
+    end
+
+    # JSON fix for marathon
+    # marathon require ENV variables to be quoted
+    json['env'].each do |key, value|
+      if (value.is_a? Numeric)
+        json['env'][key] = value.to_json
+      end
+    end
+
+    return json
+  end
+
+  def env_overrides(dir, env)
+    yml = "#{dir}/#{env}.yml"
+    if (File.exist?(yml))
+      return readFile(yml)
+    end
+
+    json = "#{dir}/#{env}.json"
+    if (File.exist?(json))
+      return readFile(json)
+    end
+
+    return {}
+  end
   end
 end

data/lib/marathon_deploy/marathon_client.rb

@@ -50,7 +50,10 @@ module MarathonDeploy
     end
 
     if ((300..999).include?(response.code.to_i))
-      $LOG.error("Deployment response body => " + JSON.pretty_generate(JSON.parse(response.body)))
+      rspjson = JSON.parse(response.body)
+      $LOG.error('Deployment error: ' + rspjson['message']) if rspjson.has_key?('message')
+      $LOG.error("With details: #{rspjson}")
+      $LOG.error("Deployment response body => " + JSON.pretty_generate(rspjson))
       raise Error::DeploymentError, "Deployment returned response code #{response.code}", caller
     end
     
@@ -85,4 +88,5 @@ module MarathonDeploy
   end
   
   end
+
 end

data/lib/marathon_deploy/version.rb

@@ -1,3 +1,3 @@
 module MarathonDeploy
-  VERSION = "0.1.50"
+  VERSION = "0.1.51"
 end

data/marathon_deploy.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency "logger"
   spec.add_dependency "json"
+  spec.add_dependency "deep_merge", '~> 1.0', '>= 1.0.1'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/test/application_test.rb

@@ -43,5 +43,27 @@ class ApplicationTest < Minitest::Test
     refute_nil(app.health_checks, "health checks returned nil")    
     refute_empty(app.health_checks, "health checks returned empty")
   end
-  
+
+  def test_overwriting_from_environment_file
+    application = MarathonDeploy::Application.new(
+        :deployfile => File.expand_path('../fixtures/env/deploy.yml', __FILE__),
+        :environment => MarathonDeploy::Environment.new("STAGING")
+    )
+    assert_instance_of(MarathonDeploy::Application,application)
+    refute_empty(application.id)
+    assert_equal(@release_version,application.env[:RELEASE_VERSION])
+    # should stay unchanged since they are not overwritten
+    assert_equal("default-settings-overriden-by-environment-example", application.id)
+    assert_equal("python", application.env[:SERVICE_NAME])
+    # should be overwritten by STAGING.yml
+    assert_equal(16, application.json[:mem])
+    assert_equal(2, application.json[:cpus])
+    assert_equal(5, application.json[:instances])
+    assert_equal("1024m", application.env[:JAVA_XMX])
+    # should be appended from STAGING.yml to already defined health checks
+    assert(application.health_checks.one? { |hc| hc[:path] == "/prod/health/check" }, "new environment-specific health-check should be added")
+    assert(application.health_checks.one? { |hc| hc[:path] == "/default/health/check" }, "default health check should be kept")
+  end
+
+
 end

data/test/fixtures/env/STAGING.yml

@@ -0,0 +1,14 @@
+---
+mem: 16
+cpus: 2
+instances: 5
+env:
+  JAVA_XMX: 1024m
+healthChecks:
+- path: "/prod/health/check"
+  portIndex: 0
+  protocol: HTTP
+  gracePeriodSeconds: 30
+  intervalSeconds: 10
+  timeoutSeconds: 30
+  maxConsecutiveFailures: 3

data/test/fixtures/env/deploy.yml

@@ -0,0 +1,25 @@
+---
+id: default-settings-overriden-by-environment-example
+cmd: echo python stable `hostname` > index.html; python3 -m http.server 8080
+mem: 2
+cpus: 0.1
+instances: 1
+env:
+  SERVICE_TAGS: python,webapp,http,weight=100
+  SERVICE_NAME: python
+  RELEASE_VERSION: %%RELEASE_VERSION%%
+  JAVA_XMX: 256m
+healthChecks:
+- portIndex: 0
+  protocol: TCP
+  gracePeriodSeconds: 30
+  intervalSeconds: 10
+  timeoutSeconds: 30
+  maxConsecutiveFailures: 3
+- path: "/default/health/check"
+  portIndex: 0
+  protocol: HTTP
+  gracePeriodSeconds: 30
+  intervalSeconds: 10
+  timeoutSeconds: 30
+  maxConsecutiveFailures: 3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marathon_deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.50
+  version: 0.1.51
 platform: ruby
 authors:
 - Jonathan Colby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -38,6 +38,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -163,12 +183,14 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
+- examples/CUSTOM_ENV.yml
 - examples/deploy.json
 - examples/deploy.yml
 - examples/jondeploy.yml
 - examples/jondeploy2.yml
 - examples/nohealthchecks.yml
 - examples/public-search-germany-webapp.pre.json
+- examples/run-with-env-overrides.sh
 - examples/run.sh
 - examples/simple-python-example.yml
 - examples/testout.json
@@ -190,6 +212,8 @@ files:
 - test/environment_test.rb
 - test/fixtures/deploy.json
 - test/fixtures/deploy.yml
+- test/fixtures/env/STAGING.yml
+- test/fixtures/env/deploy.yml
 - test/fixtures/macros.yml
 - test/macro_test.rb
 - test/test_helper.rb
@@ -222,6 +246,8 @@ test_files:
 - test/environment_test.rb
 - test/fixtures/deploy.json
 - test/fixtures/deploy.yml
+- test/fixtures/env/STAGING.yml
+- test/fixtures/env/deploy.yml
 - test/fixtures/macros.yml
 - test/macro_test.rb
 - test/test_helper.rb