dpl 2.0.0.alpha.2 → 2.0.0.alpha.5

data/lib/dpl/providers/datica.rb

@@ -25,7 +25,7 @@ module Dpl
            push:     'Deploying to Datica: %{target}'
 
       def setup
-        commit unless cleanup?
+        commit if git_dirty? && !cleanup?
       end
 
       def deploy

data/lib/dpl/providers/engineyard.rb

@@ -11,6 +11,8 @@ module Dpl
 
       required :api_key, [:email, :password]
 
+      env :engineyard, :ey
+
       opt '--api_key KEY',   'Engine Yard API key', secret: true
       opt '--email EMAIL',   'Engine Yard account email'
       opt '--password PASS', 'Engine Yard password', secret: true

data/lib/dpl/providers/gae.rb

@@ -11,7 +11,7 @@ module Dpl
 
       python '>= 2.7.9'
 
-      env :googlecloud, :cloudsdk_core, allow_skip_underscore: true
+      env :gae, :googlecloud, :cloudsdk_core, allow_skip_underscore: true
 
       opt '--project ID', 'Project ID used to identify the project on Google Cloud', required: true
       opt '--keyfile FILE', 'Path to the JSON file containing your Service Account credentials in JSON Web Token format. To be obtained via the Google Developers Console. Should be handled with care as it contains authorization keys.', default: 'service-account.json'
@@ -19,18 +19,18 @@ module Dpl
       opt '--version VER', 'The version of the app that will be created or replaced by this deployment. If you do not specify a version, one will be generated for you'
       opt '--verbosity LEVEL', 'Adjust the log verbosity', default: 'warning'
       opt '--promote', 'Do not promote the deployed version', default: true
-      opt '--stop_previous_version', 'Prevent your deployment from stopping the previously promoted version. This is from the future, so might not work (yet).', default: true
+      opt '--stop_previous_version', 'Prevent the deployment from stopping a previously promoted version', default: true
       opt '--install_sdk', 'Do not install the Google Cloud SDK', default: true
 
-      cmds install:   'curl -L https://dl.google.com/dl/cloudsdk/channels/rapid/google-cloud-sdk.tar.gz | gzip -d | tar -x -C ~',
-           bootstrap: '~/google-cloud-sdk/bin/bootstrapping/install.py --usage-reporting=false --command-completion=false --path-update=false',
+      URL = 'https://dl.google.com/dl/cloudsdk/channels/rapid/google-cloud-sdk.tar.gz'
+
+      cmds install:   'curl -L %{URL} | tar xz -C ~ && ~/google-cloud-sdk/install.sh --path-update false --usage-reporting false --command-completion false',
            login:     'gcloud -q auth activate-service-account --key-file %{keyfile}',
            deploy:    'gcloud -q app deploy %{config} %{deploy_opts}',
            cat_logs:  'find $HOME/.config/gcloud/logs -type f -print -exec cat {} \;'
 
       errs install:   'Failed to download Google Cloud SDK.',
-           login:     'Failed to authenticate.',
-           bootstrap: 'Failed bootstrap Google Cloud SDK.'
+           login:     'Failed to authenticate.'
 
       msgs failed:    'Deployment failed.'
 
@@ -39,7 +39,6 @@ module Dpl
       def install
         return unless install_sdk?
         shell :install
-        shell :bootstrap
       end
 
       def login

data/lib/dpl/providers/gcs.rb

@@ -15,15 +15,17 @@ module Dpl
 
       python '>= 2.7.9'
 
+      env :gcs
+
       opt '--access_key_id ID', 'GCS Interoperable Access Key ID', required: true, secret: true
       opt '--secret_access_key KEY', 'GCS Interoperable Access Secret', required: true, secret: true
       opt '--bucket BUCKET', 'GCS Bucket', required: true
       opt '--local_dir DIR', 'Local directory to upload from', default: '.'
       opt '--upload_dir DIR', 'GCS directory to upload to'
       opt '--dot_match', 'Upload hidden files starting with a dot'
-      opt '--acl ACL', 'Access control to set for uploaded objects'
+      opt '--acl ACL', 'Access control to set for uploaded objects', default: 'private', enum: %w(private public-read public-read-write authenticated-read bucket-owner-read bucket-owner-full-control), see: 'https://cloud.google.com/storage/docs/reference-headers#xgoogacl'
       opt '--detect_encoding', 'HTTP header Content-Encoding to set for files compressed with gzip and compress utilities.'
-      opt '--cache_control HEADER', 'HTTP header Cache-Control to suggest that the browser cache the file.'
+      opt '--cache_control HEADER', 'HTTP header Cache-Control to suggest that the browser cache the file.', see: 'https://cloud.google.com/storage/docs/xml-api/reference-headers#cachecontrol'
 
       cmds install: 'curl -L %{URL} | tar xz -C ~ && ~/google-cloud-sdk/install.sh --path-update false --usage-reporting false --command-completion false',
            copy:    'gsutil %{gs_opts}cp %{copy_opts}-r %{source} %{target}'
@@ -32,7 +34,7 @@ module Dpl
 
       errs copy:  'Failed uploading files.'
 
-      URL = 'https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-252.0.0-linux-x86_64.tar.gz'
+      URL = 'https://dl.google.com/dl/cloudsdk/channels/rapid/google-cloud-sdk.tar.gz'
 
       BOTO = sq(<<-str)
         [Credentials]

data/lib/dpl/providers/gleis.rb

@@ -0,0 +1,70 @@
+module Dpl
+  module Providers
+    class Gleis < Provider
+      status :alpha
+
+      description sq(<<-str)
+        tbd
+      str
+
+      gem 'gleis', '~> 0.6.0'
+
+      env :gleis
+
+      opt '--app APP',       'Gleis application to upload to', default: :repo_name
+      opt '--username NAME', 'Gleis username', required: true
+      opt '--password PASS', 'Gleis password', required: true, secret: true
+      opt '--key_name NAME', 'Name of the SSH deploy key pushed to Gleis', default: 'dpl_deploy_key'
+      opt '--verbose'
+
+      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}',
+           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'
+
+      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'
+
+      attr_reader :git_url
+
+      def login
+        shell :login
+      end
+
+      def setup
+        @git_url = shell :git_url, capture: true
+      end
+
+      def validate
+        shell :validate
+      end
+
+      def add_key(file)
+        shell :add_key, file: file
+      end
+
+      def deploy
+        shell :deploy
+      end
+
+      def remove_key
+        shell :remove_key
+      end
+
+      private
+
+        def push_opts
+          '-v' if verbose?
+        end
+    end
+  end
+end

data/lib/dpl/providers/hackage.rb

@@ -7,6 +7,8 @@ module Dpl
         tbd
       str
 
+      env :hackage
+
       opt '--username USER', 'Hackage username', required: true
       opt '--password USER', 'Hackage password', required: true, secret: true
       opt '--publish', 'Whether or not to publish the package'

data/lib/dpl/providers/hephy.rb

@@ -7,11 +7,13 @@ module Dpl
         tbd
       str
 
+      env :hephy
+
       opt '--controller NAME', 'Hephy controller', required: true, example: 'hephy.hephyapps.com'
       opt '--username USER',   'Hephy username', required: true
       opt '--password PASS',   'Hephy password', required: true, secret: true
       opt '--app APP',         'Deis app', required: true
-      opt '--cli_version VER', 'Install a specific hephy cli version', default: 'stable'
+      opt '--cli_version VER', 'Install a specific Hephy CLI version', default: 'stable'
       opt '--verbose',         'Verbose log output'
 
       needs :git, :ssh_key

data/lib/dpl/providers/heroku.rb

@@ -1,20 +1,16 @@
 module Dpl
   module Providers
     class Heroku < Provider
-      def self.new(ctx, args)
-        # can this be a generic dispatch feature in Cl?
-        return super unless registry_key.to_sym == :heroku
-        arg = args.detect { |arg| arg.include?('--strategy') }
-        strategy = arg ? arg.split('=').last : 'api'
-        Provider[:"heroku:#{strategy}"].new(ctx, args)
-      end
+      abstract
 
       gem 'faraday', '~> 0.9.2'
       gem 'json'
       gem 'netrc', '~> 0.11.0'
       gem 'rendezvous', '~> 0.1.3'
 
-      opt '--strategy NAME', 'Heroku deployment strategy', default: 'api', enum: %w(api git), internal: true
+      env :heroku
+
+      opt '--strategy NAME', 'Heroku deployment strategy', default: 'api', enum: %w(api git)
       opt '--app APP', 'Heroku app name', default: :repo_name
       opt '--log_level LEVEL', internal: true
 

data/lib/dpl/providers/heroku/api.rb

@@ -2,6 +2,8 @@ module Dpl
   module Providers
     class Heroku
       class Api < Heroku
+        register 'heroku:api'
+
         status :alpha
 
         full_name 'Heroku API'
@@ -40,7 +42,7 @@ module Dpl
           end
 
           def upload
-            shell :upload
+            shell :upload, echo: false
           end
 
           def build
@@ -54,7 +56,7 @@ module Dpl
           end
 
           def log
-            shell :log
+            shell :log, echo: false
           end
 
           def verify

data/lib/dpl/providers/heroku/git.rb

@@ -2,6 +2,8 @@ module Dpl
   module Providers
     class Heroku
       class Git < Heroku
+        register 'heroku:git'
+
         status :alpha
 
         full_name 'Heroku Git'
@@ -15,7 +17,7 @@ module Dpl
         opt '--api_key KEY',   'Heroku API key', secret: true
         opt '--username USER', 'Heroku username', alias: :user
         opt '--password PASS', 'Heroku password', secret: true
-        opt '--git URL'
+        opt '--git URL', 'Heroku Git remote URL'
 
         needs :git, :git_http_user_agent
 

data/lib/dpl/providers/lambda.rb

@@ -14,15 +14,15 @@ module Dpl
       gem 'aws-sdk-lambda', '~> 1.0'
       gem 'rubyzip', '~> 1.2.2', require: 'zip'
 
-      env :aws
+      env :aws, :lambda
       config '~/.aws/credentials', '~/.aws/config', prefix: 'aws'
 
       opt '--access_key_id ID',       'AWS access key id', required: true, secret: true
       opt '--secret_access_key KEY',  'AWS secret key', required: true, secret: true
       opt '--region REGION',          'AWS region the Lambda function is running in', default: 'us-east-1'
       opt '--function_name FUNC',     'Name of the Lambda being created or updated', required: true
-      opt '--role ROLE',              'ARN of the IAM role to assign to the Lambda function', note: 'required for creating a new function'
-      opt '--handler_name NAME',      'Function the Lambda calls to begin execution.', note: 'required for creating a new function'
+      opt '--role ROLE',              'ARN of the IAM role to assign to the Lambda function', note: 'required when creating a new function'
+      opt '--handler_name NAME',      'Function the Lambda calls to begin execution.', note: 'required when creating a new function'
       opt '--module_name NAME',       'Name of the module that exports the handler', default: 'index', requires: :handler_name
       opt '--description DESCR',      'Description of the Lambda being created or updated'
       opt '--timeout SECS',           'Function execution time (in seconds) at which Lambda should terminate the function', default: 3
@@ -30,7 +30,7 @@ module Dpl
       opt '--subnet_ids IDS',         'List of subnet IDs to be added to the function', type: :array, note: 'Needs the ec2:DescribeSubnets and ec2:DescribeVpcs permission for the user of the access/secret key to work'
       opt '--security_group_ids IDS', 'List of security group IDs to be added to the function', type: :array, note: 'Needs the ec2:DescribeSecurityGroups and ec2:DescribeVpcs permission for the user of the access/secret key to work'
       opt '--environment VARS',       'List of Environment Variables to add to the function', type: :array, format: /[\w\-]+=.+/, note: 'Can be encrypted for added security', alias: :environment_variables
-      opt '--runtime NAME',           'Lambda runtime to use', default: 'nodejs8.10', enum: %w(java8 nodejs8.10 nodejs10.x python2.7 python3.6 python3.7 dotnetcore2.1 go1.x ruby2.5)
+      opt '--runtime NAME',           'Lambda runtime to use', note: 'required when creating a new function', default: 'nodejs8.10', enum: %w(java8 nodejs8.10 nodejs10.x python2.7 python3.6 python3.7 dotnetcore2.1 go1.x ruby2.5)
       opt '--dead_letter_arn ARN',    'ARN to an SNS or SQS resource used for the dead letter queue.'
       opt '--kms_key_arn ARN',        'KMS key ARN to use to encrypt environment_variables.'
       opt '--tracing_mode MODE',      'Tracing mode', default: 'PassThrough', enum: %w(Active PassThrough), note: 'Needs xray:PutTraceSegments xray:PutTelemetryRecords on the role'

data/lib/dpl/providers/launchpad.rb

@@ -7,9 +7,11 @@ module Dpl
         tbd
       str
 
-      opt '--slug SLUG', 'Launchpad project slug', format: /^~[^\/]+\/[^\/]+\/[^\/]+$/, example: '~user-name/project-name/branch-name'
+      env :launchpad
+
       opt '--oauth_token TOKEN', 'Launchpad OAuth token', secret: true
       opt '--oauth_token_secret SECRET', 'Launchpad OAuth token secret', secret: true
+      opt '--slug SLUG', 'Launchpad project slug', format: /^~[^\/]+\/[^\/]+\/[^\/]+$/, example: '~user-name/project-name/branch-name'
 
       msgs invalid_credentials: 'Invalid credentials (%s)',
            unknown_error:       'Error: %s (%s)'

data/lib/dpl/providers/netlify.rb

@@ -9,6 +9,8 @@ module Dpl
 
       npm 'netlify-cli', 'netlify'
 
+      env :netlify
+
       opt '--site ID',         'A site ID to deploy to', required: true
       opt '--auth TOKEN',      'An auth token to log in with', required: true, secret: true
       opt '--dir DIR',         'Specify a folder to deploy'

data/lib/dpl/providers/npm.rb

@@ -11,6 +11,8 @@ module Dpl
 
       gem 'json'
 
+      env :npm
+
       opt '--email EMAIL', 'npm account email'
       opt '--api_token TOKEN', 'npm api token', alias: :api_key, required: true, secret: true, note: 'can be retrieved from your local ~/.npmrc file', see: 'https://docs.npmjs.com/creating-and-viewing-authentication-tokens'
       opt '--access ACCESS', 'Access level', enum: %w(public private)

data/lib/dpl/providers/openshift.rb

@@ -9,6 +9,8 @@ module Dpl
         tbd
       str
 
+      env :openshift
+
       opt '--server SERVER',   'OpenShift server', required: true
       opt '--token TOKEN',     'OpenShift token', required: true, secret: true
       opt '--project PROJECT', 'OpenShift project', required: true

data/lib/dpl/providers/opsworks.rb

@@ -11,7 +11,7 @@ module Dpl
 
       gem 'aws-sdk-opsworks', '~> 1.0'
 
-      env :aws
+      env :aws, :opsworks
       config '~/.aws/credentials', '~/.aws/config', prefix: 'aws'
 
       opt '--access_key_id ID', 'AWS access key id', required: true, secret: true

data/lib/dpl/providers/packagecloud.rb

@@ -13,6 +13,8 @@ module Dpl
 
       gem 'packagecloud-ruby', '~> 1.0.8', require: 'packagecloud'
 
+      env :packagecloud
+
       opt '--username USER', 'The packagecloud.io username.', required: true
       opt '--token TOKEN', 'The packagecloud.io api token.', required: true, secret: true
       opt '--repository REPO', 'The repository to push to.', required: true

data/lib/dpl/providers/pages.rb

@@ -1,14 +1,11 @@
 module Dpl
   module Providers
     class Pages < Provider
-      def self.new(ctx, args)
-        return super unless registry_key.to_sym == :pages
-        arg = args.detect { |arg| arg.include? '--strategy' }
-        strategy = arg ? arg.split('=', 2).last : 'git'
-        Provider[:"pages:#{strategy}"].new(ctx, args)
-      end
+      abstract
 
-      opt '--strategy NAME', 'GitHub Pages deployment strategy', default: 'git', enum: %w(api git), internal: true
+      env :github, :pages
+
+      opt '--strategy NAME', 'GitHub Pages deployment strategy', default: 'git', enum: %w(api git)
     end
   end
 end

data/lib/dpl/providers/pages/api.rb

@@ -4,6 +4,10 @@ module Dpl
   module Providers
     class Pages
       class Api < Pages
+        register 'pages:api'
+
+        status :dev
+
         PAGES_PREVIEW_MEDIA_TYPE = 'application/vnd.github.mister-fantastic-preview+json'
 
         # suppress warnings about preview API
@@ -16,8 +20,6 @@ module Dpl
 
         gem 'octokit', '~> 4.14.0'
 
-        status :alpha
-
         full_name 'GitHub Pages (API)'
 
         description sq(<<-str)
@@ -32,20 +34,22 @@ module Dpl
         str
 
         opt '--repo SLUG', 'GitHub repo slug', default: :repo_slug
-        opt '--github_token TOKEN', 'GitHub oauth token with repo permission', required: true, secret: true
+        opt '--token TOKEN', 'GitHub oauth token with repo permission', required: true, secret: true, alias: :github_token
 
-        msgs pages_not_found:             'GitHub Pages not found for %{slug}. ' \
-               'Given token has insufficient scope (\'repo\' or \'public_repo\'), ' \
-               'or GitHub Pages is not enabled for this repo (see https://github.com/%{slug}/settings)',
-             build_pages_request_timeout: 'GitHub Pages build request timed out',
-             deploy_start:                'Requesting GitHub Pages build using API'
+        msgs not_found: sq(<<-msg),
+               GitHub Pages not found for %{slug}.
+               Either the given token has insufficient scope (repo or public_repo), or
+               GitHub Pages is not enabled for this repo (see https://github.com/%{slug}/settings)'
+             msg
+             timeout: 'GitHub Pages build request timed out',
+             deploy:  'Requesting GitHub Pages build using API'
 
         def validate
-          error :pages_not_found unless pages_enabled?
+          error :not_found unless pages_enabled?
         end
 
         def deploy
-          info :deploy_start
+          info :deploy
 
           api.request_page_build slug
 
@@ -71,7 +75,7 @@ module Dpl
         rescue Octokit::Forbidden => fb
           error fb.message
         rescue Timeout::Error => to
-          error :build_pages_request_timeout
+          error :timeout
         end
 
         private
@@ -87,7 +91,7 @@ module Dpl
         end
 
         def creds
-          { access_token: github_token }
+          { access_token: token }
         end
 
         def pages_enabled?

data/lib/dpl/providers/pages/git.rb

@@ -2,6 +2,8 @@ module Dpl
   module Providers
     class Pages
       class Git < Pages
+        register 'pages:git'
+
         status :alpha
 
         full_name 'GitHub Pages'
@@ -13,10 +15,10 @@ module Dpl
         gem 'octokit', '~> 4.14.0'
         gem 'public_suffix', '~> 3.0.3'
 
-        required :github_token, :deploy_key
+        required :token, :deploy_key
 
         opt '--repo SLUG', 'Repo slug', default: :repo_slug
-        opt '--github_token TOKEN', 'GitHub oauth token with repo permission', secret: true
+        opt '--token TOKEN', 'GitHub oauth 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 '--target_branch BRANCH', 'Branch to push force to', default: 'gh-pages'
         opt '--keep_history', 'Create incremental commit instead of doing push force', default: true
@@ -30,7 +32,7 @@ module Dpl
         opt '--email EMAIL', 'Committer email', note: 'defaults to the current git commit author email'
         opt '--committer_from_gh', 'Use the token\'s owner name and email for the commit', requires: :github_token
         opt '--deployment_file', 'Enable creation of a deployment-info file'
-        opt '--github_url URL', default: 'github.com'
+        opt '--url URL', default: 'github.com', alias: :github_url
 
         needs :git
 
@@ -39,7 +41,7 @@ module Dpl
              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.',
              setup_deploy_key:    'Moving deploy key %{deploy_key} to %{path}',
              check_deploy_key:    'Checking deploy key',
-             deploy:              'Deploying branch %{target_branch} to %{github_url}',
+             deploy:              'Deploying branch %{target_branch} to %{url}',
              keep_history:        'The deployment is configured to preserve the target branch if it exists on remote.',
              work_dir:            'Using temporary work directory %{work_dir}',
              committer_from_gh:   'The repo is configured to use committer user and email.',
@@ -50,7 +52,8 @@ module Dpl
              copy_files:          'Copying %{src_dir} contents to %{work_dir}',
              git_config:          'Configuring git committer to be %{name} <%{email}>',
              prepare:             'Preparing to deploy %{target_branch} branch to gh-pages',
-             git_push:            'Pushing to %{url}'
+             git_push:            'Pushing to %{url}',
+             stop:                'There are no changes to commit, stopping.'
 
         cmds git_clone:           'git clone --quiet --branch="%{target_branch}" --depth=1 "%{remote_url}" . > /dev/null 2>&1',
              git_init:            'git init .',
@@ -74,7 +77,7 @@ module Dpl
              git_push:            'Failed to push the build to %{url}:%{target_branch}'
 
         def login
-          github_token? ? login_token : setup_deploy_key
+          token? ? login_token : setup_deploy_key
         end
 
         def setup
@@ -93,6 +96,7 @@ module Dpl
         def deploy
           git_clone? ? git_clone : git_init
           copy_files
+          return info :stop unless git_dirty?
           git_config
           git_commit
           git_push
@@ -199,19 +203,19 @@ module Dpl
         end
 
         def remote_url
-          github_token? ? https_url_with_token : git_url
+          token? ? https_url_with_token : git_url
         end
 
         def https_url_with_token
-          "https://#{github_token}@#{url}"
+          "https://#{token}@#{url}"
         end
 
         def git_url
-          "git@#{github_url}:#{slug}.git"
+          "git@#{opts[:url]}:#{slug}.git"
         end
 
         def url
-          "#{github_url}/#{slug}.git"
+          "#{opts[:url]}/#{slug}.git"
         end
 
         def slug
@@ -231,11 +235,11 @@ module Dpl
         end
 
         def api
-          @api ||= Octokit::Client.new(access_token: github_token, api_endpoint: api_endpoint)
+          @api ||= Octokit::Client.new(access_token: token, api_endpoint: api_endpoint)
         end
 
         def api_endpoint
-          github_url == 'github.com' ? 'https://api.github.com/' : "https://#{github_url}/api/v3/"
+          opts[:url] == 'github.com' ? 'https://api.github.com/' : "https://#{opts[:url]}/api/v3/"
         end
 
         def now