add optional input to use file path vs classname in annotation summary

Author: Nicole Lopez

plugin.yml

@@ -9,6 +9,8 @@ configuration:
       type: string
     job-uuid-file-pattern:
       type: string
+    failure-format:
+      type: string
   required:
     - artifacts
-  additionalProperties: false
+  additionalProperties: false

ruby/bin/annotate

@@ -12,7 +12,10 @@ abort("#{junits_dir} does not exist") unless Dir.exist?(junits_dir)
 job_pattern = ENV['BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN']
 job_pattern = '-(.*).xml' if !job_pattern || job_pattern.empty?
 
-class Failure < Struct.new(:name, :classname, :body, :job, :type)
+failure_format = ENV['BUILDKITE_PLUGIN_JUNIT_ANNOTATE_FAILURE_FORMAT']
+failure_format = 'classname' if !failure_format || failure_format.empty?
+
+class Failure < Struct.new(:name, :failed_test, :body, :job, :type)
 end
 
 junit_report_files = Dir.glob(File.join(junits_dir, "**", "*"))
@@ -28,12 +31,12 @@ junit_report_files.sort.each do |file|
 
   REXML::XPath.each(doc, '//testsuite//testcase') do |testcase|
     name = testcase.attributes['name'].to_s
-    classname = testcase.attributes['classname'].to_s
+    failed_test = testcase.attributes[failure_format].to_s
     testcase.elements.each("failure") do |failure|
-      failures << Failure.new(name, classname, failure.text, job, :failure)
+      failures << Failure.new(name, failed_test, failure.text, job, :failure)
     end
     testcase.elements.each("error") do |error|
-      failures << Failure.new(name, classname, error.text, job, :error)
+      failures << Failure.new(name, failed_test, error.text, job, :error)
     end
   end
 end
@@ -59,7 +62,7 @@ puts [
 
 failures.each do |failure|
   puts "<details>"
-  puts "<summary><code>#{failure.name} in #{failure.classname}</code></summary>\n\n"
+  puts "<summary><code>#{failure.name} in #{failure.failed_test}</code></summary>\n\n"
   if failure.body
     puts "<code><pre>#{failure.body.chomp.strip}</pre></code>\n\n"
   end

ruby/tests/annotate_test.rb

@@ -215,6 +215,90 @@
     assert_equal 0, status.exitstatus
   end
 
+  it "uses the file path instead of classname for annotation content when specified" do
+      output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_FAILURE_FORMAT=file", "#{__dir__}/../bin/annotate", "#{__dir__}/test-failure-and-error/")
+
+      assert_equal <<~OUTPUT, output
+        Parsing junit-1.xml
+        Parsing junit-2.xml
+        Parsing junit-3.xml
+        --- ❓ Checking failures
+        There are 4 failures/errors 😭
+        --- ✍️ Preparing annotation
+        2 failures and 2 errors:
+
+        <details>
+        <summary><code>Account#maximum_jobs_added_by_pipeline_changer returns 250 by default in ./spec/models/account_spec.rb</code></summary>
+
+        <code><pre>Failure/Error: expect(account.maximum_jobs_added_by_pipeline_changer).to eql(250)
+
+          expected: 250
+               got: 500
+
+          (compared using eql?)
+        ./spec/models/account_spec.rb:78:in `block (3 levels) in <top (required)>'
+        ./spec/support/database.rb:16:in `block (2 levels) in <top (required)>'
+        ./spec/support/log.rb:17:in `run'
+        ./spec/support/log.rb:66:in `block (2 levels) in <top (required)>'</pre></code>
+
+        in <a href="#1">Job #1</a>
+        </details>
+
+        <details>
+        <summary><code>Account#maximum_jobs_added_by_pipeline_changer returns 700 if the account is XYZ in ./spec/models/account_spec.rb</code></summary>
+
+        <code><pre>Failure/Error: expect(account.maximum_jobs_added_by_pipeline_changer).to eql(250)
+
+          expected: 700
+               got: 500
+
+          (compared using eql?)
+        ./spec/models/account_spec.rb:78:in `block (3 levels) in <top (required)>'
+        ./spec/support/database.rb:16:in `block (2 levels) in <top (required)>'
+        ./spec/support/log.rb:17:in `run'
+        ./spec/support/log.rb:66:in `block (2 levels) in <top (required)>'</pre></code>
+
+        in <a href="#2">Job #2</a>
+        </details>
+
+        <details>
+        <summary><code>Account#maximum_jobs_added_by_pipeline_changer returns 700 if the account is XYZ in ./spec/models/account_spec.rb</code></summary>
+
+        <code><pre>Failure/Error: expect(account.maximum_jobs_added_by_pipeline_changer).to eql(250)
+
+          expected: 700
+               got: 500
+
+          (compared using eql?)
+        ./spec/models/account_spec.rb:78:in `block (3 levels) in <top (required)>'
+        ./spec/support/database.rb:16:in `block (2 levels) in <top (required)>'
+        ./spec/support/log.rb:17:in `run'
+        ./spec/support/log.rb:66:in `block (2 levels) in <top (required)>'</pre></code>
+
+        in <a href="#3">Job #3</a>
+        </details>
+
+        <details>
+        <summary><code>Account#maximum_jobs_added_by_pipeline_changer returns 250 by default in ./spec/models/account_spec.rb</code></summary>
+
+        <code><pre>Failure/Error: expect(account.maximum_jobs_added_by_pipeline_changer).to eql(250)
+
+          expected: 250
+               got: 500
+
+          (compared using eql?)
+        ./spec/models/account_spec.rb:78:in `block (3 levels) in <top (required)>'
+        ./spec/support/database.rb:16:in `block (2 levels) in <top (required)>'
+        ./spec/support/log.rb:17:in `run'
+        ./spec/support/log.rb:66:in `block (2 levels) in <top (required)>'</pre></code>
+
+        in <a href="#3">Job #3</a>
+        </details>
+      OUTPUT
+
+      assert_equal 0, status.exitstatus
+    end
+
   it "handles failures across multiple files in sub dirs" do
     output, status = Open3.capture2e("#{__dir__}/../bin/annotate", "#{__dir__}/tests-in-sub-dirs/")