circlemator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c813019d9366200fd764c399fa6736d7e0d690e5
+  data.tar.gz: b2692e0b581a721cbe5854ba21cdb932552cbe32
+SHA512:
+  metadata.gz: c0a99bfe944824eb9e5dffb63ab81c8352e7cc63fb42dd1f8229b8535144c6f9998c13a2dabab405f269fab975778e1defefb71866c9383a5d504f6a265414c3
+  data.tar.gz: 70629c129f63f0646a1a9d185b2d8b6da8377584b93c5dacf70eacaa77f2ecf8a2c333d481c17674e14e73c561b47d56a81919e541470b49a4b931a5771eba2e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in circlemator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rainforest QA, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Circlemator
+
+Circlemator is a bucket of tricks for working with CircleCI and Github
+used internally at Rainforest QA.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'circlemator', require: false
+```
+
+Then run `bundle` and check in the resulting Gemfile.lock. That should
+be enough, really.
+
+## Usage
+
+Circlemator tasks are designed to be added to your circle.yml file
+like so:
+
+```yml
+- bundle exec circlemator <task> [options]
+```
+
+Different tasks require different options/placement in your
+circle.yml.
+
+## Tasks
+
+### Cancel old builds
+
+CircleCI starts a build every time you push to Github. That's usually
+a good thing, but if you have a big test suite it can be annoying when
+your build queue gets gummed up running builds on out-of-date
+commits. To clear things up, the `cancel-old` task cancels all builds
+that are not at the head of their branch. It should be in your
+circle.yml before your tests are run but after the dependencies have
+been fetched, for example:
+
+```yml
+test:
+  pre:
+    - bundle exec circlemator cancel-old
+```
+
+In order for this to work, you need the following environment variable
+to be set in CircleCI:
+
+- `CIRCLE_API_TOKEN`: Your CircleCI API token. (Can also be set with
+  the `-t` option.)
+
+### Self-merge release branch
+
+Preamble: at Rainforest, our process for getting code into production
+looks like this:
+
+1. Push to feature branch pull request.
+2. Run unit tests and get code review (repeat 1-2 as necessary).
+3. Merge feature branch to `develop`.
+4. Open release pull request from `develop` to `master`.
+5. Run unit tests + Rainforest against `develop`.
+6. Merge `develop` into `master` if everything's green.
+7. Deploy from `master`.
+
+Out of these, steps 1, 2, 3, and 4 require manual intervention, but
+everything else should be automatic! The `self-merge` task is designed
+to take care of step 6 (the rest is handled by CircleCI out of the
+box).
+
+To use `self-merge`, add something like the following to your
+circle.yml:
+
+```yml
+deployment:
+  staging:
+    branch: develop
+    commands:
+      <any commands you would normally run>
+      - bundle exec circlemator self-merge --base-branch=master --compare-branch=develop
+```
+
+Swap out `develop` and `master` as necessary to fit your workflow. Be
+warned, the `circlemator` command should probably be the last command
+in your deploy stage! (Otherwise you'll merge before your build is
+done.)
+
+`self-merge` will *only* run if there is an open pull request against
+the base branch. That means you have a way to prevent automatic
+shipping in exceptional circumstances: just don't open a release pull
+request.
+
+`self-merge` requires the following environment variable to be set:
+
+- `GITHUB_AUTH_TOKEN`: A Github API auth token for a user with commit
+  access to your repo. (Can also be set with the `-g` option.)
+
+Also, unfortunately branch protection cannot be enabled on your
+`master` branch. (Contributions welcome for anyone who can think of a
+workaround...)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rainforestapp/circlemator.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "circlemator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circlemator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circlemator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "circlemator"
+  spec.version       = Circlemator::VERSION
+  spec.authors       = ["Emanuel Evans"]
+  spec.email         = ["emanuel@rainforestqa.com"]
+
+  spec.summary       = %q{A bucket of tricks for CircleCI and Github.}
+  spec.description   = <<-EOF
+    A few utilities for CircleCI to improve your CI workflow.
+  EOF
+  spec.homepage      = "https://github.com/rainforestapp/circlemator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13.7"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/exe/circlemator

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require_relative '../lib/circlemator/build_canceler'
+require_relative '../lib/circlemator/self_merger'
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: circlemator (self-merge|cancel-old) [options]"
+
+  opts.on('-bBRANCH', '--base-branch=BRANCH', 'Base branch for merging') do |b|
+    options[:base_branch] = b
+  end
+
+  opts.on('-cBRANCH', '--compare-branch=BRANCH', 'Compare branch for merging') do |b|
+    options[:compare_branch] = b
+  end
+
+  opts.on('-gTOKEN', '--github-auth-token=TOKEN', 'Github auth token') do |t|
+    options[:github_auth_token] = t
+  end
+
+  opts.on('-tTOKEN', '--circle-api-token=TOKEN', 'CircleCI API token') do |t|
+    options[:circle_api_token] = t
+  end
+
+  opts.on('-h', '--help', 'Print this help message') do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+def require_env(var)
+  if !ENV[var] || ENV[var].empty?
+    puts "Environment variable '#{var}' is required"
+    exit 1
+  end
+
+  ENV[var]
+end
+
+def require_opt(opts, key)
+  if !opts[key]
+    puts "Option #{key.gsub(/_/, '-')} is required!"
+    exit 1
+  end
+end
+
+if !ENV['CIRCLECI']
+  puts 'Cirlemator should only be run from CircleCI'
+  exit 1
+end
+
+options[:user] = require_env 'CIRCLE_PROJECT_USERNAME'
+options[:repo] = require_env 'CIRCLE_PROJECT_REPONAME'
+
+case ARGV[0]
+when 'self-merge'
+  options[:sha] = require_env 'CIRCLE_SHA1'
+  options[:github_auth_token] ||= ENV['GITHUB_AUTH_TOKEN']
+  require_opt options, :github_auth_token
+  require_opt options, :base_branch
+  require_opt options, :compare_branch
+
+  Circlemator::SelfMerger.new(options).merge!
+when 'cancel-old'
+  options[:current_build] = require_env('CIRCLE_BUILD_NUM').to_i
+  options[:circle_api_token] ||= ENV['CIRCLE_API_TOKEN']
+  require_opt options, :circle_api_token
+
+  Circlemator::BuildCanceler.new(options).cancel_old_builds!
+else
+  puts parser
+end
+
+
+
+# Local Variables:
+# major-mode: ruby-mode
+# End:

data/lib/circlemator/build_canceler.rb

@@ -0,0 +1,54 @@
+require 'httparty'
+require 'json'
+
+module Circlemator
+  class BuildCanceler
+    def initialize(user: , repo: , current_build: , circle_api_token: )
+      @user = user
+      @repo = repo
+      @current_build = current_build
+      @circle_api_token = circle_api_token
+    end
+
+    def cancel_old_builds!
+      resp = HTTParty.get "https://circleci.com/api/v1/project/#{@user}/#{@repo}",
+                          circle_auth
+      check_response resp
+
+      builds = JSON.parse(resp.body)
+               .select   { |b| %w(running scheduled queued not_running).include? b.fetch('status') }
+               .group_by { |b| b.fetch('branch') }
+               .flat_map { |_, group| group.sort_by { |b| b.fetch('build_num') }[0...-1] }
+               .map      { |b| b.fetch('build_num') }
+
+      cancel_self = !!builds.delete(@current_build)
+
+      builds.each do |build_num|
+        resp = HTTParty.post "https://circleci.com/api/v1/project/#{@user}/#{@repo}/#{build_num}/cancel",
+                             circle_auth
+        check_response resp
+      end
+
+      if cancel_self
+        puts "Daisy, Daisy, give me your answer, do..."
+        HTTParty.post "https://circleci.com/api/v1/project/#{@user}/#{@repo}/#{@current_build}/cancel",
+                      circle_auth
+      end
+    end
+
+    private
+
+    def circle_auth
+      {
+        query: { 'circle-token': @circle_api_token },
+        headers: { 'Accept' => 'application/json' },
+      }
+    end
+
+    def check_response(resp)
+      if resp.code != 200
+        raise "CircleCI API call failed: #{JSON.parse(resp.body)}"
+      end
+    end
+  end
+end

data/lib/circlemator/self_merger.rb

@@ -0,0 +1,69 @@
+require 'httparty'
+require 'json'
+
+module Circlemator
+  class SelfMerger
+    def initialize(user: ,
+                   repo: ,
+                   sha: ,
+                   github_auth_token: ,
+                   base_branch: ,
+                   compare_branch: )
+      @user = user
+      @repo = repo
+      @sha = sha
+      @auth_token = github_auth_token
+      @base_branch = base_branch
+      @compare_branch = compare_branch
+    end
+
+    def merge!
+      pr_number, pr_url = find_pr
+      return if pr_number.nil? || pr_url.nil?
+
+      msg = "Auto-merge by Circlemator!"
+      response = HTTParty.put "#{pr_url}/merge",
+                              body: { commit_message: msg, sha: @sha }.to_json,
+                              basic_auth: github_auth
+      if response.code != 200
+        body = JSON.parse(response.body)
+        raise "Merge failed: #{body.fetch('message')}"
+      end
+    end
+
+    private
+
+    def find_pr
+      response = HTTParty.get "https://api.github.com/repos/#{github_repo}/pulls",
+                              query: { base: @base_branch },
+                              basic_auth: github_auth
+      if response.code != 200
+        raise "Bad response from Github: #{response.inspect}"
+      end
+
+      prs = JSON.parse(response.body)
+      pr = prs.find do |pr|
+        pr.fetch('head').fetch('ref') == @compare_branch &&
+          pr.fetch('head').fetch('sha') == @sha &&
+          pr.fetch('base').fetch('ref') == @base_branch
+      end
+
+      if pr.nil?
+        puts 'No release PR. Not merging.'
+        return
+      end
+
+      [pr.fetch('number'), pr.fetch('url')]
+    end
+
+
+    def github_repo
+      "#{@user}/#{@repo}"
+    end
+
+
+    def github_auth
+      { username: @auth_token, password: 'x-oauth-basic' }
+    end
+  end
+end

data/lib/circlemator/version.rb

@@ -0,0 +1,3 @@
+module Circlemator
+  VERSION = "0.1.1"
+end

data/lib/circlemator.rb

@@ -0,0 +1,4 @@
+require "circlemator/version"
+
+module Circlemator
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: circlemator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Emanuel Evans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: "    A few utilities for CircleCI to improve your CI workflow.\n"
+email:
+- emanuel@rainforestqa.com
+executables:
+- circlemator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circlemator.gemspec
+- exe/circlemator
+- lib/circlemator.rb
+- lib/circlemator/build_canceler.rb
+- lib/circlemator/self_merger.rb
+- lib/circlemator/version.rb
+homepage: https://github.com/rainforestapp/circlemator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A bucket of tricks for CircleCI and Github.
+test_files: []