dpl-code_deploy 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b6b1afca5c5e56e7d2f21490ed1ef98653cf698
+  data.tar.gz: b3b341b6703e21763e62b9e1121ee272cb0a4db0
+SHA512:
+  metadata.gz: e72df0817c9af23e512d8d9360e312ab89d42a7f27bdb8aca07b9720ba7f487b17fd11b55aecb32f256f6740c52c01714be82c943d7185326ec6a9e5f949f9f8
+  data.tar.gz: 6f4e23a292948ff1ef835734756b2bd151fb98ca436f2ae615e49d688b513b6fd803bdfa36f73e51b27446453ae80e3e7b8a9e5167fd58139316efec84ce3ac1

data/dpl-code_deploy.gemspec

@@ -0,0 +1,3 @@
+require './gemspec_helper'
+
+gemspec_for 'code_deploy', [['aws-sdk', '~> 2.0']]

data/lib/dpl/provider/code_deploy.rb

@@ -0,0 +1,153 @@
+require 'json'
+require 'aws-sdk'
+
+module DPL
+  class Provider
+    class CodeDeploy < Provider
+      def code_deploy
+        @code_deploy ||= Aws::CodeDeploy::Client.new(code_deploy_options)
+      end
+
+      def s3api
+        @s3api ||= Aws::S3::Client.new(code_deploy_options)
+      end
+
+      def code_deploy_options
+        code_deploy_options = {
+          region:      options[:region] || 'us-east-1',
+          credentials: Aws::Credentials.new(access_key_id, secret_access_key)
+        }
+        code_deploy_options[:endpoint] = options[:endpoint] if options[:endpoint]
+        code_deploy_options
+      end
+
+      def access_key_id
+        options[:access_key_id] || context.env['AWS_ACCESS_KEY_ID'] || raise(Error, "missing access_key_id")
+      end
+
+      def secret_access_key
+        options[:secret_access_key] || context.env['AWS_SECRET_ACCESS_KEY'] || raise(Error, "missing secret_access_key")
+      end
+
+      def needs_key?
+        false
+      end
+
+      def revision
+        case options[:revision_type].to_s.downcase
+        when "s3"     then s3_revision
+        when "github" then github_revision
+        when ""       then options[:bucket] ? s3_revision : github_revision
+        else error("unknown revision type %p" % options[:revision_type])
+        end
+      end
+
+      def revision_version_info
+        s3api.head_object({
+          bucket: option(:bucket),
+          key: s3_key
+        })
+      rescue Aws::Errors::ServiceError
+        {}
+      end
+
+      def s3_revision
+        info = {
+          revision_type: 'S3',
+          s3_location: {
+            bucket:      option(:bucket),
+            bundle_type: bundle_type,
+            key:         s3_key,
+          }
+        }
+        unless revision_version_info.empty?
+          info[:s3_location][:version] = revision_version_info[:version_id]
+          info[:s3_location][:e_tag]   = revision_version_info[:etag]
+        end
+
+        info
+      end
+
+      def github_revision
+        {
+          revision_type: 'GitHub',
+          git_hub_location: {
+            commit_id:  options[:commit_id]  || context.env['TRAVIS_COMMIT']    || `git rev-parse HEAD`.strip,
+            repository: options[:repository] || context.env['TRAVIS_REPO_SLUG'] || option(:repository)
+          }
+        }
+      end
+
+      def push_app
+        rev = revision()
+        rev_info = rev[:s3_location]
+
+        if rev_info && rev_info[:version]
+          log "Registering app revision with version=#{rev_info[:version]}, etag=#{rev_info[:e_tag]}"
+          code_deploy.register_application_revision({
+            revision:               rev,
+            application_name:       options[:application] || option(:application_name),
+            description:            options[:description] || default_description
+          })
+        end
+
+        data = code_deploy.create_deployment({
+          revision:               revision,
+          application_name:       options[:application]      || option(:application_name),
+          deployment_group_name:  options[:deployment_group] || option(:deployment_group_name),
+          description:            options[:description]      || default_description
+        })
+        log "Triggered deployment #{data.deployment_id.inspect}."
+        return unless options[:wait_until_deployed]
+        print "Deploying "
+        deployment = wait_until_deployed(data[:deployment_id])
+        print "\n"
+        if deployment[:status] == 'Succeeded'
+          log "Deployment successful."
+        else
+          error "Deployment failed."
+        end
+      rescue Aws::CodeDeploy::Errors::DeploymentLimitExceededException => exception
+        error(exception.message)
+      end
+
+      def wait_until_deployed(deployment_id)
+        deployment = {}
+        loop do
+          result = code_deploy.get_deployment(deployment_id: deployment_id)
+          deployment = result[:deployment_info]
+          break if deployment[:status] == "Succeeded" || deployment[:status] == "Failed" || deployment[:status] == "Stopped"
+          print "."
+          sleep 5
+        end
+        deployment
+      end
+
+      def bundle_type
+        if s3_key =~ /\.(tar|tgz|zip)$/
+          options[:bundle_type] || $1
+        else
+          option(:bundle_type)
+        end
+      end
+
+      def s3_key
+        options[:key] || option(:s3_key)
+      end
+
+      def default_description
+        "Deploy build #{context.env['TRAVIS_BUILD_NUMBER']} via Travis CI"
+      end
+
+      def check_auth
+        log "Logging in with Access Key: #{access_key_id[-4..-1].rjust(20, '*')}"
+      end
+
+      def cleanup
+      end
+
+      def uncleanup
+      end
+    end
+  end
+end

data/spec/provider/code_deploy_spec.rb

@@ -0,0 +1,366 @@
+require 'spec_helper'
+require 'aws-sdk'
+require 'dpl/error'
+require 'dpl/provider'
+require 'dpl/provider/code_deploy'
+
+describe DPL::Provider::CodeDeploy do
+
+  subject :provider do
+    described_class.new(DummyContext.new, :access_key_id => 'qwertyuiopasdfghjklz', :secret_access_key => 'qwertyuiopasdfghjklzqwertyuiopasdfghjklz')
+  end
+
+  describe '#code_deploy_options' do
+    context 'without region' do
+      example do
+        options = provider.code_deploy_options
+        expect(options[:region]).to eq('us-east-1')
+      end
+    end
+
+    context 'with region' do
+      example do
+        region = 'us-west-1'
+        provider.options.update(:region => region)
+        options = provider.code_deploy_options
+        expect(options[:region]).to eq(region)
+      end
+    end
+
+    context 'without endpoint' do
+      example do
+        options = provider.code_deploy_options
+        expect(options[:endpoint]).to eq(nil)
+      end
+    end
+
+    context 'with endpoint' do
+      example do
+        endpoint = 's3test.com.s3-website-us-west-2.amazonaws.com'
+        provider.options.update(:endpoint => endpoint)
+        options = provider.code_deploy_options
+        expect(options[:endpoint]).to eq(endpoint)
+      end
+    end
+  end
+end
+
+describe DPL::Provider::CodeDeploy do
+  access_key_id = 'someaccesskey'
+  secret_access_key = 'somesecretaccesskey'
+  application = 'app'
+  deployment_group = 'group'
+  description = 'description'
+  revision = '23jkljkl'
+  client_options = {
+    :stub_responses => true,
+    :region => 'us-east-1',
+    :credentials => ::Aws::Credentials.new(access_key_id, secret_access_key),
+    :endpoint => 'https://codedeploy.us-east-1.amazonaws.com'
+  }
+
+  subject :provider do
+    described_class.new(DummyContext.new, {
+      :access_key_id => access_key_id,
+      :secret_access_key => secret_access_key
+    })
+  end
+
+  before :each do
+    provider.stub(:code_deploy_options).and_return(client_options)
+  end
+
+  describe '#code_deploy' do
+    example do
+      expect(::Aws::CodeDeploy::Client).to receive(:new).with(client_options).once
+      provider.code_deploy
+    end
+  end
+
+  describe '#needs_key?' do
+    example do
+      expect(provider.needs_key?).to eq(false)
+    end
+  end
+
+  describe '#revision' do
+    expected_s3_revision = {
+      revision_type: 'S3',
+      s3_location: {
+        bucket:      'bucket',
+        bundle_type: 'tar',
+        key:         'key',
+        version:     'object_version_id',
+        e_tag:       'etag'
+      }
+    }
+
+    expected_github_revision = {
+      revision_type: 'GitHub',
+      git_hub_location: {
+        commit_id:  '2lk3j4k2j3k4j23k4j',
+        repository: 'travis-ci/dpl'
+      }
+    }
+
+    before(:each) do
+      provider.stub(:s3_revision).and_return(expected_s3_revision)
+      provider.stub(:github_revision).and_return(expected_github_revision)
+    end
+
+    context 'when s3' do
+      before do
+        provider.options.update(:revision_type => :s3)
+      end
+
+      example do
+        expect(provider.revision).to eq(expected_s3_revision)
+      end
+    end
+
+    context 'when github' do
+      before do
+        provider.options.update(:revision_type => :github)
+      end
+
+      example do
+        expect(provider.revision).to eq(expected_github_revision)
+      end
+    end
+
+    context 'when not specified' do
+      before do
+        provider.options.update(:bucket => 'bucket')
+      end
+
+      example do
+        expect(provider.revision).to eq(expected_s3_revision)
+      end
+    end
+
+    context 'when revision and bucket are not specified' do
+      example do
+        expect(provider.revision).to eq(expected_github_revision)
+      end
+    end
+
+    context 'when not a known revision type' do
+      type = :bad
+
+      before do
+        provider.options.update(:revision_type => type)
+      end
+
+      example do
+        expect(provider).to receive(:error).with(/unknown revision type :#{type}/)
+        provider.revision
+      end
+    end
+  end
+
+  describe '#s3_revision' do
+    bucket = 'bucket'
+    bundle_type = 'tar'
+    key = "/some/key.#{bundle_type}"
+
+    before(:each) do
+      head_data = provider.s3api.stub(:head_object).and_return({
+        version_id: 'object_version_id',
+        etag: 'etag'
+      })
+      provider.s3api.stub_responses(:head_object, head_data)
+      expect(provider).to receive(:option).at_least(1).times.with(:bucket).and_return(bucket)
+      expect(provider).to receive(:bundle_type).and_return(bundle_type)
+      expect(provider).to receive(:s3_key).at_least(1).times.and_return(key)
+    end
+
+    example do
+      expect(provider.s3_revision[:s3_location]).to include(
+          bucket: bucket,
+          bundle_type: bundle_type,
+          key: key,
+          version: 'object_version_id',
+          e_tag: 'etag'
+        )
+    end
+  end
+
+  describe '#github_revision' do
+    commit_id = '432s35s3'
+    repository = 'git@github.com/org/repo.git'
+
+    context 'with options set' do
+      before(:each) do
+        expect(provider.options).to receive(:[]).with(:commit_id).and_return(commit_id)
+        expect(provider.options).to receive(:[]).with(:repository).and_return(repository)
+      end
+
+      example do
+        expect(provider.github_revision).to eq({
+          revision_type: 'GitHub',
+          git_hub_location: {
+            commit_id: commit_id,
+            repository: repository
+          }
+        })
+      end
+    end
+
+    context 'with environment variables' do
+      before(:each) do
+        expect(provider.options).to receive(:[]).with(:commit_id).and_return(nil)
+        expect(provider.options).to receive(:[]).with(:repository).and_return(nil)
+        expect(provider.context.env).to receive(:[]).with('TRAVIS_COMMIT').and_return(commit_id)
+        expect(provider.context.env).to receive(:[]).with('TRAVIS_REPO_SLUG').and_return(repository)
+      end
+
+      example do
+        expect(provider.github_revision).to eq({
+          revision_type: 'GitHub',
+          git_hub_location: {
+            commit_id: commit_id,
+            repository: repository
+          }
+        })
+      end
+    end
+
+    context 'without required options' do
+      before(:each) do
+        expect(provider.options).to receive(:[]).with(:commit_id).and_return(nil)
+        provider.options.stub(:[]).with(:repository) { nil }
+        expect(provider.context.env).to receive(:[]).with('TRAVIS_COMMIT').and_return(nil)
+        expect(provider.context.env).to receive(:[]).with('TRAVIS_REPO_SLUG').and_return(nil)
+      end
+
+      example do
+        expect{provider.github_revision}.to raise_error(DPL::Error)
+      end
+    end
+  end
+
+  describe '#push_app' do
+    before(:each) do
+      old_options = provider.options
+      provider.stub(:options) {old_options.merge({
+        :application_name => application,
+        :deployment_group_name => deployment_group,
+        :description => description,
+        :repository => 'git@github.com:travis-ci/dpl.git'
+      })}
+    end
+
+    context 'without an error' do
+      deployment_id = 'some-deployment-id'
+
+      before do
+        provider.code_deploy.stub_responses(:create_deployment, :deployment_id => deployment_id)
+      end
+
+      example do
+        expect(provider).to receive(:log).with(/Triggered deployment \"#{deployment_id}\"\./)
+        provider.push_app
+      end
+
+       before do
+        allow(provider.code_deploy).to receive(:get_deployment).and_return(
+          {:deployment_info => {:status => "Created"}},
+          {:deployment_info => {:status => "Queued"}},
+          {:deployment_info => {:status => "InProgress"}},
+          {:deployment_info => {:status => "Succeeded"}})
+      end
+
+      example 'with :wait_until_deployed' do
+        old_options = provider.options
+        provider.stub(:options) {old_options.merge({
+          app_id: 'app-id',
+          wait_until_deployed: true})}
+        expect(provider).to receive(:log).with(/Triggered deployment \"#{deployment_id}\"\./)
+        expect(provider).to receive(:log).with(/Deployment successful./)
+        provider.push_app
+      end
+    end
+
+    context 'with an error' do
+      before do
+        provider.code_deploy.stub_responses(:create_deployment, 'DeploymentLimitExceededException')
+      end
+
+      example do
+        expect(provider).to receive(:error).once
+        provider.push_app
+      end
+    end
+  end
+
+  describe '#bundle_type' do
+    context 'with s3_key' do
+      format = 'zip'
+      s3_key = "/some/key/name.#{format}"
+
+      before(:each) do
+        expect(provider).to receive(:s3_key).and_return(s3_key)
+      end
+
+      example do
+        expect(provider.bundle_type).to eq(format)
+      end
+    end
+
+    context 'without s3_key' do
+      bundle_type = 'tar'
+
+      before do
+        expect(provider).to receive(:s3_key).and_return('')
+        expect(provider).to receive(:option).with(:bundle_type).and_return(bundle_type)
+      end
+
+      example do
+        expect(provider.bundle_type).to eq(bundle_type)
+      end
+    end
+  end
+
+  describe '#s3_key' do
+    key = '/some/key/name.zip'
+
+    context 'with key option' do
+      before do
+        expect(provider.options).to receive(:[]).with(:key).and_return(key)
+      end
+
+      example do
+        expect(provider.s3_key).to eq(key)
+      end
+    end
+
+    context 'with s3_key option' do
+      before do
+        expect(provider).to receive(:option).with(:s3_key).and_return(key)
+      end
+
+      example do
+        expect(provider.s3_key).to eq(key)
+      end
+    end
+  end
+
+  describe '#default_description' do
+    build_number = 2
+
+    before do
+      provider.context.env.stub(:[]).with('TRAVIS_BUILD_NUMBER').and_return(build_number)
+    end
+
+    example do
+      expect(provider.default_description).to eq("Deploy build #{build_number} via Travis CI")
+    end
+  end
+
+  describe '#check_auth' do
+    example do
+      expect(provider).to receive(:log).with("Logging in with Access Key: #{access_key_id[-4..-1].rjust(20, '*')}")
+      provider.check_auth
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: dpl-code_deploy
+version: !ruby/object:Gem::Version
+  version: 1.9.0
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dpl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: deploy tool abstraction for clients
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- dpl-code_deploy.gemspec
+- lib/dpl/provider/code_deploy.rb
+- spec/provider/code_deploy_spec.rb
+homepage: https://github.com/travis-ci/dpl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: deploy tool
+test_files:
+- spec/provider/code_deploy_spec.rb