capsulecd 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 846c1711f0ae0a45b11b3be3a3475b4ec7435d26
-  data.tar.gz: 766b95a987357b57d02ac101e5333c72c1db1c57
+  metadata.gz: 857e2ca315fe61eebf22039ea107b16caffa8888
+  data.tar.gz: 6638d4eaa9868fcbb61640d9c3f4bb099c02bac2
 SHA512:
-  metadata.gz: 78d44d3b319f7c3b6c67ed766836a0b4cc2679a1b85df54d0100052977255979fd9dbfde4c85799d4e2ec0e6674df9fef29b4cc871bc99e2ddc7f442d90a4129
-  data.tar.gz: 4d3fef2e36f78caa58f66134311eae35c8911ddbb1d850db1409c29d4faec4d4920d640a7f5dc7395d281fcb7eed41fe1218b9cfde36550e6e79eb463ed58a94
+  metadata.gz: 8e21df43463a02d533ac8d442437ec83dffe036536b288990d9d4911dcd12a6b302a4c59b0cead71a0b4fb9482587c5ce1b13cd7bf91d04f945e382f2d8037b8
+  data.tar.gz: a523f9636a72970f6f83e92590f2f7c1c3274e91280c64c769a746604d0355a78589a40ed8cb974bc303e52e0fe4b2c60eaebba4a13235599060dd11aa9a1af3

data/README.md

@@ -3,13 +3,13 @@
 [![Circle CI](https://circleci.com/gh/AnalogJ/capsulecd.svg?style=shield)](https://circleci.com/gh/AnalogJ/capsulecd)
 [![Coverage Status](https://coveralls.io/repos/github/AnalogJ/capsulecd/badge.svg)](https://coveralls.io/github/AnalogJ/capsulecd)
 [![GitHub license](https://img.shields.io/github/license/AnalogJ/capsulecd.svg)](https://github.com/AnalogJ/capsulecd/blob/master/LICENSE)
-[![Gratipay User](https://img.shields.io/gratipay/user/analogj.svg)](https://gratipay.com/~AnalogJ/)
+[![Gem](https://img.shields.io/gem/dt/capsulecd.svg)](https://rubygems.org/gems/capsulecd)
+[![Gem](https://img.shields.io/gem/v/capsulecd.svg)](https://rubygems.org/gems/capsulecd)
+[![Docker Pulls](https://img.shields.io/docker/pulls/analogj/capsulecd.svg)](https://hub.docker.com/r/analogj/capsulecd)
+[![Flattr this git repo](https://button.flattr.com/flattr-badge-large.png)](https://flattr.com/submit/auto?fid=jexon1&url=https%3A%2F%2Fgithub.com%2FAnalogJ%2Fcapsulecd&title=CapsuleCD&language=Ruby&tags=github&category=software)
 
 <!-- 
-[![Gem](https://img.shields.io/gem/dt/capsulecd.svg)]()
-[![Gem](https://img.shields.io/gem/v/capsulecd.svg)]()
 [![Gemnasium](https://img.shields.io/gemnasium/analogj/capsulecd.svg)]()
-[![Docker Pulls](https://img.shields.io/docker/pulls/analogj/capsulecd.svg)]()
 -->
 
 CapsuleCD is a generic Continuous Delivery pipeline for versioned artifacts and libraries written in any language. 
@@ -57,16 +57,16 @@ It automates away all the common steps required when creating a new version of y
 At first glance, it seems simple to publish a new library version. Just bump the version number and publish, right?
 Well, not always:
 
-- If you're library includes a Gemfile.lock, Berksfile.lock or other most common lock files, you'll need to regenerate them. 
-- Everyone runs their library unit tests before creating a new release, but hat about validating that your library dependencies exist (maybe in your Company's private repo)?
+- If you're library includes a Gemfile.lock, Berksfile.lock or other common lock files, you'll need to regenerate them as the old version number is embedded inside. 
+- Everyone runs their library unit tests before creating a new release (right?!), but what about validating that your [library dependencies exist](http://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/) (maybe in your Company's private repo)?
 - How about linting your source, to ensure that it follows common/team conventions? 
-- Who owns the gem? Is there one developer who has the credentials to push to RubyGems.org? Are they still on your team? 
+- Who owns the gem? Is there one developer who has the credentials to push to RubyGems.org? Are they still on your team/on vacation? 
 - Did you remember to tag your source when the new version was created (making it easy to determine what's changed between versions?)
 - Did you update your changelog?
 
 CapsuleCD handles all of that (and more!) for you. It pretty much guarantees that your library will have proper and consistent releases every time. 
-CapsuleCD is well structured and fully tested, unlike the release scripts you've manually cobbled together for each library. It can be customized as needed without rewriting from scratch.
-The best part is that CapsuleCD uses CapsuleCD to automate its releases. We dogfood it so we're the first ones to find any issues with a new release. 
+CapsuleCD is well structured and fully tested, unlike the release scripts you've manually cobbled together for each library and language. It can be customized as needed without rewriting from scratch.
+The best part is that CapsuleCD uses CapsuleCD to automate its releases. We [dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) it so we're the first ones to find any issues with a new release. 
 
 ## How do I start?
 You can use CapsuleCD to automate creating a new release from a pull request __or__ from the latest code on your default branch.
@@ -81,7 +81,7 @@ Here's how to use __docker__ to merge a pull request to your Ruby library
     CAPSULE_RUBYGEMS_API_KEY=ASDF12345F \
     docker run AnalogJ/capsulecd:ruby capsulecd start --source github --package_type ruby
 
-Or you could install and call CapsuleCD directly to merge a pull request to your Python library:
+Or you could __install__ and call CapsuleCD directly to merge a pull request to your Python library:
 
 	gem install capsulecd
 	CAPSULE_SOURCE_GITHUB_ACCESS_TOKEN=123456789ABCDEF \
@@ -96,7 +96,7 @@ Or you could install and call CapsuleCD directly to merge a pull request to your
 	TODO: add documentation on how to create a release from the master branch without a pull request. Specify the env variables required. 
 	
 # Engine
-Every package type is mapped to an engine class which inherits from a `BaseEngine` clas, ie `PythonEngine`, `NodeEngine`, `RubyEngine` etc. 
+Every package type is mapped to an engine class which inherits from a `BaseEngine` class, ie `PythonEngine`, `NodeEngine`, `RubyEngine` etc. 
 Every source type is mapped to a source module, ie `GithubSource`. When CapsuleCD starts, it initializes the specified Engine, and loads the correct Source module.
 Then it begins processing your source code step by step.
 
@@ -131,7 +131,7 @@ Setting | System Config | Repo Config | Notes
 package_type | No | No | Must be set by `--package-type` flag
 source | No | No | Must be set by `--source` flag
 runner | No | No | Must be set by `--runner` flag
-dry_run | Yes | No | Can be `YES` or `NO`
+dry_run | No | No | Must be set by `--[no]-dry-run` flag
 source_git_parent_path | Yes | No | Specifies the location where the git repo will be cloned, defaults to tmp directory
 source_github_api_endpoint | Yes | No | Specifies the Github api endpoint to use (for use with Enterprise Github)
 source_github_web_endpoint | Yes | No | Specifies the Github web endpoint to use (for use with Enterprise Github)
@@ -169,7 +169,35 @@ source_github_web_endpoint: https://git.mycorpsubnet.example.com/v2
 
 ## Stage pre/post hooks and overrides
 
-	TODO: add example and documetnation on how to override stages. 
+CapsuleCD is completely customizable, to the extent that you can run your own Ruby code as `pre` and `post` hooks before every step. 
+If that's not enough, you can also completely override the step itself, allowing you to use your own business logic.
+To add a `pre`/`post` hook or override a step, just modify your config `yml` file by adding the step you want to modify, and 
+specify `pre`, `post` or `override` as a subkey. Then specify your multiline ruby script:
+
+	---
+      source_configure:
+        pre: |
+          # this is my multiline ruby script
+          # the pre hook script runs before the actual step (source_configure) executes
+          # we have access to any of the specified instance variables here.
+          # check the documentation for more information.
+          puts "override pre_source_configure" 
+          `git clone ...`
+        override: |
+          # override scripts can be used to completely replace the built-in step script.
+          # to ensure that you are compatible with the capsulecd runner, please ensure that you
+          # populate all the correct instance variables.
+          # see the documentation for more information
+          puts "override source_configure"
+        post: |
+          # post scripts run after the step (source_configure) executes
+          # you can override any instance variables here, do additional cleanup or anything else you want.
+          puts "override post_source_configure"
+      build_step:
+        post: |
+          # post build step runs after the build_step runs
+          # within the script you have access to all instance variables and other methods defined in the engine.
+          puts "override post_build_step" + @source_git_local_path
 
 # Testing
 
@@ -222,6 +250,6 @@ We use SemVer for versioning. For the versions available, see the tags on this r
 
 Jason Kulatunga - Initial Development -  [@AnalogJ](https://github.com/AnalogJ)
 
-#License
+# License
 
 CapsuleCD is licensed under the MIT License - see the [LICENSE.md](https://github.com/AnalogJ/capsulecd/blob/master/LICENSE.md) file for details

data/lib/capsulecd/base/common/validation_utils.rb

@@ -1,9 +1,11 @@
 require 'capsulecd'
 module CapsuleCD
   class ValidationUtils
+    # TODO: validation almost needs to be source specific (or inherit from this base function), because source methods
+    # may require additional attributes, while these base payload keys are required for general step functions.
     def self.validate_repo_payload(repo_payload)
       unless repo_payload['sha']
-        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "sha1" key'
+        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "sha" key'
       end
       unless repo_payload['ref']
         fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "ref" key'

data/lib/capsulecd/chef/chef_engine.rb

@@ -121,7 +121,6 @@ module CapsuleCD
 
         unless @config.chef_supermarket_username || @config.chef_supermarket_key
           fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy cookbook to supermarket, credentials missing'
-          return
         end
 
         # knife is really sensitive to folder names. The cookbook name MUST match the folder name otherwise knife throws up

data/lib/capsulecd/javascript/javascript_engine.rb

@@ -160,7 +160,6 @@ module CapsuleCD
 
           unless @config.npm_auth_token
             fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy page to npm, credentials missing'
-            return
           end
 
           # write the knife.rb config file.

data/lib/capsulecd/node/node_engine.rb

@@ -112,7 +112,6 @@ module CapsuleCD
 
         unless @config.npm_auth_token
           fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy page to npm, credentials missing'
-          return
         end
 
         # write the knife.rb config file.

data/lib/capsulecd/python/python_engine.rb

@@ -118,7 +118,6 @@ TOX
 
         unless @config.pypi_username || @config.pypi_password
           fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy package to pip, credentials missing'
-          return
         end
 
         # write the knife.rb config file.

data/lib/capsulecd/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCD
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/spec/lib/capsulecd/base/common/validation_utils_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'CapsuleCD::ValidationUtils' do
+  subject{
+    CapsuleCD::ValidationUtils
+  }
+  describe '#validate_repo_payload' do
+    let(:payload){
+      {
+          'sha' => '0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c',
+          'ref' => 'mybranch',
+          'repo' => {
+              'clone_url' => 'https://github.com/analogj/capsulecd.git',
+              'name' => 'capsulecd'
+          }
+      }
+    }
+    it 'should run successfully when parsing correctly structured payload' do
+      expect(subject.validate_repo_payload(payload)).to eql(nil)
+    end
+
+    it 'should raise an error when payload is missing sha' do
+      payload.delete('sha')
+      expect{subject.validate_repo_payload(payload)}.to raise_error(CapsuleCD::Error::SourcePayloadFormatError)
+    end
+
+    it 'should raise an error when payload is missing ref' do
+      payload.delete('ref')
+      expect{subject.validate_repo_payload(payload)}.to raise_error(CapsuleCD::Error::SourcePayloadFormatError)
+    end
+
+    it 'should raise an error when payload is missing clone_url' do
+      payload['repo'].delete('clone_url')
+      expect{subject.validate_repo_payload(payload)}.to raise_error(CapsuleCD::Error::SourcePayloadFormatError)
+    end
+
+    it 'should raise an error when payload is missing name' do
+      payload['repo'].delete('name')
+      expect{subject.validate_repo_payload(payload)}.to raise_error(CapsuleCD::Error::SourcePayloadFormatError)
+    end
+  end
+
+end

data/spec/lib/capsulecd/base/runner/default_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'capsulecd/base/runner/default'
+
+describe CapsuleCD::Runner::Default do
+  describe '#runner_retrieve_payload' do
+    let(:default_runner) {
+      Class.new { include CapsuleCD::Runner::Default }
+    }
+    describe 'when no config.runner_pull_request is set' do
+      let(:config) { CapsuleCD::Configuration.new({
+          :runner_sha => '0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c',
+          :runner_branch => 'master',
+          :runner_clone_url => 'https://github.com/analogj/capsulecd.git',
+          :runner_repo_name => 'capsulecd',
+          :runner_repo_full_name => 'AnalogJ/capsulecd'
+                                                  })
+      }
+      it 'should populate a branch release payload' do
+        runner = default_runner.new
+        runner.instance_variable_set(:@config, config)
+
+        payload = runner.runner_retrieve_payload({})
+
+        expect(runner.instance_variable_get(:@runner_is_pullrequest)).to eql(false)
+        expect(payload).to eql({
+                                   'head' => {
+                                     'sha' => '0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c',
+                                     'ref' => 'master',
+                                     'repo' => {
+                                         'clone_url' => 'https://github.com/analogj/capsulecd.git',
+                                         'name' => 'capsulecd',
+                                         'full_name' => 'AnalogJ/capsulecd'
+                                     }
+                                 }
+                               })
+      end
+    end
+
+    describe 'when config.runner_pull_request is set' do
+      let(:config) { CapsuleCD::Configuration.new({
+                                                      :runner_pull_request => '4',
+                                                  })
+      }
+      let(:source_client_double) { instance_double(Octokit::Client) }
+
+      it 'should retrieve the payload from source' do
+        allow(source_client_double).to receive(:pull_request).and_return({:test => :payload})
+
+        runner = default_runner.new
+        runner.instance_variable_set(:@config, config)
+        runner.instance_variable_set(:@source_client, source_client_double)
+
+        payload = runner.runner_retrieve_payload({})
+
+        expect(runner.instance_variable_get(:@runner_is_pullrequest)).to eql(true)
+        expect(payload).to eql({:test => :payload})
+      end
+    end
+
+  end
+
+end

data/spec/lib/capsulecd/chef/chef_engine_spec.rb

@@ -23,6 +23,9 @@ describe 'CapsuleCD::Chef::ChefEngine', :chef do
       end
       it 'should create a Rakefile, Berksfile, .gitignore file,  file and tests folder' do
         FileUtils.copy_entry('spec/fixtures/chef/cookbook_analogj_test', test_directory)
+        FileUtils.rm(test_directory + '/Rakefile')
+        FileUtils.rm(test_directory + '/Gemfile')
+
         engine.instance_variable_set(:@source_git_local_path, test_directory )
 
         VCR.use_cassette('chef_build_step',:tag => :chef) do
@@ -34,6 +37,8 @@ describe 'CapsuleCD::Chef::ChefEngine', :chef do
         File.exist?(test_directory+'/Gemfile')
 
       end
+
+
     end
   end
 

data/spec/lib/capsulecd/python/python_engine_spec.rb

@@ -23,6 +23,8 @@ describe 'CapsuleCD::Python::PythonEngine', :python do
       end
       it 'should create a VERSION file, requirements.txt file and tests folder' do
         FileUtils.copy_entry('spec/fixtures/python/pip_analogj_test', test_directory)
+        FileUtils.rm(test_directory + '/VERSION')
+        FileUtils.rm(test_directory + '/tox.ini')
         engine.instance_variable_set(:@source_git_local_path, test_directory)
 
         VCR.use_cassette('pip_build_step',:tag => :ruby) do
@@ -30,6 +32,7 @@ describe 'CapsuleCD::Python::PythonEngine', :python do
         end
 
         File.exist?(test_directory+'/VERSION')
+        File.exist?(test_directory+'/tox.ini')
         File.exist?(test_directory+'/requirements.txt')
         File.exist?(test_directory+'/.gitignore')
       end

data/spec/lib/capsulecd/ruby/ruby_engine_spec.rb

@@ -21,8 +21,10 @@ describe 'CapsuleCD::Ruby::RubyEngine', :ruby do
         CapsuleCD::Ruby::RubyEngine.new(source: :github,
                                             package_type: :ruby)
       end
-      it 'should create a .gitignore file and spec folder' do
+      it 'should create a Gemfile, Rakefile, .gitignore file and spec folder' do
         FileUtils.copy_entry('spec/fixtures/ruby/gem_analogj_test', test_directory)
+        FileUtils.rm(test_directory + '/Gemfile')
+        FileUtils.rm(test_directory + '/Rakefile')
 
         engine.instance_variable_set(:@source_git_local_path, test_directory)
 
@@ -31,6 +33,8 @@ describe 'CapsuleCD::Ruby::RubyEngine', :ruby do
         end
 
         expect(File.exist?(test_directory+'/.gitignore')).to eql(true)
+        expect(File.exist?(test_directory+'/Gemfile')).to eql(true)
+        expect(File.exist?(test_directory+'/Rakefile')).to eql(true)
       end
 
       it 'should raise an error if version.rb is missing' do

data/spec/lib/capsulecd/ruby/ruby_helper_spec.rb

@@ -46,6 +46,46 @@ describe 'CapsuleCD::Ruby::RubyHelper', :ruby do
       end
     end
 
+    describe 'when modifying gemspec file' do
+      it 'should not keep old constant from version.rb file in memory' do
+        FileUtils.copy_entry('spec/fixtures/ruby/gem_analogj_test', test_directory)
+
+        gemspec_data = CapsuleCD::Ruby::RubyHelper.get_gemspec_data(test_directory)
+        expect(gemspec_data.version.to_s).to eql('0.1.3')
+
+        version_str = CapsuleCD::Ruby::RubyHelper.read_version_file(test_directory, gemspec_data.name)
+        next_version = CapsuleCD::Engine.new(:source => :github).send(:bump_version, SemVer.parse(gemspec_data.version.to_s))
+        expect(next_version.to_s).to eql('0.1.4')
+
+        new_version_str = version_str.gsub(/(VERSION\s*=\s*['"])[0-9\.]+(['"])/, "\\1#{next_version}\\2")
+        CapsuleCD::Ruby::RubyHelper.write_version_file(test_directory, gemspec_data.name, new_version_str)
+
+        Open3.popen3('gem build gem_analogj_test.gemspec', chdir: test_directory) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::BuildPackageFailed, 'gem build failed. Check gemspec file and dependencies'
+          end
+          unless File.exist?(test_directory + "/#{gemspec_data.name}-#{next_version.to_s}.gem")
+            fail CapsuleCD::Error::BuildPackageFailed, "gem build failed. #{gemspec_data.name}-#{next_version.to_s}.gem not found"
+          end
+        end
+
+        updated_gemspec_data = CapsuleCD::Ruby::RubyHelper.get_gemspec_data(test_directory)
+        expect(updated_gemspec_data.version.to_s).to eql('0.1.4')
+
+
+
+      end
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsulecd
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Jason Kulatunga (AnalogJ)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -178,8 +178,10 @@ files:
 - spec/fixtures/vcr_cassettes/integration_ruby.yml
 - spec/fixtures/vcr_cassettes/node_build_step.yml
 - spec/fixtures/vcr_cassettes/pip_build_step.yml
+- spec/lib/capsulecd/base/common/validation_utils_spec.rb
 - spec/lib/capsulecd/base/configuration_spec.rb
 - spec/lib/capsulecd/base/engine_spec.rb
+- spec/lib/capsulecd/base/runner/default_spec.rb
 - spec/lib/capsulecd/base/source/github_spec.rb
 - spec/lib/capsulecd/base/transform_engine_spec.rb
 - spec/lib/capsulecd/chef/chef_engine_spec.rb
@@ -211,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: CapsuleCD is a library for automating package releases (npm, cookbooks, gems,
@@ -268,8 +270,10 @@ test_files:
 - spec/fixtures/vcr_cassettes/integration_ruby.yml
 - spec/fixtures/vcr_cassettes/node_build_step.yml
 - spec/fixtures/vcr_cassettes/pip_build_step.yml
+- spec/lib/capsulecd/base/common/validation_utils_spec.rb
 - spec/lib/capsulecd/base/configuration_spec.rb
 - spec/lib/capsulecd/base/engine_spec.rb
+- spec/lib/capsulecd/base/runner/default_spec.rb
 - spec/lib/capsulecd/base/source/github_spec.rb
 - spec/lib/capsulecd/base/transform_engine_spec.rb
 - spec/lib/capsulecd/chef/chef_engine_spec.rb