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

data/lib/dpl/providers/git_push.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class GitPush < Provider
@@ -7,25 +9,25 @@ module Dpl
 
       full_name 'Git (push)'
 
-      description sq(<<-str)
+      description sq(<<-STR)
         Experimental, generic provider for updating a Git remote branch with
         changes produced by the build, and optionally opening a pull request.
-      str
+      STR
 
-      gem 'octokit', '~> 4.15.0'
-      gem 'public_suffix', '~> 3.0.3'
+      gem 'octokit', '~> 7'
+      gem 'public_suffix', '~> 5'
 
       env :github, :git
 
-      required :token, [:deploy_key, :name, :email]
+      required :token, %i[deploy_key name email]
 
       opt '--repo SLUG', 'Repo slug', default: :repo_slug
       opt '--token TOKEN', 'GitHub token with repo permission', secret: true, alias: :github_token
       opt '--deploy_key PATH', 'Path to a file containing a private deploy key with write access to the repository', see: 'https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys'
       opt '--branch BRANCH', 'Target branch to push to', required: true
       opt '--base_branch BRANCH', 'Base branch to branch off initially, and (optionally) create a pull request for', default: 'master'
-      opt '--name NAME', 'Committer name', note: 'defaults to the GitHub name or login associated with the GitHub token' #, default: :user_name
-      opt '--email EMAIL', 'Committer email', note: 'defaults to the GitHub email associated with the GitHub token' #, default: :user_email
+      opt '--name NAME', 'Committer name', note: 'defaults to the GitHub name or login associated with the GitHub token' # , default: :user_name
+      opt '--email EMAIL', 'Committer email', note: 'defaults to the GitHub email associated with the GitHub token' # , default: :user_email
       opt '--commit_message MSG', default: 'Update %{base_branch}', interpolate: true
       opt '--allow_empty_commit', 'Allow an empty commit to be created'
       opt '--force', 'Whether to push --force', default: false
@@ -37,38 +39,38 @@ module Dpl
 
       needs :git
 
-      msgs login:               'Authenticated as %s',
-           invalid_token:       'The provided GitHub token is invalid (error: %s)',
+      msgs login: 'Authenticated as %s',
+           invalid_token: 'The provided GitHub token is invalid (error: %s)',
            insufficient_scopes: 'Dpl does not have permission to access %{url} using the provided GitHub token. Please make sure the token have the repo or public_repo scope.',
-           same_branch:         'Prevented from pushing to the same branch as the current build branch %{git_branch}. This is meant to prevent infinite build loops. If you do need to push back to the same branch enable `allow_same_branch` and take precautions to prevent infinite loops as needed, for example using conditional builds.',
-           setup_deploy_key:    'Moving deploy key %{deploy_key} to %{path}',
-           check_deploy_key:    'Checking deploy key',
-           setup:               'Source dir: %{src_dir}, branch: %{branch}, base branch: %{base_branch}',
-           git_clone:           'Cloning the branch %{branch} to %{work_dir}',
-           git_branch:          'Switching to branch %{branch}',
-           copy_files:          'Copying %{src_dir} contents to %{work_dir}',
-           git_config:          'Configuring git committer to be: %{name} <%{email}>',
-           git_push:            'Pushing to %{url} HEAD:%{branch}',
-           pr_exists:           'Pull request exists.',
-           pr_created:          'Pull request #%{number} created.',
-           stop:                'There are no changes to commit, stopping.'
-
-      cmds git_clone:           'git clone --quiet --branch="%{clone_branch}" "%{remote_url}" . > /dev/null 2>&1',
-           git_branch:          'git checkout -b "%{branch}"',
-           check_deploy_key:    'ssh -i %{key} -T git@github.com 2>&1 | grep successful > /dev/null',
-           copy_files:          'rsync -rl --exclude .git --delete "%{src_dir}/" .',
-           git_config_email:    'git config user.email %{quoted_email}',
-           git_config_name:     'git config user.name %{quoted_name}',
-           git_add:             'git add -A .',
-           git_commit_hook:     'cp %{path} .git/hooks/pre-commit',
-           git_commit:          'git commit %{git_commit_opts} -q %{git_commit_msg_opts}',
-           git_show:            'git show --stat-count=10 HEAD',
-           git_push:            'git push %{git_push_opts} --quiet "%{remote_url}" HEAD:"%{branch}" > /dev/null 2>&1'
-
-      errs copy_files:          'Failed to copy %{src_dir}.',
-           check_deploy_key:    'Failed to authenticate using the deploy key',
-           git_init:            'Failed to create new git repo',
-           git_push:            'Failed to push the build to %{url}:%{branch}'
+           same_branch: 'Prevented from pushing to the same branch as the current build branch %{git_branch}. This is meant to prevent infinite build loops. If you do need to push back to the same branch enable `allow_same_branch` and take precautions to prevent infinite loops as needed, for example using conditional builds.',
+           setup_deploy_key: 'Moving deploy key %{deploy_key} to %{path}',
+           check_deploy_key: 'Checking deploy key',
+           setup: 'Source dir: %{src_dir}, branch: %{branch}, base branch: %{base_branch}',
+           git_clone: 'Cloning the branch %{branch} to %{work_dir}',
+           git_branch: 'Switching to branch %{branch}',
+           copy_files: 'Copying %{src_dir} contents to %{work_dir}',
+           git_config: 'Configuring git committer to be: %{name} <%{email}>',
+           git_push: 'Pushing to %{url} HEAD:%{branch}',
+           pr_exists: 'Pull request exists.',
+           pr_created: 'Pull request #%{number} created.',
+           stop: 'There are no changes to commit, stopping.'
+
+      cmds git_clone: 'git clone --quiet --branch="%{clone_branch}" "%{remote_url}" . > /dev/null 2>&1',
+           git_branch: 'git checkout -b "%{branch}"',
+           check_deploy_key: 'ssh -i %{key} -T git@github.com 2>&1 | grep successful > /dev/null',
+           copy_files: 'rsync -rl --exclude .git --delete "%{src_dir}/" .',
+           git_config_email: 'git config user.email %{quoted_email}',
+           git_config_name: 'git config user.name %{quoted_name}',
+           git_add: 'git add -A .',
+           git_commit_hook: 'cp %{path} .git/hooks/pre-commit',
+           git_commit: 'git commit %{git_commit_opts} -q %{git_commit_msg_opts}',
+           git_show: 'git show --stat-count=10 HEAD',
+           git_push: 'git push %{git_push_opts} --quiet "%{remote_url}" HEAD:"%{branch}" > /dev/null 2>&1'
+
+      errs copy_files: 'Failed to copy %{src_dir}.',
+           check_deploy_key: 'Failed to authenticate using the deploy key',
+           git_init: 'Failed to create new git repo',
+           git_push: 'Failed to push the build to %{url}:%{branch}'
 
       def validate
         error :same_branch if same_branch? && !allow_same_branch?
@@ -91,6 +93,7 @@ module Dpl
         git_clone
         copy_files
         return info :stop unless git_dirty?
+
         push
         pull_request if pull_request?
       end
@@ -107,163 +110,164 @@ module Dpl
 
       private
 
-        def same_branch?
-          git_branch == branch
-        end
-
-        def login_token
-          return unless github?
-          info :login, user.login
-          error :insufficient_scopes unless sufficient_scopes?
-        rescue Octokit::Unauthorized => e
-          error :invalid_token, e.message
-        end
-
-        def setup_deploy_key
-          path = '~/.dpl/deploy_key'
-          info :setup_deploy_key, path: path
-          mv deploy_key, path
-          chmod 0600, path
-          setup_git_ssh path
-          shell :check_deploy_key, key: path
-        end
-
-        def git_clone
-          shell :git_clone, echo: false
-          shell :git_branch unless branch_exists?
-        end
-
-        def clone_branch
-          branch_exists? ? branch : base_branch
-        end
-
-        def copy_files
-          shell :copy_files
-        end
-
-        def git_config
-          shell :git_config_name, echo: false
-          shell :git_config_email, echo: false
-        end
-
-        def branch_exists?
-          git_ls_remote?(remote_url, branch)
-        end
-
-        def git_commit
-          shell :git_commit_hook, path: asset(:git, :detect_private_key).path, echo: false if deploy_key?
-          shell :git_add
-          shell :git_commit
-          shell :git_show
-        end
-
-        def git_push
-          shell :git_push, echo: false
-        end
-
-        def git_push_opts
-          '--force' if force?
-        end
-
-        def git_commit_opts
-          ' --allow-empty' if allow_empty_commit?
-        end
-
-        def git_commit_msg_opts
-          msg = interpolate(commit_message, vars: vars)
-          msg.split("\n").reject(&:empty?).map { |msg| %(-m #{quote(msg)}) }
-        end
-
-        def name
-          str = super if name?
-          str ||= user_name
-          str = "#{str} (via Travis CI)" if ENV['TRAVIS'] && !name?
-          str
-        end
-        memoize :name
-
-        def email
-          str = super if email?
-          str || user_email
-        end
-        memoize :email
-
-        def project_name
-          super || repo_slug
-        end
-
-        def remote_url
-          token? ? https_url_with_token : git_url
-        end
-
-        def https_url_with_token
-          "https://#{token}@#{url}"
-        end
-
-        def git_url
-          "git@#{host}:#{slug}.git"
-        end
-
-        def url
-          "#{host}/#{slug}.git"
-        end
-
-        def slug
-          repo || repo_slug
-        end
-
-        def src_dir
-          @src_dir ||= expand(local_dir)
-        end
-
-        def work_dir
-          @work_dir ||= tmp_dir
-        end
-
-        def sufficient_scopes?
-          scopes.include?('public_repo') || scopes.include?('repo')
-        end
-
-        def user
-          @user ||= github.user
-        end
-
-        def user_name
-          user.name || user.login
-        end
-
-        def user_email
-          user.email
-        end
-
-        def scopes
-          @scopes ||= github.scopes
-        end
-
-        def pr_exists?
-          !!github.pulls(repo).detect { |pull| pull.head.ref == branch }
-        end
-
-        def create_pr
-          pr = github.create_pull_request(repo, base_branch, branch, "Update #{base_branch}")
-          info :pr_created, number: pr.number
-        end
-
-        def github?
-          host.include?('github') || enterprise?
-        end
-
-        def github
-          @github ||= Octokit::Client.new(access_token: token, api_endpoint: api_url, auto_paginate: true)
-        end
-
-        def api_url
-          enterprise? ? "https://#{host}/api/v3/" : 'https://api.github.com/'
-        end
-
-        def now
-          Time.now
-        end
+      def same_branch?
+        git_branch == branch
+      end
+
+      def login_token
+        return unless github?
+
+        info :login, user.login
+        error :insufficient_scopes unless sufficient_scopes?
+      rescue Octokit::Unauthorized => e
+        error :invalid_token, e.message
+      end
+
+      def setup_deploy_key
+        path = '~/.dpl/deploy_key'
+        info(:setup_deploy_key, path:)
+        mv deploy_key, path
+        chmod 0600, path
+        setup_git_ssh path
+        shell :check_deploy_key, key: path
+      end
+
+      def git_clone
+        shell :git_clone, echo: false
+        shell :git_branch unless branch_exists?
+      end
+
+      def clone_branch
+        branch_exists? ? branch : base_branch
+      end
+
+      def copy_files
+        shell :copy_files
+      end
+
+      def git_config
+        shell :git_config_name, echo: false
+        shell :git_config_email, echo: false
+      end
+
+      def branch_exists?
+        git_ls_remote?(remote_url, branch)
+      end
+
+      def git_commit
+        shell :git_commit_hook, path: asset(:git, :detect_private_key).path, echo: false if deploy_key?
+        shell :git_add
+        shell :git_commit
+        shell :git_show
+      end
+
+      def git_push
+        shell :git_push, echo: false
+      end
+
+      def git_push_opts
+        '--force' if force?
+      end
+
+      def git_commit_opts
+        ' --allow-empty' if allow_empty_commit?
+      end
+
+      def git_commit_msg_opts
+        msg = interpolate(commit_message, vars:)
+        msg.split("\n").reject(&:empty?).map { |message| %(-m #{quote(message)}) }
+      end
+
+      def name
+        str = super if name?
+        str ||= user_name
+        str = "#{str} (via Travis CI)" if ENV['TRAVIS'] && !name?
+        str
+      end
+      memoize :name
+
+      def email
+        str = super if email?
+        str || user_email
+      end
+      memoize :email
+
+      def project_name
+        super || repo_slug
+      end
+
+      def remote_url
+        token? ? https_url_with_token : git_url
+      end
+
+      def https_url_with_token
+        "https://#{token}@#{url}"
+      end
+
+      def git_url
+        "git@#{host}:#{slug}.git"
+      end
+
+      def url
+        "#{host}/#{slug}.git"
+      end
+
+      def slug
+        repo || repo_slug
+      end
+
+      def src_dir
+        @src_dir ||= expand(local_dir)
+      end
+
+      def work_dir
+        @work_dir ||= tmp_dir
+      end
+
+      def sufficient_scopes?
+        scopes.include?('public_repo') || scopes.include?('repo')
+      end
+
+      def user
+        @user ||= github.user
+      end
+
+      def user_name
+        user.name || user.login
+      end
+
+      def user_email
+        user.email
+      end
+
+      def scopes
+        @scopes ||= github.scopes
+      end
+
+      def pr_exists?
+        !!github.pulls(repo).detect { |pull| pull.head.ref == branch }
+      end
+
+      def create_pr
+        pr = github.create_pull_request(repo, base_branch, branch, "Update #{base_branch}")
+        info :pr_created, number: pr.number
+      end
+
+      def github?
+        host.include?('github') || enterprise?
+      end
+
+      def github
+        @github ||= Octokit::Client.new(access_token: token, api_endpoint: api_url, auto_paginate: true)
+      end
+
+      def api_url
+        enterprise? ? "https://#{host}/api/v3/" : 'https://api.github.com/'
+      end
+
+      def now
+        Time.now
+      end
     end
   end
 end

data/lib/dpl/providers/gleis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Gleis < Provider
@@ -5,9 +7,9 @@ module Dpl
 
       status :alpha
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       gem 'gleis', '~> 0.8.0'
 
@@ -21,20 +23,20 @@ module Dpl
 
       needs :ssh_key
 
-      cmds login:      'gleis auth login %{username} %{password} --skip-keygen',
-           logout:     'gleis auth logout',
-           validate:   'gleis app status -a %{app}',
-           add_key:    'gleis auth key add %{file} %{key_name}',
+      cmds login: 'gleis auth login %{username} %{password} --skip-keygen',
+           logout: 'gleis auth logout',
+           validate: 'gleis app status -a %{app}',
+           add_key: 'gleis auth key add %{file} %{key_name}',
            remove_key: 'gleis auth key remove %{key_name}',
-           git_url:    'gleis app git -a %{app} -q',
-           deploy:     'git push %{push_opts} -f %{git_url} HEAD:refs/heads/master'
+           git_url: 'gleis app git -a %{app} -q',
+           deploy: 'git push %{push_opts} -f %{git_url} HEAD:refs/heads/master'
 
-      errs login:      'Login failed',
-           validate:   'Application not found',
-           add_key:    'Adding SSH key failed',
+      errs login: 'Login failed',
+           validate: 'Application not found',
+           add_key: 'Adding SSH key failed',
            remove_key: 'Removing key failed',
-           git_url:    'Failed to retrieve Git URL',
-           deploy:     'Deploying application failed'
+           git_url: 'Failed to retrieve Git URL',
+           deploy: 'Deploying application failed'
 
       attr_reader :git_url
 
@@ -51,7 +53,7 @@ module Dpl
       end
 
       def add_key(file)
-        shell :add_key, file: file
+        shell :add_key, file:
       end
 
       def deploy
@@ -64,9 +66,9 @@ module Dpl
 
       private
 
-        def push_opts
-          '-v' if verbose?
-        end
+      def push_opts
+        '-v' if verbose?
+      end
     end
   end
 end

data/lib/dpl/providers/hackage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Hackage < Provider
@@ -5,9 +7,9 @@ module Dpl
 
       status :alpha
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       env :hackage
 
@@ -15,12 +17,12 @@ module Dpl
       opt '--password USER', 'Hackage password', required: true, secret: true
       opt '--publish', 'Whether or not to publish the package'
 
-      cmds check:  'cabal check',
-           sdist:  'cabal sdist',
+      cmds check: 'cabal check',
+           sdist: 'cabal sdist',
            upload: 'cabal upload %{upload_opts} %{path}'
 
-      errs check:  'cabal check failed',
-           sdist:  'cabal sdist failed',
+      errs check: 'cabal check failed',
+           sdist: 'cabal sdist failed',
            upload: 'cabal upload failed'
 
       def validate
@@ -33,19 +35,19 @@ module Dpl
 
       def deploy
         tar_files.each do |path|
-          shell :upload, path: path
+          shell :upload, path:
         end
       end
 
       private
 
-        def upload_opts
-          opts_for(%i(publish username password))
-        end
+      def upload_opts
+        opts_for(%i[publish username password])
+      end
 
-        def tar_files
-          Dir.glob('dist/*.tar.gz').sort
-        end
+      def tar_files
+        Dir.glob('dist/*.tar.gz').sort
+      end
     end
   end
 end

data/lib/dpl/providers/hephy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dpl
   module Providers
     class Hephy < Provider
@@ -5,9 +7,9 @@ module Dpl
 
       status :beta
 
-      description sq(<<-str)
+      description sq(<<-STR)
         tbd
-      str
+      STR
 
       env :hephy
 
@@ -23,19 +25,19 @@ module Dpl
 
       INSTALL = 'https://raw.githubusercontent.com/teamhephy/workflow-cli/master/install-v2.sh'
 
-      cmds install:    'curl -sSL %{INSTALL} | bash -x -s %{cli_version} && mv deis ~/.dpl',
-           login:      'deis login %{controller} --username=%{username} --password=%{password}',
-           add_key:    'deis keys:add %{key}',
-           validate:   'deis apps:info --app=%{app}',
-           deploy:     'filter_log git push %{verbose} %{url} HEAD:refs/heads/master -f',
-           run:        'deis run -a %{app} -- %{cmd}',
+      cmds install: 'curl -sSL %{INSTALL} | bash -x -s %{cli_version} && mv deis ~/.dpl',
+           login: 'deis login %{controller} --username=%{username} --password=%{password}',
+           add_key: 'deis keys:add %{key}',
+           validate: 'deis apps:info --app=%{app}',
+           deploy: 'filter_log git push %{verbose} %{url} HEAD:refs/heads/master -f',
+           run: 'deis run -a %{app} -- %{cmd}',
            remove_key: 'deis keys:remove %{key_name}'
 
-      errs login:      'Login failed.',
-           add_key:    'Adding keys failed.',
-           validate:   'Application could not be verified.',
-           deploy:     'Deploying application failed.',
-           run:        'Running command failed.',
+      errs login: 'Login failed.',
+           add_key: 'Adding keys failed.',
+           validate: 'Application could not be verified.',
+           deploy: 'Deploying application failed.',
+           run: 'Running command failed.',
            remove_key: 'Removing keys failed.'
 
       def install
@@ -51,7 +53,7 @@ module Dpl
       end
 
       def add_key(key)
-        shell :add_key, key: key
+        shell(:add_key, key:)
         wait_for_ssh_access(host, port)
       end
 
@@ -64,7 +66,7 @@ module Dpl
       end
 
       def run_cmd(cmd)
-        shell :run, app: app, cmd: cmd
+        shell :run, app:, cmd:
       end
 
       def remove_key
@@ -94,7 +96,7 @@ module Dpl
       end
 
       def host
-        controller.gsub(/https?:\/\//, '').split(':')[0]
+        controller.gsub(%r{https?://}, '').split(':')[0]
       end
 
       def install_hephy_log_filter