dpl 2.0.0.alpha.11 → 2.0.0.alpha.12

data/lib/dpl/cli.rb

@@ -22,12 +22,17 @@ module Dpl
     end
 
     def normalize(args)
+      args = unescape(args)
       args = untaint(args)
       args = with_cmd_opts(args, provider: 0, strategy: 1)
       args = with_strategy_default(args, :strategy) # should be a generic dispatch feature in Cl
       args
     end
 
+    def unescape(args)
+      args.map { |arg| arg.gsub('\\n', "\n") }
+    end
+
     # Tainting is being used for automatically obfuscating values for secure
     # options, so we want to untaint all incoming args here.
     def untaint(args)

data/lib/dpl/helper/github.rb

@@ -0,0 +1,20 @@
+require 'dpl/helper/transliterate'
+
+# I18n.load_path << File.expand_path('config/transliterate.yml')
+# I18n.eager_load!
+# I18n.config.available_locales_set << :en # seems really wrong, but ¯\_(ツ)_/¯
+
+module Dpl
+  module Github
+    include Transliterate
+
+    def normalize_filename(str)
+      str = File.basename(str)
+      str = str.split(' ').first
+      str = transliterate(str)
+      str.gsub(/[^\w@+\-_]/, '.')
+    end
+
+    extend self
+  end
+end

data/lib/dpl/helper/transliterate.rb

@@ -0,0 +1,11 @@
+module Dpl
+  module Transliterate
+    APPROXIMATIONS = YAML.load(File.read(File.expand_path('../../../../config/transliterate.yml', __FILE__)))
+
+    def transliterate(string, replacement = '.')
+      string.gsub(/[^\x00-\x7f]/u) do |char|
+        APPROXIMATIONS[char] || replacement
+      end
+    end
+  end
+end

data/lib/dpl/providers/bintray.rb

@@ -5,7 +5,7 @@ require 'find'
 module Dpl
   module Providers
     class Bintray < Provider
-      status :beta
+      status :stable
 
       description sq(<<-str)
         tbd

data/lib/dpl/providers/cloudformation.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Cloudformation < Provider
-      status :dev
+      status :stable
 
       full_name 'AWS CloudFormation'
 
@@ -27,9 +27,7 @@ module Dpl
       opt '--wait', 'Wait for CloutFormation to finish the stack creation and update', default: true
       opt '--wait_timeout SEC', 'How many seconds to wait for stack creation and update.', type: :integer, default: 3600
       opt '--create_timeout SEC', 'How many seconds to wait before the stack status becomes CREATE_FAILED', type: :integer, default: 3600, note: 'valid only when creating a stack'
-      # if passing a session_token is not recommended in CI/CD why do we add it to dpl?
-      opt '--session_token STR', 'AWS Session Access Token if using STS assume role', note: 'Not recommended on CI/CD'
-      opt '--parameters STR', 'key=value pairs or ENV var names', type: :array, sep: ',', eg: 'one=1 or ENV_VAR_TWO'
+      opt '--parameters STR', 'key=value pairs or ENV var names', type: :array, eg: 'one=1 or ENV_VAR_TWO'
       opt '--output_file PATH', 'Path to output file to store CloudFormation outputs to'
 
       msgs login:             'Using Access Key: %{access_key_id}',
@@ -184,7 +182,7 @@ module Dpl
         end
 
         def credentials
-          Aws::Credentials.new(access_key_id, secret_access_key, session_token)
+          Aws::Credentials.new(access_key_id, secret_access_key)
         end
 
         def assume_role(params)
@@ -200,7 +198,7 @@ module Dpl
         end
 
         def now
-          Time.now.strftime('%Y-%m-%dT%H:%M:%S')
+          Time.now.strftime('%Y%m%d%H%M%S')
         end
 
         def url?(str)

data/lib/dpl/providers/cloudfoundry.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Cloudfoundry < Provider
-      status :alpha
+      status :stable
 
       full_name 'Cloud Foundry'
 

data/lib/dpl/providers/convox.rb

@@ -20,10 +20,12 @@ module Dpl
       opt '--update_cli'
       opt '--create'
       opt '--promote', default: true
-      opt '--env VARS', type: :array, sep: ','
+      opt '--env_names VARS', type: :array, sep: ','
+      opt '--env VARS', type: :array
       opt '--env_file FILE'
       opt '--description STR'
       opt '--generation NUM', type: :int, default: '2'
+      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}',
@@ -58,28 +60,26 @@ module Dpl
         shell :create
       end
 
+      def prepare
+        Array(super).each do |cmd|
+          cmd.casecmp('restart').zero? ? restart : run_cmd(cmd)
+        end
+      end
+
       def deploy
         shell :set_env, echo: false unless env.empty?
-        shell promote ? :deploy : :build, echo: false
+        shell promote? ? :deploy : :build, echo: false
       end
 
-      # not sure about this api. i like that there is an api for people to include
-      # env vars from the current build env, but maybe it would be better to expose
-      # FOO=$FOO? is mapping a bare env key to a key/value pair a concept in convox?
-      #
-      # def env
-      #   env = env_file.concat(super || []) # TODO Cl should return an empty array, shouldn't it?
-      #   env = env.map { |str| str.include?('=') ? str : "#{str}=#{ENV[str]}" }
-      #   env.map { |str| escape(str) }.join(' ')
-      # end
-
-      # here's an alternative implementation that would expose FOO=$FOO:
-      gem 'sh_vars', '~> 1.0.2'
+      def env_names
+        env = super || []
+        env = env.map { |str| "#{str}=#{ENV[str]}" }
+        env_file.concat(env)
+      end
 
       def env
-        env = env_file.concat(super || [])
-        env = env.map { |str| ShVars.parse(str).to_h }.inject(&:merge) || {}
-        env.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+        env = env_names.concat(super || [])
+        env.map { |str| escape(str) }.join(' ')
       end
 
       def env_file

data/lib/dpl/providers/elasticbeanstalk.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Elasticbeanstalk < Provider
-      status :beta
+      status :stable
 
       full_name 'AWS Elastic Beanstalk'
 
@@ -29,6 +29,7 @@ module Dpl
       opt '--zip_file PATH', 'The zip file that you want to deploy'
       opt '--only_create_app_version', 'Only create the app version, do not actually deploy it'
       opt '--wait_until_deployed', 'Wait until the deployment has finished'
+      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}',
@@ -122,8 +123,8 @@ module Dpl
 
       def wait_until_deployed
         msgs = []
-        1.upto(20) { return if check_deployment(msgs) }
-        error 'Too many failures'
+        1.upto(wait_until_deployed_timeout / 5) { return if check_deployment(msgs) }
+        error 'Deploy status unknown due to timeout. Increase the wait_until_deployed_timeout option'
       end
 
       def check_deployment(msgs)

data/lib/dpl/providers/firebase.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Firebase < Provider
-      status :beta
+      status :stable
 
       description sq(<<-str)
         tbd

data/lib/dpl/providers/gae.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Gae < Provider
-      status :beta
+      status :stable
 
       full_name 'Google App Engine'
 

data/lib/dpl/providers/gcs.rb

@@ -3,7 +3,7 @@ require 'kconv'
 module Dpl
   module Providers
     class Gcs < Provider
-      status :beta
+      status :stable
 
       full_name 'Google Cloud Store'
 

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

@@ -4,7 +4,7 @@ module Dpl
       class Api < Heroku
         register 'heroku:api'
 
-        status :beta
+        status :stable
 
         full_name 'Heroku API'
 

data/lib/dpl/providers/lambda.rb

@@ -3,7 +3,7 @@ require 'dpl/helper/zip'
 module Dpl
   module Providers
     class Lambda < Provider
-      status :beta
+      status :stable
 
       full_name 'AWS Lambda'
 

data/lib/dpl/providers/netlify.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Netlify < Provider
-      status :beta
+      status :stable
 
       description sq(<<-str)
         tbd

data/lib/dpl/providers/npm.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Npm < Provider
-      status :beta
+      status :stable
 
       full_name 'npm'
 
@@ -19,6 +19,7 @@ module Dpl
       opt '--registry URL', 'npm registry url'
       opt '--src SRC', 'directory or tarball to publish', default: '.'
       opt '--tag TAGS', 'distribution tags to add'
+      opt '--run_script SCRIPT', 'run the given script from package.json', type: :array, note: 'skips running npm publish'
       opt '--dry_run', 'performs test run without uploading to registry'
       opt '--auth_method METHOD', 'Authentication method', enum: %w(auth)
 
@@ -29,10 +30,12 @@ module Dpl
            login:    'Authenticated with API token %{api_token}'
 
       cmds registry: 'npm config set registry "%{registry}"',
-           deploy:   'npm publish %{src} %{publish_opts}'
+           publish:  'npm publish %{src} %{publish_opts}',
+           run:      'npm run %{script}'
 
       errs registry: 'Failed to set registry config',
-           deploy:    'Failed pushing to npm'
+           publish:  'Failed to publish',
+           run:      'Failed to run script %{script}'
 
       def login
         info :version
@@ -42,7 +45,11 @@ module Dpl
       end
 
       def deploy
-        shell :deploy
+        if run_script?
+          run_scripts
+        else
+          shell :publish
+        end
       end
 
       def finish
@@ -51,6 +58,12 @@ module Dpl
 
       private
 
+        def run_scripts
+          run_script.each do |script|
+            shell :run, script: script
+          end
+        end
+
         def publish_opts
           opts_for(%i(access tag dry_run), dashed: true)
         end

data/lib/dpl/providers/openshift.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Openshift < Provider
-      status :beta
+      status :stable
 
       full_name 'OpenShift'
 

data/lib/dpl/providers/opsworks.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Opsworks < Provider
-      status :beta
+      status :stable
 
       full_name 'AWS OpsWorks'
 

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

@@ -18,7 +18,7 @@ module Dpl
           open_timeout: 180
         }
 
-        gem 'octokit', '~> 4.14.0'
+        gem 'octokit', '~> 4.15.0'
 
         full_name 'GitHub Pages (API)'
 

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

@@ -4,7 +4,7 @@ module Dpl
       class Git < Pages
         register 'pages:git'
 
-        status :beta
+        status :stable
 
         full_name 'GitHub Pages'
 
@@ -12,7 +12,7 @@ module Dpl
           tbd
         str
 
-        gem 'octokit', '~> 4.14.0'
+        gem 'octokit', '~> 4.15.0'
         gem 'public_suffix', '~> 3.0.3'
 
         required :token, :deploy_key
@@ -66,7 +66,7 @@ module Dpl
              cname:               'echo "%{fqdn}" > CNAME',
              git_add:             'git add -A .',
              git_commit_hook:     'cp %{path} .git/hooks/pre-commit',
-             git_commit:          'git commit %{git_commit_opts} -qm %{quoted_commit_message}',
+             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}" "%{target_branch}":"%{target_branch}" > /dev/null 2>&1'
 
@@ -170,6 +170,11 @@ module Dpl
           ' --allow-empty' if allow_empty_commit?
         end
 
+        def git_commit_msg_opts
+          msg = interpolate(commit_message)
+          msg.split("\n").reject(&:empty?).map { |msg| %(-m #{quote(msg)}) }
+        end
+
         def git_push_opts
           ' --force' unless keep_history?
         end
@@ -190,10 +195,6 @@ module Dpl
         end
         memoize :email
 
-        def commit_message
-          interpolate(super)
-        end
-
         def project_name
           super || fqdn || repo_slug
         end

data/lib/dpl/providers/pypi.rb

@@ -1,7 +1,7 @@
 module Dpl
   module Providers
     class Pypi < Provider
-      status :beta
+      status :stable
 
       full_name 'PyPI'
 

data/lib/dpl/providers/releases.rb

@@ -1,7 +1,11 @@
+require 'dpl/helper/github'
+
 module Dpl
   module Providers
     class Releases < Provider
-      status :beta
+      include Github
+
+      status :stable
 
       full_name 'GitHub Releases'
 
@@ -9,7 +13,7 @@ module Dpl
         tbd
       str
 
-      gem 'octokit', '~> 4.14.0'
+      gem 'octokit', '~> 4.15.0'
       gem 'mime-types', '~> 3.2.2'
       gem 'public_suffix', '~> 3.0.3'
 
@@ -43,6 +47,7 @@ module Dpl
            insufficient_perm:    'Release resource not found. Make sure your token belongs to an account which has push permission to this repo.',
            overwrite_existing:   'File %s already exists, overwriting.',
            skip_existing:        'File %s already exists, skipping.',
+           upload_file:          'Uploading file %s ...',
            set_tag_name:         'Setting tag_name to %s',
            set_target_commitish: 'Setting target_commitish to %s',
            missing_file:         'File %s does not exist.',
@@ -88,11 +93,13 @@ module Dpl
         files.each { |file| upload_file(file) }
       end
 
-      def upload_file(file)
+      def upload_file(path)
+        file = normalize_filename(path)
         asset = asset(file)
         return info :skip_existing, file if asset && !overwrite?
         delete(asset, file) if asset
-        api.upload_asset(url, file, name: File.basename(file), content_type: content_type(file))
+        info :upload_file, file
+        api.upload_asset(url, path, name: file, content_type: content_type(path))
       end
 
       def delete(asset, file)
@@ -168,8 +175,8 @@ module Dpl
         slug == repo_slug
       end
 
-      def asset(path)
-        api.release_assets(url).detect { |asset| asset.name == path }
+      def asset(name)
+        api.release_assets(url).detect { |asset| asset.name == name }
       end
 
       def release_notes