Merge branch 'pr-24'

Author: adangel

.rubocop_todo.yml

@@ -1,32 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-04 23:39:08 +0800 using RuboCop version 0.56.0.
+# on 2018-07-12 16:57:46 +0800 using RuboCop version 0.56.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 18
+# Offense count: 22
 Metrics/AbcSize:
   Max: 47
 
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 173
+  Max: 174
 
 # Offense count: 33
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 32
+  Max: 35
 
 # Offense count: 5
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/pmdtester/builders/pmd_report_builder.rb'
     - 'lib/pmdtester/parsers/projects_parser.rb'
-
-# Offense count: 1
-Style/MixinUsage:
-  Exclude:
-    - 'lib/pmdtester/builders/pmd_report_builder.rb'

History.md

@@ -28,3 +28,4 @@
 *   [#21](https://github.com/pmd/pmd-regression-tester/pull/21): Add auto-gen-config option for PmdTester - [BBG](https://github.com/djydewang)
 *   [#22](https://github.com/pmd/pmd-regression-tester/pull/22): Add 'introduce new errors' table head for html summary report - [BBG](https://github.com/djydewang)
 *   [#23](https://github.com/pmd/pmd-regression-tester/pull/23): Preparing for the release of PmdTester - [BBG](https://github.com/djydewang)
+*   [#24](https://github.com/pmd/pmd-regression-tester/pull/24): Adding a logging framework for PmdTester - [BBG](https://github.com/djydewang)

Manifest.txt

@@ -13,6 +13,7 @@ config/design.xml
 config/project-list.xml
 config/project_list.txt
 config/projectlist_1_0_0.xsd
+lib/pmdtester/pmdtester.rb
 lib/pmdtester/builders/diff_builder.rb
 lib/pmdtester/builders/diff_report_builder.rb
 lib/pmdtester/builders/html_report_builder.rb

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 require 'rake/testtask'
 require 'rubocop/rake_task'

bin/pmdtester

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../lib/pmdtester/runner'
 
 runner = PmdTester::Runner.new(ARGV)

lib/pmdtester/builders/diff_report_builder.rb

@@ -6,6 +6,7 @@
 module PmdTester
   # Building diff report for a single project
   class DiffReportBuilder < HtmlReportBuilder
+    include PmdTester
     NO_DIFFERENCES_MESSAGE = 'No differences found!'
 
     def build(project)
@@ -20,7 +21,7 @@ def build(project)
       index.puts html_report
       index.close
 
-      puts "Built difference report of #{project.name} successfully!"
+      logger.info "Built difference report of #{project.name} successfully!"
     end
 
     def build_body(doc)

lib/pmdtester/builders/pmd_report_builder.rb

@@ -6,11 +6,11 @@
 require_relative '../pmd_branch_detail'
 require_relative '../pmd_report_detail'
 
-include PmdTester
 module PmdTester
   # Building pmd xml reports according to a list of standard
   # projects and branch of pmd source code
   class PmdReportBuilder
+    include PmdTester
     def initialize(branch_config, projects, local_git_repo, pmd_branch_name)
       @branch_config = branch_config
       @projects = projects
@@ -27,32 +27,33 @@ def execute_reset_cmd(type, tag)
         reset_cmd = "git reset --hard #{tag}"
       when 'hg'
         reset_cmd = "hg up #{tag}"
-      else
-        raise Exception, "Unknown #{type} repository"
       end
 
       Cmd.execute(reset_cmd)
     end
 
     def get_projects
-      puts 'Cloning projects started'
+      logger.info 'Cloning projects started'
 
       @projects.each do |project|
+        logger.info "Start cloning #{project.name} repository"
         path = project.local_source_path
         clone_cmd = "#{project.type} clone #{project.connection} #{path}"
         if File.exist?(path)
-          puts "Skipping clone, project path #{path} already exists"
+          logger.warn "Skipping clone, project path #{path} already exists"
         else
           Cmd.execute(clone_cmd)
         end
 
         Dir.chdir(path) do
           execute_reset_cmd(project.type, project.tag)
         end
+        logger.info "Cloning #{project.name} completed"
       end
     end
 
     def get_pmd_binary_file
+      logger.info 'Start packaging PMD'
       Dir.chdir(@local_git_repo) do
         checkout_cmd = "git checkout #{@pmd_branch_name}"
         Cmd.execute(checkout_cmd)
@@ -71,6 +72,7 @@ def get_pmd_binary_file
         unzip_cmd = "unzip -qo pmd-dist/target/pmd-bin-#{@pmd_version}.zip -d #{@pwd}/target"
         Cmd.execute(unzip_cmd)
       end
+      logger.info 'Packaging PMD completed'
     end
 
     def get_last_commit_sha
@@ -94,11 +96,12 @@ def generate_pmd_report(src_root_dir, report_file)
     end
 
     def generate_pmd_reports
-      puts "Generating pmd Report started -- branch #{@pmd_branch_name}"
+      logger.info "Generating PMD report started -- branch #{@pmd_branch_name}"
       get_pmd_binary_file
 
       sum_time = 0
       @projects.each do |project|
+        logger.info "Generating #{project.name}'s PMD report'"
         execution_time, end_time =
           generate_pmd_report(project.local_source_path,
                               project.get_pmd_report_path(@pmd_branch_name))
@@ -108,6 +111,7 @@ def generate_pmd_reports
         report_details.execution_time = execution_time
         report_details.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

lib/pmdtester/builders/rule_set_builder.rb

@@ -4,11 +4,13 @@
 require 'set'
 require_relative '../cmd'
 require_relative '../resource_locator'
+
 module PmdTester
   # This class is responsible for generation dynamic configuration
   # according to the difference between base and patch branch of Pmd.
   # Attention: we only consider java rulesets now.
   class RuleSetBuilder
+    include PmdTester
     ALL_RULE_SETS = Set['bestpractices', 'codestyle', 'design', 'documentation',
                         'errorprone', 'multithreading', 'performance', 'security'].freeze
     PATH_TO_PMD_JAVA_BASED_RULES =
@@ -28,6 +30,7 @@ def build
       rule_sets = get_rule_sets(filenames)
       output_filter_set(rule_sets)
       build_config_file(rule_sets)
+      logger.debug "Dynamic configuration: #{[rule_sets]}"
     end
 
     def output_filter_set(rule_sets)

lib/pmdtester/builders/summary_report_builder.rb

@@ -6,6 +6,7 @@
 module PmdTester
   # Building summary report to show the details about projects and pmd branchs
   class SummaryReportBuilder < HtmlReportBuilder
+    include PmdTester
     REPORT_DIR = 'target/reports/diff'
     BASE_CONFIG_PATH = 'target/reports/diff/base_config.xml'
     PATCH_CONFIG_PATH = 'target/reports/diff/patch_config.xml'
@@ -25,7 +26,7 @@ def build(projects, base_name, patch_name)
       index.puts html_report
       index.close
 
-      puts 'Built summary report successfully!'
+      logger.info 'Built summary report successfully!'
     end
 
     def get_branch_details(branch_name)

lib/pmdtester/cmd.rb

@@ -5,20 +5,36 @@
 module PmdTester
   # Containing the common method for executing shell command
   class Cmd
+    extend PmdTester
     def self.execute(cmd)
-      puts cmd
+      logger.debug "execute command '#{cmd}'"
 
       stdout, stderr, status = Open3.capture3("#{cmd};")
 
+      logger.debug stdout
       unless status.success?
-        puts stdout
-        puts stderr
-        exit(status.exitstatus)
+        logger.error stderr
+        raise CmdException.new(cmd, stderr)
       end
 
       stdout&.chomp!
 
       stdout
     end
   end
+
+  # The exception should be raised when the shell command failed.
+  class CmdException < StandardError
+    attr_reader :cmd
+    attr_reader :error
+    attr_reader :message
+
+    COMMON_MSG = 'An error occurred while executing the shell command'
+
+    def initialize(cmd, error)
+      @cmd = cmd
+      @error = error
+      @message = "#{COMMON_MSG} '#{cmd}'"
+    end
+  end
 end