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

data/lib/dpl/assets/convox/install

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+if ! command -v convox &> /dev/null; then
+  echo "Downloading convox CLI"
+  mkdir -p $HOME/bin
+  export PATH="$HOME/bin:$PATH"
+  curl -sL -o $HOME/bin/convox %{install_url}
+  chmod +x $HOME/bin/convox
+else
+  echo "Convox CLI exists. Skipping installation"
+fi

data/lib/dpl/assets/dpl/README.erb.md

@@ -101,9 +101,13 @@ Dpl supports the following providers:
 <% providers.each do |key, name|%>
 ### <%= name %>
 
+<%= header(key) %>
+
 ```
 <%= help(key) %>
 ```
+
+<%= footer(key) %>
 <% end -%>
 
 <%= File.read('./CONTRIBUTING.md').gsub(/^#/, '##') %>

data/lib/dpl/cli.rb

@@ -8,37 +8,77 @@ module Dpl
     end
 
     def run(args)
-      args = untaint(args)
-      args = with_provider_opt(args)
       super
-    rescue UnknownCmd
-      unknown_provider(args.first)
-    rescue Error => e
+    rescue UnknownCmd => e
+      unknown_provider(e)
+    rescue UnknownOption => e
+      unknown_option(e)
+    rescue Cl::Error, Error => e
       error(e)
     end
 
+    def runner(args)
+      super(normalize(args))
+    end
+
+    def normalize(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
+
     # Tainting is being used for automatically obfuscating values for secure
     # options, so we want to untaint all incoming args here.
     def untaint(args)
       args.map(&:dup).each(&:untaint)
     end
 
-    # backwards compatibility for travis-build dpl v1 integration
-    def with_provider_opt(args)
-      return args unless arg = args.detect { |arg| arg.include?('--provider') }
-      args.delete(arg)
-      [arg.split('=').last, *args]
+    def with_cmd_opts(args, cmds)
+      cmds.inject(args) do |args, (cmd, pos)|
+        with_cmd_opt(args, cmd, pos)
+      end
+    end
+
+    def with_cmd_opt(args, cmd, pos)
+      return args unless opt = args.detect { |arg| arg.start_with?("--#{cmd}") }
+      ix = args.index(opt)
+      args.delete(opt)
+      value = opt.include?('=') ? opt.split('=').last : args.delete_at(ix)
+      args.insert(pos, value)
+      args
+    end
+
+    STRATEGIES = {
+      'heroku' => 'api',
+      'pages'  => 'git'
+    }
+
+    def with_strategy_default(args, cmd)
+      return args unless default = STRATEGIES[args.first]
+      args.insert(1, default) if args[1].nil? || args[1].to_s.start_with?('--')
+      args
     end
 
     def error(e)
       msg = "\e[31m#{e.message}\e[0m"
-      msg = [msg, *e.backtrace].join("\n") if e.backtrace?
+      msg = [msg, *e.backtrace].join("\n") if backtrace?(e)
+      abort msg
+    end
+
+    def backtrace?(e)
+      e.respond_to?(:backtrace?) && e.backtrace?
+    end
+
+    def unknown_provider(e)
+      msg = "\e[31m#{e.message}\e[0m"
+      msg << "\nDid you mean: #{e.suggestions.join(', ')}?" if e.suggestions.any?
       abort msg
     end
 
-    def unknown_provider(name)
-      msg = "\e[31mUnknown provider: #{name}\e[0m"
-      msg << "\nDid you mean: #{suggestions(name).join(', ')}?" if suggestions(name).any?
+    def unknown_option(e)
+      msg = "\e[31m#{e.message}\e[0m"
+      msg << "\nDid you mean: #{e.suggestions.join(', ')}?" if e.suggestions.any?
       abort msg
     end
 
@@ -46,9 +86,5 @@ module Dpl
       return [] unless defined?(DidYouMean)
       DidYouMean::SpellChecker.new(dictionary: providers).correct(name)
     end
-
-    def providers
-      Cl::Cmd.registry.keys.map(&:to_s)
-    end
   end
 end

data/lib/dpl/ctx/test.rb

@@ -60,8 +60,8 @@ module Dpl
         info cmd.msg if cmd.msg?
         info cmd.echo if cmd.echo?
         cmds << cmd.cmd
-        return true unless cmd.capture?
-        stdout[cmd.key] || 'captured_stdout'
+        return stdout[cmd.key] if stdout.key?(cmd.key)
+        cmd.capture? ? 'captured_stdout' : true
       end
 
       def success?
@@ -86,7 +86,7 @@ module Dpl
 
       def deprecate_opt(key, msg)
         msg = "please use #{msg}" if msg.is_a?(Symbol)
-        warn("deprecated option #{key} (#{msg})")
+        warn "Deprecated option #{key} used (#{msg})."
       end
 
       def repo_name
@@ -105,6 +105,10 @@ module Dpl
         1
       end
 
+      def git_branch
+        'git branch'
+      end
+
       def git_commit_msg
         'commit msg'
       end

data/lib/dpl/helper/env.rb

@@ -1,35 +1,84 @@
+require 'dpl/helper/memoize'
+
 module Dpl
   module Env
     def self.included(base)
       base.extend(ClassMethods)
     end
 
+    class Env
+      include Memoize
+      # opts[:allow_skip_underscore] allows unconventional ENV vars such as GOOGLECLOUDKEYFILE
+
+      attr_reader :cmd, :env, :strs, :keys, :opts
+
+      def initialize(env, args)
+        @env = env
+        @opts = args.last.is_a?(Hash) ? args.pop : {}
+        @strs = args.map(&:to_s).map(&:upcase)
+      end
+
+      def env(cmd)
+        @cmd = cmd
+        env = @env.select { |key, _| keys.include?(key) }
+        env = env.map { |key, value| [unprefix(key).downcase.to_sym, value] }.to_h
+        env.map { |key, value| [dealias(key), value] }.to_h
+      end
+
+      def description(cmd)
+        strs = self.strs.map { |str| "#{str}_" }
+        strs += self.strs if opts[:allow_skip_underscore]
+        strs = strs.size > 1 ? "[#{strs.sort.join('|')}]" : strs.join
+        "Options can be given via env vars if prefixed with `#{strs}`. #{example(cmd)}"
+      end
+
+      def example(cmd)
+        return unless opt = cmd.opts.detect { |opt| opt.secret? }
+        env = self.strs.map { |str| "`#{str}_#{opt.name.upcase}=<#{opt.name}>`" }
+        env += self.strs.map { |str| "`#{str}#{opt.name.upcase}=<#{opt.name}>`" } if opts[:allow_skip_underscore]
+        "E.g. the option `--#{opt.name}` can be given as #{sentence(env)}."
+      end
+
+      def sentence(strs)
+        return strs.join if strs.size == 1
+        [strs[0..-2].join(', '), strs[-1]].join(' or ')
+      end
+
+      private
+
+        def dealias(key)
+          opt = cmd.opts.detect { |opt| opt.aliases.include?(key) }
+          opt ? opt.name : key
+        end
+
+        def unprefix(key)
+          strs.inject(key) { |key, str| key.sub(/^#{str}_?/, '') }
+        end
+
+        def keys
+          keys = cmd.opts.map(&:name) + cmd.opts.map(&:aliases).flatten
+          strs.map { |str| keys.map { |key| keys_for(str, key) } }.flatten
+        end
+        memoize :keys
+
+        def keys_for(str, key)
+          keys = [["#{str}_", key.upcase].join]
+          keys << [str, key.upcase].join if opts[:allow_skip_underscore]
+          keys
+        end
+    end
+
     # should this sit in Cl?
     module ClassMethods
-      attr_reader :env_prefixes
-
       def env(*strs)
-        opts = strs.last.is_a?(Hash) ? strs.pop : {}
         if strs.any?
-          strs = strs.map(&:to_s).map(&:upcase)
-          @env_prefixes = strs.map { |str| "#{str.to_s.upcase}_" }
-          # allow unconventional ENV vars such as GOOGLECLOUDKEYFILE
-          @env_prefixes += strs if opts[:allow_skip_underscore]
-        elsif env_prefixes
-          opts = ENV.select { |key, _| prefixed?(key) }
-          opts.map { |key, value| [unprefix(key).downcase.to_sym, value] }.to_h
+          @env = Env.new(ENV, strs)
+        elsif env = @env || superclass.instance_variable_get(:@env)
+          env.env(self)
         else
           {}
         end
       end
-
-      def prefixed?(key)
-        env_prefixes.any? { |prefix| key.to_s.start_with?(prefix) }
-      end
-
-      def unprefix(key)
-        env_prefixes.inject(key) { |key, prefix| key.sub(prefix, '') }
-      end
     end
 
     def opts

data/lib/dpl/helper/wrap.rb

@@ -0,0 +1,9 @@
+module Wrap
+  extend self
+
+  def wrap(str, width = 80)
+    str.lines.map do |line|
+      line.size > width ? line.gsub(/(.{1,#{width}})(\s+|$)/, "\\1\n").strip : line
+    end.join("\n")
+  end
+end

data/lib/dpl/provider.rb

@@ -147,8 +147,8 @@ module Dpl
 
     arg :provider, 'The provider name', required: true
 
-    opt '--run CMD',      'Command to execute after the deployment finished successfully', type: :array
-    opt '--cleanup',      'Skip cleaning up build artifacts before the deployment', negate: %w(skip)
+    opt '--cleanup',      'Clean up build artifacts from the Git working directory before the deployment', negate: %w(skip)
+    opt '--run CMD',      'Commands to execute after the deployment finished successfully', type: :array
     opt '--stage NAME',   'Execute the given stage(s) only', type: :array, internal: true, default: STAGES
     opt '--backtrace',    'Print the backtrace for exceptions', internal: true
     opt '--fold',         'Wrap log output in folds', internal: true
@@ -170,13 +170,15 @@ module Dpl
       :validate_runtimes, :user_agent
 
     def_delegators :ctx, :apt_get, :gem_require, :npm_install, :pip_install,
-      :build_dir, :build_number, :repo_slug, :encoding, :git_author_email,
-      :git_author_name, :git_branch, :git_commit_msg, :git_dirty?, :git_log,
-      :git_ls_files, :git_ls_remote?, :git_remote_urls, :git_rev_parse,
-      :git_sha, :git_tag, :machine_name, :node_version, :npm_version, :sleep,
-      :ssh_keygen, :success?, :tmp_dir, :which, :logger, :rendezvous,
-      :file_size, :write_file, :write_netrc, :last_out, :last_err, :test?,
-      :tty?
+      :build_dir, :build_number, :encoding, :file_size, :git_author_email,
+      :git_author_name, :git_branch, :git_branch, :git_commit_author,
+      :git_commit_msg, :git_commit_msg, :git_dirty?, :git_log, :git_log,
+      :git_ls_files, :git_ls_remote?, :git_remote_urls, :git_remote_urls,
+      :git_rev_parse, :git_rev_parse, :git_sha, :git_tag, :last_err, :last_out,
+      :last_out, :logger, :machine_name, :mv, :node_version, :node_version,
+      :npm_version, :rendezvous, :rendezvous, :repo_slug, :sleep, :sleep,
+      :ssh_keygen, :success?, :test?, :test?, :tmp_dir, :tty?, :which, :which,
+      :write_file, :write_netrc
 
     attr_reader :repo_name, :key_name
 

data/lib/dpl/provider/dsl.rb

@@ -1,3 +1,5 @@
+require 'dpl/helper/squiggle'
+require 'dpl/helper/wrap'
 require 'dpl/provider/status'
 
 module Dpl
@@ -25,7 +27,7 @@ module Dpl
 
       # Summary of the provider's functionality.
       def description(str = nil)
-        str << status.msg if str && status && status.announce?
+        str = str.strip if str
         super
       end
 

data/lib/dpl/provider/status.rb

@@ -4,11 +4,11 @@ module Dpl
       STATUS = %i(dev alpha beta stable deprecated)
 
       MSG = {
-        dev:        'Support for deployments to %s is in development',
-        alpha:      'Support for deployments to %s is in alpha',
-        beta:       'Support for deployments to %s is in beta',
-        deprecated: 'Support for deployments to %s is deprecated',
-        pre_stable: 'Please see here: %s'
+        dev:        'Support for deployments to %s is in **development**',
+        alpha:      'Support for deployments to %s is in **alpha**',
+        beta:       'Support for deployments to %s is in **beta**',
+        deprecated: 'Support for deployments to %s is *deprecated**',
+        pre_stable: 'Please see [Maturity Levels](%s) for details.'
       }
 
       URL = 'https://github.com/travis-ci/dpl/#maturity-levels'
@@ -26,7 +26,7 @@ module Dpl
         msg = "#{MSG[status] % name}"
         msg << "(#{info})" if info
         msg << ". #{MSG[:pre_stable] % URL}" if pre_stable?
-        "\n#{msg}\n"
+        msg
       end
 
       private

data/lib/dpl/providers.rb

@@ -1,5 +1,4 @@
 require 'dpl/providers/anynines'
-require 'dpl/providers/atlas'
 require 'dpl/providers/azure_web_apps'
 require 'dpl/providers/bintray'
 require 'dpl/providers/boxfuse'
@@ -9,13 +8,16 @@ require 'dpl/providers/datica'
 require 'dpl/providers/chef_supermarket'
 require 'dpl/providers/cloud66'
 require 'dpl/providers/cloudfiles'
+require 'dpl/providers/cloudformation'
 require 'dpl/providers/cloudfoundry'
 require 'dpl/providers/codedeploy'
+require 'dpl/providers/convox'
 require 'dpl/providers/elasticbeanstalk'
 require 'dpl/providers/engineyard'
 require 'dpl/providers/firebase'
 require 'dpl/providers/gae'
 require 'dpl/providers/gcs'
+require 'dpl/providers/gleis'
 require 'dpl/providers/hackage'
 require 'dpl/providers/hephy'
 require 'dpl/providers/heroku'

data/lib/dpl/providers/anynines.rb

@@ -7,12 +7,14 @@ module Dpl
         tbd
       str
 
+      env :anynines
+
       opt '--username USER',    'anynines username', required: true
       opt '--password PASS',    'anynines password', required: true, secret: true
-      opt '--organization ORG', 'anynines target organization', required: true
-      opt '--space SPACE',      'anynines target space', required: true
+      opt '--organization ORG', 'anynines organization', required: true
+      opt '--space SPACE',      'anynines space', required: true
       opt '--app_name APP',     'Application name'
-      opt '--buildpack PACK',   'Custom buildpack name or Git URL'
+      opt '--buildpack PACK',   'Buildpack name or Git URL'
       opt '--manifest FILE',    'Path to the manifest'
       opt '--logout', default: true, internal: true
 

data/lib/dpl/providers/azure_web_apps.rb

@@ -11,9 +11,9 @@ module Dpl
 
       env :AZURE_WA
 
-      opt '--site SITE',     'Web App name (e.g. myapp in myapp.azurewebsites.net)', required: true
       opt '--username NAME', 'Web App Deployment Username', required: true
       opt '--password PASS', 'Web App Deployment Password', required: true, secret: true
+      opt '--site SITE',     'Web App name (e.g. myapp in myapp.azurewebsites.net)', required: true
       opt '--slot SLOT',     'Slot name (if your app uses staging deployment)'
       opt '--verbose',       'Print deployment output from Azure. Warning: If authentication fails, Git prints credentials in clear text. Correct credentials remain hidden.'
 

data/lib/dpl/providers/bintray.rb

@@ -13,6 +13,8 @@ module Dpl
 
       gem 'json'
 
+      env :bintray
+
       opt '--user USER', 'Bintray user', required: true
       opt '--key KEY', 'Bintray API key', required: true, secret: true
       opt '--file FILE', 'Path to a descriptor file for the Bintray upload', required: true

data/lib/dpl/providers/bluemixcloudfoundry.rb

@@ -9,14 +9,16 @@ module Dpl
         tbd
       str
 
+      env :cloudfoundry
+
       opt '--username USER',       'Bluemix username', required: true
       opt '--password PASS',       'Bluemix password', required: true, secret: true
-      opt '--organization ORG',    'Bluemix target organization', required: true
-      opt '--space SPACE',         'Bluemix target space', required: true
+      opt '--organization ORG',    'Bluemix organization', required: true
+      opt '--space SPACE',         'Bluemix space', required: true
       opt '--region REGION',       'Bluemix region', default: 'ng', enum: %w(ng eu-gb eu-de au-syd)
       opt '--api URL',             'Bluemix api URL'
       opt '--app_name APP',        'Application name'
-      opt '--buildpack PACK',      'Custom buildpack name or Git URL'
+      opt '--buildpack PACK',      'Buildpack name or Git URL'
       opt '--manifest FILE',       'Path to the manifest'
       opt '--skip_ssl_validation', 'Skip SSL validation'
       opt '--logout', default: true, internal: true

data/lib/dpl/providers/boxfuse.rb

@@ -11,11 +11,11 @@ module Dpl
 
       opt '--user USER', required: true
       opt '--secret SECRET', required: true, secret: true
-      opt '--config_file FILE', alias: :configfile, deprecated: :configfile
       opt '--payload PAYLOAD'
       opt '--app APP'
       opt '--version VERSION'
       opt '--env ENV'
+      opt '--config_file FILE', alias: :configfile, deprecated: :configfile
       opt '--extra_args ARGS'
 
       URL = 'https://files.boxfuse.com/com/boxfuse/client/boxfuse-commandline/latest/boxfuse-commandline-latest-linux-x64.tar.gz'

data/lib/dpl/providers/cargo.rb

@@ -7,13 +7,22 @@ module Dpl
         tbd
       str
 
+      env :cargo
+
       opt '--token TOKEN', 'Cargo registry API token', required: true, secret: true
+      opt '--allow_dirty', 'Allow publishing from a dirty git working directory'
 
-      cmds publish: 'cargo publish --token %{token}'
+      cmds publish: 'cargo publish %{publish_opts}'
 
       def deploy
         shell :publish
       end
+
+      private
+
+        def publish_opts
+          opts_for(%i(token allow_dirty), dashed: true)
+        end
     end
   end
 end