gerricator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee449454a494c46f37194ccd50bd6a4ded5f4059
+  data.tar.gz: d5ec69ec969d164089100c413913962c52d1b590
+SHA512:
+  metadata.gz: 123e5020fc9355e7b55e15b546fb3d0d2db08571c0b86962a21d72e346358ba19c9b35a51dece8adbc4a8ba6e48fc683f7487766c2eb8e0afd4d930a2838397a
+  data.tar.gz: 96762cdc978f1824cc6b981320feab49a3d3bb5b9f5ec19e844c558e1d9e158f1250d15ac354002d1bf3a7d1e6bac4b3dc2830438d6592faf6b1370b4a206e68

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2015 Jun Wu <quark@lihdd.net>
+
+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,43 @@
+gerricator
+==========
+
+Command-line tool to create or update [Phabricator](http://phabricator.org/) diff from [Gerrit](https://code.google.com/p/gerrit/) change
+
+Requirements
+------------
+* git
+* arc
+* ruby (> 2.0)
+
+Installation
+------------
+
+```bash
+gem install gerricator
+gerricator init
+editor ~/.config/gerricator/config.yml
+```
+
+Examples
+--------
+
+```bash
+# push patchset 1 in gerrit change 2020 to phabricator
+gerricator push 2020 1  # outputs differential id, ex. 'D201'
+
+# push patchset 3, update the same phabricator diff
+gerricator push 2020 3
+
+# push latest patchset in change 2020
+gerricator push 2020
+
+# does nothing because 2020#3 is already pushed
+gerricator push 2020 3
+
+# you can also use long change-id
+gerricator push Id7c5ef224f847422350ecbdaa8da397ffd929f9a
+
+# see debug logs
+export VERBOSE=1
+gerricator push 2020 2
+```

data/bin/gerricator

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require_relative '../config/app'
+
+
+class Gerricator < Thor
+  desc 'push CHANGE REVISION', 'push Gerrit change to Phabricator'
+  def push change_id, rev_no=nil
+    App::push_change change_id, rev_no
+  end
+
+  desc 'init', 'create an example config file'
+  method_option :force, type: :boolean, aliases: '-f', default: false, desc: 'overwrite existing config file'
+  def init
+    App::write_example_config force: options.force
+  end
+end
+
+Gerricator.start

data/config/app.rb

@@ -0,0 +1,145 @@
+require 'active_record'
+require 'fileutils'
+require 'logger'
+require 'sqlite3'
+require 'thor'
+require 'yaml'
+require_relative '../lib/arcanist'
+require_relative '../lib/gerrit'
+require_relative '../lib/git'
+
+CONFIG_PATH = File.expand_path('~/.config/gerricator/config.yml')
+
+def logger
+  @logger ||=\
+    if ENV['VERBOSE'] || ENV['DEBUG']
+      Logger.new(STDERR)
+    else
+      Logger.new('/dev/null')
+    end
+end
+
+def config
+  @config ||=\
+    begin
+      config_path = Dir["{#{CONFIG_PATH},{./,./config/}config.yml{,.example}}"].first
+      if config_path.nil?
+        raise "Config file not found: #{CONFIG_PATH}"
+      else
+        logger.info "Config file: #{config_path}"
+      end
+      YAML::load_file(config_path)
+    end
+end
+
+def initialize_database
+  app_path = File.expand_path('../', __FILE__)
+  db_path = config['db_path']
+  FileUtils.mkdir_p File.dirname(db_path)
+  logger.info "Database: #{db_path}"
+
+  ActiveRecord::Base.logger = logger if STDERR.isatty
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: db_path,
+    pool: 5,
+    timeout: 5000)
+  ActiveRecord::Migrator.migrate(File.join(app_path, '../db/migrate'))
+end
+
+def gerrit_bots
+  config['gerrit']['bots']
+end
+
+def gerrit
+  @gerrit ||= Gerrit.new(*%w[base_url username http_password].map {|x| config['gerrit'][x]})
+end
+
+def arc
+  @arc ||= Arcanist.new(*%w[conduit_uri username certificate].map {|x| config['phabricator'][x]})
+end
+
+class Link < ActiveRecord::Base; end
+
+HTTPI.logger = logger
+
+module App; class << self
+  # push gerrit change to phabricator
+  def push_change change_id, rev_no=nil
+    initialize_database
+    change = gerrit.change(change_id)
+    number = change.number
+    project = change.project
+    raise "Cannot find change #{change_id}" unless number.to_i > 0
+
+    oid, rev = if rev_no.nil?
+                 # last revision
+                 change.revisions.max_by {|k, v| v['_number']}
+               else
+                 change.revisions.find {|k, v| v['_number'] == rev_no.to_i}
+               end
+    raise "Cannot find revision #{rev_no}" unless rev && oid
+    rev_no = rev['_number']
+    logger.info "Revision #{rev_no}: #{oid}"
+
+    make_temp_work_dir do |work_dir|
+      link = Link.find_by(change_number: change.number)
+      if link && link.patch_set_revisions.to_s.split.include?(rev_no.to_s)
+        logger.info "Revision #{rev_no} is already at D#{link.differential_id}"
+      else
+        checkout_commit project, work_dir, oid
+        if link
+          logger.info "Updating D#{link.differential_id}"
+          arc.diff work_dir, config['projects'][project]['phabricator_callsign'], message: "Patchset #{rev_no}", differential_id: link.differential_id
+          link.patch_set_revisions = "#{link.patch_set_revisions} #{rev_no}"
+          link.save!
+        else
+          change_url = File.join(config['gerrit']['base_url'], "#/c/#{number}")
+          message = "#{Git::message(work_dir)}\nGerrit URL: #{change_url}\n"
+          reviewers = [*config['projects'][project]['reviewers']].compact
+          reviewers = change.reviewers - gerrit_bots if reviewers.empty?
+          logger.info "Creating new diff, reviewers: #{reviewers}"
+          differential_id = arc.diff(work_dir, config['projects'][project]['phabricator_callsign'], message: message, reviewers: reviewers)
+          link = Link.create! differential_id: differential_id, change_number: number, patch_set_revisions: rev_no
+        end
+      end
+      puts "D#{link.differential_id}"
+    end
+  end
+
+  def write_example_config force: false
+    example_config_path = File.expand_path('../config.yml.example', __FILE__)
+    raise "#{CONFIG_PATH} already exists" if !force && File.exists?(CONFIG_PATH)
+    FileUtils.mkdir_p File.dirname(CONFIG_PATH)
+    FileUtils.cp example_config_path, CONFIG_PATH
+    logger.info "Example config written: #{CONFIG_PATH}"
+  end
+
+  private
+
+    def sync_repo project
+      File.join(File.expand_path(config['local_cache_path']), 'projects', project).tap do |dest|
+        url = config['projects'][project]['git_url']
+        logger.info "Mirroring #{project} (#{url}) to #{dest}"
+        Git::mirror url, dest
+      end
+    end
+
+    def checkout_commit project, work_dir, oid
+      sync_repo(project).tap do |dest|
+        logger.info "Checking out #{oid} at #{work_dir}"
+        Git::write_commit_tree dest, work_dir, oid
+      end
+    end
+
+    def make_temp_work_dir
+      work_dir = File.join(File.expand_path(config['local_cache_path']), 'work_dir', $$.to_s)
+      raise "#{work_dir} already exists" if File.exists?(work_dir)
+      begin
+        FileUtils.mkdir_p work_dir
+        yield work_dir
+      ensure
+        FileUtils.rm_rf work_dir
+      end
+    end
+end; end

data/config/config.yml.example

@@ -0,0 +1,21 @@
+phabricator:
+  conduit_uri: http://phricator.example.com/
+  username: gerricator
+  certificate: f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0
+gerrit:
+  base_url: https://gerrit.example.com/
+  username: gerricator
+  http_password: HTTPpasswd
+  bots: ['jenkins']
+projects:
+  gerrit_project_name_a:
+    git_url: ssh://gerricator@gerrit.example.com/gerrit_project_name_a.git
+    phabricator_callsign: A
+    # if 'reviewers' is not set, it will be gerrit reviewers - gerrit bots.
+    # note: phabricator must have these reviewers accounts.
+  gerrit_project_name_b:
+    git_url: ssh://gerricator@gerrit.example.com/gerrit_project_name_b.git
+    phabricator_callsign: B
+    reviewers: ['alice', 'bob']
+local_cache_path: ~/.cache/gerricator/
+db_path: ~/.config/gerricator/main.sqlite3

data/db/migrate/001_schema.rb

@@ -0,0 +1,10 @@
+class Schema < ActiveRecord::Migration
+  def change
+    create_table :links, force: true do |t|
+      t.integer :change_number, null: false
+      t.integer :differential_id, null: false
+      t.text :patch_set_revisions
+    end
+    add_index :links, :change_number, unique: true
+  end
+end

data/gerricator.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = 'gerricator'
+  s.version = '0.1.0'
+  s.date = Date.civil(2015,1,25)
+  s.summary = 'Gerrit change to Phabricator diff'
+  s.description = 'Command-line tool to create or update Phabricator diff from Gerrit change'
+  s.authors = ['Jun Wu']
+  s.email = 'quark@lihdd.net'
+  s.homepage = 'https://github.com/quark-zju/gerricator'
+  s.require_paths = ['lib']
+  s.licenses = ['BSD']
+  s.files = %w(LICENSE README.md gerricator.gemspec)
+  s.files += Dir.glob('{bin/*,lib/*.rb,db/**/*.rb,config/*.{example,rb}}')
+  s.executables = ['gerricator']
+  s.add_dependency 'activerecord', '~> 4.1'
+  s.add_dependency 'sqlite3', '~> 1.3'
+  s.add_dependency 'thor', '~> 0.19'
+  s.add_dependency 'httpi', '~> 2.2'
+end

data/lib/arcanist.rb

@@ -0,0 +1,66 @@
+require 'json'
+require 'shellwords'
+require 'tempfile'
+require_relative 'git'
+
+
+class Arcanist < Struct.new(:conduit_uri, :user, :cert)
+
+  def diff work_dir, callsign, commit: 'HEAD^', differential_id: nil, message: nil, reviewers: ''
+    arcrc = write_arcrc
+    temps = [arcrc]
+    args = ['--no-ansi', '--conduit-uri', conduit_uri, '--config', "repository.callsign=#{callsign}", '--arcrc-file', arcrc.path]
+
+    if differential_id
+      # update existing diff
+      args += ['--update', differential_id.to_s, '--message', message || 'Update']
+    else
+      # create new diff
+      tmp = Tempfile.create 'arcmsg'
+      tmp.write <<"EOS"
+#{message || Git::message(work_dir)}
+
+Test Plan:
+N/A (imported by gerricator)
+
+Reviewers: #{[*reviewers].join(', ')}
+EOS
+      tmp.flush
+      temps << tmp
+      args += ['--create', '--message-file', tmp.path]
+    end
+
+    Dir.chdir work_dir do
+      cmd = Shellwords.join(['arc', 'diff', *args, commit])
+      result = `#{cmd}`
+
+      if not differential_id
+        differential_id = result[/#{File.join(conduit_uri, 'D')}(\d+)/, 1]
+      end
+    end
+
+    differential_id
+  ensure
+    temps.each do |t|
+      File.unlink(t) if t && File.exists?(t)
+    end
+  end
+
+  private
+
+    def write_arcrc
+      Tempfile.create('arcrc').tap do |t|
+        content = {
+          hosts: {
+            File.join(conduit_uri, 'api/') => {
+              user: user,
+              cert: cert,
+            }
+          }
+        }
+        t.write JSON.dump(content)
+        t.flush
+      end
+    end
+
+end

data/lib/gerrit.rb

@@ -0,0 +1,78 @@
+require 'httpi'
+require 'json'
+require 'base64'
+
+class Gerrit < Struct.new(:base_url, :username, :password)
+  
+  def get endpoint
+    request endpoint
+  end
+
+  def post endpoint, body = ''
+    request endpoint, method: 'post', body: body.to_s
+  end
+
+  class Change < Struct.new(:gerrit, :change_id)
+    def number
+      @number ||= get['_number']
+    end
+
+    def project
+      @project ||= get['project']
+    end
+
+    def reviewers
+      get('reviewers').map {|x| x['username']}.compact
+    end
+
+    def revisions
+      get('?o=ALL_REVISIONS')['revisions']
+    end
+
+    def get subpath=''
+      path = File.join("changes/#{change_id}", subpath)
+      gerrit.get path
+    end
+  end
+
+  def change(change_id)
+    Change.new(self, change_id)
+  end
+
+  private
+
+    def request endpoint, method: 'get', body: nil
+      if method == 'get' && body.nil?
+        @get_caches ||= {}
+        @get_caches[endpoint] ||= send_request endpoint, method: method, body: body
+      else
+        send_request endpoint, method: method, body: body
+      end
+    end
+
+    def send_request endpoint, method: 'get', body: nil
+      req = HTTPI::Request.new File.join(base_url, username ? 'a' : '', endpoint)
+      req.auth.digest username, password if username && password && !username.empty?
+      req.auth.ssl.verify_mode = :none
+      if body
+        req.body = body
+        req.headers['Content-Type'] = 'application/json;charset=UTF-8'
+      end
+      res = HTTPI.send method, req
+      content_type = [*res.headers['Content-Type']].last.split(/[ ;]/).first
+      case content_type
+      when 'application/json'
+        JSON.parse res.body.lines[1..-1].join
+      when 'text/plain'
+        case res.headers['X-FYI-Content-Encoding']
+        when 'base64'
+          Base64::decode64 res.body
+        else
+          res.body
+        end
+      else
+        raise "Unknown content type: #{content_type}"
+      end
+    end
+
+end

data/lib/git.rb

@@ -0,0 +1,67 @@
+require 'fileutils'
+require 'shellwords'
+
+
+module Git; class << self
+  def mirror url, dest
+    if File.exists?(dest)
+      Dir.chdir(dest) do
+        system! 'git', 'fetch', '--tags', '--all', '--force', '--prune'
+      end
+    else
+      FileUtils.mkdir_p dest
+      system! 'git', 'clone', '--mirror', url, dest
+    end
+  end
+
+  def add_shared_objects path, object_path
+    raise "object_path is empty" unless object_path
+    Dir.chdir path do
+      alernates_path = '.git/objects/info/alternates'
+      content = (File.read(alernates_path) rescue '')
+      return if content.include?(object_path)
+      File.write alernates_path, "#{object_path}\n#{content}"
+    end
+  end
+
+  def init dest
+    FileUtils.mkdir_p dest
+    Dir.chdir dest do system! 'git', 'init' end
+  end
+
+  def checkout dest, commit
+    raise "commit is empty" unless commit
+    Dir.chdir dest do
+      system! 'git', 'checkout', '--quiet', '--force', '--detach', commit
+    end
+  end
+
+  def message dest, commit='HEAD'
+    Dir.chdir dest do
+      `git log --format=%B -n 1 #{Shellwords.join([commit])}`.chomp
+    end
+  end
+
+  def amend dest, message
+    Dir.chdir dest do
+      system! 'git', 'commit', '--amend', '--message', message
+    end
+  end
+
+  def write_commit_tree repo_path, dest, commit
+    init dest
+    object_path = Dir["#{repo_path}/{.git/,}objects"].first
+    add_shared_objects dest, object_path
+    checkout dest, commit
+  end
+
+  private
+
+    def system! *args
+      quiet = !ENV['VERBOSE'] && !ENV['DEBUG']
+      options = quiet ? {:out => '/dev/null', :err => '/dev/null'} : {}
+
+      raise "Cannot run #{Shellwords.join(args)}" unless system(*args, options)
+    end
+
+end; end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gerricator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jun Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Command-line tool to create or update Phabricator diff from Gerrit change
+email: quark@lihdd.net
+executables:
+- gerricator
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/gerricator
+- config/app.rb
+- config/config.yml.example
+- db/migrate/001_schema.rb
+- gerricator.gemspec
+- lib/arcanist.rb
+- lib/gerrit.rb
+- lib/git.rb
+homepage: https://github.com/quark-zju/gerricator
+licenses:
+- BSD
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Gerrit change to Phabricator diff
+test_files: []
+has_rdoc: