harrison 0.5.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 438dd20b8530a8b199713be701f928204ffc23f1
-  data.tar.gz: 73c8b343dd39608a630f6096b22f606014605a6b
+SHA256:
+  metadata.gz: 4ac6e8aca51fd74e1b84b13585f9bd8733d92e12a413c76818dca4de77aff614
+  data.tar.gz: d471919b9f85f9dc53abd62b5820b8aabdb0de9d7df278088720475f9209a3fd
 SHA512:
-  metadata.gz: 0e551411587565663827accb294e2fc3d720af283ecce502a0e401487e1ac17e17f25f04d44f07baab69ae78c2890b383a67c5c38260a3c6f9e55f7e6fd5be51
-  data.tar.gz: 802fa4f53e5342e40219d7494b8dbe31e00a87388661794746287a38b6141d1547ca1b0d87b4ec9bce93d89dcce6c583c9214044b2ec26dd578205da59c6dc1e
+  metadata.gz: 2516c2cdc2745f7392f5a9993b3fd0d431ba9875db6c5a77b8919c5ea3ef1a20064ca15079b533fc1c0889b06955be5f3e1d64d14e876295351cbff4526f6f6e
+  data.tar.gz: e08b862b1d1957d5629a529e5437f7da9fcc37a9c1b256d1cce9591e37bc7c1c45d37a2e9baf94251507dc9219b6f2ba64b0e0b469f5cf7e55200ba783d7e367

data/CHANGELOG

@@ -1,3 +1,32 @@
+0.9.1
+-------------------
+- Bumped dependencies on net-ssh and net-scp to latest majors
+
+0.9.0
+-------------------
+- Added ability to package via Docker
+- Added ability to generate multiple builds from a single invocation (when building via Docker)
+
+0.8.0
+-------------------
+- BREAKING: Bumped required Ruby version to >= 2.3.1
+- Bumped net-ssh to 5.2.x
+- Bumped net-scp to 2.0.x
+
+0.7.0
+-------------------
+- Added ability to calculate build host dynamically in package task.
+
+0.6.0
+-------------------
+- Added ability to package from forks. When packaging from HEAD or a branch,
+  harrison will now check to see if that branch is tracking a remote branch.
+  If so, it will attempt to package code from that remote. If the branch
+  being packaged is not tracking a remote branch, or if what is being packaged
+  is not a branch, harrison will look for a remote named "origin" and package
+  from there. Lastly, if there is not a remote named "origin", it will package
+  from the configured "git_src".
+
 0.5.0
 -------------------
 - BREAKING: Bumped net-ssh to 3.2.x which results in Harrison now

data/CODEOWNERS

@@ -0,0 +1 @@
+* @puppetlabs/forge-team

data/README.md

@@ -119,8 +119,9 @@ Harrison.deploy do |h|
 end
 ```
 
-Next, ensure that your SSH key is authorized to log in as the `user` you have specified in
-the Harrisonfile for each task. (Or be ready to type the password a lot. :weary:)
+Next, ensure that your SSH key is authorized to log in as the `user` you have
+specified in the Harrisonfile for each task. (Or be ready to type the password
+a lot. :weary:)
 
 ### Building a Release
 
@@ -130,18 +131,25 @@ Use the `harrison package` command:
 $ harrison package
 ```
 
-By default this will build and package `HEAD` of your current branch. You may specify another commit to
-build using the `--commit` option:
+By default this will build and package `HEAD` of your current branch. You may
+specify another commit to build using the `--commit` option:
 
 ```
 $ harrison package --commit mybranch
 ```
 
-The `--commit` option understands anything that `git rev-parse` understands. *NOTE: The commit you
-reference must be pushed to the repository referenced as `git_src` in the Harrisonfile before
-you can build it.*
+The `--commit` option understands anything that `git rev-parse` understands.
+*NOTE: The commit you reference must be pushed to a repository accessible by
+your build server before you can build it.*
 
-The packaged release artifact will, by default, be saved into a local 'pkg' subfolder:
+By default, harrison will automatically detect the correct remote repository to
+attempt to package from by first checking to see if the branch being deployed
+is tracking a specific remote and if not, looking for a remote named "origin"
+to package from. If neither of these is available, it will fall back to the
+git\_src configured in your Harrisonfile.
+
+The packaged release artifact will, by default, be saved into a local 'pkg'
+subfolder:
 
 ```
 $ harrison package
@@ -149,8 +157,8 @@ Packaging 5a547d8 for "harrison" on build-server.example.com...
 Sucessfully packaged 5a547d8 to pkg/20140711170226-5a547d8.tar.gz
 ```
 
-You can set the destination on the command line with the `--destination` option, or
-specify a new default in your Harrisonfile:
+You can set the destination on the command line with the `--destination`
+option, or specify a new default in your Harrisonfile:
 
 ```
 h.destination = '/tmp'
@@ -162,16 +170,18 @@ You can also specify a remote destination:
 h.destination = 'jesse@artifact-host.example.com:/tmp/artifacts'
 ```
 
-The username is optional and, if omitted, the build user will be used. *NOTE: Your build server
-must have already accepted the SSH host key of the destination server in order to transfer the
-artifact.*
+The username is optional and, if omitted, the build user will be used. *NOTE:
+Your build server must have already accepted the SSH host key of the
+destination server in order to transfer the artifact.*
 
-There are some additional options available, run `harrison package --help` to see everything available.
+There are some additional options available, run `harrison package --help` to
+see everything available.
 
 
 ### Deploying a Release
 
-Use the `harrison deploy` command passing the artifact to be deployed as an argument:
+Use the `harrison deploy` command passing the artifact to be deployed as an
+argument:
 
 ```
 $ harrison deploy pkg/20140711170226-5a547d8.tar.gz
@@ -183,10 +193,11 @@ You can also deploy from a remote artifact source:
 $ harrison deploy jesse@artifact-host.example.com:/tmp/artifacts/20140711170226-5a547d8.tar.gz
 ```
 
-*NOTE: Each target server must have already accepted the SSH host key of the source server in order to
-transfer the artifact.*
+*NOTE: Each target server must have already accepted the SSH host key of the
+source server in order to transfer the artifact.*
 
-By default, the artifact will be deployed to the list of hosts defined in your Harrisonfile.
+By default, the artifact will be deployed to the list of hosts defined in your
+Harrisonfile.
 
 You can override the target hosts by passing a `--hosts` option:
 
@@ -200,7 +211,8 @@ You can also pass an `--env` option to deploy into multi-stage environments:
 $ harrison deploy pkg/20140711170226-5a547d8.tar.gz --env prod
 ```
 
-This value can then be tested to alter the default target hosts in your Harrisonfile:
+This value can then be tested to alter the default target hosts in your
+Harrisonfile:
 
 ```ruby
 if h.env =~ /prod/
@@ -210,11 +222,42 @@ else
 end
 ```
 
-You can use the `--keep` option (or set it in the deploy section of your Harrisonfile) to specify the total number of
-deploys you want to retain on each server after a successful deployment. The default is to keep all previous deploys
-around indefinitely.
+The hosts option in your Harrisonfile can also be defined as a block of code
+which will be evaluated in order to calculate a list of hosts to deploy to.
+The code block should evaluate to an array of hostnames, for example:
+
+```ruby
+h.hosts = Proc.new do |h; client, response, instances|
+  require 'aws-sdk'
+
+  AWS.config(region: 'us-west-2')
+
+  client = AWS.ec2.client
+
+  response = client.describe_instances(filters: [
+    { name: 'tag:Name', values: ["app-server-*.#{h.env}.example.com"] },
+    { name: 'instance-state-name', values: ['running'] },
+  ])
+
+  instances = response.data[:reservation_set].flat_map do |r|
+    r[:instances_set] && r[:instances_set].collect do |i|
+      name_tag = i[:tag_set].find { |tag| tag[:key] == 'Name' }
+
+      name_tag[:value]
+    end
+  end
+
+  instances
+end
+```
+
+You can use the `--keep` option (or set it in the deploy section of your
+Harrisonfile) to specify the total number of deploys you want to retain on each
+server after a successful deployment. The default is to keep all previous
+deploys around indefinitely.
 
-There are some additional options available, run `harrison deploy --help` to see everything available.
+There are some additional options available, run `harrison deploy --help` to
+see everything available.
 
 
 ## Contributing

data/harrison.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.3.1'
 
   spec.add_runtime_dependency "trollop", "~> 2.1.2"
-  spec.add_runtime_dependency "net-ssh", "~> 3.2"
-  spec.add_runtime_dependency "net-scp", "~> 1.2.1"
+  spec.add_runtime_dependency "net-ssh", "~> 6.1"
+  spec.add_runtime_dependency "net-scp", "~> 3.0"
   spec.add_runtime_dependency "highline", "~> 1.7.8"
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/lib/harrison/base.rb

@@ -6,9 +6,11 @@ module Harrison
     def initialize(arg_opts=[], opts={})
       # Config helpers for Harrisonfile.
       self.class.option_helper(:user)
+      self.class.option_helper(:env)
 
       @arg_opts = arg_opts
       @arg_opts << [ :debug, "Output debug messages.", :type => :boolean, :default => false ]
+      @arg_opts << [ :env, "Environment to package for or deploy to. This can be examined in your Harrisonfile to calculate target hosts.", :type => :string ]
 
       @options = opts
     end

data/lib/harrison/deploy.rb

@@ -15,7 +15,6 @@ module Harrison
     def initialize(opts={})
       # Config helpers for Harrisonfile.
       self.class.option_helper(:hosts)
-      self.class.option_helper(:env)
       self.class.option_helper(:base_dir)
       self.class.option_helper(:deploy_via)
       self.class.option_helper(:keep)
@@ -24,7 +23,6 @@ module Harrison
       # Command line opts for this action. Will be merged with common opts.
       arg_opts = [
         [ :hosts, "List of remote hosts to deploy to. Can also be specified in Harrisonfile.", :type => :strings ],
-        [ :env, "Environment to deploy to. This can be examined in your Harrisonfile to calculate target hosts.", :type => :string ],
         [ :keep, "Number of recent deploys to keep after a successful deploy. (Including the most recent deploy.) Defaults to keeping all deploys forever.", :type => :integer ],
         [ :confirm, "Whether to interactively confirm the list of target hosts for deployment.", :type => :flag, :default => true ],
       ]

data/lib/harrison/package.rb

@@ -2,6 +2,8 @@ module Harrison
   class Package < Base
     def initialize(opts={})
       # Config helpers for Harrisonfile.
+      self.class.option_helper(:via)
+      self.class.option_helper(:dockerfiles)
       self.class.option_helper(:host)
       self.class.option_helper(:commit)
       self.class.option_helper(:purge)
@@ -33,33 +35,75 @@ module Harrison
     def run(&block)
       return super if block_given?
 
+      # Find the URL of the remote in case it differs from git_src.
+      remote_url = find_remote(self.commit)
+
       # Resolve commit ref to an actual short SHA.
       resolve_commit!
 
-      puts "Packaging #{commit} for \"#{project}\" on #{host}..."
+      return run_docker if self.via == :docker
+
+      if self.host.respond_to?(:call)
+        resolved_host = self.host.call(self)
+        self.host = resolved_host
+      end
+
+      # Require at least one host.
+      if !self.host || self.host.empty?
+        abort("ERROR: Unable to resolve build host.")
+      end
+
+      puts "Packaging #{commit} from #{remote_url} for \"#{project}\" on #{host}..."
 
       # Make sure the folder to save the artifact to locally exists.
       ensure_destination(destination)
 
+      # To avoid collisions, we use a version of the full URL as remote name.
+      remote_cache_name = remote_url.gsub(/[^a-z0-9_]/i, '_')
+
       # Fetch/clone git repo on remote host.
-      remote_exec("if [ -d cached ] ; then cd cached && git fetch origin -p ; else git clone #{git_src} cached ; fi")
+      remote_exec <<~ENDCMD
+        if [ -d cached ]
+        then
+          cd cached
+          if [ -d .git/refs/remotes/#{remote_cache_name} ]
+          then
+            git fetch #{remote_cache_name} -p
+          else
+            git remote add -f #{remote_cache_name} #{remote_url}
+          fi
+        else
+          git clone -o #{remote_cache_name} #{remote_url} cached
+        fi
+      ENDCMD
 
-      # Make a build folder of the target commit.
-      remote_exec("rm -rf #{artifact_name(commit)} && cp -a cached #{artifact_name(commit)}")
+      build_dir = remote_cache_name + '-' + artifact_name(commit)
 
-      # Check out target commit.
-      remote_exec("cd #{artifact_name(commit)} && git reset --hard #{commit} && git clean -f -d")
+      # Clean up any stale build folder of the target remote/commit.
+      remote_exec("rm -rf #{build_dir} && mkdir -p #{build_dir}")
+
+      # Check out target commit into the build_dir.
+      checkout_failure = catch :failure do
+        remote_exec("cd cached && GIT_WORK_TREE=../#{build_dir} git checkout --detach -f #{commit} && git checkout -f -") # TODO: When git is upgraded: --ignore-other-worktrees
+
+        # We want "checkout_failure" to be false if nothing was caught.
+        false
+      end
+
+      if checkout_failure
+        abort("ERROR: Unable to checkout requested git reference '#{commit}' on build server, ensure you have pushed the requested branch or tag to the remote repo.")
+      end
 
       # Run user supplied build code in the context of the checked out code.
       begin
-        @_remote_context = "#{remote_project_dir}/package/#{artifact_name(commit)}"
+        @_remote_context = "#{remote_project_dir}/package/#{build_dir}"
         super
       ensure
         @_remote_context = nil
       end
 
       # Package build folder into tgz.
-      remote_exec("rm -f #{artifact_name(commit)}.tar.gz && cd #{artifact_name(commit)} && tar #{excludes_for_tar} -czf ../#{artifact_name(commit)}.tar.gz .")
+      remote_exec("rm -f #{artifact_name(commit)}.tar.gz && cd #{build_dir} && tar #{excludes_for_tar} -czf ../#{artifact_name(commit)}.tar.gz .")
 
       if match = remote_regex.match(destination)
         # Copy artifact to remote destination.
@@ -73,7 +117,8 @@ module Harrison
       end
 
       if purge
-        remote_exec("rm -rf #{artifact_name(commit)}")
+        remote_exec("rm -rf #{build_dir}")
+        remote_exec("rm #{artifact_name(commit)}.tar.gz")
       end
 
       puts "Sucessfully packaged #{commit} to #{destination}/#{artifact_name(commit)}.tar.gz"
@@ -81,10 +126,160 @@ module Harrison
 
     protected
 
+    def run_docker
+      require 'open3'
+
+      packages = []
+
+      git_worktree_prune_argv = [
+        "git",
+        "worktree",
+        "prune",
+      ].join(' ')
+
+      if Harrison::DEBUG
+        system(git_worktree_prune_argv) || (throw :failure)
+      else
+        _, gwtp_err, gwtp_status = Open3.capture3(git_worktree_prune_argv)
+
+        if gwtp_status != 0
+          puts gwtp_err
+          throw :failure
+        end
+      end
+
+      begin
+        tmp_dir = Dir.mktmpdir("harrison-#{project}", "/tmp")
+        tmp_src_dir = File.join(tmp_dir, 'src')
+
+        git_worktree_add_argv = [
+          "git",
+          "worktree",
+          "add",
+          "--force", # allow new worktree to check out duplicate branch
+          tmp_src_dir,
+          commit,
+        ].join(' ')
+
+        git_worktree_add_env = {
+          "OVERCOMMIT_DISABLE" => "1",
+        }
+
+        if Harrison::DEBUG
+          system(git_worktree_add_env, git_worktree_add_argv) || (throw :failure)
+        else
+          _, gwta_err, gwta_status = Open3.capture3(git_worktree_add_env, git_worktree_add_argv)
+
+          if gwta_status != 0
+            puts gwta_err
+            throw :failure
+          end
+        end
+
+        self.dockerfiles.each do |df|
+          df_basename = File.basename(df, '.Dockerfile')
+          docker_image_tag = "#{project}-harrison-#{df_basename}:latest"
+
+          docker_build_argv = [
+            'docker', 'build',
+            '--file', df,
+            '--tag', docker_image_tag,
+            '.',
+          ].join(' ')
+
+          puts "Running: #{docker_build_argv}"
+
+          if Harrison::DEBUG
+            system(docker_build_argv) || (throw :failure)
+          else
+            _, build_err, build_status = Open3.capture3(docker_build_argv)
+
+            if build_status != 0
+              puts build_err
+              throw :failure
+            end
+          end
+
+          docker_run_argv = [
+            "docker", "run",
+            "--mount", "type=bind,source=#{tmp_src_dir},target=/src,readonly",
+            "--mount", "type=bind,source=\"$(pwd)/pkg\",target=/pkg",
+            docker_image_tag,
+            commit,
+          ].join(' ')
+
+          puts "Running: #{docker_run_argv}"
+
+          if Harrison::DEBUG
+            system(docker_run_argv) || (throw :failure)
+          else
+            pkg_out, pkg_err, pkg_status = Open3.capture3(docker_run_argv)
+
+            if pkg_status != 0
+              puts pkg_err
+              throw :failure
+            end
+            pkg_out_lines = pkg_out.split("\n")
+
+            packages << pkg_out_lines[-1]
+          end
+        end
+
+        git_worktree_remove_argv = [
+          "git",
+          "worktree",
+          "remove",
+          "--force", # don't care if worktree is unclean
+          tmp_src_dir,
+        ].join(' ')
+
+        if Harrison::DEBUG
+          system(git_worktree_remove_argv) || (throw :failure)
+        else
+          _, gwtr_err, gwtr_status = Open3.capture3(git_worktree_remove_argv)
+
+          if gwtr_status != 0
+            puts gwtr_err
+            throw :failure
+          end
+        end
+      ensure
+        FileUtils.rm_rf(tmp_dir, secure: true)
+      end
+
+      puts "\n#{packages.join("\n")}"
+    end
+
     def remote_project_dir
       "#{remote_dir}/#{project}"
     end
 
+    def find_remote(ref)
+      remote = nil
+      remote_url = nil
+
+      catch :failure do
+        # If it's a branch, try to resolve what it's tracking.
+        # This will exit non-zero (and throw :failure) if the ref is
+        # not a branch.
+        remote = exec("git rev-parse --symbolic-full-name #{ref}@{upstream} 2>/dev/null")&.match(/\Arefs\/remotes\/(.+)\/.+\Z/i)&.captures.first
+      end
+
+      # Fallback to 'origin' if not deploying a branch with a tracked
+      # upstream.
+      remote ||= 'origin'
+
+      catch :failure do
+        # Look for a URL for whatever remote we have. git-config exits
+        # non-zero if the requested value doesn't exist.
+        remote_url = exec("git config remote.#{remote}.url 2>/dev/null")
+      end
+
+      # If we found a remote_url, return that, otherwise fall back to
+      # configured git_src.
+      return remote_url || self.git_src
+    end
+
     def resolve_commit!
       self.commit = exec("git rev-parse --short #{self.commit} 2>/dev/null")
     end

data/lib/harrison/version.rb

@@ -1,3 +1,3 @@
 module Harrison
-  VERSION = "0.5.0"
+  VERSION = "0.9.1"
 end

data/spec/unit/harrison/package_spec.rb

@@ -4,6 +4,7 @@ describe Harrison::Package do
   before(:all) do
     Harrison.class_variable_set(:@@config, Harrison::Config.new)
     Harrison.config.project = 'test_project'
+    Harrison.config.git_src = 'git_src_from_config'
   end
 
   let(:instance) do
@@ -97,6 +98,49 @@ describe Harrison::Package do
       end
     end
 
+    describe '#find_remote' do
+      before(:each) do
+        allow(instance).to receive(:exec).with(/^git config remote.my_remote.url/).and_return('my_remote_url')
+      end
+
+      context 'when deploying a branch that is tracking a remote branch' do
+        before(:each) do
+          allow(instance).to receive(:exec).with(/^git rev-parse/).and_return('refs/remotes/my_remote/branch')
+        end
+
+        it 'should return url for tracked remote' do
+          expect(instance.send(:find_remote, 'HEAD')).to eq 'my_remote_url'
+        end
+      end
+
+      context 'when deploying a tree-ish with no remote tracking' do
+        before(:each) do
+          allow(instance).to receive(:exec).with(/^git rev-parse/).and_throw(:failure)
+        end
+
+        context 'when an \'origin\' remote exists' do
+          before(:each) do
+            allow(instance).to receive(:exec).with(/^git config remote.origin.url/).and_return('origin_url')
+          end
+
+          it 'should return url for origin' do
+            expect(instance.send(:find_remote, 'HEAD')).to eq 'origin_url'
+          end
+        end
+
+        context 'when no \'origin\' remote exists' do
+          before(:each) do
+            allow(instance).to receive(:exec).with(/^git config remote.origin.url/).and_throw(:failure)
+          end
+
+          it 'should return the configured git_src' do
+            # git_src is defined globally at the top of this file
+            expect(instance.send(:find_remote, 'HEAD')).to eq 'git_src_from_config'
+          end
+        end
+      end
+    end
+
     describe '#resolve_commit!' do
       it 'should resolve commit reference to a short sha using git rev-parse' do
         instance.commit = 'giant'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harrison
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Jesse Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +162,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG
+- CODEOWNERS
 - Gemfile
 - IDEAS
 - LICENSE.txt
@@ -199,15 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: 2.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Simple artifact-based deployment for web applications.