travis_dpl_test 2.0.3.beta.4.ror

data/lib/dpl/providers/s3.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+# we want this, don't we?
+Thread.abort_on_exception = true
+
+module Dpl
+  module Providers
+    class S3 < Provider
+      register :s3
+
+      status :stable
+
+      full_name 'AWS S3'
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      gem 'aws-sdk-s3', '~> 1'
+      gem 'mime-types', '~> 3.4.1'
+
+      env :aws, :s3
+      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 '--bucket BUCKET', 'S3 bucket', required: true
+      opt '--region REGION', 'S3 region', default: 'us-east-1'
+      opt '--endpoint URL', 'S3 endpoint'
+      opt '--upload_dir DIR', 'S3 directory to upload to'
+      opt '--local_dir DIR', 'Local directory to upload from', default: '.', example: '~/travis/build (absolute path) or ./build (relative path)'
+      opt '--glob GLOB', 'Files to upload', default: '**/*'
+      opt '--dot_match', 'Upload hidden files starting with a dot'
+      opt '--acl ACL', 'Access control for the uploaded objects', default: 'private', enum: %w[private public_read public_read_write authenticated_read bucket_owner_read bucket_owner_full_control]
+      opt '--detect_encoding', 'HTTP header Content-Encoding for files compressed with gzip and compress utilities'
+      opt '--cache_control STR', 'HTTP header Cache-Control to suggest that the browser cache the file', type: :array, default: 'no-cache', enum: [/^no-cache.*/, /^no-store.*/, /^max-age=\d+.*/, /^s-maxage=\d+.*/, /^no-transform/, /^public/, /^private/], note: 'accepts mapping values to globs', eg: 'public: *.css,*.js'
+      opt '--expires DATE', 'Date and time that the cached object expires', type: :array, format: /^"?\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} .+"?.*$/, note: 'accepts mapping values to globs', eg: '2020-01-01 00:00:00 UTC: *.css,*.js'
+      opt '--default_text_charset CHARSET', 'Default character set to append to the content-type of text files'
+      opt '--storage_class CLASS', 'S3 storage class to upload as', default: 'STANDARD', enum: %w[STANDARD STANDARD_IA REDUCED_REDUNDANCY]
+      opt '--server_side_encryption', 'Use S3 Server Side Encryption (SSE-AES256)'
+      opt '--index_document_suffix SUFFIX', 'Index document suffix of a S3 website'
+      opt '--overwrite', 'Whether or not to overwrite existing files', default: true
+      opt '--force_path_style', 'Whether to force keeping the bucket name on the path'
+      opt '--max_threads NUM', 'The number of threads to use for S3 file uploads', default: 5, max: 15, type: :integer
+      opt '--verbose', 'Be verbose about uploading files'
+
+      msgs login: 'Using Access Key: %{access_key_id}',
+           default_uri_schema: 'S3 endpoint does not specify a scheme; defaulting to https',
+           access_denied: 'It looks like you tried to write to a bucket that is not yours or does not exist. Please create the bucket before trying to write to it.',
+           checksum_error: 'AWS secret key does not match the access key id',
+           invalid_access_key_id: 'Invalid S3 access key id',
+           upload: 'Uploading %s files with up to %s threads ...',
+           upload_file: 'Uploading %s to %s with %s',
+           upload_skipped: 'Skipping %{file}, already exists',
+           upload_failed: 'Failed to upload %s',
+           index_document_suffix: 'Setting index document suffix to %s'
+
+      DEFAULT_CONTENT_TYPE = 'application/octet-stream'
+
+      def setup
+        @cwd = Dir.pwd
+        Dir.chdir(local_dir)
+        # Aws.eager_autoload!(services: ['S3'])
+      end
+
+      def login
+        info :login
+      end
+
+      def deploy
+        upload
+        index_document_suffix if index_document_suffix?
+      rescue Aws::S3::Errors::ServiceError => e
+        handle_error(e)
+      end
+
+      def finish
+        Dir.chdir(@cwd) if @cwd
+      end
+
+      private
+
+      def upload
+        info :upload, files.length, max_threads
+        threads = max_threads.times.map { |_i| Thread.new(&method(:upload_files)) }
+        threads.each(&:join)
+        info "\n" unless verbose?
+      end
+
+      def upload_files
+        while file = files.pop
+          opts = upload_opts(file)
+          progress(file, opts)
+          upload_file(file, opts)
+        end
+      end
+
+      def progress(file, data)
+        if verbose?
+          info :upload_file, file, upload_dir || '/', to_pairs(data)
+        else
+          print '.'
+        end
+      end
+
+      def upload_file(file, opts)
+        object = bucket.object(upload_path(file))
+        return warn :upload_skipped, file: file if !overwrite && object.exists?
+
+        info :upload_file, file, upload_dir || '/', to_pairs(opts)
+        object.upload_file(file, opts) || warn(:upload_failed, file)
+      end
+
+      def index_document_suffix
+        info :index_document_suffix, super
+        body = { website_configuration: { index_document: { suffix: super } } }
+        bucket.website.put(body)
+      end
+
+      def upload_path(file)
+        [upload_dir, file].compact.join('/')
+      end
+
+      def upload_opts(file)
+        compact(
+          acl:,
+          content_type: content_type(file),
+          content_encoding: detect_encoding? ? encoding(file) : nil,
+          cache_control: match_opt(cache_control, file),
+          expires: match_opt(expires, file),
+          storage_class:,
+          server_side_encryption:
+        )
+      end
+
+      def files
+        @files ||= Dir.glob(*glob).reject { |path| File.directory?(path) }
+      end
+
+      def glob
+        [super, dot_match? ? File::FNM_DOTMATCH : nil].compact
+      end
+
+      def acl
+        super.gsub(/_/, '-') if acl?
+      end
+
+      def server_side_encryption
+        'AES256' if server_side_encryption?
+      end
+
+      def content_type(file)
+        return DEFAULT_CONTENT_TYPE unless type = MIME::Types.type_for(file).first
+
+        type = "#{type}; charset=#{default_text_charset}" if encoding(file) == 'text' && default_text_charset?
+        type.to_s
+      end
+
+      def compact(hash)
+        hash.reject { |_, value| value.nil? }.to_h
+      end
+
+      def endpoint
+        @endpoint ||= normalize_endpoint(super) if endpoint?
+      end
+
+      def normalize_endpoint(url)
+        uri = URI.parse(url)
+        return uri if uri.scheme
+
+        info :default_uri_scheme
+        URI.parse("https://#{url}")
+      end
+
+      def handle_error(err)
+        case err
+        when Aws::S3::Errors::InvalidAccessKeyId
+          error :invalid_access_key_id
+        when Aws::S3::Errors::ChecksumError
+          error :checksum_error
+        when Aws::S3::Errors::AccessDenied
+          error :access_denied
+        else
+          error err.message
+        end
+      end
+
+      def bucket
+        @bucket ||= Aws::S3::Resource.new(client:).bucket(super)
+      end
+
+      def client
+        Aws::S3::Client.new(s3_opts)
+      end
+
+      def s3_opts
+        compact(
+          region:,
+          credentials:,
+          endpoint:,
+          force_path_style: force_path_style?
+        )
+      end
+
+      def credentials
+        Aws::Credentials.new(access_key_id, secret_access_key)
+      end
+
+      def to_pairs(hash)
+        hash.map { |pair| pair.join('=') }.join(' ')
+      end
+
+      def match_opt(strs, file)
+        maps = Array(strs).map { |str| Mapping.new(str, file) }
+        maps.map(&:value).compact.first
+      end
+
+      class Mapping < Struct.new(:str, :file)
+        MATCH = File::FNM_DOTMATCH | File::FNM_EXTGLOB
+
+        def value
+          str, glob = parse
+          unquote(str) if match?(glob)
+        end
+
+        private
+
+        def unquote(str)
+          str =~ /^"(.*)"$/ && ::Regexp.last_match(1) || str
+        end
+
+        def match?(glob)
+          glob.nil? || File.fnmatch?(normalize(glob), file, MATCH)
+        end
+
+        def normalize(glob)
+          return glob if glob.include?('{')
+
+          "{#{glob.split(',').map(&:strip).join(',')}}"
+        end
+
+        def parse
+          parts = str.split(': ')
+          parts.size > 1 ? [parts[0..-2].join(': '), parts.last] : parts
+        end
+      end
+    end
+  end
+end

data/lib/dpl/providers/scalingo.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Scalingo < Provider
+      register :scalingo
+
+      status :alpha
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      env :scalingo
+
+      required :api_token, %i[username password]
+
+      opt '--app APP', default: :repo_name
+      opt '--api_token TOKEN', 'Scalingo API token', alias: :api_key, deprecated: :api_key
+      opt '--username NAME', 'Scalingo username'
+      opt '--password PASS', 'Scalingo password', secret: true
+      opt '--region REGION', 'Scalingo region', default: 'agora-fr1', enum: %w[agora-fr1 osc-fr1]
+      opt '--remote REMOTE', 'Git remote name', default: 'scalingo-dpl'
+      opt '--branch BRANCH', 'Git branch', default: 'master'
+      opt '--timeout SEC', 'Timeout for Scalingo CLI commands', default: 60, type: :integer
+
+      needs :git, :ssh_key
+
+      cmds login_key: 'timeout %{timeout} ./scalingo login --api-token %{api_token} > /dev/null',
+           login_creds: 'echo -e \"%{username}\n%{password}\" | timeout %{timeout} ./scalingo login > /dev/null',
+           add_key: 'timeout %{timeout} ./scalingo keys-add dpl_tmp_key %{key}',
+           remove_key: 'timeout %{timeout} ./scalingo keys-remove dpl_tmp_key',
+           git_setup: './scalingo --app %{app} git-setup --remote %{remote}',
+           push: 'git push %{remote} HEAD:%{branch} -f'
+
+      errs install: 'Failed to install the Scalingo CLI.',
+           login: 'Failed to authenticate with the Scalingo API.',
+           add_key: 'Failed to add the ssh key.',
+           remove_key: 'Failed to remove the ssh key.',
+           git_setup: 'Failed to add the git remote.',
+           push: 'Failed to push the app.'
+
+      def install
+        script :install
+        ENV['SCALINGO_REGION'] = region if region?
+      end
+
+      def login
+        shell api_token ? :login_key : :login_creds, assert: err(:login)
+      end
+
+      def add_key(key, _type = nil)
+        shell :add_key, key:
+      end
+
+      def setup
+        shell :git_setup
+      end
+
+      def deploy
+        shell :push
+      end
+
+      def remove_key
+        shell :remove_key
+      end
+    end
+  end
+end

data/lib/dpl/providers/script.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Script < Provider
+      register :script
+
+      status :stable
+
+      summary 'Minimal provider that executes a custom command'
+
+      description sq(<<-STR)
+        This deployment provider executes a single, custom command. This is
+        usually a script that is contained in your repository, but it can be
+        any command executable in the build environment.
+
+        It is possible to pass arguments to a script deployment like so:
+
+          dpl script -s './scripts/deploy.sh production --verbose'
+
+        Deployment will be marked a failure if the script exits with nonzero
+        status.
+      STR
+
+      opt '-s', '--script SCRIPT', 'The script to execute', required: true
+
+      def deploy
+        shell script, assert: 'Script failed with status %{status}'
+      end
+    end
+  end
+end

data/lib/dpl/providers/snap.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Snap < Provider
+      register :snap
+
+      status :stable
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      env :snap
+
+      opt '--token TOKEN', 'Snap API token', required: true, secret: true
+      opt '--snap STR', 'Path to the snap to be pushed (can be a glob)', default: '**/*.snap'
+      opt '--channel CHAN', 'Channel into which the snap will be released', default: 'edge'
+
+      apt 'snapd', 'snap'
+
+      cmds apt_get_update: 'sudo apt-get update -qq',
+           update_snapd: 'sudo apt-get install snapd',
+           install: 'sudo snap install snapcraft --classic',
+           login: 'echo "%{token}" | snapcraft login --with -',
+           deploy: 'snapcraft push %{snap_path} --release=%{channel}'
+
+      msgs login: 'Attemping to login ...',
+           no_snaps: 'No snap found matching %{snap}',
+           multiple_snaps: 'Multiple snaps found matching %{snap}: %{snap_paths}',
+           deploy: 'Pushing snap %{snap_path}'
+
+      def install
+        return if which 'snapcraft'
+
+        shell :apt_get_update
+        shell :update_snapd
+        shell :install
+        ENV['PATH'] += ':/snap/bin'
+      end
+
+      def login
+        shell :login, assert: 'Failed to authenticate: %{err}', success: '%{out}', capture: true
+      end
+
+      def validate
+        error :no_snaps if snaps.empty?
+        error :multiple_snaps if snaps.size > 1
+      end
+
+      def deploy
+        shell :deploy
+      end
+
+      def snap_path
+        snaps.first
+      end
+
+      def snap_paths
+        snaps.join(', ')
+      end
+
+      def snaps
+        @snaps ||= Dir[snap].sort
+      end
+    end
+  end
+end

data/lib/dpl/providers/surge.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+module Dpl
+  module Providers
+    class Surge < Provider
+      register :surge
+
+      status :stable
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      node_js '>= 8.8.1'
+
+      gem 'json'
+      npm :surge
+      env :surge
+
+      opt '--login EMAIL', 'Surge login (the email address you use with Surge)', required: true
+      opt '--token TOKEN', 'Surge login token (can be retrieved with `surge token`)', required: true, secret: true
+      opt '--domain NAME', 'Domain to publish to. Not required if the domain is set in the CNAME file in the project folder.'
+      opt '--project PATH', 'Path to project directory relative to repo root', default: '.'
+
+      cmds deploy: 'surge %{project} %{domain}'
+
+      msgs invalid_project: '%{project} is not a directory',
+           missing_domain: 'Please set the domain in .travis.yml or in a CNAME file in the project directory'
+
+      def login
+        ENV['SURGE_LOGIN'] ||= opts[:login]
+        ENV['SURGE_TOKEN'] ||= opts[:token]
+      end
+
+      def validate
+        error :invalid_project if invalid_project?
+        error :missing_domain  if missing_domain?
+      end
+
+      def deploy
+        shell :deploy
+      end
+
+      def invalid_project?
+        !File.directory?(project)
+      end
+
+      def missing_domain?
+        !domain && !File.exist?("#{project}/CNAME")
+      end
+
+      def project
+        expand(super, build_dir)
+      end
+    end
+  end
+end

data/lib/dpl/providers/testfairy.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'dpl/version'
+require 'net/http'
+require 'securerandom'
+
+module Dpl
+  module Providers
+    class Testfairy < Provider
+      register :testfairy
+
+      status :alpha
+
+      full_name 'TestFairy'
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      gem 'json'
+      gem 'multipart-post', '~> 2.0.0', require: 'net/http/post/multipart'
+
+      env :testfairy
+
+      opt '--api_key KEY', 'TestFairy API key', required: true, secret: true
+      opt '--app_file FILE', 'Path to the app file that will be generated after the build (APK/IPA)', required: true
+      opt '--symbols_file FILE', 'Path to the symbols file'
+      opt '--testers_groups GROUPS', 'Tester groups to be notified about this build', example: 'e.g. group1,group1'
+      opt '--notify', 'Send an email with a changelog to your users'
+      opt '--auto_update', 'Automaticall upgrade all the previous installations of this app this version'
+      opt '--advanced_options OPTS', 'Comma_separated list of advanced options', example: 'option1,option2'
+
+      URL = 'https://upload.testfairy.com/api/upload'
+      UA  = "Travis CI dpl version=#{Dpl::VERSION}".freeze
+
+      msgs deploy: 'Uploading to TestFairy: %s',
+           done: 'Done. Check your build at %s'
+
+      def deploy
+        info :deploy, pretty_print(params)
+        body = JSON.parse(http.request(request).body)
+        error body['message'] if body['status'] == 'fail'
+        info :done, body['build_url']
+      end
+
+      private
+
+      def params
+        @params ||= compact(
+          'api_key': api_key,
+          'apk_file': file(app_file),
+          'symbols_file': file(symbols_file),
+          'testers-groups': testers_groups,
+          'notify': bool(notify),
+          'auto-update': bool(auto_update),
+          'advanced-options': advanced_options,
+          'changelog': changelog
+        )
+      end
+
+      def changelog
+        git_log "--pretty=oneline --abbrev-commit #{commits}" if commits
+      end
+
+      def commits
+        ENV['TRAVIS_COMMIT_RANGE']
+      end
+
+      def request
+        Net::HTTP::Post::Multipart.new(uri.path, params, 'User-Agent' => UA)
+      end
+
+      def http
+        Net::HTTP.start(uri.host, uri.port, use_ssl: true)
+      end
+
+      def uri
+        @uri ||= URI.parse(URL)
+      end
+
+      def file(path)
+        UploadIO.new(path, '', File.basename(path)) if path
+      end
+
+      def bool(obj)
+        unless obj.nil?
+          obj ? 'on' : 'off'
+        end
+      end
+
+      def pretty_print(params)
+        params = params.map do |key, value|
+          value = obfuscate(value) if key == :api_key
+          value = value.path if value.respond_to?(:path)
+          [key, value]
+        end
+        JSON.pretty_generate(params.to_h)
+      end
+    end
+  end
+end

data/lib/dpl/providers/transifex.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Dpl
+  module Providers
+    class Transifex < Provider
+      register :transifex
+
+      status :alpha
+
+      description sq(<<-STR)
+        tbd
+      STR
+
+      python '>= 2.7', '!= 3.0', '!= 3.1', '!= 3.2', '!= 3.3', '< 3.8'
+
+      required :api_token, %i[username password]
+
+      env :transifex
+
+      opt '--api_token TOKEN', 'Transifex API token', secret: true
+      opt '--username NAME',   'Transifex username'
+      opt '--password PASS',   'Transifex password', secret: true
+      opt '--hostname NAME',   'Transifex hostname', default: 'www.transifex.com'
+      opt '--cli_version VER', 'CLI version to install', default: '>=0.11'
+
+      cmds status: 'tx status',
+           push: 'tx push --source --no-interactive'
+
+      msgs login:  'Writing ~/.transifexrc (user: %{username}, password: %{password})'
+      errs push:   'Failure pushing to Transifex'
+
+      RC = sq(<<-RC)
+        [%{url}]
+        hostname = %{url}
+        username = %{username}
+        password = %{password}
+      RC
+
+      def install
+        pip_install 'transifex-client', 'tx', cli_version
+      end
+
+      def login
+        info :login
+        write_rc
+        shell :status
+      end
+
+      def deploy
+        shell :push, retry: true
+      end
+
+      private
+
+      def write_rc
+        write_file '~/.transifexrc', interpolate(RC, opts, secure: true)
+      end
+
+      def username
+        super || 'api'
+      end
+
+      def password
+        super || api_token
+      end
+
+      def url
+        hostname.start_with?('https://') ? hostname : "https://#{hostname}"
+      end
+    end
+  end
+end