travis_dpl_test 2.0.3.beta.4.ror

data/lib/dpl/providers/elasticbeanstalk.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Elasticbeanstalk < Provider
+      register :elasticbeanstalk
+
+      status :stable
+
+      full_name 'AWS Elastic Beanstalk'
+
+      description sq(<<-STR)
+        Deploy to AWS Elastic Beanstalk: https://aws.amazon.com/elasticbeanstalk/
+
+        This provider:
+
+        * Creates a zip file (or uses one you provide)
+        * Uploads it to your EB application
+        * Optionally deploys to a specific EB environment
+        * Optionally waits until the deployment finishes
+      STR
+
+      gem 'aws-sdk-elasticbeanstalk', '~> 1'
+      gem 'aws-sdk-s3', '~> 1'
+      gem 'rubyzip', '~> 2.3', require: 'zip'
+      gem 'pathspec', '~> 1.1', require: 'pathspec'
+
+      env :aws, :elastic_beanstalk
+      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 Elastic Beanstalk app is running in', default: 'us-east-1'
+      opt '--app NAME', 'Elastic Beanstalk application name', default: :repo_name
+      opt '--env NAME', 'Elastic Beanstalk environment name to be updated.'
+      opt '--bucket NAME', 'Bucket name to upload app to', required: true, alias: :bucket_name
+      opt '--bucket_path PATH', 'Location within Bucket to upload app to'
+      opt '--description DESC', 'Description for the application version'
+      opt '--label LABEL', 'Label for the application version'
+      opt '--zip_file PATH', 'The zip file that you want to deploy. If not given, a zipfile will be created from the current directory, honoring .ebignore and .gitignore.'
+      opt '--wait_until_deployed', 'Wait until the deployment has finished', requires: :env
+      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}',
+           zip_add: 'Adding %s'
+
+      msgs clean_description: 'Removed non-printable characters from the version description'
+
+      attr_reader :started, :object, :version
+
+      def login
+        info :login
+      end
+
+      def setup
+        info :login
+        Aws.config.update(credentials:, region:)
+      end
+
+      def deploy
+        @started = Time.now
+        bucket.create unless bucket.exists?
+        create_zip unless zip_exists?
+        upload
+        create_version
+        update_app if env?
+      end
+
+      def zip_file
+        zip_file? ? expand(super) : archive_name
+      end
+
+      def archive_name
+        "#{label}.zip"
+      end
+
+      def label
+        @label ||= super || "travis-#{git_sha}-#{Time.now.to_i}"
+      end
+
+      def description
+        super || git_commit_msg
+      end
+
+      def bucket_path
+        bucket_path? ? "#{super.gsub(%r{/*$}, '')}/#{archive_name}" : archive_name
+      end
+
+      def cwd
+        @cwd ||= "#{Dir.pwd}/"
+      end
+
+      def zip_exists?
+        File.exist?(zip_file)
+      end
+
+      def create_zip
+        ::Zip::File.open(zip_file, ::Zip::File::CREATE) do |zip|
+          files.each do |path|
+            debug :zip_add, path
+            zip.add(path.sub(cwd, ''), path)
+          end
+        end
+      end
+
+      def upload
+        @object = bucket.object(bucket_path)
+        object.put(body: File.open(zip_file))
+        sleep 5 # s3 eventual consistency
+      end
+
+      def create_version
+        @version = eb.create_application_version(
+          application_name: app,
+          version_label: label,
+          description: clean(description[0, 200]),
+          source_bundle: {
+            s3_bucket: bucket.name,
+            s3_key: object.key
+          },
+          auto_create_application: false
+        )
+      end
+
+      def update_app
+        eb.update_environment(
+          environment_name: env,
+          version_label: version[:application_version][:version_label]
+        )
+        wait_until_deployed if wait_until_deployed?
+      end
+
+      def wait_until_deployed
+        msgs = []
+        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)
+        sleep 5
+        events.each do |event|
+          msg = "#{event.event_date} [#{event.severity}] #{event.message}"
+          error "Deployment failed: #{msg}" if event.severity == 'ERROR'
+          info msg unless msgs.include?(msg)
+          msgs << msg
+        end
+        environment[:status] == 'Ready'
+      rescue Aws::Errors::ServiceError => e
+        info "Caught #{e}: #{e.message}. Retrying ..."
+      end
+
+      def files
+        files = Dir.glob('**/*', File::FNM_DOTMATCH)
+        ignore = %w[.ebignore .gitignore].detect { |file| file?(file) }
+        files = filter(files, ignore) if ignore
+        files
+      end
+
+      def filter(files, spec)
+        spec = PathSpec.from_filename(spec)
+        files.reject { |file| spec.match(file) }
+      end
+
+      def events
+        args = { environment_name: env, start_time: started.utc.iso8601 }
+        eb.describe_events(args)[:events].reverse
+      end
+
+      def environment
+        args = { application_name: app, environment_names: [env] }
+        eb.describe_environments(args)[:environments].first
+      end
+
+      def credentials
+        Aws::Credentials.new(access_key_id, secret_access_key)
+      end
+
+      def s3
+        @s3 ||= Aws::S3::Resource.new
+      end
+
+      def bucket
+        @bucket ||= s3.bucket(super)
+      end
+
+      def eb
+        @eb ||= Aws::ElasticBeanstalk::Client.new(retry_limit: 10)
+      end
+
+      # We do not actually know what characters are valid on AWS EB's side,
+      # see: https://github.com/aws/aws-sdk-ruby/issues/1502
+      #
+      # Reference: https://www.w3.org/TR/xml/#charsets
+      NON_PRINTABLE_CHARS = "\u0009\u000A\u000D\u0020-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF"
+
+      def clean(str)
+        str.gsub!(/[^#{NON_PRINTABLE_CHARS}]/, '') && info(:clean_description)
+        str
+      end
+
+      def debug(*args)
+        info(*args) if debug?
+      end
+    end
+  end
+end

data/lib/dpl/providers/engineyard.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Engineyard < Provider
+      register :engineyard
+
+      status :alpha
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      gem 'ey-core', '~> 3.6'
+
+      required :api_key, %i[email password]
+
+      env :engineyard, :ey
+
+      opt '--api_key KEY',   'Engine Yard API key', secret: true, note: 'can be obtained at https://cloud.engineyard.com/cli'
+      opt '--email EMAIL',   'Engine Yard account email'
+      opt '--password PASS', 'Engine Yard password', secret: true
+      opt '--app APP',       'Engine Yard application name', default: :repo_name
+      opt '--env ENV',       'Engine Yard application environment', alias: :environment
+      opt '--migrate CMD',   'Engine Yard migration commands'
+      opt '--account NAME',  'Engine Yard account name'
+
+      msgs deploy: 'Deploying ...',
+           login: 'Authenticating via email and password ...',
+           write_rc: 'Authenticating via api token ...',
+           authenticated: 'Authenticated as %{name}',
+           invalid_migrate: 'Invalid migration command, try --migrate="rake db:migrate"',
+           envs: 'Checking environment ...',
+           no_env: 'No matching environment found',
+           too_many_envs: 'Multiple environments match, please be more specific: %s',
+           env_entry: 'environment=%s account=%s'
+
+      cmds login: "ey-core login << str\n%{email}\n%{password}\nstr",
+           whoami: 'ey-core whoami',
+           envs: 'ey-core environments',
+           deploy: 'ey-core deploy %{deploy_opts}'
+
+      def login
+        api_key? ? write_rc : authenticate
+        info :authenticated, name: whoami
+      end
+
+      def validate
+        error :invalid_migrate if invalid_migrate?
+        env
+      end
+
+      def deploy
+        shell :deploy
+      end
+
+      private
+
+      def authenticate
+        shell :login, echo: false, capture: true
+      end
+
+      def whoami
+        shell(:whoami, echo: false, capture: true) =~ /email\s*:\s*"(.+)"/ && ::Regexp.last_match(1)
+      end
+
+      def write_rc
+        info :write_rc
+        write_file '~/.ey-core', "https://api.engineyard.com/: #{api_key}"
+      end
+
+      def invalid_migrate?
+        migrate.is_a?(TrueClass) || migrate == 'true'
+      end
+
+      def deploy_opts
+        opts = [%(--ref="#{git_sha}" --environment="#{env}")]
+        opts << opts_for(%i[app account])
+        opts << migrate_opt
+        opts.join(' ')
+      end
+
+      def migrate_opt
+        migrate? ? opts_for(%i[migrate]) : '--no-migrate'
+      end
+
+      def env
+        @env ||= super || detect_env(envs)
+      end
+
+      def detect_env(envs)
+        case envs.size
+        when 1 then envs.first[:name]
+        when 0 then error :no_env
+        else too_many_envs(envs)
+        end
+      end
+
+      def envs
+        lines = shell(:envs, echo: false, capture: true).split("\n")[2..] || []
+        envs = lines.map { |line| line.split('|')[1..].map(&:strip) }
+        envs = envs.map { |pair| %i[name account].zip(pair).to_h }
+        envs.select { |env| env[:name] == opts[:env] } if env?
+        envs
+      end
+
+      def too_many_envs(envs)
+        envs = envs.map { |env| msg(:env_entry) % env.values_at(:name, :account) }
+        error msg(:too_many_envs) % envs.join(', ')
+      end
+    end
+  end
+end

data/lib/dpl/providers/firebase.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Firebase < Provider
+      register :firebase
+
+      status :stable
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      node_js '>= 8.0.0'
+
+      npm 'firebase-tools@^6.3', 'firebase'
+
+      path 'node_modules/.bin'
+
+      env :firebase
+
+      opt '--token TOKEN',   'Firebase CI access token (generate with firebase login:ci)', required: true, secret: true
+      opt '--project NAME',  'Firebase project to deploy to (defaults to the one specified in your firebase.json)'
+      opt '--message MSG',   'Message describing this deployment.'
+      opt '--only SERVICES', 'Firebase services to deploy', note: 'can be a comma-separated list'
+      opt '--force',         'Whether or not to delete Cloud Functions missing from the current working directory'
+
+      cmds deploy: 'firebase deploy --non-interactive %{deploy_opts}'
+      errs deploy: 'Firebase deployment failed'
+      msgs missing_config: 'Missing firebase.json'
+
+      def validate
+        error :missing_config unless File.exist?('firebase.json')
+      end
+
+      def deploy
+        shell :deploy
+      end
+
+      def deploy_opts
+        opts_for(%i[project message token only force])
+      end
+    end
+  end
+end

data/lib/dpl/providers/flynn.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Gae < Provider
+      register :gae
+
+      status :stable
+
+      full_name 'Google App Engine'
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      python '>= 2.7.9'
+
+      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'
+      opt '--config FILE', 'Path to your service configuration file', type: :array, default: 'app.yaml'
+      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', 'Whether to promote the deployed version', default: true
+      opt '--stop_previous_version', 'Prevent the deployment from stopping a previously promoted version', default: true
+      opt '--install_sdk', 'Whether to install the Google Cloud SDK', default: true
+
+      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.'
+
+      msgs failed: 'Deployment failed.'
+
+      path '~/google-cloud-sdk/bin'
+
+      def install
+        return unless install_sdk?
+
+        shell :install
+      end
+
+      def login
+        shell :login
+      end
+
+      def deploy
+        shell :deploy
+        failed unless success?
+      end
+
+      private
+
+      def deploy_opts
+        opts = [*opts_for(%i[project verbosity version])]
+        opts << '--no-promote' unless promote?
+        opts << '--no-stop-previous-version' unless stop_previous_version?
+        opts.join(' ')
+      end
+
+      def failed
+        warn :failed
+        shell :cat_logs
+        error ''
+      end
+
+      def project
+        super || File.dirname(build_dir)
+      end
+    end
+  end
+end

data/lib/dpl/providers/gcs.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'kconv'
+
+module Dpl
+  module Providers
+    class Gcs < Provider
+      register :gcs
+
+      status :stable
+
+      full_name 'Google Cloud Store'
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      gem 'mime-types', '~> 3.4.1'
+
+      python '>= 2.7.9'
+
+      env :gcs
+
+      required :key_file, %i[access_key_id secret_access_key]
+
+      opt '--key_file FILE', 'Path to a GCS service account key JSON file'
+      opt '--access_key_id ID', 'GCS Interoperable Access Key ID', secret: true
+      opt '--secret_access_key KEY', 'GCS Interoperable Access Secret', 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', 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.', see: 'https://cloud.google.com/storage/docs/xml-api/reference-headers#cachecontrol'
+      opt '--glob GLOB', default: '**/*'
+
+      cmds install: 'curl -L %{URL} | tar xz -C ~ && ~/google-cloud-sdk/install.sh --quiet --path-update false --usage-reporting false --command-completion false',
+           login_key: 'gcloud auth activate-service-account --key-file=%{key_file}',
+           rsync: 'gsutil %{gs_opts} rsync %{rsync_opts} %{glob} %{target}',
+           copy: 'gsutil %{gs_opts} cp %{copy_opts} -r %{source} %{target}'
+
+      msgs login_key: 'Authenticating with service account key file %{key_file}',
+           login_creds: 'Authenticating with access key: %{access_key_id}'
+
+      errs copy: 'Failed uploading files.'
+
+      URL = 'https://dl.google.com/dl/cloudsdk/channels/rapid/google-cloud-sdk.tar.gz'
+
+      BOTO = sq(<<-STR)
+        [Credentials]
+        gs_access_key_id = %{access_key_id}
+        gs_secret_access_key = %{secret_access_key}
+      STR
+
+      path '~/google-cloud-sdk'
+      move '/etc/boto.cfg'
+
+      def install
+        shell :install
+      end
+
+      def login
+        key_file? ? login_key : login_creds
+      end
+
+      def deploy
+        Dir.chdir(local_dir) do
+          files.each { |file| copy(file) }
+        end
+      end
+
+      private
+
+      def login_key
+        shell :login_key
+      end
+
+      def login_creds
+        info :login_creds
+        write_boto
+      end
+
+      def write_boto
+        write_file '~/.boto', interpolate(BOTO, opts, secure: true), 0600
+      end
+
+      def files
+        Dir.glob(*glob_args).select { |path| File.file?(path) }
+      end
+
+      def copy(source)
+        to = [target.sub(%r{/$}, ''), source].join('/')
+        shell :copy, gs_opts: gs_opts(source), source:, target: to
+      end
+
+      def dirname(path)
+        dir = File.dirname(path)
+        dir unless dir.empty? || dir == '.'
+      end
+
+      def gs_opts(path)
+        opts = []
+        opts << %(-h "Cache-Control:#{cache_control}") if cache_control?
+        opts << %(-h "Content-Encoding:#{encoding(path)}") if detect_encoding?
+        opts << %(-h "Content-type:#{mime_type(path)}") if mime_type(path)
+        "#{opts.join(' ')} " if opts.any?
+      end
+
+      def copy_opts
+        opts = []
+        opts << %(-a "#{acl}") if acl?
+        "#{opts.join(' ')} " if opts.any?
+      end
+
+      def target
+        "gs://#{bucket}/#{upload_dir}"
+      end
+
+      def mime_type(path)
+        type = MIME::Types.type_for(path).first
+        type&.to_s
+      end
+
+      def glob_args
+        args = [glob]
+        args << File::FNM_DOTMATCH if dot_match?
+        args
+      end
+    end
+  end
+end