Class: PmdTester::PmdReportBuilder

Inherits:
Object
  • Object
show all
Includes:
PmdTester
Defined in:
lib/pmdtester/builders/pmd_report_builder.rb

Overview

Building pmd xml reports according to a list of standard projects and branch of pmd source code

Constant Summary

Constants included from PmdTester

BASE, PATCH, PR_NUM_ENV_VAR, VERSION

Instance Method Summary collapse

Methods included from PmdTester

#logger, logger

Constructor Details

#initialize(projects, options, branch_config, branch_name) ⇒ PmdReportBuilder

Returns a new instance of PmdReportBuilder.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 12

def initialize(projects, options, branch_config, branch_name)
  @projects = projects
  @local_git_repo = options.local_git_repo
  @threads = options.threads
  @error_recovery = options.error_recovery
  @branch_config = branch_config
  @pmd_branch_name = branch_name
  @pwd = Dir.getwd

  @pmd_branch_details = PmdBranchDetail.new(@pmd_branch_name)
  @project_builder = ProjectBuilder.new(@projects)
end

Instance Method Details

#build ⇒ Object

returns the branch details



158
159
160
161
162
163
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 158

def build
  @project_builder.clone_projects
  @project_builder.build_projects
  get_pmd_binary_file
  generate_pmd_reports
end

#build_pmd(into_dir:) ⇒ Object

builds pmd on currently checked out branch



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 53

def build_pmd(into_dir:)
  # in CI there might have been a build performed already. In that case
  # we reuse the build result, otherwise we build PMD freshly
  pmd_dist_target = "pmd-dist/target/pmd-bin-#{@pmd_version}.zip"
  binary_exists = File.exist?(pmd_dist_target)
  logger.debug "#{@pmd_branch_name}: Does the file #{pmd_dist_target} exist? #{binary_exists} (cwd: #{Dir.getwd})"
  if binary_exists
    # that's a warning, because we don't know, whether this build really
    # belongs to the current branch or whether it's from a previous branch.
    # In CI, that's not a problem, because the workspace is always fresh.
    logger.warn "#{@pmd_branch_name}: Reusing already existing #{pmd_dist_target}"
  else
    logger.info "#{@pmd_branch_name}: Building PMD #{@pmd_version}..."
    package_cmd = './mvnw clean package' \
                  ' -Dmaven.test.skip=true' \
                  ' -Dmaven.javadoc.skip=true' \
                  ' -Dmaven.source.skip=true' \
                  ' -Dcheckstyle.skip=true' \
                  ' -Dpmd.skip=true' \
                  ' -T1C -B'
    Cmd.execute(package_cmd)
  end

  logger.info "#{@pmd_branch_name}: Extracting the zip"
  Cmd.execute("unzip -qo #{pmd_dist_target} -d pmd-dist/target/exploded")
  Cmd.execute("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version} #{into_dir}")
end

#determine_pmd_version ⇒ Object 



81
82
83
84
85
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 81

def determine_pmd_version
  version_cmd = "./mvnw -q -Dexec.executable=\"echo\" -Dexec.args='${project.version}' " \
                '--non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec'
  Cmd.execute(version_cmd)
end

#generate_config_for(project) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 118

def generate_config_for(project)
  logger.debug "Generating ruleset with excludes from #{@branch_config}"
  doc = Nokogiri::XML(File.read(@branch_config))
  ruleset = doc.at_css('ruleset')
  ruleset.add_child("\n")
  project.exclude_patterns.each do |exclude_pattern|
    ruleset.add_child("    <exclude-pattern>#{exclude_pattern}</exclude-pattern>\n")
  end

  File.open(project.get_config_path(@pmd_branch_name), 'w') do |x|
    x << doc.to_s
  end

  logger.debug "Created file #{project.get_config_path(@pmd_branch_name)}"
end

#generate_pmd_report(project) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 97

def generate_pmd_report(project)
  error_recovery_options = @error_recovery ? 'PMD_JAVA_OPTS="-Dpmd.error_recovery -ea" ' : ''
  run_path = "#{saved_distro_path(@pmd_branch_details.branch_last_sha)}/bin/run.sh"
  fail_on_violation = should_use_long_cli_options ? '--fail-on-violation false' : '-failOnViolation false'
  pmd_cmd = "#{error_recovery_options}" \
            "#{run_path} pmd -d #{project.local_source_path} -f xml " \
            "-R #{project.get_config_path(@pmd_branch_name)} " \
            "-r #{project.get_pmd_report_path(@pmd_branch_name)} " \
            "#{fail_on_violation} -t #{@threads} " \
            "#{project.auxclasspath}"
  start_time = Time.now
  if File.exist?(project.get_pmd_report_path(@pmd_branch_name))
    logger.warn "#{@pmd_branch_name}: Skipping PMD run - report " \
                "#{project.get_pmd_report_path(@pmd_branch_name)} already exists"
  else
    Cmd.execute(pmd_cmd)
  end
  end_time = Time.now
  [end_time - start_time, end_time]
end

#generate_pmd_reports ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 134

def generate_pmd_reports
  logger.info "Generating PMD report started -- branch #{@pmd_branch_name}"

  sum_time = 0
  @projects.each do |project|
    progress_logger = SimpleProgressLogger.new("generating #{project.name}'s PMD report")
    progress_logger.start
    generate_config_for(project)
    execution_time, end_time = generate_pmd_report(project)
    progress_logger.stop
    sum_time += execution_time

    report_details = PmdReportDetail.new(execution_time: execution_time, timestamp: end_time)
    report_details.save(project.get_report_info_path(@pmd_branch_name))
    logger.info "#{project.name}'s PMD report was generated successfully"
  end

  @pmd_branch_details.execution_time = sum_time
  @pmd_branch_details.save
  FileUtils.cp(@branch_config, @pmd_branch_details.target_branch_config_path)
  @pmd_branch_details
end

#get_last_commit_message ⇒ Object 



92
93
94
95
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 92

def get_last_commit_message
  get_last_commit_message_cmd = 'git log -1 --pretty=%B'
  Cmd.execute(get_last_commit_message_cmd)
end

#get_last_commit_sha ⇒ Object 



87
88
89
90
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 87

def get_last_commit_sha
  get_last_commit_sha_cmd = 'git rev-parse HEAD^{commit}'
  Cmd.execute(get_last_commit_sha_cmd)
end

#get_pmd_binary_file ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/pmdtester/builders/pmd_report_builder.rb', line 25

def get_pmd_binary_file
  logger.info "#{@pmd_branch_name}: Start packaging PMD"
  Dir.chdir(@local_git_repo) do
    build_branch_sha = Cmd.execute("git rev-parse #{@pmd_branch_name}^{commit}")

    checkout_build_branch # needs a clean working tree, otherwise fails

    raise "Wrong branch #{get_last_commit_sha}" unless build_branch_sha == get_last_commit_sha

    distro_path = saved_distro_path(build_branch_sha)
    logger.debug "#{@pmd_branch_name}: PMD Version is #{@pmd_version} " \
                 "(sha=#{build_branch_sha})"
    logger.debug "#{@pmd_branch_name}: distro_path=#{distro_path}"
    if File.directory?(distro_path)
      logger.info "#{@pmd_branch_name}: Skipping packaging - saved version exists " \
                  " in #{distro_path}"
    else
      build_pmd(into_dir: distro_path)
    end

    # we're still on the build branch
    @pmd_branch_details.branch_last_sha = build_branch_sha
    @pmd_branch_details.branch_last_message = get_last_commit_message
  end
  logger.info "#{@pmd_branch_name}: Packaging PMD completed"
end