Compare all updates (#7)

Author: dentarg

.github/workflows/ci.yml

@@ -3,30 +3,25 @@ on:
   push:
   workflow_dispatch:
     inputs:
-      name:
-        description: 'Name of gem to compare'
-        required: false
-        type: string
-      from:
-        description: 'From version'
-        required: false
-        type: string
-      to:
-        description: 'To version'
-        required: false
-        type: string
       pr:
-        description: 'The number of the pull request to comment in'
+        description: "The number of the pull request to comment in"
         required: false
         type: number
 
+
 jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+
+      - run: rake
+
       - uses: ./
         with:
-          pr_title: "Bump ${{ inputs.name || 'pg' }} from ${{ inputs.from || '1.4.0' }} to ${{ inputs.to || '1.4.1' }}"
-          pr_number: ${{ inputs.pr || 1 }}
+          pr_diff: test/fixtures/sentry.diff
+          pr_number: ${{ inputs.pr || 2 }}
           github-token: ${{ secrets.GITHUB_TOKEN }}

Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.options = "--verbose=normal" unless ENV.key?("TESTOPTS")
+end
+
+task default: :test

action.yml

@@ -8,9 +8,9 @@ inputs:
     description: "Version of the gem-compare plugin"
     default: "1.2.1"
     required: false
-  pr_title:
-    description: "String with gem name and from/to versions"
-    default: "Bump pg from 1.4.0 to 1.4.1"
+  pr_diff:
+    description: "Output from 'git diff' for Gemfile.lock"
+    default: ""
     required: false
   pr_number:
     description: "The number of the pull request to comment in"
@@ -25,68 +25,46 @@ runs:
   steps:
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1
-
-    - name: Extract info from pull request
-      shell: bash
-      run: |
-        echo "PR_NUMBER=${{ github.event.pull_request.number || inputs.pr_number }}" >> $GITHUB_ENV
-        echo "PR_TITLE=${{ github.event.pull_request.title || inputs.pr_title }}" >> $GITHUB_ENV
+        ruby-version: 3.2
 
     # Ensure our scripts can be found when running the action
     # https://docs.github.com/en/actions/creating-actions/creating-a-composite-action#creating-an-action-metadata-file
     - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
       shell: bash
 
-    - name: Parse pull request title
+    - name: Get pull request number
       shell: bash
       run: |
-        echo "COMPARE_GEM=$(echo $PR_TITLE | parse_title name)" >> $GITHUB_ENV
-        echo "COMPARE_FROM_VERSION=$(echo $PR_TITLE | parse_title from)" >> $GITHUB_ENV
-        echo "COMPARE_TO_VERSION=$(echo $PR_TITLE | parse_title to)" >> $GITHUB_ENV
+        echo "PR_NUMBER=${{ github.event.pull_request.number || inputs.pr_number }}" >> $GITHUB_ENV
 
-    - name: Post Diffend URL
+    - name: Get pull request diff from input
+      if: ${{ inputs.pr_diff != '' }}
       shell: bash
-      env:
-        GITHUB_TOKEN: ${{ inputs.github-token }}
       run: |
-        echo "https://my.diffend.io/gems/$COMPARE_GEM/$COMPARE_FROM_VERSION/$COMPARE_TO_VERSION" >> comment0.txt
-        with_retries gh pr comment $PR_NUMBER --body-file comment0.txt --repo ${{ github.repository }}
+        {
+          echo 'PR_DIFF<<EOF'
+          cat ${{ inputs.pr_diff }}
+          echo EOF
+        } >> "$GITHUB_ENV"
 
-    - name: Run gem install gem-compare
+    - name: Get pull request diff from repo
+      if: ${{ inputs.pr_diff == '' }}
       shell: bash
       run: |
-        with_retries gem install gem-compare --version ${{ inputs.gem_compare_version }} || true
+        {
+          echo 'PR_DIFF<<EOF'
+          git diff HEAD^ HEAD -- Gemfile.lock
+          echo EOF
+        } >> "$GITHUB_ENV"
 
-    - name: Run gem compare
+    - name: Run gem install gem-compare
       shell: bash
       run: |
-        with_retries gem compare $COMPARE_GEM $COMPARE_FROM_VERSION $COMPARE_TO_VERSION > compare_output.txt || true
+        with_retries gem install gem-compare --version ${{ inputs.gem_compare_version }} || true
 
-    - name: Run gem compare --diff
+    - name: Run compare steps
       shell: bash
       run: |
-        with_retries gem compare --diff $COMPARE_GEM $COMPARE_FROM_VERSION $COMPARE_TO_VERSION > compare_diff.txt || true
-
-    - name: Run gh pr comment
-      shell: bash
+        compare_gem_versions
       env:
         GITHUB_TOKEN: ${{ inputs.github-token }}
-      run: |
-        echo "## <code>gem compare $COMPARE_GEM $COMPARE_FROM_VERSION $COMPARE_TO_VERSION</code>" > comment1.txt
-        echo ''                        >> comment1.txt
-        echo '````ruby'                >> comment1.txt
-        cat compare_output.txt         >> comment1.txt
-        echo '````'                    >> comment1.txt
-        echo ''                        >> comment1.txt
-
-        echo "<Details><Summary><h2><code>gem compare --diff"\
-             "$COMPARE_GEM $COMPARE_FROM_VERSION $COMPARE_TO_VERSION</code></h2></Summary>" >> comment2.txt
-        echo ''                        >> comment2.txt
-        echo '````ruby'                >> comment2.txt
-        cat compare_diff.txt           >> comment2.txt
-        echo '````'                    >> comment2.txt
-        echo '</Details>'              >> comment2.txt
-
-        with_retries gh pr comment $PR_NUMBER --body-file comment1.txt --repo ${{ github.repository }} || true
-        gh pr comment $PR_NUMBER --body-file comment2.txt --repo ${{ github.repository }} || true

compare_gem_versions

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+
+require "json"
+require "open3"
+require "stringio"
+require "tempfile"
+
+require_relative "lib/parse_diff"
+
+def to_file(str)
+  file = Tempfile.new("gem-compare-action")
+  file.write(str)
+  file.rewind
+  file.path
+end
+
+def diffend_url(gem_name:, from:, to:)
+  "https://my.diffend.io/gems/#{gem_name}/#{from}/#{to}"
+end
+
+def post_gh_comment(pr_number:, body:, repo:)
+  command = %W[
+    gh
+    pr
+    comment
+    #{pr_number}
+    --body-file
+    #{to_file(body)}
+    --repo
+    #{repo}
+  ]
+
+  run_with_retries(command:)
+end
+
+def run_with_retries(command: [])
+  command_args = command.dup.prepend("./with_retries")
+
+  if ENV.key?("DEBUG")
+    puts "+ #{command_args.join(" ")}"
+    return
+  end
+
+  system(*command_args, exception: true)
+end
+
+def output_from_with_retries(command: [])
+  command_args = command.dup.prepend("./with_retries")
+
+  if ENV.key?("DEBUG")
+    puts "+ #{command_args.join(" ")}"
+    return "dummy output"
+  end
+
+  stdout_str, stderr_str, status = Open3.capture3(*command_args)
+
+  if status.success?
+    stdout_str
+  else
+    raise "Command '#{command_args.join(' ')}' failed: #{stderr_str}"
+  end
+end
+
+def gem_compare_command(gem_name:, from:, to:, diff: false)
+  diff_flag = diff ? "--diff" : ""
+
+  [
+    "gem",
+    "compare",
+    diff ? "--diff" : nil,
+    gem_name,
+    from,
+    to,
+  ].compact
+end
+
+def gem_compare_comment(command:, output:)
+  <<~COMMENT
+    <Details><Summary><h2><code>#{command.join(" ")}</code></h2></Summary>
+
+    ````ruby
+    #{output}
+    ````
+    </Details>
+
+  COMMENT
+end
+
+#
+# main
+#
+
+repo            = ENV.fetch("GITHUB_REPOSITORY", "dentarg/gem-compare")
+pr_number       = ENV.fetch("PR_NUMBER", 2)
+diff_input      = ENV["PR_DIFF"] || STDIN.readlines.join
+versions        = ParseDiff.parse(diff_input)
+diffend_comment = StringIO.new
+diffend_comment.puts "## Diff URLs"
+
+puts "Changes detected:"
+versions.each do |gem_name, (from, to)|
+  puts "* #{gem_name} #{from} ➡ #{to}"
+
+  diffend_comment.puts "* #{diffend_url(gem_name:, from:, to:)}"
+end
+
+puts "Posting comment with Diffend URLs"
+post_gh_comment(pr_number:, body: diffend_comment.string, repo:)
+
+versions.each do |gem_name, (from, to)|
+  puts "Comparing: #{gem_name} #{from} ➡ #{to}"
+
+  command = gem_compare_command(gem_name:, from:, to:)
+  output  = output_from_with_retries(command:)
+  body    = gem_compare_comment(command:, output:)
+
+  puts "Posting comment with 'gem compare' output"
+  post_gh_comment(pr_number:, body:, repo:)
+
+  command = gem_compare_command(gem_name:, from:, to:, diff: true)
+  output  = output_from_with_retries(command:)
+  body    = gem_compare_comment(command:, output:)
+
+  puts "Posting comment with 'gem compare --diff' output"
+  post_gh_comment(pr_number:, body:, repo:)
+end

lib/parse_diff.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ParseDiff
+  def self.parse(input)
+    versions    = Hash.new { |hash, key| hash[key] = [] }
+    versions_re = %r{\A(-|\+)    (?<gem>((\w|-))+) \((?<version>.+)\)\z}
+
+    input.each_line do |line|
+      $stderr.puts "line=#{line.inspect}" if ENV.key?("DEBUG")
+
+      if m = line.chomp.match(versions_re)
+        gem_name = m.match(:gem)
+        version  = m.match(:version)
+
+        versions[gem_name] << version
+      end
+    end
+
+    versions
+  end
+end

parse_title

@@ -0,0 +1,27 @@
+diff --git a/Gemfile.lock b/Gemfile.lock
+index b7bae4a..9079ca6 100644
+--- a/Gemfile.lock
++++ b/Gemfile.lock
+@@ -82,7 +82,7 @@ GEM
+     rdiscount (2.2.7.1)
+     redis (5.0.7)
+       redis-client (>= 0.9.0)
+-    redis-client (0.16.0)
++    redis-client (0.17.0)
+       connection_pool
+     redis-namespace (1.11.0)
+       redis (>= 4)
+@@ -117,10 +117,10 @@ GEM
+       nokogiri (>= 1.10.8)
+       rubyzip (>= 1.3.0)
+     rubyzip (2.3.2)
+-    sentry-resque (5.10.0)
++    sentry-resque (5.11.0)
+       resque (>= 1.24)
+-      sentry-ruby (~> 5.10.0)
+-    sentry-ruby (5.10.0)
++      sentry-ruby (~> 5.11.0)
++    sentry-ruby (5.11.0)
+       concurrent-ruby (~> 1.0, >= 1.0.2)
+     sequel (5.72.0)
+       bigdecimal

test/fixtures/sentry.diff

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "test/unit"
+
+require_relative "../lib/parse_diff"
+
+class ParseDiffTest < Test::Unit::TestCase
+  def test_parse_diff
+    fixture  = File.join(__dir__, "fixtures", "sentry.diff")
+    input    = File.read(fixture)
+    expected = {
+      "redis-client"  => %w[0.16.0 0.17.0],
+      "sentry-resque" => %w[5.10.0 5.11.0],
+      "sentry-ruby"   => %w[5.10.0 5.11.0],
+    }
+
+    assert_equal expected, ParseDiff.parse(input)
+  end
+end