gerrit-cli 0.0.1

data/README.md

@@ -0,0 +1,29 @@
+# Gerrit::Cli
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gerrit-cli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gerrit-cli
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rspec/core/version"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color --format documentation]
+end

data/bin/gerrit

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'logger'
+
+require 'gerrit/cli/dispatcher'
+
+
+logger = Logger.new(STDOUT)
+logger.formatter = proc {|severity, datetime, progname, msg| "#{msg}\n" }
+
+dispatcher = Gerrit::Cli::Dispatcher.new(logger)
+dispatcher.run_command(ARGV)

data/gerrit-cli.gemspec

@@ -0,0 +1,22 @@
+# Copyright (C) 2012 VMware, Inc. All rights reserved.
+require File.expand_path('../lib/gerrit/cli/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["VMware"]
+  gem.email         = ["support@vmware.com"]
+  gem.description   = "This provides a tool for easing common interactions"   \
+                      + " with Gerrit. It is mostly orthogonal to the `repo'" \
+                      + " tool and tries not to interfere with your workflow."
+  gem.summary       = "A simple cli for interacting with Gerrit."
+  gem.homepage      = "http://www.cloudfoundry.org"
+
+  gem.files         = Dir.glob("**/*")
+  gem.executables   = ["gerrit"]
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.name          = "gerrit-cli"
+  gem.require_paths = ["lib"]
+  gem.version       = Gerrit::Cli::VERSION
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec")
+end

data/lib/gerrit/cli/command/base.rb

@@ -0,0 +1,52 @@
+require 'logger'
+require 'optparse'
+
+module Gerrit
+  module Cli
+    module Command
+    end
+  end
+end
+
+class Gerrit::Cli::Command::Base
+
+  attr_reader :option_parser
+
+  def initialize(logger)
+    @logger = logger
+    @option_parser = OptionParser.new
+
+    setup_option_parser
+  end
+
+  def setup_option_parser
+    @option_parser.on('-h', '--help', 'Display usage') do
+      show_usage
+      exit 0
+    end
+
+    @option_parser.on('-v', '--verbose', 'Show debugging information') do
+      @logger.level = Logger::DEBUG
+    end
+  end
+
+  def run(argv)
+    raise NotImplementedError
+  end
+
+  def name
+    self.class.name.split('::').last.downcase
+  end
+
+  def summary
+    @option_parser.banner
+  end
+
+  def usage
+    "Usage: gerrit #{name} [options]\n\n" + @option_parser.help
+  end
+
+  def show_usage
+    @logger.info(usage())
+  end
+end

data/lib/gerrit/cli/command/clone.rb

@@ -0,0 +1,81 @@
+require 'uri'
+
+require 'gerrit/cli/command/base'
+require 'gerrit/cli/constants'
+require 'gerrit/cli/errors'
+
+# A thin wrapper around git-clone that attempts to install commit-msg hooks
+# that automatically insert the ChangeID lines used by Gerrit.
+class Gerrit::Cli::Command::Clone < Gerrit::Cli::Command::Base
+  def initialize(logger, runner)
+    super(logger)
+
+    @runner = runner
+  end
+
+  def setup_option_parser
+    super
+
+    @option_parser.banner =
+      "Clone a Gerrit hosted repo and install commit-msg hooks."
+  end
+
+  def usage
+    "Usage: gerrit clone [options] <repo> [<dir>]\n\n" + @option_parser.help
+  end
+
+  def run(argv)
+    args = @option_parser.parse(argv)
+
+    repo_uri, repo_dir = nil, nil
+    case args.length
+    when 2
+      repo_uri, repo_dir = args
+    when 1
+      repo_uri = args[0]
+    else
+      raise Gerrit::Cli::UsageError.new("Incorrect number of arguments")
+    end
+
+    @runner.system!("git clone #{repo_uri} #{repo_dir}")
+
+    # At this point the uri must be valid, otherwise the clone would have
+    # failed
+    parsed_repo_uri = URI.parse(repo_uri)
+
+    unless repo_dir
+      if parsed_repo_uri.path =~ /\/([^\/]+?)(.git)?$/
+        repo_dir = $1
+      else
+        emsg = "Failed to determine the directory the repo was cloned into."
+        raise Gerrit::Cli::Error.new(emsg)
+      end
+    end
+
+    install_commit_hooks(parsed_repo_uri, repo_dir)
+    install_tracked_hooks(repo_dir)
+  end
+
+  def install_commit_hooks(parsed_repo_uri, repo_dir)
+    hook_src = "#{parsed_repo_uri.host}:hooks/commit-msg"
+    if parsed_repo_uri.user
+      hook_src = "#{parsed_repo_uri.user}@#{hook_src}"
+    end
+
+    hook_dst = "#{repo_dir}/.git/hooks"
+
+    gerrit_port = parsed_repo_uri.port || Gerrit::Cli::DEFAULT_GERRIT_PORT
+
+    @logger.info("\nInstalling commit-msg hooks into '#{hook_dst}'.")
+    @runner.system!("scp -p -P #{gerrit_port} #{hook_src} #{hook_dst}")
+  end
+
+  def install_tracked_hooks(repo_dir)
+    Dir.chdir(repo_dir) do
+      if File.executable?("git/install-hook-symlinks")
+        @logger.info("\nInstalling tracked git hooks: ")
+        @runner.system!("git/install-hook-symlinks")
+      end
+    end
+  end
+end

data/lib/gerrit/cli/command/help.rb

@@ -0,0 +1,49 @@
+require 'gerrit/cli/command/base'
+require 'gerrit/cli/errors'
+require 'gerrit/cli/util'
+
+class Gerrit::Cli::Command::Help < Gerrit::Cli::Command::Base
+
+  attr_reader :commands_summary
+
+  def initialize(logger, commands)
+    super(logger)
+
+    @commands = commands.dup.merge(self.name => self)
+
+    rows = @commands.keys.sort.map {|k| [k, @commands[k].summary] }
+    @commands_summary = Gerrit::Cli::Util.render_table(rows,
+                                                       :delimiter => '  ')
+  end
+
+  def setup_option_parser
+    super
+
+    @option_parser.banner =
+      "Show a list of commands or display help for a specific command."
+  end
+
+  def usage
+    "Usage: gerrit help [options] [<command>]\n\n" \
+    + @option_parser.help                          \
+    + "\nAvailable commands:\n"                    \
+    + @commands_summary
+  end
+
+  def run(argv)
+    args = @option_parser.parse(argv)
+
+    case args.length
+    when 1
+      if command = @commands[args[0]]
+        command.show_usage
+      else
+        raise Gerrit::Cli::UsageError.new("Unknown command '#{args[0]}'")
+      end
+    when 0
+      show_usage
+    else
+      raise Gerrit::Cli::UsageError.new("Too many arguments")
+    end
+  end
+end

data/lib/gerrit/cli/command/push.rb

@@ -0,0 +1,60 @@
+require 'uri'
+
+require 'gerrit/cli/command/base'
+require 'gerrit/cli/constants'
+require 'gerrit/cli/errors'
+
+# Posts reviews to Gerrit. Assumes that your repo has at least one Gerrit
+# remote.
+class Gerrit::Cli::Command::Push < Gerrit::Cli::Command::Base
+  def initialize(logger, runner)
+    super(logger)
+
+    @branch = "master"
+    @runner = runner
+  end
+
+  def setup_option_parser
+    super
+
+    @option_parser.banner =
+      "Post changes from the current branch to Gerrit for review."
+
+    @option_parser.on('-b', '--branch BRANCH',
+                      "The remote branch these changes should be merged into." \
+                      + "Master is assumed by default.") do |branch|
+      @branch = branch
+    end
+  end
+
+  def usage
+    "Usage: gerrit push [options] [<remote>]\n\n" + @option_parser.help
+  end
+
+  def run(argv)
+    args = @option_parser.parse(argv)
+
+    remote = nil
+    case args.length
+    when 1
+      remote = args[0]
+    when 0
+      remote = "origin"
+    else
+      raise Gerrit::Cli::UsageError.new("Incorrect number of arguments")
+    end
+
+    topic = get_current_branch()
+
+    cmd = ["git push",
+           remote,
+           "HEAD:refs/for/#{@branch}/#{topic}"].join(" ")
+    @runner.system!(cmd)
+  end
+
+  def get_current_branch
+    @logger.debug("Getting current branch")
+    output = @runner.capture!("git symbolic-ref HEAD")
+    output.gsub(/^refs\/heads\//,"")
+  end
+end

data/lib/gerrit/cli/constants.rb

@@ -0,0 +1,5 @@
+module Gerrit
+  module Cli
+    DEFAULT_GERRIT_PORT = 29418
+  end
+end

data/lib/gerrit/cli/dispatcher.rb

@@ -0,0 +1,51 @@
+require 'logger'
+require 'gerrit/cli/shell_runner'
+require 'gerrit/cli/command/clone'
+require 'gerrit/cli/command/help'
+require 'gerrit/cli/command/push'
+require 'gerrit/cli/errors'
+
+module Gerrit
+  module Cli
+  end
+end
+
+class Gerrit::Cli::Dispatcher
+  def initialize(logger=nil)
+    @logger = logger ||  Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+
+    runner = Gerrit::Cli::ShellRunner.new(logger)
+
+    @commands = {
+      'clone' => Gerrit::Cli::Command::Clone.new(logger, runner),
+      'push'  => Gerrit::Cli::Command::Push.new(logger, runner),
+    }
+
+    @commands['help'] = Gerrit::Cli::Command::Help.new(logger, @commands)
+  end
+
+  def run_command(argv)
+    if argv.empty?
+      @logger.info("Available Commands:")
+      @logger.info(@commands['help'].commands_summary)
+    else
+      args = argv.dup
+      command_name = args.shift
+      if command = @commands[command_name]
+        command.run(args)
+      else
+        @logger.error("ERROR: Unknown command '#{command_name}'")
+        @commands['help'].show_command_summaries
+      end
+    end
+  rescue Gerrit::Cli::UsageError => ue
+    @logger.error("ERROR: #{ue}\n")
+    command.show_usage
+    exit 1
+  rescue => e
+    @logger.error("ERROR: #{e}")
+    @logger.debug(e.backtrace.join("\n")) if e.backtrace
+    exit 1
+  end
+end

data/lib/gerrit/cli/errors.rb

@@ -0,0 +1,6 @@
+module Gerrit
+  module Cli
+    class Error      < StandardError; end
+    class UsageError < Error; end
+  end
+end

data/lib/gerrit/cli/shell_runner.rb

@@ -0,0 +1,37 @@
+require 'logger'
+
+require 'gerrit/cli/errors'
+
+module Gerrit
+  module Cli
+  end
+end
+
+class Gerrit::Cli::ShellRunner
+  def initialize(logger)
+    @logger = logger || Logger.new(STDOUT)
+  end
+
+  def system!(command)
+    @logger.debug("+ #{command}")
+
+    unless system(command)
+      st = $?.exitstatus
+      emsg = "Command '#{command}' exited with non-zero status (#{st})."
+      raise Gerrit::Cli::Error.new(emsg)
+    end
+  end
+
+  def capture!(command)
+    @logger.debug("+ #{command}")
+
+    out = `#{command}`
+    unless $?.success?
+      st = $?.exitstatus
+      emsg = "Command '#{command}' exited with non-zero status (#{st})."
+      raise Gerrit::Cli::Error.new(emsg)
+    end
+
+    out
+  end
+end

data/lib/gerrit/cli/util.rb

@@ -0,0 +1,34 @@
+module Gerrit
+  module Cli
+  end
+end
+
+module Gerrit::Cli::Util
+  class << self
+    def render_table(rows, opts={})
+      return "" if rows.empty?
+
+      max_col_lengths = []
+      rows.first.length.times { max_col_lengths << 0 }
+
+      # Compute maximum length of each column
+      rows.each do |row|
+        if row.length != max_col_lengths.length
+          raise ArgumentError, "Column mismatch"
+        end
+
+        row.each_with_index do |c, ii|
+          len = c.to_s.length
+          if len> max_col_lengths[ii]
+            max_col_lengths[ii] = len
+          end
+        end
+      end
+
+      delim = opts[:delimiter] || ' '
+      row_format = max_col_lengths.map {|len| "%-#{len}s" }.join(delim)
+
+      rows.map {|row| row_format % row }.join("\n")
+    end
+  end
+end