gergich 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a633dec2c1eb9cec61cba56c145a1c31c4022c19c7c75e91e368b0a3bc3cf89a
-  data.tar.gz: 0721f82a0c12ce4069a00bed04d4097d8d712b6289e3a7f16d29865bf5220055
+  metadata.gz: 2d16295d82fb11923e2cb49cb0656420e3235d4a08cc573e34436ec32a341870
+  data.tar.gz: 2019c58f7af8b708787e27c05f6a41c99e927128d9288461b913fd90f129461c
 SHA512:
-  metadata.gz: 4ecba879accbb6c196d3bad117360a6469e47a252043d3b4d71e6aaa50ac265294188d078b9798087cc92a17a83b319885dbf1e85e661dc4bd82566e77e182a3
-  data.tar.gz: 4c40b055c23de9019776720c41167fec8a031f3592896f11131935b7641cf9ff34487377f552388e936e5349fe284b30d74d1870d1e6b2122964da1a40811605
+  metadata.gz: 6f99d44011d1358420564a0ffc7b2846c1ddd536e41f183c1e2da9a330e0a690bb25dc2110c5b5d4bae00bf6d5ffc166652229012dfa817047fd6d909e838f93
+  data.tar.gz: ed476739a4a99eafba3362a38c439cca37a08130ef81818e1537abe3112189a15b905eb636c9cb3f3fb628a10d7681427e48ce835c8e97e4cbdd81410f795bec

data/lib/gergich/cli/gergich.rb

@@ -92,7 +92,8 @@ commands["publish"] = {
 commands["status"] = {
   summary: "Show the current draft for this patchset",
   action: -> {
-    Gergich::Review.new.status
+    commit = Gergich::Commit.new
+    Gergich::Review.new(commit).status
   },
   help: -> {
     <<~TEXT

data/lib/gergich/cli/master_bouncer.rb

@@ -9,6 +9,9 @@ MASTER_BOUNCER_REVIEW_LABEL = ENV.fetch("GERGICH_REVIEW_LABEL", "Code-Review")
 require_relative "../../gergich"
 
 PROJECT = ENV["GERRIT_PROJECT"] || error("no GERRIT_PROJECT set")
+# on Jenkins GERRIT_MAIN_BRANCH env var will default to empty string if not set
+MAIN_BRANCH = ENV["GERRIT_MAIN_BRANCH"].nil? || ENV["GERRIT_MAIN_BRANCH"].empty? ? "master" :
+        ENV["GERRIT_MAIN_BRANCH"]
 # TODO: time-based thresholds
 WARN_DISTANCE = ENV.fetch("MASTER_BOUNCER_WARN_DISTANCE", 50).to_i
 ERROR_DISTANCE = ENV.fetch("MASTER_BOUNCER_ERROR_DISTANCE", 100).to_i
@@ -17,7 +20,7 @@ def potentially_mergeable_changes
   url = "/changes/?q=status:open+" \
         "p:#{PROJECT}+" \
         "label:Verified=1+" \
-        "branch:master" \
+        "branch:#{MAIN_BRANCH}" \
         "&o=CURRENT_REVISION"
   changes = Gergich::API.get(url)
   changes.reject { |c| c["subject"] =~ /\Awip($|\W)/i }
@@ -27,8 +30,8 @@ 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"
+  distance = Gergich.git("rev-list origin/#{MAIN_BRANCH} ^#{commit.ref} --count").to_i
+  detail = "#{distance} commits behind #{MAIN_BRANCH}"
 
   score = 0
   message = nil
@@ -84,10 +87,18 @@ commands["check"] = {
 commands["check_all"] = {
   summary: "Check the age of all potentially mergeable changes",
   action: -> {
-    Gergich.git("fetch")
     gerrit_host = ENV["GERRIT_HOST"] || error("No GERRIT_HOST set")
+    Gergich.git("fetch")
 
     changes = potentially_mergeable_changes
+    # if changes is empty or nil, we don't need to iterate over it
+    # log that we're skipping, and return
+    if changes.nil? || changes.empty?
+      Logging.logger.info "No changes to check"
+      return
+    end
+    Logging.logger.info "Checking #{changes.size} changes"
+
     next if ENV["DRY_RUN"]
 
     changes.each do |change|

data/lib/gergich.rb

@@ -4,6 +4,8 @@ require "erb"
 require "json"
 require "fileutils"
 require "base64"
+require "open3"
+require_relative "logging"
 
 GERGICH_REVIEW_LABEL = ENV.fetch("GERGICH_REVIEW_LABEL", "Code-Review")
 GERGICH_USER = ENV.fetch("GERGICH_USER", "gergich")
@@ -12,24 +14,35 @@ GERGICH_GIT_PATH = ENV.fetch("GERGICH_GIT_PATH", ".")
 GergichError = Class.new(StandardError)
 
 module Gergich
+  include Logging
   def self.use_git?
-    Dir.chdir(GERGICH_GIT_PATH) do
-      system "git rev-parse --show-toplevel >/dev/null 2>&1"
-    end
+    !git("rev-parse --show-toplevel").nil?
   end
 
   def self.git(args)
     Dir.chdir(GERGICH_GIT_PATH) do
-      `git #{args} 2>/dev/null`
+      raise(GergichError, "git not installed") unless system("which git > /dev/null 2>&1")
+
+      output, error, status = Open3.capture3("git #{args}")
+      if status.success?
+        Logging.logger.debug "git #{args}: #{output}"
+        output
+      else
+        Logging.logger.warn "Output: #{output}"
+        Logging.logger.warn "git #{args} failed: #{error}"
+        nil
+      end
     end
   end
 
   class Commit
+    include Logging
     attr_reader :ref
 
     def initialize(ref = ENV.fetch("GERRIT_PATCHSET_REVISION", "HEAD"), revision_number = nil)
       @ref = ref
       @revision_number = revision_number
+      logger.debug "Commit initialized with ref: #{ref}"
     end
 
     def info
@@ -89,7 +102,7 @@ module Gergich
   class Review
     attr_reader :commit, :draft
 
-    def initialize(commit = Commit.new, draft = Draft.new)
+    def initialize(commit = Commit.new, draft = Draft.new(commit))
       @commit = commit
       @draft = draft
     end

data/lib/logging.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: false
+
+require "logger"
+
+module Logging
+  def logger
+    Logging.logger
+  end
+
+  def self.logger
+    @logger ||= Logger.new($stdout)
+    @logger.formatter = proc do |severity, datetime, _progname, msg|
+      datefmt = datetime.strftime("%Y-%m-%d %H:%M:%S")
+      # ensure that there is only one newline at the end of the message
+      "#{severity} [#{datefmt}]: #{msg}\n".gsub!(/\n+/, "\n")
+    end
+    @logger
+  end
+
+  def self.log_level
+    # default to only showing errors
+    ENV.fetch("RUBY_LOG_LEVEL", "ERROR")
+  end
+
+  logger.level = log_level
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gergich
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.2.0
 platform: ruby
 authors:
 - Jon Jensen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -169,6 +169,7 @@ files:
 - lib/gergich/cli.rb
 - lib/gergich/cli/gergich.rb
 - lib/gergich/cli/master_bouncer.rb
+- lib/logging.rb
 homepage: https://github.com/instructure/gergich
 licenses:
 - MIT
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.8
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Command-line tool for adding Gerrit comments