Merge pull request #91 from adangel:filter-baseline

adangel · adangel · commit d10e25ce1faf · 2021-06-20T17:23:39.000+02:00
Filter baseline based on patch config #91
diff --git a/History.md b/History.md
@@ -7,6 +7,7 @@
 ## Fixed Issues
 
 *   [#89](https://github.com/pmd/pmd-regression-tester/pull/89): Make it possible to select a subpath of cloned directory
+*   [#91](https://github.com/pmd/pmd-regression-tester/pull/91): Filter baseline based on patch config
 
 ## External Contributions
 
diff --git a/README.rdoc b/README.rdoc
@@ -20,29 +20,30 @@ on a list of standard projects(Spring Framework, Hibernate, Solr, etc.)
 == SYNOPSIS:
 
 === Options:
-    -r, --local-git-repo     path to the local PMD repository
-    -b, --base-branch        name of the base branch in local PMD repository
-    -p, --patch-branch       name of the patch branch in local PMD repository
-    -bc, --base-config       path to the base PMD configuration file default:PMDTESTER_INSTALLED_DIR/config/all-java.xml
-    -pc, --patch-config      path to the patch PMD configuration file default:PMDTESTER_INSTALLED_DIR/config/all-java.xml
-    -c, --config             path to the base and patch PMD configuration file
-    -l, --list-of-project    path to the file which contains the list of standard projects default:PMDTESTER_INSTALLED_DIR/config/project-list.xml
-    -m, --mode               the mode of the tool: 'local', 'online' or 'single'
+    -r, --local-git-repo        path to the local PMD repository
+    -b, --base-branch           name of the base branch in local PMD repository
+    -p, --patch-branch          name of the patch branch in local PMD repository
+    -bc, --base-config          path to the base PMD configuration file
+    -pc, --patch-config         path to the patch PMD configuration file
+    -c, --config                path to the base and patch PMD configuration file
+    -l, --list-of-project       path to the file which contains the list of standard projects
+    -m, --mode                          the mode of the tool: 'local', 'online' or 'single'
           single: Set this option to 'single' if your patch branch contains changes
             for any option that can't work on master/base branch
           online: Set this option to 'online' if you want to download
             the PMD report of master/base branch rather than generating it locally
           local: Default option is 'local', PMD reports for the base and patch branches are generated locally.
 
-    -t, --threads            Sets the number of threads used by PMD. Set threads to 0 to disable multi-threading processing. default:1
-    -f, --html-flag          whether to not generate the html diff report in single mode
-    -a, --auto-gen-config    whether to generate configurations automatically based on branch differences,this option only works in online and local mode
-    --keep-reports           whether to keep old reports and skip running PMD again if possible
-    -d, --debug              whether change log level to DEBUG to see more information
-    --error-recovery         enable error recovery mode when executing PMD. Might help to analyze errors.
-    --baseline-download-url  download url prefix from where to download the baseline in online mode default:https://sourceforge.net/projects/pmd/files/pmd-regression-tester/
-    -v, --version
-    -h, --help
+    -t, --threads               Sets the number of threads used by PMD. Set threads to 0 to disable multi-threading processing.
+    -f, --html-flag             whether to not generate the html diff report in single mode
+    -a, --auto-gen-config       whether to generate configurations automatically based on branch differences,this option only works in online and local mode
+    --filter-with-patch-config  whether to use patch config to filter baseline result as if --auto-gen-config has been used. This option only works in online mode.
+    --keep-reports              whether to keep old reports and skip running PMD again if possible
+    -d, --debug                 whether change log level to DEBUG to see more information
+    --error-recovery            enable error recovery mode when executing PMD. Might help to analyze errors.
+    --baseline-download-url     download url prefix from where to download the baseline in online mode
+    -v, --version               
+    -h, --help                  
 
 === Quick start
 
diff --git a/lib/pmdtester/builders/rule_set_builder.rb b/lib/pmdtester/builders/rule_set_builder.rb
@@ -33,6 +33,10 @@ def build
       rule_refs
     end
 
+    def calculate_filter_set
+      output_filter_set(ALL_CATEGORIES)
+    end
+
     def output_filter_set(rule_refs)
       if rule_refs == ALL_CATEGORIES
         if @options.mode == Options::ONLINE
diff --git a/lib/pmdtester/parsers/options.rb b/lib/pmdtester/parsers/options.rb
@@ -29,6 +29,7 @@ class Options
     attr_reader :threads
     attr_reader :html_flag
     attr_reader :auto_config_flag
+    attr_reader :filter_with_patch_config
     attr_reader :debug_flag
     attr_accessor :filter_set
     attr_reader :keep_reports
@@ -48,6 +49,7 @@ def initialize(argv)
       @threads = options[:t]
       @html_flag = options[:f]
       @auto_config_flag = options[:a]
+      @filter_with_patch_config = options.filter_with_patch_config?
       @debug_flag = options[:d]
       @filter_set = nil
       @keep_reports = options.keep_reports?
@@ -100,6 +102,9 @@ def parse(argv)
         o.bool '-a', '--auto-gen-config',
                'whether to generate configurations automatically based on branch differences,' \
                'this option only works in online and local mode'
+        o.bool '--filter-with-patch-config',
+               'whether to use patch config to filter baseline result as if --auto-gen-config ' \
+               'has been used. This option only works in online mode.'
         o.bool '--keep-reports',
                'whether to keep old reports and skip running PMD again if possible'
         o.bool '-d', '--debug',
diff --git a/lib/pmdtester/runner.rb b/lib/pmdtester/runner.rb
@@ -59,6 +59,7 @@ def run_online_mode
         @options.patch_config = "#{baseline_path}/config.xml"
       else
         logger.info "Using config #{@options.patch_config} which might differ from baseline"
+        RuleSetBuilder.new(@options).calculate_filter_set if @options.filter_with_patch_config
       end
 
       patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)
diff --git a/test/resources/rule_set_builder/patch-ruleset.xml b/test/resources/rule_set_builder/patch-ruleset.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd" name="Dynamic PmdTester Ruleset">
+    <description>The ruleset generated by PmdTester dynamically</description>
+    <rule ref="category/java/performance.xml/ConsecutiveLiteralAppends"/>
+</ruleset>
diff --git a/test/resources/runner/master-baseline.zip b/test/resources/runner/master-baseline.zip
diff --git a/test/resources/runner/patch-config.xml b/test/resources/runner/patch-config.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd" name="Dynamic PmdTester Ruleset">
+    <description>The ruleset generated by PmdTester dynamically</description>
+    <rule ref="category/java/performance.xml/ConsecutiveLiteralAppends"/>
+</ruleset>
diff --git a/test/resources/runner/pmd_report.xml b/test/resources/runner/pmd_report.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<pmd xmlns="http://pmd.sourceforge.net/report/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/report/2.0.0 http://pmd.sourceforge.net/report_2_0_0.xsd"
+    version="6.3.0-SNAPSHOT" timestamp="2018-04-16T22:41:45.065">
+<file name="Base1.java">
+<violation beginline="51" endline="51" begincolumn="9" endcolumn="46" rule="ConsecutiveLiteralAppends" ruleset="Performance" package="org.springframework.aop" class="Pointcut" variable="TRUE" externalInfoUrl="http://pmd.sourceforge.net/snapshot/pmd_rules_java_codestyle.html#fielddeclarationsshouldbeatstartofclass" priority="3">
+  This stays in the report.
+</violation>
+<violation beginline="151" endline="151" begincolumn="9" endcolumn="46" rule="ConsecutiveLiteralAppends" ruleset="Performance" package="org.springframework.aop" class="Pointcut" variable="TRUE" externalInfoUrl="http://pmd.sourceforge.net/snapshot/pmd_rules_java_codestyle.html#fielddeclarationsshouldbeatstartofclass" priority="3">
+  This is a new violation.
+</violation>
+</file>
+</pmd>
diff --git a/test/resources/runner/project-list.xml b/test/resources/runner/project-list.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+
+<projectlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:noNamespaceSchemaLocation="projectlist_1_1_0.xsd">
+  <description>Standard Projects</description>
+
+  <project>
+    <name>checkstyle</name>
+    <type>git</type>
+    <connection>https://github.com/checkstyle/checkstyle</connection>
+    <exclude-pattern>**/src/test/resources-noncompilable/**/*</exclude-pattern>
+    <exclude-pattern>**/src/test/resources/**/*</exclude-pattern>
+    <build-command></build-command>
+    <auxclasspath-command>echo -n "$(pwd)/target/classes:"</auxclasspath-command>
+  </project>
+
+</projectlist>
diff --git a/test/test_rule_set_builder.rb b/test/test_rule_set_builder.rb
@@ -104,4 +104,16 @@ def test_filter_ruleset_single_rule_and_category_duplicated
     actual = File.read(RuleSetBuilder::PATH_TO_DYNAMIC_CONFIG)
     assert_equal(expected, actual)
   end
+
+  def test_filter_ruleset_based_on_patch_config
+    options = Options.new(['--mode', 'online',
+                           '--patch-config', "#{PATH_TO_TEST_RESOURCES}/patch-ruleset.xml",
+                           '--patch-branch', 'test_filter_ruleset_based_on_patch_branch',
+                           '--base-branch', 'main',
+                           '--local-git-repo', 'target/repositories/pmd',
+                           '--debug'])
+    RuleSetBuilder.new(options).calculate_filter_set
+
+    assert_equal(Set['performance.xml/ConsecutiveLiteralAppends'], options.filter_set)
+  end
 end
diff --git a/test/test_runner.rb b/test/test_runner.rb
@@ -136,6 +136,40 @@ def test_online_mode_multithreading
     assert_summarized_diffs(summarized_results)
   end
 
+  def test_online_mode_keep_reports_second_run_filtering
+    FileUtils.mkdir_p 'target/reports/pmd_releases_6.7.0/checkstyle'
+    # placing the baseline zip here avoid downloading it during test run - and we can craft it for the test
+    FileUtils.cp 'test/resources/runner/master-baseline.zip', 'target/reports'
+    # placing the report here avoids running PMD again - and we can craft it for the test
+    FileUtils.cp 'test/resources/runner/pmd_report.xml', 'target/reports/pmd_releases_6.7.0/checkstyle/pmd_report.xml'
+
+    # create a empty directory for PMD build to avoid building PMD during test
+    fake_pmd_bin = 'target/pmd-bin-6.7.0-pmd_releases_6.7.0-b98bd0bb961d9f82437acccfe64923d992970310'
+    FileUtils.mkdir_p fake_pmd_bin unless Dir.exist?(fake_pmd_bin)
+
+    begin
+      argv = %w[-r target/repositories/pmd -m online -b master -p pmd_releases/6.7.0
+                --list-of-project test/resources/runner/project-list.xml
+                --keep-reports --filter-with-patch-config
+                --patch-config test/resources/runner/patch-config.xml]
+      summarized_results = run_runner(argv)
+      assert_equal(0, summarized_results[:violations][:changed])
+      assert_equal(1, summarized_results[:violations][:new])
+      # while the baseline has also a violation for a different rule (AbstractClassWithoutAbstractMethod)
+      # the patch-config.xml ruleset only contains the rule ConsecutiveLiteralAppends
+      # and so does the prepared result pmd_report.xml.
+      # with "--filter-with-patch-config" the irrelevant rules from baseline are ignored
+      assert_equal(0, summarized_results[:violations][:removed])
+      # baseline has only one violation for rule ConsecutiveLiteralAppends
+      assert_equal(1, summarized_results[:violations][:base_total])
+      # patch has two violations for rule ConsecutiveLiteralAppends
+      assert_equal(2, summarized_results[:violations][:patch_total])
+    ensure
+      # cleanup
+      Dir.rmdir fake_pmd_bin if Dir.empty?(fake_pmd_bin)
+    end
+  end
+
   private
 
   def assert_summarized_diffs(diffs)
