dpl 2.0.0.alpha.14 → 2.0.0.beta.2

data/lib/dpl/helper/interpolate.rb

@@ -52,6 +52,14 @@ module Dpl
       Interpolator.new(str, self, args || {}, opts).apply
     end
 
+    # Interpolation variables as declared by the provider.
+    #
+    # By default this contains string option names, but additional
+    # methods can be added using Provider::Dsl#vars.
+    def vars
+      self.class.vars
+    end
+
     # Obfuscates the given string.
     #
     # Replaces all but the first N characters with asterisks, and paddes
@@ -71,6 +79,7 @@ module Dpl
       PATTERN  = /%\{(\$?[\w]+)\}/
       ENV_VAR  = /^\$[A-Z_]+$/
       UPCASE   = /^[A-Z_]+$/
+      UNKNOWN  = '[unknown variable: %s]'
 
       def apply
         str = interpolate(self.str.to_s)
@@ -102,7 +111,9 @@ module Dpl
       end
 
       def lookup(key)
-        if mod = modifier(key)
+        if vars? && !var?(key)
+          UNKNOWN % key
+        elsif mod = modifier(key)
           key = key.to_s.sub("#{mod}d_", '')
           obj.send(mod, lookup(key))
         elsif key.to_s =~ ENV_VAR
@@ -121,6 +132,18 @@ module Dpl
       def modifier(key)
         MODIFIER.detect { |mod| key.to_s.start_with?("#{mod}d_") }
       end
+
+      def var?(key)
+        vars.include?(key)
+      end
+
+      def vars
+        opts[:vars]
+      end
+
+      def vars?
+        !!vars
+      end
     end
   end
 end

data/lib/dpl/provider.rb

@@ -152,6 +152,16 @@ module Dpl
     opt '--fold',         'Wrap log output in folds', internal: true
     opt '--edge',         internal: true
 
+    vars *%i(
+      git_author_email
+      git_author_name
+      git_branch
+      git_commit_author
+      git_commit_msg
+      git_sha
+      git_tag
+    )
+
     msgs before_install:  'Installing deployment dependencies',
          before_setup:    'Setting the build environment up for the deployment',
          setup_git_ssh:   'Setting up git-ssh',

data/lib/dpl/provider/dsl.rb

@@ -2,6 +2,15 @@ require 'dpl/helper/squiggle'
 require 'dpl/helper/wrap'
 require 'dpl/provider/status'
 
+# TODO figure out how to allow adding domain specific behavior like this to Cl
+class Cl::Opt
+  OPTS << :interpolate
+
+  def interpolate?
+    opts[:interpolate]
+  end
+end
+
 module Dpl
   class Provider < Cl::Cmd
     # DSL available on the provider's class body.
@@ -36,6 +45,22 @@ module Dpl
         status ? @status = Status.new(self, status, msg) : @status
       end
 
+      # Declare additional variables available for interpolation.
+      #
+      # Interpolating strings, when these exposed to the user, should safelist
+      # which variables are available. Options declared on a provider are
+      # always available, except if they are flags, arrays, internal, or
+      # secrets. This method can be used to allow additional variables, e.g.
+      # from the git context.
+      def vars(*vars)
+        return self.vars.concat(vars) if vars.any?
+        return @vars if instance_variable_defined?(:@vars)
+        vars = superclass.respond_to?(:vars) ? superclass.vars : []
+        reject = %i(flag array internal interpolate secret)
+        opts = reject.inject(self.opts) { |opts, attr| opts.reject(&:"#{attr}?") }
+        @vars = vars.dup.concat(opts.map(&:name)).uniq.sort - [:strategy]
+      end
+
       # @!method env
       # Declare an environment variable prefix to accept env vars as options
       #

data/lib/dpl/providers.rb

@@ -15,6 +15,7 @@ require 'dpl/providers/convox'
 require 'dpl/providers/elasticbeanstalk'
 require 'dpl/providers/engineyard'
 require 'dpl/providers/firebase'
+require 'dpl/providers/flynn'
 require 'dpl/providers/gae'
 require 'dpl/providers/gcs'
 require 'dpl/providers/gleis'

data/lib/dpl/providers/anynines.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Anynines < Provider
+      register :anynines
+
       status :alpha
 
       description sq(<<-str)

data/lib/dpl/providers/azure_web_apps.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class AzureWebApps < Provider
+      register :azure_web_apps
+
       status :alpha
 
       full_name 'Azure Web Apps'

data/lib/dpl/providers/bintray.rb

@@ -5,6 +5,8 @@ require 'find'
 module Dpl
   module Providers
     class Bintray < Provider
+      register :bintray
+
       status :stable
 
       description sq(<<-str)

data/lib/dpl/providers/bluemixcloudfoundry.rb

@@ -1,7 +1,9 @@
 module Dpl
   module Providers
     class Bluemixcloudfoundry < Provider
-      status :alpha
+      register :bluemixcloudfoundry
+
+      status :beta
 
       full_name 'Bluemix Cloud Foundry'
 

data/lib/dpl/providers/boxfuse.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Boxfuse < Provider
+      register :boxfuse
+
       status :alpha
 
       description sq(<<-str)

data/lib/dpl/providers/cargo.rb

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

data/lib/dpl/providers/cloud66.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Cloud66 < Provider
+      register :cloud66
+
       status :alpha
 
       description sq(<<-str)

data/lib/dpl/providers/cloudfiles.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Cloudfiles < Provider
+      register :cloudfiles
+
       status :alpha
 
       full_name 'Cloud Files'

data/lib/dpl/providers/cloudformation.rb

@@ -1,6 +1,7 @@
 module Dpl
   module Providers
     class Cloudformation < Provider
+      register :cloudformation
       status :stable
 
       full_name 'AWS CloudFormation'

data/lib/dpl/providers/cloudfoundry.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Cloudfoundry < Provider
+      register :cloudfoundry
+
       status :stable
 
       full_name 'Cloud Foundry'

data/lib/dpl/providers/codedeploy.rb

@@ -3,7 +3,9 @@ module Dpl
     # split this up to CodeDeploy::Github and CodeDeploy::S3 using the
     # revision_type, in order to make opts more strict
     class Codedeploy < Provider
-      status :alpha
+      register :codedeploy
+
+      status :beta
 
       full_name 'AWS Code Deploy'
 
@@ -30,7 +32,7 @@ module Dpl
       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'
+      opt '--description DESCR', 'Description of the revision', interpolate: true
       opt '--endpoint ENDPOINT', 'S3 endpoint url'
 
       msgs login:                 'Using Access Key: %{access_key_id}',
@@ -44,6 +46,8 @@ module Dpl
            unknown_revision_type: 'Unknown revision type %p',
            unknown_bundle_type:   'Unknown bundle type'
 
+      vars :build_number
+
       def login
         info :login
       end
@@ -152,7 +156,7 @@ module Dpl
       end
 
       def description
-        super || interpolate(msg(:description))
+        interpolate(super || msg(:description), vars: vars)
       end
 
       def build_number

data/lib/dpl/providers/convox.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Convox < Provider
+      register :convox
+
       status :dev
 
       description sq(<<-str)

data/lib/dpl/providers/datica.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Datica < Provider
+      register :datica
+
       status :dev
 
       register :datica, :catalyze

data/lib/dpl/providers/elasticbeanstalk.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Elasticbeanstalk < Provider
+      register :elasticbeanstalk
+
       status :stable
 
       full_name 'AWS Elastic Beanstalk'

data/lib/dpl/providers/engineyard.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Engineyard < Provider
+      register :engineyard
+
       status :alpha
 
       description sq(<<-str)

data/lib/dpl/providers/firebase.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Firebase < Provider
+      register :firebase
+
       status :stable
 
       description sq(<<-str)

data/lib/dpl/providers/flynn.rb

@@ -0,0 +1,33 @@
+module Dpl
+  module Providers
+    class Flynn < Provider
+      register :flynn
+
+      status :dev
+
+      full_name 'Flynn'
+
+      description sq(<<-str)
+        Flynn provider for Dpl
+      str
+
+      opt '--git URL', 'Flynn Git remote URL', required: true
+
+      needs :git, :git_http_user_agent
+
+      cmds fetch: 'git fetch origin $TRAVIS_BRANCH --unshallow',
+           push:  'git push %{remote} HEAD:refs/heads/master -f'
+
+      def deploy
+        shell :fetch, assert: false
+        shell :push
+      end
+
+      private
+
+        def remote
+          git
+        end
+    end
+  end
+end

data/lib/dpl/providers/gae.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Gae < Provider
+      register :gae
+
       status :stable
 
       full_name 'Google App Engine'

data/lib/dpl/providers/gcs.rb

@@ -3,6 +3,8 @@ require 'kconv'
 module Dpl
   module Providers
     class Gcs < Provider
+      register :gcs
+
       status :stable
 
       full_name 'Google Cloud Store'

data/lib/dpl/providers/gleis.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Gleis < Provider
+      register :gleis
+
       status :alpha
 
       description sq(<<-str)

data/lib/dpl/providers/hackage.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Hackage < Provider
+      register :hackage
+
       status :alpha
 
       description sq(<<-str)

data/lib/dpl/providers/hephy.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Hephy < Provider
+      register :hephy
+
       status :beta
 
       description sq(<<-str)

data/lib/dpl/providers/heroku.rb

@@ -1,6 +1,8 @@
 module Dpl
   module Providers
     class Heroku < Provider
+      register :heroku
+
       abstract
 
       gem 'faraday', '~> 0.9.2'

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

@@ -2,7 +2,7 @@ module Dpl
   module Providers
     class Heroku
       class Api < Heroku
-        register 'heroku:api'
+        register :'heroku:api'
 
         status :stable
 

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

@@ -2,7 +2,7 @@ module Dpl
   module Providers
     class Heroku
       class Git < Heroku
-        register 'heroku:git'
+        register :'heroku:git'
 
         status :alpha
 

data/lib/dpl/providers/lambda.rb

@@ -3,6 +3,8 @@ require 'dpl/helper/zip'
 module Dpl
   module Providers
     class Lambda < Provider
+      register :lambda
+
       status :stable
 
       full_name 'AWS Lambda'
@@ -24,7 +26,7 @@ module Dpl
       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 '--description DESCR',      'Description of the Lambda being created or updated', interpolate: true
       opt '--timeout SECS',           'Function execution time (in seconds) at which Lambda should terminate the function', default: 3
       opt '--memory_size MB',         'Amount of memory in MB to allocate to this Lambda', default: 128
       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'
@@ -157,7 +159,7 @@ module Dpl
         end
 
         def description
-          super || interpolate(msg(:description))
+          interpolate(super || msg(:description), vars: vars)
         end
 
         def client