dpl 2.0.3.beta.4 → 2.0.3.beta.5

data/lib/dpl/providers/codedeploy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     # split this up to CodeDeploy::Github and CodeDeploy::S3 using the
@@ -9,12 +11,12 @@ module Dpl
 
       full_name 'AWS Code Deploy'
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       gem 'aws-sdk-codedeploy', '~> 1.0'
-      gem 'aws-sdk-s3', '~> 1.0'
+      gem 'aws-sdk-s3', '~> 1'
 
       env :aws, :codedeploy
       config '~/.aws/credentials', '~/.aws/config', prefix: 'aws'
@@ -23,28 +25,28 @@ module Dpl
       opt '--secret_access_key KEY', 'AWS secret access key', required: true, secret: true
       opt '--application NAME', 'CodeDeploy application name', required: true
       opt '--deployment_group GROUP', 'CodeDeploy deployment group name'
-      opt '--revision_type TYPE', 'CodeDeploy revision type', enum: %w(s3 github), downcase: true
+      opt '--revision_type TYPE', 'CodeDeploy revision type', enum: %w[s3 github], downcase: true
       opt '--commit_id SHA', 'Commit ID in case of GitHub'
       opt '--repository NAME', 'Repository name in case of GitHub'
       opt '--bucket NAME', 'S3 bucket in case of S3'
       opt '--region REGION', 'AWS availability zone', default: 'us-east-1'
-      opt '--file_exists_behavior STR', 'How to handle files that already exist in a deployment target location', enum: %w(disallow overwrite retain), default: 'disallow'
+      opt '--file_exists_behavior STR', 'How to handle files that already exist in a deployment target location', enum: %w[disallow overwrite retain], default: 'disallow'
       opt '--wait_until_deployed', 'Wait until the deployment has finished'
       opt '--bundle_type TYPE', 'Bundle type of the revision'
       opt '--key KEY', 'S3 bucket key of the revision'
       opt '--description DESCR', 'Description of the revision', interpolate: true
       opt '--endpoint ENDPOINT', 'S3 endpoint url'
 
-      msgs login:                 'Using Access Key: %{access_key_id}',
-           deploy_triggered:      'Deployment triggered: %s',
-           register_revision:     'Registering app revision with version=%s, etag=%s',
-           waiting_for_deploy:    'Waiting for the deployment to finish ',
-           finished_deploy:       'done: %s.',
-           description:           'Deploy build %{build_number} via Travis CI',
-           missing_bucket:        'Missing required bucket for S3 deployment',
-           missing_key:           'Missing required key for S3 deployment',
+      msgs login: 'Using Access Key: %{access_key_id}',
+           deploy_triggered: 'Deployment triggered: %s',
+           register_revision: 'Registering app revision with version=%s, etag=%s',
+           waiting_for_deploy: 'Waiting for the deployment to finish ',
+           finished_deploy: 'done: %s.',
+           description: 'Deploy build %{build_number} via Travis CI',
+           missing_bucket: 'Missing required bucket for S3 deployment',
+           missing_key: 'Missing required key for S3 deployment',
            unknown_revision_type: 'Unknown revision type %p',
-           unknown_bundle_type:   'Unknown bundle type'
+           unknown_bundle_type: 'Unknown bundle type'
 
       vars :build_number
 
@@ -64,18 +66,18 @@ module Dpl
       def register_revision
         info :register_revision, revision_info[:version], revision_info[:e_tag]
         code_deploy.register_application_revision(
-          revision: revision,
+          revision:,
           application_name: application,
-          description: description
+          description:
         )
       end
 
       def create_deployment
         deployment = code_deploy.create_deployment(
-          revision: revision,
+          revision:,
           application_name: application,
           deployment_group_name: deployment_group,
-          description: description,
+          description:,
           file_exists_behavior: file_exists_behavior.upcase
         )
         deployment.deployment_id
@@ -83,7 +85,7 @@ module Dpl
 
       def wait_until_deployed(id)
         print :waiting_for_deploy
-        status = poll(id) until %w(Succeeded Failed Stopped).include?(status)
+        status = poll(id) until %w[Succeeded Failed Stopped].include?(status)
         case status
         when 'Succeeded'
           info :finished_deploy, status
@@ -104,28 +106,28 @@ module Dpl
 
       def revision
         @revision ||= case revision_type
-        when 's3'     then s3_revision
-        when 'github' then github_revision
-        when nil      then bucket? ? s3_revision : github_revision
-        else error :unknown_revision_type, revision_type
-        end
+                      when 's3'     then s3_revision
+                      when 'github' then github_revision
+                      when nil      then bucket? ? s3_revision : github_revision
+                      else error :unknown_revision_type, revision_type
+                      end
       end
 
       def s3_revision
         {
           revision_type: 'S3',
           s3_location: compact(
-            bucket: bucket,
-            bundle_type: bundle_type,
+            bucket:,
+            bundle_type:,
             version: revision_version_info[:version_id],
             e_tag: revision_version_info[:etag],
-            key: key,
+            key:
           )
         }
       end
 
       def revision_version_info
-        s3.head_object(bucket: bucket, key: key)
+        s3.head_object(bucket:, key:)
       rescue Aws::Errors::ServiceError => e
         error e.message
       end
@@ -134,8 +136,8 @@ module Dpl
         {
           revision_type: 'GitHub',
           git_hub_location: {
-            commit_id:  commit_id,
-            repository: repository
+            commit_id:,
+            repository:
           }
         }
       end
@@ -157,11 +159,11 @@ module Dpl
       end
 
       def bundle_type
-        super || key =~ /\.(tar|tgz|zip)$/ && $1 || error(:unknown_bundle_type)
+        super || key =~ /\.(tar|tgz|zip)$/ && ::Regexp.last_match(1) || error(:unknown_bundle_type)
       end
 
       def description
-        interpolate(super || msg(:description), vars: vars)
+        interpolate(super || msg(:description), vars:)
       end
 
       def build_number
@@ -177,7 +179,7 @@ module Dpl
       end
 
       def client_options
-        compact(region: region, credentials: credentials, endpoint: endpoint)
+        compact(region:, credentials:, endpoint:)
       end
 
       def credentials

data/lib/dpl/providers/convox.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Convox < Provider
@@ -5,9 +7,9 @@ module Dpl
 
       status :dev
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       gem 'json'
 
@@ -30,21 +32,21 @@ module Dpl
       opt '--prepare CMDS', 'Run commands with convox cli available just before deployment', type: :array
 
       # if app and rack are exported to the env, do they need to be passed to these commands?
-      cmds login:    'convox version --rack %{rack}',
+      cmds login: 'convox version --rack %{rack}',
            validate: 'convox apps info --rack %{rack} --app %{app}',
-           create:   'convox apps create %{app} --generation %{generation} --rack %{rack} --wait',
-           update:   'convox update',
-           set_env:  'convox env set %{env} --rack %{rack} --app %{app} --replace',
-           build:    'convox build --rack %{rack} --app %{app} --id --description %{escaped_description}',
-           deploy:   'convox deploy --rack %{rack} --app %{app} --wait --id --description %{escaped_description}'
-
-      msgs create:   'Application %{app} does not exist on rack %{rack}. Creating it ...',
-           missing:  'Application %{app} does not exist on rack %{rack}.',
+           create: 'convox apps create %{app} --generation %{generation} --rack %{rack} --wait',
+           update: 'convox update',
+           set_env: 'convox env set %{env} --rack %{rack} --app %{app} --replace',
+           build: 'convox build --rack %{rack} --app %{app} --id --description %{escaped_description}',
+           deploy: 'convox deploy --rack %{rack} --app %{app} --wait --id --description %{escaped_description}'
+
+      msgs create: 'Application %{app} does not exist on rack %{rack}. Creating it ...',
+           missing: 'Application %{app} does not exist on rack %{rack}.',
            env_file: 'The given env_file does not exist.',
-           deploy:   'Building and promoting application ...',
-           build:    'Building application ...'
+           deploy: 'Building and promoting application ...',
+           build: 'Building application ...'
 
-      errs login:    'Login failed.'
+      errs login: 'Login failed.'
 
       def install
         script :install
@@ -86,23 +88,28 @@ module Dpl
 
       def env_file
         return [] unless env_file?
+
         error :env_file unless file?(super)
         lines = read(super).split("\n").map(&:strip)
         lines.reject(&:empty?)
       end
 
       def description
-        description? ? super : JSON.dump(
-          repo_slug: repo_slug,
-          git_commit_sha: git_sha,
-          git_commit_message: git_commit_msg,
-          git_commit_author: git_author_name,
-          git_tag: git_tag,
-          branch: git_branch,
-          travis_build_id: ENV['TRAVIS_BUILD_ID'],
-          travis_build_number: ENV['TRAVIS_BUILD_NUMBER'],
-          pull_request: ENV['TRAVIS_PULL_REQUEST']
-        )
+        if description?
+          super
+        else
+          JSON.dump(
+            repo_slug:,
+            git_commit_sha: git_sha,
+            git_commit_message: git_commit_msg,
+            git_commit_author: git_author_name,
+            git_tag:,
+            branch: git_branch,
+            travis_build_id: ENV['TRAVIS_BUILD_ID'],
+            travis_build_number: ENV['TRAVIS_BUILD_NUMBER'],
+            pull_request: ENV['TRAVIS_PULL_REQUEST']
+          )
+        end
       end
 
       def export

data/lib/dpl/providers/datica.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Datica < Provider
@@ -7,9 +9,9 @@ module Dpl
 
       register :datica, :catalyze
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       env :datica, :catalyze
 
@@ -19,12 +21,12 @@ module Dpl
       needs :git
 
       cmds checkout: 'git checkout HEAD',
-           add:      'git add %{path} --all --force',
-           commit:   'git commit -m "%{message}" --quiet',
-           push:     'git push --force %{target} HEAD:master'
+           add: 'git add %{path} --all --force',
+           commit: 'git commit -m "%{message}" --quiet',
+           push: 'git push --force %{target} HEAD:master'
 
-      msgs commit:   'Committing build files for deployment',
-           push:     'Deploying to Datica: %{target}'
+      msgs commit: 'Committing build files for deployment',
+           push: 'Deploying to Datica: %{target}'
 
       def setup
         commit if git_dirty? && !cleanup?
@@ -36,27 +38,27 @@ module Dpl
 
       private
 
-        def commit
-          info :commit
-          shell :checkout
-          shell :add
-          shell :commit
-        end
-
-        def message
-          vars.empty? ? 'Local build' : 'Build #%s (%s) of %s@%s' % vars
-        end
-
-        VARS = %w(
-          TRAVIS_BUILD_NUMBER
-          TRAVIS_COMMIT
-          TRAVIS_REPO_SLUG
-          TRAVIS_BRANCH
-        )
-
-        def vars
-          @vars ||= ENV.values_at(*VARS).compact
-        end
+      def commit
+        info :commit
+        shell :checkout
+        shell :add
+        shell :commit
+      end
+
+      def message
+        vars.empty? ? 'Local build' : 'Build #%s (%s) of %s@%s' % vars
+      end
+
+      VARS = %w[
+        TRAVIS_BUILD_NUMBER
+        TRAVIS_COMMIT
+        TRAVIS_REPO_SLUG
+        TRAVIS_BRANCH
+      ].freeze
+
+      def vars
+        @vars ||= ENV.values_at(*VARS).compact
+      end
     end
   end
 end

data/lib/dpl/providers/ecr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Ecr < Provider
@@ -5,9 +7,9 @@ module Dpl
 
       full_name 'AWS ECR'
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       gem 'aws-sdk-ecr', '~> 1.0'
       # gem 'docker-api', '~> 1.34'
@@ -22,14 +24,14 @@ module Dpl
       opt '--target TARGET', 'Comma separated list of partial repository names to push to', eg: 'image-one:tag,image-two', required: true
       opt '--region REGION', 'Comma separated list of regions to push to', default: 'us-east-1'
 
-      msgs login:        'Using Access Key: %{access_key_id}',
-           auth_region:  'Authenticated with %{url}',
-           deploy:       'Pushing image %{source} to regions %{regions} as %{targets}',
+      msgs login: 'Using Access Key: %{access_key_id}',
+           auth_region: 'Authenticated with %{url}',
+           deploy: 'Pushing image %{source} to regions %{regions} as %{targets}',
            image_pushed: 'Pushed image %{source} to region %{region} as %{target}'
 
       cmds login: 'docker login -u %{user} -p %{pass} %{url}',
-           tag:   'docker tag %{source} %{url}/%{repo}:%{tag}',
-           push:  'docker push %{url}/%{repo}'
+           tag: 'docker tag %{source} %{url}/%{repo}:%{tag}',
+           push: 'docker push %{url}/%{repo}'
 
       errs unknown_image: 'Image %{source} not found in the local Docker repository'
 
@@ -41,7 +43,7 @@ module Dpl
       end
 
       def validate
-        # TODO validate the image exists locally
+        # TODO: validate the image exists locally
       end
 
       def deploy
@@ -53,75 +55,75 @@ module Dpl
 
       private
 
-        def push(region, target)
-          url, repo, tag = endpoints[region], *target.split(':')
-          shell :tag, url: url, repo: repo, tag: tag || 'latest'
-          shell :push, url: url, repo: repo
-          info :image_pushed, region: region, target: target
-        end
+      def push(region, target)
+        url, repo, tag = endpoints[region], *target.split(':')
+        shell :tag, url:, repo:, tag: tag || 'latest'
+        shell(:push, url:, repo:)
+        info :image_pushed, region:, target:
+      end
 
-        def auth_regions
-          @endpoints = regions.map { |region| [region, auth_region(region)] }.to_h
-        end
+      def auth_regions
+        @endpoints = regions.map { |region| [region, auth_region(region)] }.to_h
+      end
 
-        def auth_region(region)
-          token = auth_token(region)
-          user, pass = parse_auth(token.authorization_token)
-          url = token.proxy_endpoint
-          shell :login, user: user, pass: pass, url: url, echo: false, silent: true
-          info :auth_region, url: url
-          strip_protocol(url)
-        end
+      def auth_region(region)
+        token = auth_token(region)
+        user, pass = parse_auth(token.authorization_token)
+        url = token.proxy_endpoint
+        shell :login, user:, pass:, url:, echo: false, silent: true
+        info(:auth_region, url:)
+        strip_protocol(url)
+      end
 
-        def auth_token(region)
-          ecr(region).get_authorization_token(registry_ids).authorization_data[0]
-        end
+      def auth_token(region)
+        ecr(region).get_authorization_token(registry_ids).authorization_data[0]
+      end
 
-        def registry_ids
-          account_id? ? { registry_ids: [account_id] } : {}
-        end
+      def registry_ids
+        account_id? ? { registry_ids: [account_id] } : {}
+      end
 
-        def regions
-          # not sure how this was meant to be normalized when being a YAML list
-          region.split(',')
-        end
+      def regions
+        # not sure how this was meant to be normalized when being a YAML list
+        region.split(',')
+      end
 
-        def targets
-          # not sure how this was meant to be normalized when being a YAML list
-          target.split(',')
-        end
+      def targets
+        # not sure how this was meant to be normalized when being a YAML list
+        target.split(',')
+      end
 
-        def creds
-          @creds ||= only(opts, :access_key_id, :secret_access_key)
-        end
+      def creds
+        @creds ||= only(opts, :access_key_id, :secret_access_key)
+      end
 
-        def ecr(region)
-          Aws::ECR::Client.new(region: region, **creds)
-        end
+      def ecr(region)
+        Aws::ECR::Client.new(region:, **creds)
+      end
 
-        def parse_auth(str)
-          user, pass = Base64.decode64(str).split(':')
-          [user, pass.chomp]
-        end
+      def parse_auth(str)
+        user, pass = Base64.decode64(str).split(':')
+        [user, pass.chomp]
+      end
 
-        def strip_protocol(url)
-          url.sub(/^https?:\/\//, '')
-        end
+      def strip_protocol(url)
+        url.sub(%r{^https?://}, '')
+      end
 
-        def progress(events)
-          events.split("\r\n").each do |event|
-            event = JSON.parse(event)
-            if e = event['error']
-              error e
-            elsif %w(Preparing Pushing).include?(event['status'])
-              nil
-            elsif event['id']
-              info "#{event['status']} [#{event['id']}]"
-            elsif event['status']
-              info event['status']
-            end
+      def progress(events)
+        events.split("\r\n").each do |event|
+          event = JSON.parse(event)
+          if e = event['error']
+            error e
+          elsif %w[Preparing Pushing].include?(event['status'])
+            nil
+          elsif event['id']
+            info "#{event['status']} [#{event['id']}]"
+          elsif event['status']
+            info event['status']
           end
         end
+      end
     end
   end
 end

data/lib/dpl/providers/elasticbeanstalk.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Elasticbeanstalk < Provider
@@ -7,7 +9,7 @@ module Dpl
 
       full_name 'AWS Elastic Beanstalk'
 
-      description sq(<<-str)
+      description sq(<<-STR)
         Deploy to AWS Elastic Beanstalk: https://aws.amazon.com/elasticbeanstalk/
 
         This provider:
@@ -16,12 +18,12 @@ module Dpl
         * Uploads it to your EB application
         * Optionally deploys to a specific EB environment
         * Optionally waits until the deployment finishes
-      str
+      STR
 
-      gem 'aws-sdk-elasticbeanstalk', '~> 1.0'
-      gem 'aws-sdk-s3', '~> 1.0'
-      gem 'rubyzip', '~> 1.2.2', require: 'zip'
-      gem 'pathspec', '~> 0.2.1', require: 'pathspec'
+      gem 'aws-sdk-elasticbeanstalk', '~> 1'
+      gem 'aws-sdk-s3', '~> 1'
+      gem 'rubyzip', '~> 2.3', require: 'zip'
+      gem 'pathspec', '~> 1.1', require: 'pathspec'
 
       env :aws, :elastic_beanstalk
       config '~/.aws/credentials', '~/.aws/config', prefix: 'aws'
@@ -40,7 +42,7 @@ module Dpl
       opt '--wait_until_deployed_timeout SEC', 'How many seconds to wait for Elastic Beanstalk deployment update.', type: :integer, default: 600
       opt '--debug', internal: true
 
-      msgs login:   'Using Access Key: %{access_key_id}',
+      msgs login: 'Using Access Key: %{access_key_id}',
            zip_add: 'Adding %s'
 
       msgs clean_description: 'Removed non-printable characters from the version description'
@@ -53,7 +55,7 @@ module Dpl
 
       def setup
         info :login
-        Aws.config.update(credentials: credentials, region: region)
+        Aws.config.update(credentials:, region:)
       end
 
       def deploy
@@ -82,7 +84,7 @@ module Dpl
       end
 
       def bucket_path
-        bucket_path? ? "#{super.gsub(/\/*$/, '')}/#{archive_name}" : archive_name
+        bucket_path? ? "#{super.gsub(%r{/*$}, '')}/#{archive_name}" : archive_name
       end
 
       def cwd
@@ -90,7 +92,7 @@ module Dpl
       end
 
       def zip_exists?
-        File.exists?(zip_file)
+        File.exist?(zip_file)
       end
 
       def create_zip
@@ -150,7 +152,7 @@ module Dpl
 
       def files
         files = Dir.glob('**/*', File::FNM_DOTMATCH)
-        ignore = %w(.ebignore .gitignore).detect { |file| file?(file) }
+        ignore = %w[.ebignore .gitignore].detect { |file| file?(file) }
         files = filter(files, ignore) if ignore
         files
       end
@@ -198,7 +200,7 @@ module Dpl
       end
 
       def debug(*args)
-        info *args if debug?
+        info(*args) if debug?
       end
     end
   end