gergich 0.0.1

data/lib/gergich/cli/master_bouncer.rb

@@ -0,0 +1,109 @@
+require_relative "../cli"
+
+ENV["GERGICH_USER"] = ENV.fetch("MASTER_BOUNCER_USER", "master_bouncer")
+ENV["GERGICH_KEY"] = ENV["MASTER_BOUNCER_KEY"] || error("no MASTER_BOUNCER_KEY set")
+
+require_relative "../../gergich"
+
+PROJECT = ENV["GERRIT_PROJECT"] || error("no GERRIT_PROJECT set")
+# TODO: configurable thresholds per-project, also time-based thresholds
+WARN_DISTANCE = 100
+ERROR_DISTANCE = 200
+
+def potentially_mergeable_changes
+  url = "/changes/?q=status:open+" \
+                    "p:#{PROJECT}+" \
+                    "label:Verified=1+" \
+                    "is:mergeable+" \
+                    "branch:master" \
+                 "&o=CURRENT_REVISION"
+  changes = Gergich::API.get(url)
+  changes.select { |c| c["subject"] !~ /\Awip($|\W)/i }
+end
+
+def maybe_bounce_commit!(commit)
+  draft = Gergich::Draft.new(commit)
+  draft.reset!
+
+  distance = Gergich.git("rev-list origin/master ^#{commit.ref} --count").to_i
+  detail = "#{distance} commits behind master"
+
+  score = 0
+  message = nil
+  if distance > ERROR_DISTANCE
+    score = -2
+    message = "This commit is probably not safe to merge (#{detail}). You'll " \
+              "need to rebase it to ensure all the tests still pass."
+  elsif distance > WARN_DISTANCE
+    score = -1
+    message = "This commit may not be safe to merge (#{detail}). Please " \
+              "rebase to make sure all the tests still pass."
+  end
+
+  review = Gergich::Review.new(commit, draft)
+  previous_score = review.previous_score
+
+  puts "#{detail}, " + (score == previous_score ?
+                        "score still #{score}" :
+                        "changing score from #{previous_score} to #{score}")
+
+  # since we run on a daily cron, we might be checking the same patchset
+  # many times, so bail if nothing has changed
+  return if score == previous_score
+
+  draft.add_label "Code-Review", score
+  draft.add_message message if message
+
+  # otherwise we always publish ... even in the score=0 case it's
+  # important, as we might be undoing a previous negative score.
+  # similarly, over time the same patchset will become more out of date,
+  # so we allow_repost (so to speak) so we can add increasingly negative
+  # reviews
+  review.publish!(:allow_repost)
+end
+
+commands = {}
+
+commands["check"] = {
+  summary: "Check the current commit's age",
+  action: ->(_args) {
+    maybe_bounce_commit! Gergich::Commit.new
+  },
+  help: ->() {
+    <<-TEXT
+master_bouncer check
+
+Check the current commit's age, and bounce it if it's too old (-1 or -2,
+depending on the threshold)
+TEXT
+  }
+}
+
+commands["check_all"] = {
+  summary: "Check the age of all potentially mergeable changes",
+  action: ->(_args) {
+    Gergich.git("fetch")
+
+    potentially_mergeable_changes.each do |change|
+      print "Checking g/#{change['_number']}... "
+
+      sha = change["current_revision"]
+      revinfo = change["revisions"][sha]
+      refspec = revinfo["ref"]
+      number = revinfo["_number"]
+      Gergich.git("fetch ssh://gerrit.instructure.com:29418/#{PROJECT} #{refspec}")
+
+      maybe_bounce_commit! Gergich::Commit.new(sha, number)
+      sleep 1
+    end
+  },
+  help: ->() {
+    <<-TEXT
+master_bouncer check_all
+
+Check all open Verified+1 patchsets and bounce any that are too old.
+TEXT
+  }
+}
+
+run_app commands

data/spec/gergich/capture_spec.rb

@@ -0,0 +1,59 @@
+require_relative "../../lib/gergich/capture"
+
+RSpec.describe Gergich::Capture do
+  let!(:draft) { double }
+
+  before do
+    allow(Gergich::Draft).to receive(:new).and_return(draft)
+  end
+
+  context "rubocop" do
+    it "should catch errors" do
+      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
+bin/gergich:47:8: C: Prefer double-quoted strings
+if ENV['DEBUG']
+       ^^^^^^^
+OUTPUT
+      expect(draft).to receive(:add_comment).with(
+        "bin/gergich",
+        47,
+        "[rubocop] C: Prefer double-quoted strings\n\n if ENV['DEBUG']\n        ^^^^^^^\n",
+        "error"
+      )
+      described_class.run("rubocop", "false")
+    end
+  end
+
+  context "eslint" do
+    it "should catch errors" do
+      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
+jsapp/models/user.js
+  4:21  error  Missing semicolon  semi
+OUTPUT
+      expect(draft).to receive(:add_comment).with(
+        "jsapp/models/user.js",
+        4,
+        "[eslint] Missing semicolon",
+        "error"
+      )
+      described_class.run("eslint", "false")
+    end
+  end
+
+  context "i18nliner" do
+    it "should catch errors" do
+      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
+1)
+invalid signature on line 4: <unsupported expression>
+jsapp/models/user.js
+OUTPUT
+      expect(draft).to receive(:add_comment).with(
+        "jsapp/models/user.js",
+        4,
+        "[i18n] invalid signature: <unsupported expression>",
+        "error"
+      )
+      described_class.run("i18nliner", "false")
+    end
+  end
+end

data/spec/gergich_spec.rb

@@ -0,0 +1,133 @@
+require_relative "../lib/gergich"
+
+RSpec.describe Gergich::Draft do
+  let!(:draft) do
+    commit = double(:commit, {
+      files: [
+        "foo.rb",
+        "bar/baz.lol"
+      ],
+      revision_id: "test",
+      change_id: "test"
+    })
+    described_class.new commit
+  end
+
+  after do
+    draft.reset!
+  end
+
+  describe "#info" do
+    subject { draft.info }
+
+    describe "[:comments]" do
+      subject { super()[:comments] }
+
+      it "includes file comments" do
+        draft.add_comment "foo.rb", 1, "fix foo", "info"
+        expect(subject).to eq({ "foo.rb" => [{ line: 1, message: "[INFO] fix foo" }] })
+      end
+
+      it "includes COMMIT_MSG comments" do
+        draft.add_comment "/COMMIT_MSG", 1, "fix commit", "info"
+        expect(subject).to eq({ "/COMMIT_MSG" => [{ line: 1, message: "[INFO] fix commit" }] })
+      end
+
+      it "doesn't include orphaned file comments" do
+        draft.add_comment "invalid.rb", 1, "fix invalid", "info"
+        expect(subject).to eq({})
+      end
+    end
+
+    describe "[:cover_message]" do
+      subject { super()[:cover_message] }
+
+      it "includes the Code-Review score if negative" do
+        draft.add_label "Code-Review", -1
+        expect(subject).to match(/^-1/)
+      end
+
+      it "doesn't include the score if not negative" do
+        draft.add_label "Code-Review", 0
+        expect(subject).to_not match(/^0/)
+      end
+
+      it "includes explicitly added messages" do
+        draft.add_message "this is good"
+        draft.add_message "loljk it's terrible"
+        expect(subject).to include("this is good\n\nloljk it's terrible")
+      end
+    end
+
+    describe "[:total_comments]" do
+      subject { super()[:total_comments] }
+
+      it "includes inline and orphaned comments" do
+        draft.add_comment "foo.rb", 1, "fix foo", "info"
+        draft.add_comment "invalid.rb", 1, "fix invalid", "info"
+        expect(subject).to eq 2
+      end
+    end
+
+    describe "[:labels]" do
+      subject { super()[:labels] }
+
+      it "uses the lowest score for each label" do
+        draft.add_label "QA-Review", 1
+        draft.add_label "QA-Review", -1
+        draft.add_label "Code-Review", -2
+        draft.add_label "Code-Review", 1
+
+        expect(subject).to eq({
+          "QA-Review" => -1,
+          "Code-Review" => -2
+        })
+      end
+
+      it "disallows \"Verified\"" do
+        expect { draft.add_label "Verified", 1 }.to raise_error(/can't set Verified/)
+      end
+
+      it "disallows scores > 1" do
+        expect { draft.add_label "Foo", 2 }.to raise_error(/invalid score/)
+      end
+
+      describe "[\"Code-Review\"]" do
+        subject { super()["Code-Review"] }
+
+        it "defaults to zero" do
+          expect(subject).to eq(0)
+        end
+
+        it "is the lowest comment severity if not set" do
+          draft.add_comment "foo.rb", 1, "fix foo", "info"
+          draft.add_comment "foo.rb", 2, "fix foo", "error"
+          draft.add_comment "foo.rb", 3, "fix foo", "warn"
+
+          expect(subject).to eq(-2)
+        end
+
+        it "is trumped by a lower comment severity if negative" do
+          draft.add_label "Code-Review", 1
+          draft.add_comment "foo.rb", 1, "fix foo", "warn"
+
+          expect(subject).to eq(-1)
+        end
+
+        it "is not trumped by a lower comment severity if zero" do
+          draft.add_label "Code-Review", 1
+          draft.add_comment "foo.rb", 1, "this is ok", "info"
+
+          expect(subject).to eq(1)
+        end
+
+        it "is not trumped by a higher comment severity" do
+          draft.add_label "Code-Review", -1
+          draft.add_comment "foo.rb", 1, "this is ok", "info"
+
+          expect(subject).to eq(-1)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+require "simplecov" if ENV["COVERAGE"]
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: gergich
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Jensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies:
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Gergich is a little command-line tool for wiring up linters to Gerrit
+  so you can get nice inline comments right on the review
+email: jon@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/check_coverage
+- bin/gergich
+- bin/master_bouncer
+- lib/gergich.rb
+- lib/gergich/capture.rb
+- lib/gergich/capture/eslint_capture.rb
+- lib/gergich/capture/i18nliner_capture.rb
+- lib/gergich/capture/rubocop_capture.rb
+- lib/gergich/cli.rb
+- lib/gergich/cli/gergich.rb
+- lib/gergich/cli/master_bouncer.rb
+- spec/gergich/capture_spec.rb
+- spec/gergich_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/instructure/gergich
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Command-line tool for adding Gerrit comments
+test_files: []
+has_rdoc: