dpl 1.10.17.travis.6637.6 → 2.0.0.alpha.1

data/lib/dpl/providers/pages.rb

@@ -0,0 +1,17 @@
+module Dpl
+  module Providers
+    class Pages < Provider
+      def self.new(ctx, args)
+        return super unless registry_key.to_sym == :pages
+        arg = args.detect { |arg| arg.include? '--strategy' }
+        strategy = arg ? arg.split('=', 2).last : 'git'
+        Provider[:"pages:#{strategy}"].new(ctx, args)
+      end
+
+      opt '--strategy NAME', 'GitHub Pages deployment strategy', default: 'git', enum: %w(api git), internal: true
+    end
+  end
+end
+
+require 'dpl/providers/pages/git'
+require 'dpl/providers/pages/api'

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

@@ -0,0 +1,102 @@
+require 'timeout'
+
+module Dpl
+  module Providers
+    class Pages
+      class Api < Pages
+        PAGES_PREVIEW_MEDIA_TYPE = 'application/vnd.github.mister-fantastic-preview+json'
+
+        # suppress warnings about preview API
+        ENV['OCTOKIT_SILENT'] = 'true'
+
+        TIMEOUTS = {
+          timeout: 180,
+          open_timeout: 180
+        }
+
+        gem 'octokit', '~> 4.14.0'
+
+        status :alpha
+
+        full_name 'GitHub Pages (API)'
+
+        description sq(<<-str)
+          This provider requests GitHub Pages build for the repository given by
+          the `--repo` flag, or the current one, if the flag is not given.
+          Note that `dpl` does not perform any check about the fitness of the request;
+          it is assumed that the target repository (and the branch that GitHub Pages is
+          configured to use) is ready for building.
+          For example, if your GitHub Pages is configured to use `gh-pages` but the
+          deployment is run on the `master` branch, you would have to ensure that the
+          `gh-pages` would be updated accordingly during the build.
+        str
+
+        opt '--repo SLUG', 'GitHub repo slug', default: :repo_slug
+        opt '--github_token TOKEN', 'GitHub oauth token with repo permission', required: true, secret: true
+
+        msgs pages_not_found:             'GitHub Pages not found for %{slug}. ' \
+               'Given token has insufficient scope (\'repo\' or \'public_repo\'), ' \
+               'or GitHub Pages is not enabled for this repo (see https://github.com/%{slug}/settings)',
+             build_pages_request_timeout: 'GitHub Pages build request timed out',
+             deploy_start:                'Requesting GitHub Pages build using API'
+
+        def validate
+          error :pages_not_found unless pages_enabled?
+        end
+
+        def deploy
+          info :deploy_start
+
+          api.request_page_build slug
+
+          response = api.pages slug
+          logger.debug response
+
+          Timeout::timeout(30) do
+            until response.status == 'built'
+              response = api.pages slug
+              logger.debug response
+              sleep 1
+            end
+          end
+
+          latest_pages_build = api.latest_pages_build slug
+          if msg = latest_pages_build.error.message
+            error "Build failed: #{msg}"
+          end
+
+          info "Pages deployed to #{response.html_url}, using commit #{latest_pages_build.commit}"
+          logger.debug latest_pages_build
+
+        rescue Octokit::Forbidden => fb
+          error fb.message
+        rescue Timeout::Error => to
+          error :build_pages_request_timeout
+        end
+
+        private
+
+        def slug
+          repo || repo_slug
+        end
+
+        def api
+          ::Octokit.default_media_type = PAGES_PREVIEW_MEDIA_TYPE unless @api
+
+          @api ||= Octokit::Client.new(**creds, auto_paginate: true, connection_options: { request: TIMEOUTS })
+        end
+
+        def creds
+          { access_token: github_token }
+        end
+
+        def pages_enabled?
+          api.pages slug
+        rescue Octokit::NotFound => e
+          false
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,251 @@
+module Dpl
+  module Providers
+    class Pages
+      class Git < Pages
+        status :alpha
+
+        full_name 'GitHub Pages'
+
+        description sq(<<-str)
+          tbd
+        str
+
+        gem 'octokit', '~> 4.14.0'
+        gem 'public_suffix', '~> 3.0.3'
+
+        required :github_token, :deploy_key
+
+        opt '--repo SLUG', 'Repo slug', default: :repo_slug
+        opt '--github_token TOKEN', 'GitHub oauth token with repo permission', secret: true
+        opt '--deploy_key PATH', 'Path to a file containing a private deploy key with write access to the repository', see: 'https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys'
+        opt '--target_branch BRANCH', 'Branch to push force to', default: 'gh-pages'
+        opt '--keep_history', 'Create incremental commit instead of doing push force', default: true
+        opt '--commit_message MSG', default: 'Deploy %{project_name} to %{url}:%{target_branch}'
+        opt '--allow_empty_commit', 'Allow an empty commit to be created', requires: :keep_history
+        opt '--verbose', 'Be verbose about the deploy process'
+        opt '--local_dir DIR', 'Directory to push to GitHub Pages', default: '.'
+        opt '--fqdn FQDN', 'Write the given domain name to the CNAME file'
+        opt '--project_name NAME', 'Used in the commit message only (defaults to fqdn or the current repo slug)'
+        opt '--name NAME', 'Committer name', note: 'defaults to the current git commit author name'
+        opt '--email EMAIL', 'Committer email', note: 'defaults to the current git commit author email'
+        opt '--committer_from_gh', 'Use the token\'s owner name and email for the commit', requires: :github_token
+        opt '--deployment_file', 'Enable creation of a deployment-info file'
+        opt '--github_url URL', default: 'github.com'
+
+        needs :git
+
+        msgs login:               'Authenticated as %s',
+             invalid_token:       'The provided GitHub token is invalid (error: %s)',
+             insufficient_scopes: 'Dpl does not have permission to access %{url} using the provided GitHub token. Please make sure the token have the repo or public_repo scope.',
+             setup_deploy_key:    'Moving deploy key %{deploy_key} to %{path}',
+             check_deploy_key:    'Checking deploy key',
+             deploy:              'Deploying branch %{target_branch} to %{github_url}',
+             keep_history:        'The deployment is configured to preserve the target branch if it exists on remote.',
+             work_dir:            'Using temporary work directory %{work_dir}',
+             committer_from_gh:   'The repo is configured to use committer user and email.',
+             setup_dir:           'The source dir for deployment is %s',
+             git_clone:           'Cloning the branch %{target_branch} from the remote repo',
+             git_init:            'Initializing local git repo',
+             git_checkout:        'Checking out orphan branch %{target_branch}',
+             copy_files:          'Copying %{src_dir} contents to %{work_dir}',
+             git_config:          'Configuring git committer to be %{name} <%{email}>',
+             prepare:             'Preparing to deploy %{target_branch} branch to gh-pages',
+             git_push:            'Pushing to %{url}'
+
+        cmds git_clone:           'git clone --quiet --branch="%{target_branch}" --depth=1 "%{remote_url}" . > /dev/null 2>&1',
+             git_init:            'git init .',
+             git_checkout:        'git checkout --orphan "%{target_branch}"',
+             check_deploy_key:    'ssh -i %{key} -T git@github.com 2>&1 | grep successful > /dev/null',
+             copy_files:          'rsync -rl --exclude .git --delete "%{src_dir}/" .',
+             git_config_email:    'git config user.email %{quoted_email}',
+             git_config_name:     'git config user.name %{quoted_name}',
+             deployment_file:     'touch "deployed at %{now} by %{name}"',
+             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_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'
+
+        errs copy_files:          'Failed to copy %{src_dir}.',
+             check_deploy_key:    'Failed to authenticate using the deploy key',
+             git_init:            'Failed to create new git repo',
+             git_checkout:        'Failed to create the orphan branch',
+             git_push:            'Failed to push the build to %{url}:%{target_branch}'
+
+        def login
+          github_token? ? login_token : setup_deploy_key
+        end
+
+        def setup
+          info :setup_dir, src_dir
+          info :committer_from_gh if committer_from_gh?
+          info :git_config
+        end
+
+        def prepare
+          info :deploy
+          info :keep_history if keep_history?
+          debug :work_dir
+          Dir.chdir(work_dir)
+        end
+
+        def deploy
+          git_clone? ? git_clone : git_init
+          copy_files
+          git_config
+          git_commit
+          git_push
+          git_status if verbose?
+        end
+
+        private
+
+        def login_token
+          user.login
+          info :login, user.login
+          error :insufficient_scopes unless sufficient_scopes?
+        rescue Octokit::Unauthorized => e
+          error :invalid_token, e.message
+        end
+
+        def setup_deploy_key
+          path = '~/.dpl/deploy_key'
+          info :setup_deploy_key, path: path
+          mv deploy_key, path
+          chmod 0600, path
+          setup_git_ssh path
+          shell :check_deploy_key, key: path
+        end
+
+        def git_clone?
+          keep_history? && git_branch_exists?
+        end
+
+        def git_clone
+          shell :git_clone, echo: false
+        end
+
+        def git_init
+          shell :git_init
+          shell :git_checkout
+        end
+
+        def copy_files
+          shell :copy_files
+        end
+
+        def git_config
+          shell :git_config_name, echo: false
+          shell :git_config_email, echo: false
+        end
+
+        def git_commit
+          info :prepare
+          shell :git_commit_hook, path: asset(:git, :detect_private_key).path, echo: false if deploy_key?
+          shell :deployment_file if deployment_file?
+          shell :cname if fqdn?
+          shell :git_add
+          shell :git_commit
+          shell :git_show
+        end
+
+        def git_push
+          shell :git_push, echo: false
+        end
+
+        def git_status
+          shell 'git status'
+        end
+
+        def git_branch_exists?
+          git_ls_remote?(remote_url, target_branch)
+        end
+
+        def git_commit_opts
+          ' --allow-empty' if allow_empty_commit?
+        end
+
+        def git_push_opts
+          ' --force' unless keep_history?
+        end
+
+        def name
+          str = super if name?
+          str ||= user.name if committer_from_gh?
+          str ||= git_author_name
+          str = "#{str} (via Travis CI)" if ENV['TRAVIS'] && !name?
+          str
+        end
+        memoize :name
+
+        def email
+          str = super if email?
+          str ||= user.email if committer_from_gh?
+          str || git_author_email
+        end
+        memoize :email
+
+        def commit_message
+          interpolate(super)
+        end
+
+        def project_name
+          super || fqdn || repo_slug
+        end
+
+        def sufficient_scopes?
+          api.scopes.include?('public_repo') || api.scopes.include?('repo')
+        end
+
+        def remote_url
+          github_token? ? https_url_with_token : git_url
+        end
+
+        def https_url_with_token
+          "https://#{github_token}@#{url}"
+        end
+
+        def git_url
+          "git@#{github_url}:#{slug}.git"
+        end
+
+        def url
+          "#{github_url}/#{slug}.git"
+        end
+
+        def slug
+          repo || repo_slug
+        end
+
+        def user
+          @user ||= api.user
+        end
+
+        def src_dir
+          @src_dir ||= expand(local_dir)
+        end
+
+        def work_dir
+          @work_dir ||= tmp_dir
+        end
+
+        def api
+          @api ||= Octokit::Client.new(access_token: github_token, api_endpoint: api_endpoint)
+        end
+
+        def api_endpoint
+          github_url == 'github.com' ? 'https://api.github.com/' : "https://#{github_url}/api/v3/"
+        end
+
+        def now
+          Time.now
+        end
+
+        def debug(*args)
+          info *args if verbose?
+        end
+      end
+    end
+  end
+end

data/lib/dpl/providers/puppetforge.rb

@@ -0,0 +1,44 @@
+module Dpl
+  module Providers
+    class Puppetforge < Provider
+      status :alpha
+
+      full_name 'Puppet Forge'
+
+      description sq(<<-str)
+        tbd
+      str
+
+      gem 'puppet', '~> 5.5.14', require: 'puppet/face'
+      gem 'puppet-blacksmith', '~> 3.3.1', require: 'puppet_blacksmith'
+
+      opt '--username NAME', 'Puppet Forge user name', required: true, alias: :user
+      opt '--password PASS', 'Puppet Forge password', required: true, secret: true
+      opt '--url URL', 'Puppet Forge URL to deploy to', default: 'https://forgeapi.puppetlabs.com/'
+
+      msgs upload: 'Uploading to Puppet Forge %s/%s'
+
+      def validate
+        file.metadata
+      end
+
+      def deploy
+        build
+        info :upload, forge.username, file.name
+        forge.push!(file.name)
+      end
+
+      def file
+        @file ||= Blacksmith::Modulefile.new
+      end
+
+      def build
+        Puppet::Face['module', :current].build('./')
+      end
+
+      def forge
+        @forge ||= Blacksmith::Forge.new(username, password, url)
+      end
+    end
+  end
+end

data/lib/dpl/providers/pypi.rb

@@ -0,0 +1,120 @@
+module Dpl
+  module Providers
+    class Pypi < Provider
+      status :alpha
+
+      full_name 'PyPI'
+
+      description sq(<<-str)
+        tbd
+      str
+
+      env :pypi
+
+      VERSION = /\A\d+(?:\.\d+)*\z/
+
+      opt '--username NAME', 'PyPI Username', required: true, alias: :user
+      opt '--password PASS', 'PyPI Password', required: true, secret: true
+      opt '--server SERVER', 'Release to a different index', default: 'https://upload.pypi.org/legacy/'
+      opt '--distributions DISTS', 'Space-separated list of distributions to be uploaded to PyPI', default: 'sdist'
+      opt '--docs_dir DIR', 'Path to the directory to upload documentation from', default: 'build/docs'
+      opt '--skip_existing', 'Do not overwrite an existing file with the same name on the server.'
+      opt '--upload_docs', 'Upload documentation', default: false, type: :boolean, note: 'most PyPI servers, including upload.pypi.org, do not support uploading documentation'
+      opt '--twine_check', 'Whether to run twine check', default: true
+      opt '--remove_build_dir', 'Remove the build dir after the upload', default: true
+      opt '--setuptools_version VER', format: VERSION
+      opt '--twine_version VER', format: VERSION
+      opt '--wheel_version VER', format: VERSION
+
+      msgs login:        'Authenticated as %{username}',
+           upload_docs:  'Uploading documentation (skip using "skip_upload_docs: true")'
+
+      cmds setup_py:     'python setup.py %{distributions}',
+           twine_check:  'twine check dist/*',
+           twine_upload: 'twine upload %{skip_existing_option} -r pypi dist/*',
+           rm_dist:      'rm -rf dist/*',
+           upload_docs:  'python setup.py upload_docs %{docs_dir_option} -r %{server}'
+
+      errs install:      'Failed to install pip, setuptools, twine or wheel.',
+           setup_py:     'setup.py failed',
+           twine_check:  'Twine check failed',
+           twine_upload: 'Twine upload failed.',
+           upload_docs:  'Uploading docs failed.'
+
+
+      def install
+        script :install
+      end
+
+      def login
+        write_config
+        info :login
+      end
+
+      def setup
+        shell :setup_py
+      end
+
+      def validate
+        shell :twine_check if twine_check?
+      end
+
+      def deploy
+        shell :twine_upload
+        upload_docs if upload_docs?
+        shell :rm_dist if remove_build_dir?
+      end
+
+      private
+
+        PYPIRC = sq(<<-rc)
+          [distutils]
+          index-servers = pypi
+              pypi
+          [pypi]
+          repository: %{server}
+          username: %{username}
+          password: %{password}
+        rc
+
+        def write_config
+          write_file('~/.pypirc', pypirc)
+        end
+
+        def pypirc
+          interpolate(PYPIRC, opts, secure: true)
+        end
+
+        def upload_docs
+          info :upload_docs
+          shell :upload_docs
+        end
+
+        def skip_existing_option
+          '--skip-existing' if skip_existing?
+        end
+
+        def docs_dir_option
+          '--upload-dir ' + docs_dir if docs_dir
+        end
+
+        def setuptools_arg
+          version_arg(:setuptools)
+        end
+
+        def twine_arg
+          version_arg(:twine)
+        end
+
+        def wheel_arg
+          version_arg(:wheel)
+        end
+
+        def version_arg(name)
+          arg = name.to_s
+          arg << "==#{send(:"#{name}_version")}" if send(:"#{name}_version") =~ VERSION
+          arg
+        end
+    end
+  end
+end