capsulecd 1.0.0

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

@@ -0,0 +1,90 @@
+require 'git'
+require 'mkgitignore'
+
+module CapsuleCD
+  class GitUtils
+    def self.clone(parent_path, repository_name, git_remote)
+      repo_path = File.expand_path("#{parent_path}/#{repository_name}/")
+      if !File.directory?(repo_path)
+        FileUtils.mkdir_p(repo_path)
+      else
+        fail 'the repository path already exists, this should never happen'
+      end
+
+      repo = Git.clone(git_remote, '', path: repo_path)
+      repo.config('user.name', 'CapsuleCD')
+      repo.config('user.email', 'CapsuleCD@users.noreply.github.com')
+      repo.dir.to_s
+    end
+
+    def self.fetch(repo_path, remote_ref, local_branch)
+      repo = Git.open(repo_path)
+      repo.fetch(['origin', "#{remote_ref}:#{local_branch}"])
+    end
+
+    def self.checkout(repo_path, branch)
+      repo = Git.open(repo_path)
+      repo.checkout(branch)
+    end
+
+    def self.commit(repo_path, message, _all = true)
+      repo = Git.open(repo_path)
+      repo.add(all: true)
+      repo.commit_all(message)
+    end
+
+    def self.tag(repo_path, version)
+      repo = Git.open(repo_path)
+      repo.add_tag(version)
+    end
+
+    def self.push(repo_path, local_branch, remote_branch)
+      repo = Git.open(repo_path)
+      repo.push('origin', "#{local_branch}:#{remote_branch}", tags: true)
+    end
+
+    def self.pull(repo_path)
+      repo = Git.open(repo_path)
+      repo.pull
+    end
+
+    # gets the commit of the latest tag on current branch
+    def self.get_latest_tag_commit(repo_path)
+      repo = Git.open(repo_path)
+      tag_name = repo.describe(nil,:abbrev => 0, :exact_match => true)
+
+      #we're dealing with annotated tags, which have thier own git commit, which causes issues with the github release api
+      # so we're manually creating a Git Object with the data we need (.sha and .name)
+      tag_sha = repo.tag(tag_name).log.first.sha
+
+      Git::Object::Tag.new(repo,tag_sha, tag_name)
+    end
+
+    def self.generate_changelog(repo_path, base_sha, head_sha, full_name)
+      repo = Git.open(repo_path)
+      markdown = "Timestamp |  SHA | Message | Author \n"
+      markdown += "------------- | ------------- | ------------- | ------------- \n"
+      repo.log.between(base_sha, head_sha).each do |commit|
+        markdown += "#{commit.date.strftime('%Y-%m-%dT%H:%M:%SZ')} | [`#{commit.sha.slice 0..8}`](https://github.com/#{full_name}/commit/#{commit.sha}) | #{commit.message.gsub('|', '!').gsub(/[\n]+/,' ') || '--'} | #{commit.author.name} \n"
+      end
+      markdown
+    end
+
+    def self.create_gitignore(repo_path, ignore_types)
+      #store current working directory, and change to the cookbook
+      wd = Dir.getwd
+      Dir.chdir(repo_path)
+
+      begin
+        #download gitignore templates and write them
+        templates = Mkgitignore::searchForTemplatesWithNames(ignore_types)
+        gitignore = String.new
+        templates.each { |t| gitignore += Mkgitignore::downloadFromURL(t["url"], t["name"]) }
+        Mkgitignore::writeGitignore(gitignore, true)
+      ensure
+        #restore previous working dir
+        Dir.chdir(wd)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'capsulecd'
+module CapsuleCD
+  class ValidationUtils
+    def self.validate_repo_payload(repo_payload)
+      unless repo_payload['sha']
+        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "sha1" key'
+      end
+      unless repo_payload['ref']
+        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "ref" key'
+      end
+      unless repo_payload['repo']
+        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "repo" key'
+      end
+      unless repo_payload['repo']['clone_url']
+        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "clone_url" key'
+      end
+      unless repo_payload['repo']['name']
+        fail CapsuleCD::Error::SourcePayloadFormatError, 'Incorrectly formatted payload, missing "name" key'
+      end
+    end
+  end
+end

data/lib/capsulecd/base/configuration.rb

@@ -0,0 +1,151 @@
+require 'yaml'
+require 'erb'
+require 'base64'
+module CapsuleCD
+  class Configuration
+    # Order of inheritance: file <- environment <- cli options
+    # <- means 'overridden by', eg. file overridden by environment vars
+    # @param [String] config_path The path to the configuration file
+    def initialize(options={})
+      @options = options
+      @config_path = @options[:config_file]
+
+      populate_defaults
+      populate_system_config_file
+      populate_runner_overrides
+      populate_env_overrides
+      populate_cli_overrides
+      standardize_settings
+    end
+
+    # Cli config, shouldnt be set via environmental variables (will be overridden)
+    attr_reader :package_type
+    attr_reader :source
+    attr_reader :runner
+    attr_reader :dry_run
+
+    # General config
+    attr_reader :config_path
+    attr_reader :configuration
+
+    # Source config (any credentials added here should also be added to the spec_helper.rb VCR config)
+    attr_reader :source_git_parent_path
+    attr_reader :source_github_api_endpoint
+    attr_reader :source_github_web_endpoint
+    attr_reader :source_github_access_token
+
+    # Runner config
+    attr_reader :runner_pull_request
+    attr_reader :runner_sha
+    attr_reader :runner_branch
+    attr_reader :runner_clone_url
+    attr_reader :runner_repo_full_name
+    attr_reader :runner_repo_name
+
+    # Package auth/config (any credentials added here should also be added to the spec_helper.rb VCR config)
+    attr_reader :chef_supermarket_username
+    attr_reader :npm_auth_token
+    attr_reader :pypi_username
+    attr_reader :pypi_password
+    attr_reader :chef_supermarket_type
+    attr_reader :rubygems_api_key
+    def chef_supermarket_key
+      @chef_supermarket_key.to_s.empty? ? nil : Base64.strict_decode64(@chef_supermarket_key)
+    end
+
+    # Engine config
+    attr_reader :engine_disable_test
+    attr_reader :engine_disable_minification
+    attr_reader :engine_disable_lint
+    attr_reader :engine_disable_coverage
+    attr_reader :engine_cmd_test
+    attr_reader :engine_cmd_minification
+    attr_reader :engine_cmd_lint
+    attr_reader :engine_cmd_coverage
+    attr_reader :engine_version_bump_type
+
+    def populate_repo_config_file(repo_local_path)
+      repo_config_file_path = repo_local_path + '/capsule.yml'
+      load_config_file(repo_config_file_path)
+      populate_runner_overrides
+      populate_env_overrides
+      populate_cli_overrides
+      standardize_settings
+    end
+
+    # The raw parsed configuration file, system level, a repo level configuration file will override settings in this file.
+    def populate_system_config_file
+      load_config_file(@config_path)
+    end
+
+    private
+    # These are defaults for engine settings. They can be overridden via configuration files or env variables
+    def populate_defaults
+      @engine_version_bump_type = :patch # can be :major, :minor, :patch
+      @chef_supermarket_type = 'Other'
+    end
+
+    def load_config_file(path)
+      if !path || !File.exist?(path)
+        puts 'The configuration file could not be found. Using defaults'
+        return
+      end
+      file = File.open(path).read
+      unserialize(file)
+    end
+
+
+    def populate_runner_overrides
+      @runner = :circleci unless ENV['CIRCLECI'].to_s.empty?
+      populate_runner
+    end
+
+    def populate_runner
+      if (@runner == :circleci)
+        # parse the PR# from the environment variable, eg. https://github.com/AnalogJ/cookbook_analogj_test/pull/9
+        @runner_pull_request ||= File.basename(URI.parse(ENV['CI_PULL_REQUEST']).path).to_i # => baz
+        @runner_sha ||= ENV['CIRCLE_SHA1']
+        @runner_branch ||= ENV['CIRCLE_BRANCH']
+        @runner_clone_url ||= 'https://github.com/' + ENV['CIRCLE_PROJECT_USERNAME'] + '/' + ENV['CIRCLE_PROJECT_REPONAME'] + '.git'
+        @runner_repo_name ||= ENV['CIRCLE_PROJECT_REPONAME']
+        @runner_repo_full_name ||= ENV['CIRCLE_PROJECT_USERNAME'] + '/' + ENV['CIRCLE_PROJECT_REPONAME']
+      end
+    end
+
+    def populate_env_overrides
+      # override config file with env variables.
+      ENV.each do|key, value|
+        config_key = key.dup
+        if config_key.start_with?('CAPSULE_') && !value.to_s.empty?
+          config_key.slice!('CAPSULE_')
+          config_key.downcase!
+
+          # override instance variable
+          instance_variable_set('@' + config_key, value)
+        end
+      end
+    end
+
+    def populate_cli_overrides
+      # then override with cli options
+      @options.each do|key, value|
+        instance_variable_set('@' + key.to_s, value)
+      end
+    end
+
+    # certain settings are symbols, so make sure that any settings that are specified via a string are converted to the correct type.
+    def standardize_settings
+      # set types if missing
+      @engine_version_bump_type = @engine_version_bump_type.to_sym if @engine_version_bump_type.is_a? String
+    end
+
+    def unserialize(string)
+      obj = YAML.load(string)
+      obj.keys.each do |key|
+        next if %w(source_configure source_process_pull_request_payload source_process_push_payload runner_retrieve_payload build_step test_step package_step source_release release_step).include?(key)
+        instance_variable_set('@' + key, obj[key])
+      end
+      obj
+    end
+  end
+end

data/lib/capsulecd/base/engine.rb

@@ -0,0 +1,163 @@
+require_relative 'runner/default'
+require_relative 'configuration'
+require 'pp'
+module CapsuleCD
+  class Engine
+    attr_reader :config
+
+    def initialize(options)
+      @config = CapsuleCD::Configuration.new(options)
+      if @config.source == :github
+        require_relative 'source/github'
+        self.class.send(:include, CapsuleCD::Source::Github)
+      else
+        fail CapsuleCD::Error::SourceUnspecifiedError, 'No source defined.'
+      end
+
+      if @config.runner == :circleci
+        require_relative 'runner/circleci'
+        self.class.send(:include, CapsuleCD::Runner::Circleci)
+      else
+        self.class.send(:include, CapsuleCD::Runner::Default)
+      end
+    end
+
+    def start
+      # start the source, and whatever work needs to be done there.
+      # MUST set @source_git_parent_path
+      # MUST set @source_client
+      pre_source_configure
+      source_configure
+      post_source_configure
+
+      # runner must determine if this is a pull request or a push.
+      # if it's a pull request the runner must retrieve the pull request payload and return it
+      # if its a push, the runner must retrieve the push payload and return it
+      # the variable @runner_is_pullrequest will be true if a pull request was created.
+      # MUST set runner_is_pullrequest
+      # REQUIRES source_client
+      pre_runner_retrieve_payload
+      payload = runner_retrieve_payload(@options)
+      post_runner_retrieve_payload
+
+      if @runner_is_pullrequest
+        # all capsule CD processing will be kicked off via a payload. In this case the payload is the pull request data.
+        # should check if the pull request opener even has permissions to create a release.
+        # all sources should process the payload by downloading a git repository that contains the master branch merged with the test branch
+        # MUST set source_git_local_path
+        # MUST set source_git_local_branch
+        # MUST set source_git_base_info
+        # MUST set source_git_head_info
+        # REQUIRES source_client
+        pre_source_process_pull_request_payload
+        source_process_pull_request_payload(payload)
+        post_source_process_pull_request_payload
+      else
+        # start processing the payload, which should result in a local git repository that we
+        # can begin to test. Since this is a push, no packaging is required
+        # MUST set source_git_local_path
+        # MUST set source_git_local_branch
+        # MUST set source_git_head_info
+        # REQUIRES source_client
+        pre_source_process_push_payload
+        source_process_push_payload(payload)
+        post_source_process_push_payload
+      end
+
+      # now that the payload has been processed we can begin by building the code.
+      # this may be creating missing files/default structure, compilation, version bumping, etc.
+
+      source_notify('build') do
+        pre_build_step
+        build_step
+        post_build_step
+      end
+
+      # this step should download dependencies, run the package test runner(s) (eg. npm test, rake test, kitchen test)
+      # REQUIRES @config.engine_cmd_test
+      # REQUIRES @config.engine_disable_test
+      source_notify('test') do
+        pre_test_step
+        test_step
+        post_test_step
+      end
+
+      # this step should commit any local changes and create a git tag. Nothing should be pushed to remote repository
+      source_notify('package') do
+        pre_package_step
+        package_step
+        post_package_step
+      end
+
+      if @runner_is_pullrequest
+        # this step should push the release to the package repository (ie. npm, chef supermarket, rubygems)
+        source_notify('release') do
+          pre_release_step
+          release_step
+          post_release_step
+        end
+
+        # this step should push the merged, tested and version updated code up to the source code repository
+        # this step should also do any source specific releases (github release, asset uploading, etc)
+        source_notify('source release') do
+          pre_source_release
+          source_release
+          post_source_release
+        end
+      end
+
+      # rescue => ex #TODO if you enable this rescue block, hooks stop working.
+      # TODO: it shouldnt be required anylonger because source_notify will handle rescueing the failures.
+      #   puts ex
+      #
+      #   self.run_hook :pre_source_process_failure, ex
+      #   source_process_failure(ex)
+      #   self.run_hook :post_source_process_failure, ex
+    end
+
+    # base methods
+    def pre_source_configure; puts 'pre_source_configure'; end
+    def post_source_configure; puts 'post_source_configure'; end
+    def pre_source_process_pull_request_payload; puts 'pre_source_process_pull_request_payload'; end
+    def post_source_process_pull_request_payload; puts 'post_source_process_pull_request_payload'; end
+    def pre_source_process_push_payload; puts 'pre_source_process_push_payload'; end
+    def post_source_process_push_payload; puts 'post_source_process_push_payload'; end
+    def pre_source_release; puts 'pre_source_release'; end
+    def post_source_release; puts 'post_source_release'; end
+
+    def pre_runner_retrieve_payload; puts 'pre_runner_retrieve_payload'; end
+    def post_runner_retrieve_payload; puts 'post_runner_retrieve_payload'; end
+
+    def pre_build_step; puts 'pre_build_step'; end
+    def build_step; puts 'build_step'; end
+    def post_build_step; puts 'post_build_step'; end
+    def pre_test_step; puts 'pre_test_step'; end
+    def test_step; puts 'test_step'; end
+    def post_test_step; puts 'post_test_step'; end
+    def pre_package_step; puts 'pre_package_step'; end
+    def package_step; puts 'package_step'; end
+    def post_package_step; puts 'post_package_step'; end
+    def pre_release_step; puts 'pre_release_step'; end
+    def release_step; puts 'release_step'; end
+    def post_release_step; puts 'post_release_step'; end
+
+    protected
+
+    # determine which segment of the semvar version to bump/increment. The default (as specified in CapsuleCD::Configuration is :patch)
+    def bump_version(current_version)
+      next_version = current_version
+
+      if @config.engine_version_bump_type == :major
+        next_version.major = next_version.major + 1
+        next_version.minor = 0
+        next_version.patch = 0
+      elsif @config.engine_version_bump_type == :minor
+        next_version.minor = next_version.minor + 1
+        next_version.patch = 0
+      else
+        next_version.patch = next_version.patch + 1
+      end
+      return next_version
+    end
+  end
+end

data/lib/capsulecd/base/runner/circleci.rb

@@ -0,0 +1,37 @@
+require 'uri'
+module CapsuleCD
+  module Runner
+    module Circleci
+      def runner_retrieve_payload(_options)
+        puts 'circleci runner_retrieve_payload'
+
+        # circleci only works with github, no need to parse @options[:source]
+        # here are the environmental variables we need to handle:
+        # https://circleci.com/docs/environment-variables
+
+        if @config.runner_pull_request.to_s.empty?
+          puts 'This is not a pull request. No automatic continuous deployment processing required. Continuous Integration testing will continue.'
+          @runner_is_pullrequest = false
+          # make this as similar to the pull request payload as possible.
+          payload = {
+            'head' => {
+              'sha' => @config.runner_sha,
+              'ref' => @config.runner_branch,
+              'repo' => {
+                'clone_url' => @config.runner_clone_url,
+                'name' => @config.runner_repo_name,
+                'full_name' => @config.runner_repo_full_name
+              }
+            }
+          }
+
+          payload
+        else
+          @runner_is_pullrequest = true
+          pull_request_number =  @config.runner_pull_request.to_i
+          @source_client.pull_request(@config.runner_repo_full_name, pull_request_number)
+        end
+      end
+    end
+  end
+end

data/lib/capsulecd/base/runner/default.rb

@@ -0,0 +1,38 @@
+module CapsuleCD
+  module Runner
+    module Default
+      # TODO: this needs to be fleshed out/working. ie. Jenkins, Bamboo, GoCD, Drone, other self hosted services
+      def runner_retrieve_payload(_opts)
+        puts 'default runner_retrieve_payload'
+
+        # capsulecd only works with github, no need to parse @options[:source]
+        # since we're the default handler, we have to verify that the required configuration options are available
+
+
+
+        if @config.runner_pull_request.to_s.empty?
+          puts 'This is not a pull request. No automatic continuous deployment processing required. Continuous Integration testing will continue.'
+          @runner_is_pullrequest = false
+          # make this as similar to the pull request payload as possible.
+          payload = {
+              'head' => {
+                  'sha' => @config.runner_sha,
+                  'ref' => @config.runner_branch,
+                  'repo' => {
+                      'clone_url' => @config.runner_clone_url,
+                      'name' => @config.runner_repo_name,
+                      'full_name' => @config.runner_repo_full_name
+                  }
+              }
+          }
+
+          payload
+        else
+          @runner_is_pullrequest = true
+          pull_request_number =  @config.runner_pull_request.to_i
+          @source_client.pull_request(@config.runner_repo_full_name, pull_request_number)
+        end
+      end
+    end
+  end
+end