Fix integration tests for single mode

Author: adangel

lib/pmdtester/runner.rb

@@ -12,6 +12,7 @@ def initialize(argv)
 
     def run
       clean unless @options.keep_reports
+
       case @options.mode
       when Options::LOCAL
         run_local_mode
@@ -35,8 +36,8 @@ def run_local_mode
       rule_sets = RuleSetBuilder.new(@options).build if @options.auto_config_flag
       return if rule_sets&.empty?
 
-      base_branch_details = make_branch_details(config: @options.base_config, branch: @options.base_branch)
-      patch_branch_details = make_branch_details(config: @options.patch_config, branch: @options.patch_branch)
+      base_branch_details = create_pmd_report(config: @options.base_config, branch: @options.base_branch)
+      patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)
 
       build_html_reports(@projects, base_branch_details, patch_branch_details)
     end
@@ -60,7 +61,7 @@ def run_online_mode
         logger.info "Using config #{@options.patch_config} which might differ from baseline"
       end
 
-      patch_branch_details = make_branch_details(config: @options.patch_config, branch: @options.patch_branch)
+      patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)
 
       base_branch_details = PmdBranchDetail.load(@options.base_branch, logger)
       build_html_reports(@projects, base_branch_details, patch_branch_details)
@@ -106,12 +107,16 @@ def run_single_mode
       logger.info "Mode: #{@options.mode}"
 
       get_projects(@options.project_list) unless @options.nil?
-      patch_branch_details = make_branch_details(config: @options.patch_config, branch: @options.patch_branch)
+      patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)
       # copy list of projects file to the patch baseline
       FileUtils.cp(@options.project_list, patch_branch_details.target_branch_project_list_path)
 
-      base_branch_details = PmdBranchDetail.load(@options.base_branch, logger)
-      build_html_reports(@projects, base_branch_details, patch_branch_details) unless @options.html_flag
+      # for creating a baseline, no html report is needed
+      return if @options.html_flag
+
+      # in single mode, we don't have a base branch, only a patch branch...
+      empty_base_branch_details = PmdBranchDetail.load('single-mode', logger)
+      build_html_reports(@projects, empty_base_branch_details, patch_branch_details)
     end
 
     def get_projects(file_path)
@@ -125,8 +130,11 @@ def summarize_diffs
       @projects.each do |project|
         diff = project.report_diff
 
-        error_total.merge!(diff.error_counts)
-        violations_total.merge!(diff.violation_counts)
+        # in case we are in single mode, there might be no diffs (only the patch branch is available)
+        unless diff.nil?
+          error_total.merge!(diff.error_counts)
+          violations_total.merge!(diff.violation_counts)
+        end
       end
 
       {
@@ -138,7 +146,7 @@ def summarize_diffs
 
     private
 
-    def make_branch_details(config:, branch:)
+    def create_pmd_report(config:, branch:)
       PmdReportBuilder.new(@projects, @options, config, branch).build
     end
   end

test/integration_test_runner.rb

@@ -27,7 +27,8 @@ def test_local_mode
 
   def test_single_mode
     argv = '-r target/repositories/pmd -m single' \
-              ' -p pmd_releases/6.7.0 -pc config/design.xml -l test/resources/project-test.xml'
+              ' -p pmd_releases/6.7.0 -pc config/design.xml' \
+              ' -l test/resources/integration_test_runner/project-list-single.xml'
 
     system("bundle exec bin/pmdtester #{argv}")
 
@@ -42,7 +43,9 @@ def test_single_mode
 
   def test_single_mode_with_html_flag_option
     argv = '-r target/repositories/pmd -m single' \
-              ' -p pmd_releases/6.7.0 -pc config/design.xml -l test/resources/project-test.xml -f'
+              ' -p pmd_releases/6.7.0 -pc config/design.xml' \
+              ' -l test/resources/integration_test_runner/project-list-single.xml' \
+              ' -f'
 
     system("bundle exec bin/pmdtester #{argv}")
 

test/resources/integration_test_runner/project-list-single.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+
+<projectlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:noNamespaceSchemaLocation="projectlist_1_1_0.xsd">
+  <description>Projects used in integration_test_runner.rb</description>
+
+  <project>
+    <name>checkstyle</name>
+    <type>git</type>
+    <connection>https://github.com/checkstyle/checkstyle</connection>
+    <tag>checkstyle-8.10</tag>
+    <exclude-pattern>.*/target/test-classes/com/puppycrawl/tools/checkstyle/.*</exclude-pattern>
+    <exclude-pattern>.*/target/generated-sources/.*</exclude-pattern>
+
+    <build-command><![CDATA[#!/usr/bin/env bash
+if test -e classpath.txt; then
+  exit
+fi
+
+set -e
+
+mvn clean test-compile
+mvn dependency:build-classpath -DincludeScope=test -Dmdep.outputFile=classpath.txt
+]]></build-command>
+    <auxclasspath-command>echo -n "$(pwd)/target/classes:$(pwd)/target/test-classes:"; cat classpath.txt</auxclasspath-command>
+  </project>
+
+  <!-- this project configuration is here, so that PMD's repo is cloned into target/repositories for integration tests -->
+  <project>
+    <name>pmd</name>
+    <type>git</type>
+    <connection>https://github.com/pmd/pmd</connection>
+    <tag>pmd_releases/6.7.0</tag> <!-- this is already the correct checkout to speed up repeated integration tests -->
+  </project>
+</projectlist>

test/test_runner.rb

@@ -12,7 +12,6 @@ def setup
 
   def run_runner(argv)
     runner = Runner.new(argv)
-    runner.expects(:summarize_diffs).once
     runner.run
   end
 
@@ -27,7 +26,22 @@ def test_single_mode
 
     argv = %w[-r target/repositories/pmd -p pmd_releases/6.1.0
               -pc config/design.xml -l test/resources/project-test.xml -m single]
-    run_runner(argv)
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
+  end
+
+  def test_single_mode_no_html
+    project_list_path = 'test/resources/project-test.xml'
+    target_project_list_path = 'target/reports/test_branch/project-list.xml'
+    PmdReportBuilder.any_instance.stubs(:build)
+                    .returns(PmdBranchDetail.new('test_branch')).once
+    FileUtils.expects(:cp).with(project_list_path, target_project_list_path).once
+
+    argv = %w[-r target/repositories/pmd -p pmd_releases/6.1.0
+              -pc config/design.xml -l test/resources/project-test.xml -m single
+              --html-flag]
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
   end
 
   def test_single_mode_multithreading
@@ -45,7 +59,8 @@ def test_single_mode_multithreading
 
     argv = %w[-r target/repositories/pmd -p pmd_releases/6.1.0
               -pc config/design.xml -l test/resources/project-test.xml -m single -t 4]
-    run_runner(argv)
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
   end
 
   def test_local_mode
@@ -55,7 +70,8 @@ def test_local_mode
 
     argv = %w[-r target/repositories/pmd -b master -bc config/design.xml -p pmd_releases/6.1.0
               -pc config/design.xml -l test/resources/project-test.xml]
-    run_runner(argv)
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
   end
 
   def test_local_mode_multithreading
@@ -72,7 +88,8 @@ def test_local_mode_multithreading
 
     argv = %w[-r target/repositories/pmd -b master -bc config/design.xml -p pmd_releases/6.1.0
               -pc config/design.xml -l test/resources/project-test.xml -t 5]
-    run_runner(argv)
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
   end
 
   def test_online_mode
@@ -92,7 +109,8 @@ def test_online_mode
     PmdReportBuilder.any_instance.stubs(:build).returns(PmdBranchDetail.new('test_branch')).once
 
     argv = %w[-r target/repositories/pmd -m online -b master -p pmd_releases/6.7.0]
-    run_runner(argv)
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
   end
 
   def test_online_mode_multithreading
@@ -114,6 +132,16 @@ def test_online_mode_multithreading
     SummaryReportBuilder.any_instance.stubs(:write_all_projects).once
 
     argv = %w[-r target/repositories/pmd -m online -b master -p pmd_releases/6.7.0 -t 3]
-    run_runner(argv)
+    summarized_results = run_runner(argv)
+    assert_summarized_diffs(summarized_results)
+  end
+
+  private
+
+  def assert_summarized_diffs(diffs)
+    refute_nil(diffs)
+    refute_nil(diffs[:errors])
+    refute_nil(diffs[:violations])
+    refute_nil(diffs[:configerrors])
   end
 end