shipit-engine 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 982c05d52c22af2e2e26f352efc805d9ef961759
-  data.tar.gz: 3a43a97130cc13814c6368ec89e219cb5face2c9
+  metadata.gz: 80b89004571af2792321c0d57a3659ebb7cb21aa
+  data.tar.gz: 06363fdf4d7f9e3ba64bf992eaf11855ecfb1061
 SHA512:
-  metadata.gz: 2579172befb2eb5054a42935b8bf4fd97bfc53098291468a881171faa708b10f538c3ddbedc2b0560dd0a597bc9f64cee2066d2045ba46d9d66d60e152c38d13
-  data.tar.gz: 72f2f25e93719769e1ceeffe3c952cbd460a80864151ba9a5761b813114791aadbc6888cebd48e24fb552384ce3943250d698f2ef195ed1c3f304e5bd10d206c
+  metadata.gz: ea768d3e022264786c9ddf0b9bbc1d36fb5f8379fc362c9a285d4eab28014d17c248ea9471ff55b0ef45dafa7ac529858e632ee2c2b99aa96cb1f0f1e1d5a00a
+  data.tar.gz: 26c9579f88a71172c84c510172d882c31a2edac8b468ef1c983ab056b5a37ff367331a79524172321abd2cecfa19b89a88c40e1784a25600de713f156d3e4009

data/README.md

@@ -250,6 +250,23 @@ deploy:
 ```
 <br>
 
+**<code>deploy.variables.select</code>** will turn the input into a `<select>` of values.
+
+For example:
+
+```yaml
+deploy:
+  variables:
+    -
+      name: REGION
+      title: Run a deploy in a given region
+      select:
+        - east
+        - west
+        - north
+```
+<br>
+
 **<code>deploy.max_commits</code>** allows you to set a limit to the number of commits being shipped per deploys.
 
 Human users will be warned that they are not respecting the recommendation, but allowed to continue.

data/app/assets/stylesheets/_pages/_deploy.scss

@@ -15,7 +15,7 @@
 }
 
 .variables-fields {
-  input {
+  input, select {
     display: inline-block;
     width: inherit;
     margin-right: 1rem;

data/app/assets/stylesheets/_structure/_layout.scss

@@ -14,7 +14,6 @@
 // -----------------------------------------------------------------------------
 
 .header {
-  height: 9rem;
   border-bottom: 1px solid #e5e5e5;
   background-color: #fff;
   color: #999;

data/app/models/shipit/deploy_spec/bundler_discovery.rb

@@ -12,8 +12,11 @@ module Shipit
       end
 
       def bundle_exec(command)
-        return command unless bundler?
-        "bundle exec #{command}"
+        if bundler? && dependencies_steps.include?(remove_ruby_version_from_gemfile)
+          "bundle exec #{command}"
+        else
+          command
+        end
       end
 
       def bundle_install
@@ -51,10 +54,7 @@ module Shipit
       end
 
       def coerce_task_definition(config)
-        return super unless bundler?
-        config['steps'] ||= []
-        config['steps'] = config['steps'].map(&method(:bundle_exec))
-        config
+        config.merge('steps' => Array(config['steps']).map(&method(:bundle_exec)))
       end
     end
   end

data/app/models/shipit/stack.rb

@@ -284,6 +284,8 @@ module Shipit
       handle_github_redirections do
         Shipit.github_api.commits(github_repo_name, sha: branch)
       end
+    rescue Octokit::Conflict
+      [] # Repository is empty...
     end
 
     def handle_github_redirections

data/app/models/shipit/variable_definition.rb

@@ -1,11 +1,12 @@
 module Shipit
   class VariableDefinition
-    attr_reader :name, :title, :default
+    attr_reader :name, :title, :default, :select
 
     def initialize(attributes)
       @name = attributes.fetch('name')
       @title = attributes['title']
       @default = attributes['default'].to_s
+      @select = attributes['select'].presence
     end
 
     def to_h
@@ -13,6 +14,7 @@ module Shipit
         'name' => @name,
         'title' => @title,
         'default' => @default,
+        'select' => @select,
       }
     end
   end

data/app/views/shipit/_variables.html.erb

@@ -6,7 +6,11 @@
     <%= form.fields_for field_name do |field| %>
       <% variables.each do |variable| %>
         <p class="variables-fields">
-          <%= field.text_field variable.name, value: variable.default %>
+          <% if variable.select %>
+            <%= field.select variable.name, options_for_select([["Please select...", { disabled: "disabled", selected: true }]] + variable.select) %>
+          <% else %>
+            <%= field.text_field variable.name, value: variable.default %>
+          <% end %>
           <%= field.label variable.name, variable.title || variable.name %>
         </p>
       <% end %>

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

data/lib/snippets/deploy-to-gke

@@ -0,0 +1,162 @@
+#!/usr/bin/env ruby
+
+# Usage: deploy-to-gke <app's namespace> <gcloud deployment> <gcloud project>
+
+# Requires the following to be available on Shipit machine:
+#  - gcloud binary available on the shipit machine's path
+#  - kubectl binary available in the shipit machine's path
+#  - $GCLOUD_CREDENTIALS_DIR/my-gcloud-project-name.json must exist
+
+# Optionally, the following variables can be used to override script defaults:
+#  - K8S_TEMPLATE_FOLDER: location of Kubernetes files to deploy. Default is config/deploy/#{environment}.
+
+require 'open3'
+require 'securerandom'
+require 'erb'
+require 'json'
+require 'yaml'
+require 'shellwords'
+require 'tempfile'
+
+class GKEDeployment
+  class FatalDeploymentError < StandardError; end
+
+  def initialize(namespace:, gcloud_deployment:, gcloud_project:, environment:, current_sha:, key_dir:, template_folder: nil)
+    @namespace = namespace
+    @gcloud_deployment = gcloud_deployment
+    @gcloud_project = gcloud_project
+    @current_sha = current_sha
+    @key_file = "#{key_dir}/#{@gcloud_project}.json"
+    @template_path = './' + (template_folder || "config/deploy/#{environment}")
+
+    # Validate params + check existance of auth key and template(s)
+    enforce_required_params
+    preliminary_check
+
+    # Max length of podname is only 63chars so try to save some room by truncating sha to 8 chars
+    @id = current_sha[0...8] + "-#{SecureRandom.hex(4)}"
+  end
+
+  def run
+    authorize_gcloud
+    fetch_clusters.each do |cluster|
+      set_kubectl_cluster(cluster)
+      apply_all_templates
+    end
+  rescue FatalDeploymentError => error
+    print_error(error.message)
+    exit 1
+  end
+
+  def template_variables
+    {
+      'current_sha' => @current_sha,
+      'deployment_id' => @id,
+    }
+  end
+
+  private
+
+  def enforce_required_params
+    [@namespace, @gcloud_project, @gcloud_deployment, @current_sha, @key_file].each do |required_param|
+      raise ArgumentError, "#{required_param} is required" unless required_param && !required_param.empty?
+    end
+  end
+
+  def preliminary_check
+    raise FatalDeploymentError, "Project config missing at #{@key_file}" unless File.file?(@key_file)
+    raise FatalDeploymentError, "#{@template_path} doesn't exist" unless File.directory?(@template_path)
+    raise FatalDeploymentError, "#{@template_path} doesn't have files with postfix .yml or .yml.erb" unless Dir.entries(@template_path).select {|file| file =~ /\.yml(.erb)?$/}.size > 0
+  end
+
+  def apply_all_templates
+    found = 0
+    Dir.foreach(@template_path) do |file|
+      file_path = "#{@template_path}/#{file}"
+      if File.extname(file) == '.yml'
+        found += 1
+        apply_template(file_path)
+      elsif File.extname(file) == '.erb'
+        found += 1
+        render_and_apply_template(file_path)
+      end
+    end
+    raise FatalDeploymentError, "No templates found in #{@template_path}" if found.zero?
+  end
+
+  def render_and_apply_template(file_path)
+    erb_template = ERB.new(File.read(file_path))
+    erb_binding = binding
+    template_variables.each do |var_name, value|
+      erb_binding.local_variable_set(var_name, value)
+    end
+    content = erb_template.result(erb_binding)
+
+    f = Tempfile.new(['kube_template', '.yml'])
+    f.write(content)
+    f.close
+    apply_template(f.path, original_path: file_path)
+  ensure
+    f.unlink if f
+  end
+
+  def apply_template(path, original_path: nil)
+    status = run_command('kubectl', 'apply', '-f', path, "--namespace=#{@namespace}")
+    raise FatalDeploymentError, "Failed to apply template #{original_path || path}" unless status
+  end
+
+  def authorize_gcloud
+    ENV['GOOGLE_APPLICATION_CREDENTIALS'] = @key_file
+    status = run_command('gcloud', '-q', 'auth', 'activate-service-account', '--key-file', @key_file)
+    status = run_command('gcloud', '-q', 'config', 'set', 'project', @gcloud_project) if status
+    raise FatalDeploymentError, "Failed to set gcloud project #{@gcloud_project}" unless status
+  end
+
+  def set_kubectl_cluster(cluster)
+    cluster_name = cluster[0]
+    cluster_zone = cluster[1]
+    status = run_command('gcloud', '-q', 'container', 'clusters', 'get-credentials', cluster_name, '--zone', cluster_zone)
+    raise FatalDeploymentError, "Failed to set cluster #{cluster_name}/#{cluster_zone}" unless status
+  end
+
+  def fetch_clusters
+    result = query_deployments
+    result['resources'].each_with_object([]) do |resource, data|
+      next unless resource['type'] == 'container.v1.cluster'
+      properties = YAML.load(resource['finalProperties'])
+      data << [resource['name'], properties['zone']]
+    end
+  end
+
+  def run_command(*args)
+    puts Shellwords.join(args)
+    out, err, st = Open3.capture3(*args)
+    puts out
+    print_error(err) unless st.success?
+    st.success?
+  end
+
+  def print_error(msg)
+    puts "\033[0;31m#{msg}\033[0m"
+  end
+
+  def query_deployments
+    out, err, st = Open3.capture3('gcloud', '-q', 'deployment-manager', 'deployments', 'describe', @gcloud_deployment, '--format=json')
+    unless st.success?
+      print_error(err)
+      raise FatalDeploymentError, "Failed to fetch cluster with deployment #{@gcloud_deployment}"
+    end
+    JSON.parse(out)
+  end
+end
+
+deployment = GKEDeployment.new(
+  namespace: ARGV[0],
+  gcloud_deployment: ARGV[1],
+  gcloud_project: ARGV[2],
+  environment: ENV['ENVIRONMENT'],
+  template_folder: ENV['K8S_TEMPLATE_FOLDER'],
+  current_sha: ENV['REVISION'],
+  key_dir: ENV['GCLOUD_CREDENTIALS_DIR']
+)
+deployment.run

data/test/dummy/app/views/layouts/application.html.erb

@@ -2,6 +2,7 @@
 <html>
 <head>
   <title>Shipit</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
   <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
   <%= csrf_meta_tags %>

data/test/models/task_definitions_test.rb

@@ -34,8 +34,8 @@ module Shipit
         checklist: [],
         allow_concurrency: true,
         variables: [
-          {'name' => 'FOO', 'title' => 'Set to 0 to foo', 'default' => '1'},
-          {'name' => 'BAR', 'title' => 'Set to 1 to bar', 'default' => '0'},
+          {'name' => 'FOO', 'title' => 'Set to 0 to foo', 'default' => '1', 'select' => nil},
+          {'name' => 'BAR', 'title' => 'Set to 1 to bar', 'default' => '0', 'select' => nil},
         ],
       }
       assert_equal as_json, TaskDefinition.load(TaskDefinition.dump(@definition)).as_json

data/test/unit/deploy_spec_test.rb

@@ -37,14 +37,14 @@ module Shipit
     end
 
     test '#dependencies_steps returns `bundle install` if a `Gemfile` is present' do
-      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:bundle_install).returns(['bundle install'])
       assert_equal ['bundle install'], @spec.dependencies_steps
     end
 
     test "#dependencies_steps prepend and append pre and post steps" do
       @spec.stubs(:load_config).returns('dependencies' => {'pre' => ['before'], 'post' => ['after']})
-      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:bundle_install).returns(['bundle install'])
       assert_equal ['before', 'bundle install', 'after'], @spec.dependencies_steps
     end
@@ -111,14 +111,14 @@ module Shipit
     end
 
     test '#deploy_steps returns `cap $ENVIRONMENT deploy` if a `Capfile` is present' do
-      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:capistrano?).returns(true)
       assert_equal ['bundle exec cap $ENVIRONMENT deploy'], @spec.deploy_steps
     end
 
     test "#deploy_steps prepend and append pre and post steps" do
       @spec.stubs(:load_config).returns('deploy' => {'pre' => ['before'], 'post' => ['after']})
-      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:capistrano?).returns(true)
       assert_equal ['before', 'bundle exec cap $ENVIRONMENT deploy', 'after'], @spec.deploy_steps
     end
@@ -136,14 +136,14 @@ module Shipit
     end
 
     test '#rollback_steps returns `cap $ENVIRONMENT deploy:rollback` if a `Capfile` is present' do
-      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:capistrano?).returns(true)
       assert_equal ['bundle exec cap $ENVIRONMENT deploy:rollback'], @spec.rollback_steps
     end
 
     test "#rollback_steps prepend and append pre and post steps" do
       @spec.stubs(:load_config).returns('rollback' => {'pre' => ['before'], 'post' => ['after']})
-      @spec.expects(:bundler?).returns(true)
+      @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:capistrano?).returns(true)
       assert_equal ['before', 'bundle exec cap $ENVIRONMENT deploy:rollback', 'after'], @spec.rollback_steps
     end
@@ -262,6 +262,17 @@ module Shipit
       assert_equal ['bundle exec foo'], definition.steps
     end
 
+    test "task definitions do not prepend bundle exec if depedency step is overridden" do
+      @spec.expects(:load_config).returns(
+        'dependencies' => {'override' => []},
+        'tasks' => {'restart' => {'steps' => %w(foo)}},
+      )
+      @spec.expects(:bundler?).returns(true).at_least_once
+      definition = @spec.find_task_definition('restart')
+
+      assert_equal ['foo'], definition.steps
+    end
+
     test "task definitions prepend bundle exec before serialization" do
       @spec.expects(:load_config).returns('tasks' => {'restart' => {'steps' => %w(foo)}})
       @spec.expects(:bundler?).returns(true).at_least_once

data/test/unit/variable_definition_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module Shipit
+  class VariableDefinitionTest < ActiveSupport::TestCase
+    setup do
+      @attributes = {
+        "name" => "Variable name",
+        "title" => "Variable title",
+        "default" => "Variable default",
+      }
+      @select = %w(var1 var2 var3)
+    end
+
+    test "#initialize sets up the expected values" do
+      subject = Shipit::VariableDefinition.new(@attributes)
+
+      assert_equal "Variable name", subject.name
+      assert_equal "Variable title", subject.title
+      assert_equal "Variable default", subject.default
+      assert_nil subject.select
+    end
+
+    test "#initialize name is required" do
+      assert_raises KeyError do
+        @attributes.delete("name")
+        Shipit::VariableDefinition.new(@attributes)
+      end
+    end
+
+    test "#initialize stringifies the default" do
+      @attributes["default"] = :value
+      subject = Shipit::VariableDefinition.new(@attributes)
+
+      assert_equal "value", subject.default
+    end
+
+    test "#initialize sets the select if present" do
+      @attributes["select"] = @select
+      subject = Shipit::VariableDefinition.new(@attributes)
+
+      assert_equal @select, subject.select
+    end
+
+    test "#initialize sets nil for select if the array is empty" do
+      @attributes["select"] = []
+      subject = Shipit::VariableDefinition.new(@attributes)
+
+      assert_nil subject.select
+    end
+
+    test "#to_h returns hash version" do
+      assert_equal @attributes.merge("select" => nil), Shipit::VariableDefinition.new(@attributes).to_h
+    end
+
+    test "#to_h returns hash version that includes select" do
+      assert_equal @attributes.merge("select" => @select), Shipit::VariableDefinition.new(@attributes.merge("select" => @select)).to_h
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -737,6 +737,7 @@ files:
 - lib/shipit/version.rb
 - lib/snippets/assert-egg-version-tag
 - lib/snippets/assert-gem-version-tag
+- lib/snippets/deploy-to-gke
 - lib/snippets/extract-egg-version
 - lib/snippets/extract-gem-version
 - lib/snippets/fetch-gem-version
@@ -883,6 +884,7 @@ files:
 - test/unit/environment_variables_test.rb
 - test/unit/github_url_helper_test.rb
 - test/unit/shipit_test.rb
+- test/unit/variable_definition_test.rb
 - vendor/assets/javascripts/clusterize.js
 - vendor/assets/javascripts/jquery-notify.js
 - vendor/assets/javascripts/mousetrap-global-bind.js
@@ -1051,3 +1053,4 @@ test_files:
 - test/unit/environment_variables_test.rb
 - test/unit/github_url_helper_test.rb
 - test/unit/shipit_test.rb
+- test/unit/variable_definition_test.rb