bcnd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 703e6c4a7228ffff25568739b2f1e18d57ffb086
+  data.tar.gz: 8977b5932bd0bc0ed00cb7063af63f46e30f44c9
+SHA512:
+  metadata.gz: 4fe701eeb0cd98f0985bd6dd9adc8fc725f9a92c8263524ce99c16815afe37e65b430080d4eff619b237b247a644ed3cfd70b6a3156baf71f1082d8a41feba7a
+  data.tar.gz: 4f74ad4442c5e3d867f34bca44bb6d77c898797c9dcb921fc789d1689b8fea463c785fa0c3d61a8879aa8171f858e0b71a22cf098fd59bd5c41bbc668d6e8419

data/README.md

@@ -0,0 +1,131 @@
+# Barcelona Deployer
+
+Degica's opinionated deploy pipeline tool
+
+## Installation
+
+```
+gem 'bcnd'
+```
+
+## Prerequisites
+
+bcnd is very opinionated about your development configurations.
+So there are lots of requirements you need to prepare beforehand.
+
+### Quay.io
+
+You need quay.io as your docker image registry
+
+### Barcelona
+
+where your applications will be deployed
+
+### GitHub
+
+bcnd only supports GitHub as a source code repository.
+Your GitHub repository must have 2 branches: mainline and stable
+bcnd doesn't offer a customizability for the branch names.
+
+#### mainline branch
+
+a mainline branch includes all reviewed commits. By default mainline branch is `master`.
+bcnd automatically deploys mainline branch to your mainline environment.
+
+#### stable branch
+
+a stable branch includes stable commits. By default stable branch is `production`.
+bcnd automatically deploys stable branch to your stable environment.
+
+### Webhooks
+
+- webhook for quay.io automated builds
+- webhook for your CI service
+
+## Usage
+
+Setup your CI configuration as follows:
+
+- Install barcelona client
+- Install bcnd
+- Execute `bcnd` in your CI's "after success" script
+
+Here's the example for travis CI
+
+```yml
+before_script:
+- npm install -g barcelona
+- gem install bcnd
+script:
+- bundle excec rspec
+- bcnd
+```
+
+### Environment variables
+
+Set the following environment variables to your CI build environment:
+
+- `QUAY_TOKEN`
+  - **Required**
+  - a quay.io oauth token. you can create a new oauth token at quay.io organization page -> OAuth Applications -> Create New Application -> Generate Token
+- `GITHUB_TOKEN`
+  - **Conditional** If you have stable branch this is required.
+  - a github oauth token which has a permission to read your application's repository
+- `BARCELONA_ENDPOINT`
+  - **Required**
+  - A URL of Barcelona service e.g. `https://barcelona.your-domain.com`
+- `MAINLINE_HERITAGE_TOKEN`
+  - **Required**
+  - Barcelona's heritage token for the mainline application
+- `STABLE_HERITAGE_TOKEN`
+  - **Conditional** If you have stable branch this is required.
+  - Barcelona's heritage token for the stable application
+- `QUAY_REPOSITORY`
+  - **Optional**
+  - A name of your quay repository. It should be `[organization]/[repo name]`. If you don't set this variable bcnd uses github repository name as a quay repository name.
+
+### Configurations
+
+You can customize mainline branch name, mainline environment(where mainline code is deployed), stable branch name, and stable environment with `barcelona.yml`
+
+```yaml
+# /barcelona.yml example
+---
+environments:
+  # your barcelona configurations. bcnd doesn't touch this.
+bcnd:
+  mainline_branch: dev # default: master
+  mainline_environment: dev # default: staging
+  stable_branch: master # default: production
+  stable_environment: master # default: production
+```
+
+## How It Works
+
+### Deploying to a staging environment
+
+When a commit is pushed into a mainline branch, bcnd deploys your application to barcelona's mainline environment.
+Here's what bcnd actually does:
+
+- Wait for quay.io automated build to be finished
+- Attach a docker image tag to the `latest` docker image.
+  - The tag is the latest mainline branch's commit hash
+- Call Barcelona deploy API with the tag name
+  - `bcn deploy -e [mainline env] --tag [git_commit_hash]`
+
+### Deploying to a production environment
+
+When a commit is pushed into a stable branch, bcnd deploys your application to barcelona's stable environment
+Here's what bcnd actually does:
+
+- Compare `master` and `production` branch
+  - If there is a difference between the branches, bcnd raises an error
+- Get master branch's latest commit hash
+- Find a docker image from quay.io with the tag of the master commit hash
+- Call Barcelona deploy API with the tag name
+  - `bcn deploy -e [stable env] --tag [git_commit_hash]`
+ 
+
+## LICENSE
+
+MIT

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/bcnd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bcnd'
+Bcnd::Runner.new.deploy

data/lib/bcnd.rb

@@ -0,0 +1,6 @@
+require 'bcnd/quay_io'
+require 'bcnd/ci'
+require 'bcnd/runner'
+
+module Bcnd
+end

data/lib/bcnd/ci.rb

@@ -0,0 +1,97 @@
+require 'yaml'
+module Bcnd
+  class CI
+    DEFAULT_CONFIG = {
+      "mainline_branch" => "master",
+      "mainline_environment" => "staging",
+      "stable_branch" => "production",
+      "stable_environment" => "production"
+    }
+
+    attr_accessor :repository,
+      :commit,
+      :branch,
+      :quay_repository,
+      :quay_token,
+      :github_token,
+      :mainline_heritage_token,
+      :stable_heritage_token,
+      :stage_config
+
+    def initialize
+      load_ci_environment
+      load_stage_config
+      self.quay_token = ENV['QUAY_TOKEN']
+      self.github_token = ENV['GITHUB_TOKEN']
+      self.mainline_heritage_token = ENV['MAINLINE_HERITAGE_TOKEN']
+      self.stable_heritage_token = ENV['STABLE_HERITAGE_TOKEN']
+      self.quay_repository = ENV['QUAY_REPOSITORY'] || self.repository
+    end
+
+    def pull_request?
+      case ci_service
+      when :travis
+        ENV['TRAVIS_PULL_REQUEST'] != 'false'
+      end
+    end
+
+    def ci_service
+      if ENV['TRAVIS']
+        :travis
+      else
+        :unknown
+      end
+    end
+
+    def mainline_branch
+      stage_config[:mainline][:branch]
+    end
+
+    def stable_branch
+      stage_config[:stable][:branch]
+    end
+
+    def deploy_stage
+      {
+        mainline_branch => :mainline,
+        stable_branch => :stable
+      }[self.branch]
+    end
+
+    def deploy_environment
+      stage_config[deploy_stage][:environment]
+    end
+
+    private
+
+    def load_ci_environment
+      case ci_service
+      when :travis
+        self.repository = ENV['TRAVIS_REPO_SLUG']
+        self.commit     = ENV['TRAVIS_COMMIT']
+        self.branch     = ENV['TRAVIS_BRANCH']
+      end
+    end
+
+    def load_stage_config
+      config = DEFAULT_CONFIG.merge(load_config_file)
+      self.stage_config = {
+        mainline: {
+          branch: config["mainline_branch"],
+          environment: config["mainline_environment"]
+        },
+        stable: {
+          branch: config["stable_branch"],
+          environment: config["stable_environment"]
+        }
+      }
+    end
+
+    def load_config_file
+      file = File.read('barcelona.yml')
+      YAML.load(file)["bcnd"] || {}
+    rescue Errno::ENOENT => e
+      {}
+    end
+  end
+end

data/lib/bcnd/quay_io.rb

@@ -0,0 +1,111 @@
+require 'rest-client'
+require 'json'
+
+module Bcnd
+  class QuayIo
+    class Connection
+      BASE_URL = 'https://quay.io/api/v1'
+      attr_accessor :token
+
+      def initialize(token)
+        @token = token
+      end
+
+      def request(method: :get, path:, body: {}, query_params: {})
+        response = RestClient::Request.execute(
+          method: method,
+          url: "#{BASE_URL}#{path}",
+          payload: body.empty? ? nil : body.to_json,
+          headers: {
+            "Authorization" => "Bearer #{token}",
+            "Content-Type" => "application/json",
+            params: query_params
+          }
+        )
+        JSON.load(response.to_s)
+      end
+
+      def get(path:, body: {}, query_params: {})
+        request(method: :get, path: path, body: body, query_params: query_params)
+      end
+
+      def put(path:, body: {}, query_params: {})
+        request(method: :put, path: path, body: body, query_params: query_params)
+      end
+
+      def post(path:, body: {}, query_params: {})
+        request(method: :post, path: path, body: body, query_params: query_params)
+      end
+
+      def delete(path:, body: {}, query_params: {})
+        request(method: :delete, path: path, body: body, query_params: query_params)
+      end
+    end
+
+    attr_accessor :conn
+
+    def initialize(token)
+      @conn = Connection.new(token)
+    end
+
+    def automated_builds_for(repo:, git_sha:)
+      builds = conn.get(path: "/repository/#{repo}/build/")["builds"]
+      builds.select do |b|
+        b["trigger_metadata"]["commit"] == git_sha.downcase
+      end
+    end
+
+    def automated_build_status(repo:, git_sha:)
+      builds = automated_builds_for(repo: repo, git_sha: git_sha)
+      phases = builds.map { |b| b["phase"] }
+
+      if !phases.include?("complete") && phases.include?("error")
+        return :failed
+      end
+
+      if phases.include?("complete")
+        return :finished
+      else
+        return :building
+      end
+    end
+
+    def wait_for_automated_build(repo:, git_sha:, timeout: 3600)
+      loop do
+        status = automated_build_status(repo: repo, git_sha: git_sha)
+        case status
+        when :failed
+          raise "The docker build failed"
+        when :finished
+          puts ""
+          return
+        when :building
+          print '.'
+          sleep 5
+        end
+      end
+    end
+
+    def docker_image_id_for_tag(repo:, tag:)
+      resp = conn.get(
+        path: "/repository/#{repo}/tag/",
+        query_params: {
+          "specificTag" => tag
+        }
+      )
+      tags = resp["tags"]
+      tags.find { |tag|
+        tag["end_ts"].nil?
+      }["docker_image_id"]
+    end
+
+    def put_tag(repo:, image_id:, tag:)
+      conn.put(
+        path: "/repository/#{repo}/tag/#{tag}",
+        body: {
+          image: image_id
+        }
+      )
+    end
+  end
+end

data/lib/bcnd/runner.rb

@@ -0,0 +1,58 @@
+require 'octokit'
+
+module Bcnd
+  class Runner
+    attr_accessor :env
+    def initialize
+      self.env = Bcnd::CI.new
+    end
+
+    def deploy
+      return if env.pull_request?
+
+      case env.deploy_stage
+      when :mainline
+        deploy_mainline
+      when :stable
+        deploy_stable
+      else
+        puts "Can't recognize the current stage"
+      end
+    end
+
+    private
+
+    def deploy_mainline
+      quay.wait_for_automated_build(repo: env.quay_repository, git_sha: env.commit)
+      image_id = quay.docker_image_id_for_tag(repo: env.quay_repository, tag: 'latest') # FIXME
+      quay.put_tag(repo: env.quay_repository, image_id: image_id, tag: env.commit)
+      puts "attached tag #{env.commit} to image #{image_id}"
+      bcn_deploy(env.commit, env.mainline_heritage_token)
+    end
+
+    def deploy_stable
+      comp = github.compare(env.repository, env.mainline_branch, env.stable_branch)
+      tag = comp.merge_base_commit.sha
+      image_id = quay.docker_image_id_for_tag(repo: env.quay_repository, tag: tag)
+      raise "There is no docker image to be deployed" unless image_id
+
+      bcn_deploy(tag, env.stable_heritage_token)
+    end
+
+    def quay
+      @quay ||= Bcnd::QuayIo.new(env.quay_token)
+    end
+
+    def github
+      @github ||= Octokit::Client.new(access_token: env.github_token)
+    end
+
+    def bcn_deploy(tag, token)
+      system "bcn deploy -e #{env.deploy_environment} --tag #{tag} --heritage-token #{token} 1> /dev/null"
+      puts "deploy triggered with tag #{tag} to #{env.deploy_environment} environment"
+      if $?.exitstatus != 0
+        raise "bcn returned non-zero exitcode #{$?.exitstatus}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: bcnd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazunori Kajihiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: Degica's opinionated deployment tool.
+email:
+- kkajihiro@degica.com
+executables:
+- bcnd
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/bcnd
+- lib/bcnd.rb
+- lib/bcnd/ci.rb
+- lib/bcnd/quay_io.rb
+- lib/bcnd/runner.rb
+homepage: https://github.com/degica/bcnd
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Degica's opinionated deployment tool
+test_files: []