Merge pull request #79 from adangel/pmd-regression-tester:download-url

Add new configuration option "--baseline-download-url" #79

Author: adangel

History.md

@@ -17,6 +17,7 @@ Typeresolution is now supported by two new tags in the project-list.xml file:
 *   [#74](https://github.com/pmd/pmd-regression-tester/pull/74): Merge violations that have just changed messages
 *   [#75](https://github.com/pmd/pmd-regression-tester/pull/75): Add new option "--error-recovery"
 *   [#76](https://github.com/pmd/pmd-regression-tester/pull/76): Speedup XML parsing
+*   [#79](https://github.com/pmd/pmd-regression-tester/pull/79): Add new configuration option "--baseline-download-url"
 
 ## External Contributions
 

README.rdoc

@@ -20,26 +20,27 @@ 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 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'
           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.
+    -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
 

lib/pmdtester/parsers/options.rb

@@ -16,6 +16,7 @@ class Options
     SINGLE = 'single'
     DEFAULT_CONFIG_PATH = ResourceLocator.locate('config/all-java.xml')
     DEFAULT_LIST_PATH = ResourceLocator.locate('config/project-list.xml')
+    DEFAULT_BASELINE_URL_PREFIX = 'https://sourceforge.net/projects/pmd/files/pmd-regression-tester/'
 
     attr_reader :local_git_repo
     attr_reader :base_branch
@@ -32,6 +33,7 @@ class Options
     attr_accessor :filter_set
     attr_reader :keep_reports
     attr_reader :error_recovery
+    attr_reader :baseline_download_url_prefix
 
     def initialize(argv)
       options = parse(argv)
@@ -50,6 +52,12 @@ def initialize(argv)
       @filter_set = nil
       @keep_reports = options.keep_reports?
       @error_recovery = options.error_recovery?
+      url = options[:baseline_download_url]
+      @baseline_download_url_prefix = if url[-1] == '/'
+                                        url
+                                      else
+                                        "#{url}/"
+                                      end
 
       # if the 'config' option is selected then `config` overrides `base_config` and `patch_config`
       @base_config = @config if !@config.nil? && @mode == 'local'
@@ -98,6 +106,9 @@ def parse(argv)
                'whether change log level to DEBUG to see more information'
         o.bool '--error-recovery',
                'enable error recovery mode when executing PMD. Might help to analyze errors.'
+        o.string '--baseline-download-url',
+                 'download url prefix from where to download the baseline in online mode',
+                 default: DEFAULT_BASELINE_URL_PREFIX
         o.on '-v', '--version' do
           puts VERSION
           exit

lib/pmdtester/runner.rb

@@ -47,7 +47,7 @@ def run_local_mode
     def run_online_mode
       logger.info "Mode: #{@options.mode}"
 
-      baseline_path = download_baseline(@options.base_branch)
+      baseline_path = download_baseline(@options.baseline_download_url_prefix, @options.base_branch)
 
       project_list = determine_project_list_for_online_mode(baseline_path)
       get_projects(project_list)
@@ -83,13 +83,13 @@ def determine_project_list_for_online_mode(baseline_path)
       project_list
     end
 
-    def download_baseline(branch_name)
+    def download_baseline(url_prefix, branch_name)
       branch_filename = PmdBranchDetail.branch_filename(branch_name)
       zip_filename = "#{branch_filename}-baseline.zip"
       target_path = 'target/reports'
       FileUtils.mkdir_p(target_path) unless File.directory?(target_path)
 
-      url = get_baseline_url(zip_filename)
+      url = get_baseline_url(url_prefix, zip_filename)
       wget_cmd = "wget --timestamping #{url}"
       unzip_cmd = "unzip -qo #{zip_filename}"
 
@@ -101,8 +101,8 @@ def download_baseline(branch_name)
       "#{target_path}/#{branch_filename}"
     end
 
-    def get_baseline_url(zip_filename)
-      "https://sourceforge.net/projects/pmd/files/pmd-regression-tester/#{zip_filename}"
+    def get_baseline_url(url_prefix, zip_filename)
+      "#{url_prefix}#{zip_filename}"
     end
 
     def run_single_mode

test/test_options.rb

@@ -38,9 +38,22 @@ def test_default_value
     assert_equal(Options::DEFAULT_CONFIG_PATH, opts.base_config)
     assert_equal(Options::DEFAULT_CONFIG_PATH, opts.patch_config)
     assert_equal(Options::DEFAULT_LIST_PATH, opts.project_list)
+    assert_equal(Options::DEFAULT_BASELINE_URL_PREFIX, opts.baseline_download_url_prefix)
     assert_false(opts.error_recovery)
   end
 
+  def test_download_url_with_trailing_slash
+    command_line = %w[-r /path/to/repo -b pmd_releases/6.2.0 -p master --baseline-download-url https://example.com/]
+    opts = Options.new(command_line)
+    assert_equal('https://example.com/', opts.baseline_download_url_prefix)
+  end
+
+  def test_download_url_without_trailing_slash
+    command_line = %w[-r /path/to/repo -b pmd_releases/6.2.0 -p master --baseline-download-url https://example.com]
+    opts = Options.new(command_line)
+    assert_equal('https://example.com/', opts.baseline_download_url_prefix)
+  end
+
   def test_enable_error_recovery
     command_line = %w[-r /path/to/repo -b pmd_releases/6.2.0 -p master --error-recovery]
     opts = Options.new(command_line)