ding 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 152cdf9f3aabb65b05c06221910c6260db5f1034
+  data.tar.gz: d687eb4faa485a64a53521a68613f32f4c29bee5
+SHA512:
+  metadata.gz: 37a8445e13983b973f6017ef464af96e8363f854aa3bec7fdf066a819db1ff867f32a2d1a301b4645d117a4311eec3ddc7ef15b3943d1f23d0113dfb6b9b32cd
+  data.tar.gz: d8e834a7f6aed324918085c708e879d3fbd570c611d47bc96cfc75ea99f9a49a4e89e2514045b6b3ebaece22330982067368dfc0940dfdcf88459578acd53cf7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+# Ding
+
+![Ding](./ding.png)
+
+Simple command line tool for deploying a specific feature branch of a
+repo to a testing branch for driving CI deployment for QA.
+
+## Installation
+
+The usual method works:
+
+    gem install ding
+
+## Configuration
+
+By default, `ding` will create a branch called `testing` from the
+selected feature branch. It also assumes that the master branch is
+called `master`. Branches named `master` and `develop` cannot be deleted
+by calling `Ding::Git.delete_branch` in code.
+
+These defaults can be over-ridden by providing ENV vars to the shell:
+
+    DING_MASTER_BRANCH       - main branch to switch to for synchronising
+    DING_TESTING_BRANCH      - branch to over-ride from feature branch
+    DING_SACROSANCT_BRANCHES - space separated list of protected branches
+
+## Using Ding
+
+There are several commands available with global options for verbosity and forcing actions:
+
+    Commands:
+      ding help [COMMAND]  # Describe available commands or one specific command
+      ding key-gen         # Create a new private/public key pair and associated ssh config
+      ding key-show        # Copy a public ssh key signature to the system clipboard (use -v to also display the signature)
+      ding test            # Push a feature branch to the testing branch (this is the default action)
+
+    Options:
+      -f, [--force], [--no-force]      # use the force on commands that allow it e.g. git push
+      -v, [--verbose], [--no-verbose]  # show verbose output such as full callstack on errors
+
+### ding test
+
+This is the default action so running `ding` is the equivalent of `ding test`.
+
+There is an option to specify the feature branch pattern to display for
+selection of the code to be pushed to `testing`.
+
+    $ ding help test
+
+    Usage:
+      ding test
+
+    Options:
+      -p, [--pattern=PATTERN]          # specify a pattern for listing branches
+                                       # Default: origin/XAP*
+
+    Push a feature branch to the testing branch
+
+### ding key-gen
+
+This will generate a new ssh key pair and configure them into the ssh config
+for the relevant host. This allows `ding test` to push code to bitbucket.org,
+for example, so that you aren't prompted for a userid and password each
+time.
+
+On completion, the public key is copied to the system clipboard so that
+it can be pasted into the users account on bitbucket.org.
+
+    Usage:
+      ding key-gen
+
+    Options:
+      -h, [--host=HOST]                # specify repository host for ssh config
+                                       # Default: bitbucket.org
+      -n, [--name=NAME]                # name for key, defaults to host name
+      -p, [--passphrase=PASSPHRASE]    # optional passphrase for key
+      -t, [--type=TYPE]                # type of key to create per -t option on ssh-keygen
+                                       # Default: rsa
+
+    Create a new private/public key pair and associated ssh config
+
+### ding key-show
+
+If the public key is needed again for pasting into the bitbucket.org config it can be
+captured on the clipboard by running this command and selecting the appropriate key from
+the list presented.
+

data/Rakefile

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

data/bin/ding

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "ding"
+
+Ding::Cli.start

data/ding.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ding/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ding'
+  spec.version       = Ding::VERSION
+  spec.authors       = ['Warren Bain']
+  spec.email         = ['warren@thoughtcroft.com']
+
+  spec.summary       = %q{Push specific feature branch code to a testing branch}
+  spec.description   = %q{Push specific feature branch code to a testing branch}
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency     'thor', '~> 0.19'
+  spec.add_runtime_dependency     'git-up'
+end

data/lib/ding.rb

@@ -0,0 +1,12 @@
+require 'ding/version'
+require 'ding/cli'
+require 'ding/models/git'
+require 'ding/models/ssh'
+
+module Ding
+  MASTER_BRANCH   = ENV['DING_MASTER_BRANCH'] || 'master'
+  TESTING_BRANCH  = ENV['DING_TESTING_BRANCH'] || 'testing'
+  SACROSANCT_BRANCHES = (ENV['DING_SACROSANCT_BRANCHES'] || 'master develop').split
+
+  # because we lurve the command line... ding!
+end

data/lib/ding/cli.rb

@@ -0,0 +1,144 @@
+require 'shellwords'
+require 'thor'
+
+module Ding
+  class Cli < Thor
+    class_option :force,   type: 'boolean', aliases: '-f', default: false, desc: 'use the force on commands that allow it e.g. git push'
+    class_option :verbose, type: 'boolean', aliases: '-v', default: false, desc: 'show verbose output such as full callstack on errors'
+
+    default_task :test
+
+    desc "test", "Push a feature branch to the testing branch (this is the default action)"
+    option :pattern, type: 'string',  aliases: '-p', default: 'origin/XAP*', desc: 'specify a pattern for listing branches'
+    def test
+      master_branch, testing_branch = Ding::MASTER_BRANCH.dup, Ding::TESTING_BRANCH.dup
+      say "\nDing ding ding: let's push a feature branch to #{testing_branch}...\n\n", :green
+
+      repo = Ding::Git.new(options).tap do |r|
+        say "> Synchronising with the remote...", :green
+        r.checkout master_branch
+        r.update
+      end
+
+      branches = repo.branches(options[:pattern])
+      if branches.empty?
+        say "\n --> No feature branches available to test, I'm out of here!\n\n", :red
+        exit 1
+      end
+
+      feature_branch = ask_which_item(branches, 'Which feature branch should I use?')
+
+      repo.tap do |r|
+        say "\n> Deleting #{testing_branch}...", :green
+        r.delete_branch(testing_branch)
+        say "> Checking out #{feature_branch}...", :green
+        r.checkout(feature_branch)
+        say "> Creating #{testing_branch}...", :green
+        r.create_branch(testing_branch)
+        say "> Pushing #{testing_branch} to the remote...", :green
+        r.push(testing_branch)
+      end
+
+    rescue => e
+      show_error e
+    else
+      say "\n  --> I'm finished: ding ding ding!\n\n", :green
+    end
+
+    desc "key-gen", "Create a new private/public key pair and associated ssh config"
+    option :host,       type: 'string', aliases: '-h', default: 'bitbucket.org', desc: 'specify repository host for ssh config'
+    option :name,       type: 'string', aliases: '-n', default: nil,             desc: 'name for key, defaults to host name'
+    option :passphrase, type: 'string', aliases: '-p', default: '',              desc: 'optional passphrase for key'
+    option :type,       type: 'string', aliases: '-t', default: 'rsa',           desc: 'type of key to create per -t option on ssh-keygen'
+    def key_gen
+      key_name = options[:name] || "#{options[:host]}_#{options[:type]}"
+      say "\nDing ding ding: let's create and configure a new ssh key #{key_name}...\n\n", :green
+
+      Ding::Ssh.new(options).tap do |s|
+        if s.ssh_key_exists?(key_name)
+          if yes?("Do you want me to replace the existing key?", :yellow)
+            say "> Removing existing key #{key_name}...", :cyan
+            s.delete_ssh_key key_name
+            say "> Creating the replacement ssh key pair...", :cyan
+            s.create_ssh_key key_name, ENV['USER']
+          else
+            say "> Using existing key #{key_name}...", :cyan
+          end
+        else
+          say "> Creating the new ssh key pair...", :green
+          s.create_ssh_key key_name, ENV['USER']
+        end
+        say "> Adding the private key to the ssh config...", :green
+        s.update_config options[:host], key_name
+        say "> Copying the public key to the clipboard...", :green
+        copy_file_to_clipboard s.ssh_public_key_file(key_name)
+      end
+
+    rescue => e
+      show_error e
+    else
+      say "\n  --> I'm finished: ding ding ding!\n\n", :green
+    end
+
+    desc "key-show", "Copy a public ssh key signature to the system clipboard (use -v to also display the signature)"
+    def key_show
+      say "\nDing ding ding: let's copy a public key to the clipboard...\n\n", :green
+
+      Ding::Ssh.new(options).tap do |s|
+        key_name = ask_which_item(s.list_ssh_keys, 'Which key do you want to copy?')
+        say "\n> Copying the public key to the clipboard...", :green
+        copy_file_to_clipboard s.ssh_public_key_file(key_name)
+      end
+
+    rescue => e
+      show_error e
+    else
+      say "\n  --> You can now Command-V to paste that key: ding ding ding!\n\n", :green
+    end
+
+    private
+
+    def show_error(e)
+      say "\n  --> Error: #{e.message}\n\n", :red
+      raise if options[:verbose]
+      exit 1
+    end
+
+    def ask_which_item(items, prompt)
+      return items.first if items.size == 1
+      str_format = "\n %#{items.count.to_s.size}s: %s"
+      question   = set_color prompt, :yellow
+      answers    = {}
+
+      items.each_with_index do |item, index|
+        i = (index + 1).to_s
+        answers[i] = item
+        question << format(str_format, i, item)
+      end
+
+      say question
+      reply = ask("> ").to_s
+      if answers[reply]
+        answers[reply]
+      else
+        say "\n  --> That's not a valid selection, I'm out of here!\n\n", :red
+        exit 1
+      end
+    end
+
+    def copy_file_to_clipboard(file)
+      cmd = "cat #{file} | "
+      if options[:verbose]
+        cmd << 'tee >(pbcopy)'
+      else
+        cmd << ' pbcopy'
+      end
+      bash cmd
+    end
+
+    def bash(cmd)
+      escaped_cmd = Shellwords.escape cmd
+      system "bash -c #{escaped_cmd}"
+    end
+  end
+end

data/lib/ding/models/git.rb

@@ -0,0 +1,99 @@
+module Ding
+  class Git
+
+    def initialize(options={})
+      raise "#{repo} is NOT a git repository" unless git_repo?
+      @options = options
+    end
+
+    def branches(pattern)
+      %x(git branch --remote --list #{remote_version(pattern)}).split.map {|b| b.split('/').last}
+    end
+
+    def branch_exists?(branch)
+      ! %x(git branch --list #{branch}).empty?
+    end
+
+    def checkout(branch)
+      raise "Unable to checkout #{branch}" unless run_cmd "git checkout #{branch}"
+    end
+
+    def create_branch(branch)
+      raise "Unable to create #{branch}" unless run_cmd "git branch --track #{branch}"
+    end
+
+    def delete_branch(branch)
+      local_branch  = local_version(branch)
+      remote_branch = remote_version(branch)
+      raise "You are not allowed to delete #{local_branch}" if Ding::SACROSANCT_BRANCHES.include?(local_branch)
+      if branch_exists?(local_branch)
+        branch_cmd = "git branch #{options[:force] ? '-D' : '-d'} #{local_branch}"
+        raise "Unable to delete #{local_branch}" unless run_cmd branch_cmd
+      end
+      if branch_exists?(remote_branch)
+        branch_cmd = "git push #{remote_name} :#{local_branch} #{options[:force] ? '-f' : ''}"
+        raise "Unable to delete #{remote_branch}" unless run_cmd branch_cmd
+      end
+    end
+
+    def push(branch)
+      checkout branch
+      push_cmd = "git push #{remote_name} #{branch}"
+      push_cmd << " --force" if options[:force]
+      raise "Unable to push #{branch} branch!" unless run_cmd push_cmd
+    end
+
+    def update
+      raise "Error synchronising with the remote" unless run_cmd "git up"
+    end
+
+    private
+
+    def git_repo?
+      run_cmd "git status"
+    end
+
+    def repo
+      @repo || Dir.pwd
+    end
+
+    def remote_version(branch)
+      if is_remote?(branch)
+        branch
+      else
+        "#{remote_prefix}#{branch}"
+      end
+    end
+
+    def local_version(branch)
+      if is_remote?(branch)
+        branch.gsub(remote_name, '')
+      else
+        branch
+      end
+    end
+
+    def is_remote?(branch)
+      branch.start_with?(remote_prefix)
+    end
+
+    def remote_name
+      @remote_name || %x(git remote).chomp
+    end
+
+    def remote_prefix
+      "#{remote_name}/"
+    end
+
+    # NOTE: only for commands where we are interested in the effect
+    # as unless verbose is turned on, stdout and stderr are suppressed
+    def run_cmd(cmd)
+      cmd << ' &>/dev/null ' unless options[:verbose]
+      system cmd
+    end
+
+    def options
+      @options || {}
+    end
+  end
+end

data/lib/ding/models/ssh.rb

@@ -0,0 +1,75 @@
+require 'fileutils'
+
+module Ding
+  class Ssh
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def list_ssh_keys
+      Dir.glob(File.join(ssh_config_path, '*.pub')).map {|f| File.basename f, '.pub'}
+    end
+
+    def create_ssh_key(name, comment)
+      raise "ssh key #{name} already exists!" if ssh_key_exists? name
+      run_cmd "ssh-keygen -t #{options[:type]} -C #{comment} -P '#{options[:passphrase]}' -f #{File.join(ssh_config_path, name)}"
+    end
+
+    def delete_ssh_key(name)
+      File.delete ssh_public_key_file(name), ssh_private_key_file(name) if ssh_key_exists? name
+    end
+
+    def update_config(host, name)
+      if File.exists?(ssh_config_file)
+        config = File.open(ssh_config_file).read
+        raise "Host #{host} already configured in ssh config" if config.include?(host)
+        raise "Key #{name} already configured in ssh config" if config.include?(name)
+      else
+        FileUtils.mkdir_p ssh_config_path
+      end
+
+      File.open(ssh_config_file, 'a') do |f|
+        f.puts "Host #{host}"
+        f.puts "  IdentityFile #{ssh_private_key_file name}"
+      end
+    end
+
+    def ssh_key_exists?(name)
+      File.exists? ssh_private_key_file(name)
+    end
+
+    def ssh_private_key_file(name)
+      File.join ssh_config_path, name
+    end
+
+    def ssh_public_key_file(name)
+      "#{ssh_private_key_file name}.pub"
+    end
+
+    private
+
+    def ssh_config_exists?
+      File.exists? ssh_config_file
+    end
+
+    def ssh_config_path
+      @ssh_config_path || options[:ssh_config_path] || File.join(ENV['HOME'], '.ssh')
+    end
+
+    def ssh_config_file
+      @ssh_config_file || options[:ssh_config_file] || File.join(ssh_config_path, 'config')
+    end
+
+    # NOTE: only for commands where we are interested in the effect
+    # as unless verbose is turned on, stdout and stderr are suppressed
+    def run_cmd(cmd)
+      cmd << ' &>/dev/null ' unless options[:verbose]
+      system cmd
+    end
+
+    def options
+      @options || {}
+    end
+  end
+end

data/lib/ding/version.rb

@@ -0,0 +1,3 @@
+module Ding
+  VERSION = "0.4.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ding
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Warren Bain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: git-up
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Push specific feature branch code to a testing branch
+email:
+- warren@thoughtcroft.com
+executables:
+- ding
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/ding
+- ding.gemspec
+- ding.png
+- lib/ding.rb
+- lib/ding/cli.rb
+- lib/ding/models/git.rb
+- lib/ding/models/ssh.rb
+- lib/ding/version.rb
+homepage: 
+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
+signing_key: 
+specification_version: 4
+summary: Push specific feature branch code to a testing branch
+test_files: []