Class: PmdTester::Runner

Inherits:
Object
  • Object
show all
Includes:
PmdTesterUtils
Defined in:
lib/pmdtester/runner.rb

Overview

The Runner is a class responsible of organizing all PmdTester modules and running the PmdTester

Constant Summary

Constants included from PmdTester

BASE, PATCH, PR_NUM_ENV_VAR, VERSION

Instance Method Summary collapse

Methods included from PmdTesterUtils

#build_html_reports, #build_report_diff, #compute_project_diffs, #parse_pmd_report

Methods included from PmdTester

#logger, logger

Constructor Details

#initialize(argv) ⇒ Runner

Returns a new instance of Runner.



9
10
11
 
# File 'lib/pmdtester/runner.rb', line 9

def initialize(argv)
  @options = Options.new(argv)
end

Instance Method Details

#clean ⇒ Object 



28
29
30
31
 
# File 'lib/pmdtester/runner.rb', line 28

def clean
  clean_target = 'target/reports'
  FileUtils.remove_dir(clean_target) if Dir.exist?(clean_target)
end

#determine_project_list_for_online_mode(baseline_path) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/pmdtester/runner.rb', line 75

def determine_project_list_for_online_mode(baseline_path)
  # patch branch build pmd report with same list of projects as base branch
  # if not specified otherwise. This allows to use a different project list
  # than used for creating the baseline. Use with care, though
  if @options.project_list == Options::DEFAULT_LIST_PATH
    project_list = "#{baseline_path}/project-list.xml"
  else
    logger.info "Using project list #{@options.project_list} which might differ from baseline"
    project_list = @options.project_list
  end
  project_list
end

#download_baseline(url_prefix, branch_name) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/pmdtester/runner.rb', line 88

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(url_prefix, zip_filename)
  logger.info "Downloading baseline for branch #{branch_name} from #{url}"
  wget_cmd = "wget --timestamping #{url}"
  unzip_cmd = "unzip -qo #{zip_filename}"

  Dir.chdir(target_path) do
    Cmd.execute_successfully(wget_cmd) unless File.exist?(zip_filename)
    Cmd.execute_successfully(unzip_cmd)
  end

  "#{target_path}/#{branch_filename}"
end

#get_baseline_url(url_prefix, zip_filename) ⇒ Object 



107
108
109
 
# File 'lib/pmdtester/runner.rb', line 107

def get_baseline_url(url_prefix, zip_filename)
  "#{url_prefix}#{zip_filename}"
end

#get_projects(file_path) ⇒ Object 



127
128
129
 
# File 'lib/pmdtester/runner.rb', line 127

def get_projects(file_path)
  @projects = ProjectsParser.new.parse(file_path)
end

#run ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/pmdtester/runner.rb', line 13

def run
  clean unless @options.keep_reports

  case @options.mode
  when Options::LOCAL
    run_local_mode
  when Options::ONLINE
    run_online_mode
  when Options::SINGLE
    run_single_mode
  end

  summarize_diffs
end

#run_local_mode ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/pmdtester/runner.rb', line 33

def run_local_mode
  logger.info "Mode: #{@options.mode}"
  get_projects(@options.project_list) unless @options.nil?
  if @options.auto_config_flag
    run_required = RuleSetBuilder.new(@options).build?
    logger.debug "Run required: #{run_required}"
    return unless run_required
  end

  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

#run_online_mode ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/pmdtester/runner.rb', line 48

def run_online_mode
  logger.info "Mode: #{@options.mode}"

  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)

  if @options.auto_config_flag
    logger.info 'Autogenerating a dynamic ruleset based on source changes'
    return unless RuleSetBuilder.new(@options).build?
  elsif @options.patch_config == Options::DEFAULT_CONFIG_PATH
    # patch branch build pmd reports with same configuration as base branch
    # if not specified otherwise. This allows to use a different config (e.g. less rules)
    # than used for creating the baseline. Use with care, though
    @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)

  base_branch_details = PmdBranchDetail.load(@options.base_branch, logger)
  build_html_reports(@projects, base_branch_details, patch_branch_details, @options.filter_set)
end

#run_single_mode ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/pmdtester/runner.rb', line 111

def run_single_mode
  logger.info "Mode: #{@options.mode}"

  get_projects(@options.project_list) unless @options.nil?
  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)

  # 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

#summarize_diffs ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/pmdtester/runner.rb', line 131

def summarize_diffs
  error_total = RunningDiffCounters.new(0)
  violations_total = RunningDiffCounters.new(0)
  configerrors_total = RunningDiffCounters.new(0)

  @projects.each do |project|
    diff = project.report_diff

    # in case we are in single mode, there might be no diffs (only the patch branch is available)
    next if diff.nil?

    error_total.merge!(diff.error_counts)
    violations_total.merge!(diff.violation_counts)
    configerrors_total.merge!(diff.configerror_counts)
  end

  {
    errors: error_total.to_h,
    violations: violations_total.to_h,
    configerrors: configerrors_total.to_h
  }
end