fastlane-plugin-code_static_analyzer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31ca64424721af47394fb63b3f00532811b84bdf
-  data.tar.gz: e12379d050bad5565564d5402ab6b7517b8594a9
+  metadata.gz: f27b577db79a18a272cb128f635addb0ac1d4740
+  data.tar.gz: 292c5593392ca861eb7915ce1cbdd5bc52f45e8d
 SHA512:
-  metadata.gz: b7925823d710984f81d6b483aa41a010325475e68ecf9792fe6ce79a19e70de027170c7950d18565483b6ac16d6f29ef44b4a39b566cc2c687cd4d108c483b3b
-  data.tar.gz: 5c3fde6b0c8e7179ca53ea4952ff8f1c7fdddc242d79e6d6a598e85f5c22f46fa7cf879d1f812e73ce096caf7ca1545f7c91ae11d916bdc288d1764fe4edac24
+  metadata.gz: be0c3524e9f856179ac50ef7116d22e1a9ca59e3eb6f7b223b789693d324c45e852d86f49d09c9950fa8c61bcdcc14d875adb668d2b10eb3aa9dcb551e306258
+  data.tar.gz: 11a075f75f5d5431ef10682cca0bb0f1ba8227f0f9e71a77af1dde540f5ae83bcc33fd8aaba73534a28bac8955d78d497aa456cb178bf274e199fdd200ee9472

data/README.md

@@ -16,7 +16,8 @@ This plugins runs different Static Analyzers for checking your code on warnings,
 Each analyzer in this plugin generate separate report `codeAnalysResult_<name of analyzer>.xml` and 
 save result status in shared values `<NAME>_ANALYZER_STATUS`: 0 - code is clear, any other value - code include warnings/errors.
 Finally you can check plugin return value (true='code is clear'/false) to decide what to do next. <br />
-All reports are generated in JUnit format for easier start-up at the CI servers.
+All reports are generated in JUnit format for easier start-up at the CI servers.<br />
+This plugin can be used in pair with CI static code analysis plugins. Check out the `Using CI plugins` section.
 
 ## Important
 - You can configure rubocop analyzer by creating configuration file `.rubocop.yml` in your project (more about rubocop configuration http://rubocop.readthedocs.io/en/latest/cops/)
@@ -25,7 +26,7 @@ All reports are generated in JUnit format for easier start-up at the CI servers.
 ### Specific for copy paste analyzer (CPD)
 - PMD have to be installed on your machine (http://pmd.sourceforge.net/snapshot/usage/installing.html)
 - [!]Pay attention on language parameter: if your code language is available in supported list you have to set this parameter.
- 
+
 ## Actions
 
 `code_static_analyzer` - runs all configured analyzers together (Copy paste analyzer always runs).<br />
@@ -56,7 +57,8 @@ code_static_analyzer(
       xcode_project_name: 'path/to/TestProject',
       xcode_workspace_name: 'path/to/testWorkspace',
       xcode_targets: ['TPClientTarget','TPServerTarget'],
-      ruby_files: 'fastlane/Fastfile'
+      ruby_files: 'fastlane/Fastfile',
+      disable_junit: 'all' # don't create any results in JUnit format
     )
 ````
 Parameter | Description
@@ -71,6 +73,7 @@ Parameter | Description
 `xcode_workspace_name`| *(optional)* Xcode workspace name in work directory. Set it if you use different project & workspace names
 `xcode_targets` | *(optional)* List of Xcode targets to inspect. By default used all targets which are available in project
 `ruby_files` | *(optional)* List of paths to ruby files to be inspected 
+`disable_junit` | *(optional)* List of analysers for which you want to disable results in JUnit format.<br />Supported analyzers: "xcodeWar", "rubocop", "CPD", "all"<br />By default all results will be created in JUnit format.
 
 ### `code_static_analyzer` other examples (full configuration):
 CPD:
@@ -93,7 +96,8 @@ code_static_analyzer(
       cpd_language: 'objectivec',
       cpd_files_to_inspect: %w('path/to/myFiles/' 'path/to/testFiles/'),
       cpd_files_to_exclude: %w('Pods' 'ThirdParty'),
-      ruby_files: 'fastlane/Fastfile'
+      ruby_files: 'fastlane/Fastfile',
+      disable_junit: 'CPD' # results of rubocop analyzer - in JUnit format, CPD analyzer - not in JUnit format
     )
 ````
 CPD + Xcode project warnings:
@@ -110,24 +114,17 @@ code_static_analyzer(
       xcode_targets: ['TPClientTarget','TPServerTarget'],
     )
 ````
+## Using CI plugins
 
-## Run tests for this plugin
-
-To run both the tests, and code style validation, run
-
-```
-rake
-```
-
-To automatically fix many of the styling issues, use
-```
-rubocop -a
-```
+If you want to use CI static code analysis plugins pay attention on type of file which they use. 
+Commonly CI static code analysis plugins don't scan files in JUnit format, so you need to `disable usage of results in JUnit format` (especially for ruby analyzer).
+After that each analyzer in this plugin will generate separate report(s):
+CPD analyzer - `cpd.xml`; Ruby analyzer - `ruby.log`; Warning analyzer - `warnings_<target name>.log`
 
 ## Issues and Feedback
 
 - In some cases CPD can't recognize patterns in file/dir paths like `path/to/files/*.m`
-(about path you may read in CPD documentation: http://pmd.sourceforge.net/snapshot/usage/cpd-usage.html)<br />
+(about path you may read in [CPD documentation](http://pmd.sourceforge.net/snapshot/usage/cpd-usage.html)).<br />
 For any other issues and feedback about this plugin, please submit it to this repository.
 
 ## Troubleshooting

data/lib/assets/junit_parser.rb

@@ -59,7 +59,7 @@ module JunitParser
   end
 
   def self.construct_failure_mes(attributes, values)
-    properties = xml_level(0).to_s
+    properties = ''
     attributes.each_with_index do |property, index|
       value = values[index]
       properties += format("#{xml_level(4)}%-18s: %s", property, value) unless value.nil?
@@ -104,34 +104,57 @@ module JunitParser
   def self.parse_xcode_log(file, project, is_warn)
     if is_warn
       error_text = ''
+      temp_testcase = ''
       File.open(file).each do |line|
-        if line =~ /warning:|error:/
+        if line =~ /warning:|error:|BCEROR/
+        failure_type = get_failure_type(line)
           warning_params = line.split(':')
           if warning_params.count == 5
-            error_text += construct_failure_mes(
-              ['Error ClassType', 'Error in File', 'Error Line', 'Error Message'],
-              [get_failure_type(warning_params[4]), warning_params[0].tr('<', '').tr('>', ''),
-               "#{warning_params[1]}:#{warning_params[2]}", warning_params[4].tr("\n", '')]
+             error_text = construct_failure_mes(
+              ['Error ClassType', 'Error Message'],
+              [failure_type, warning_params[4].tr("\n", '')]
             )
+            testcase_name = project+':'+warning_params[0].tr('<', '').tr('>', '')+
+               ":#{warning_params[1]}:#{warning_params[2]}"
           else
-            error_text += construct_failure_mes(
+            error_text = construct_failure_mes(
               ['Error ClassType', 'Error Message'],
-              ['-W', line.tr("\n", '')]
+              [failure_type, line.tr("\n", '').gsub('warning:','')]
             )
+            testcase_name = project
+            testcase_name += ':project configuration' if line =~ /BCEROR/
+            file_info = check_for_file_info(warning_params)
+            testcase_name += ":#{file_info[0]}" unless file_info[0]==nil
+            testcase_name += ":#{file_info[1]}" unless file_info[1]==nil
           end
+          failures = add_failure('', '', error_text)
+          temp_testcase += add_failed_testcase(testcase_name, failures)
         end
-        next unless line =~ /BCEROR/
-        error_text += construct_failure_mes(['Error ClassType', 'Error in File', 'Error Message'],
-                                            [get_failure_type(line), 'project configuration',
-                                             line.tr("\n", '')])
       end
-      failures = add_failure('', '', error_text)
-      add_failed_testcase(project, failures)
+      temp_testcase
     else
       add_success_testcase(project)
     end
   end
-
+  
+  def self.check_for_file_info(text_list)
+    result =[]
+    text_list.each_with_index do |text, i|
+      file = /([a-zA-Z0-9\.]*)?(\/[a-zA-Z0-9\._-]+)*(\.){1}[a-zA-Z0-9\._-]+/.match(text)
+      file = nil if file.to_s =~ /\.{2,}/
+      unless file==nil 
+        next_value=text_list.to_a[i.to_i+1].nil? ? '' : text_list.to_a[i.to_i+1]
+     	line = /[0-9]+/.match(next_value)
+     	if line ==nil
+     	  result=[file]
+     	else
+     	  result=[file, line]
+     	end
+     	break
+      end 
+    end
+    result
+  end
   #####################################################
   # ============== Rubocop-json Parser ================
   #####################################################

data/lib/fastlane/plugin/code_static_analyzer/actions/code_static_analyzer_action.rb

@@ -24,7 +24,15 @@ module Fastlane
         xcode_project = params[:xcode_project_name]
         xcode_workspace = params[:xcode_workspace_name]
         xcode_targets = params[:xcode_targets]
-        # use additional checks for optional parameters, but required in specific analyzer
+        
+        # use additional checks for optional parameters, but required in specific analyzer     
+        exclude_junit = params[:disable_junit]
+        if exclude_junit
+          exclude_junit.each do |exclude_from|
+            UI.error "disable_junit parameter is partly skipped: the analyzer '#{exclude_from}' is not supported.  Supported analyzers: #{SUPPORTED_ANALYZER}, 'all'" unless SUPPORTED_ANALYZER.map(&:downcase).include? exclude_from.downcase or exclude_from == 'all'
+          end
+        exclude_junit = SUPPORTED_ANALYZER  if exclude_junit[0] == 'all'
+        end                  
         analyzers.each do |analyzer|
           case analyzer.downcase
           when 'xcodewar'
@@ -43,8 +51,10 @@ module Fastlane
         sh "rm -rf #{clear_all_files}"
 
         # Run alyzers
+        use_junit = is_include(exclude_junit, "cpd") ? false : true
         status_cpd = Actions::CpdAnalyzerAction.run(
           result_dir: params[:result_dir],
+          use_junit_format: use_junit,
           tokens: params[:cpd_tokens],
           language: params[:cpd_language],
           cpd_files_to_inspect: params[:cpd_files_to_inspect],
@@ -53,24 +63,28 @@ module Fastlane
         analyzers.each do |analyzer|
           case analyzer.downcase
           when 'xcodewar'
+            use_junit = is_include(exclude_junit, "xcodewar") ? false : true
             if platform != "android"
               status_static = Actions::WarningAnalyzerAction.run(
                 result_dir: params[:result_dir],
                 xcode_project_name: xcode_project,
                 xcode_workspace_name: xcode_workspace,
-                xcode_targets: xcode_targets
+                xcode_targets: xcode_targets,
+                use_junit_format: use_junit
               )
             end
           when 'rubocop'
+            use_junit = is_include(exclude_junit, "rubocop") ? false : true
             status_rubocop = Actions::RubyAnalyzerAction.run(
               result_dir: params[:result_dir],
-              ruby_files: params[:ruby_files]
+              ruby_files: params[:ruby_files],
+              use_junit_format: use_junit
             )
           end
         end
         # sh "rm -rf #{clear_temp_files}"
 
-        create_analyzers_run_result("#{root_dir}#{params[:result_dir]}/") unless @xml_content.empty?
+        create_analyzers_run_result("#{root_dir}#{params[:result_dir]}/")
 
         if  Actions::CodeStaticAnalyzerAction.status_to_boolean(status_cpd) &&
             Actions::CodeStaticAnalyzerAction.status_to_boolean(status_static) &&
@@ -127,6 +141,16 @@ module Fastlane
         end
       end
 
+	  def self.is_include(list, value)
+	    if list
+	      list = list.map(&:downcase)
+	      value = value.downcase
+	      return (list.include? value) ? true : false 
+	    else
+	      return false
+	    end
+	  end
+	  
       def self.is_pmd_installed
         @checked_pmd = false
         begin
@@ -243,6 +267,11 @@ module Fastlane
                                     UI.user_error!("The analyzer '#{run_analyzer}' is not supported.  Supported analyzers: #{SUPPORTED_ANALYZER}, 'all'") unless SUPPORTED_ANALYZER.map(&:downcase).include? run_analyzer.downcase or run_analyzer == 'all'
                                   end
                                 end),
+          FastlaneCore::ConfigItem.new(key: :disable_junit,
+                                env_name: "FL_CSA_DISABLED_JUNIT_RESULTS",
+                                description: "List of analysers for which you want to disable results in JUnit format.  Supported analyzers: #{SUPPORTED_ANALYZER}, 'all'",
+                                optional: true,
+                                type: Array),
           FastlaneCore::ConfigItem.new(key: :result_dir,
                               env_name: "CSA_RESULT_DIR_NAME",
                               description: "Directory's name for storing  analysis results",

data/lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb

@@ -11,7 +11,6 @@ module Fastlane
         UI.header 'CPD analyzer' if Actions::CodeStaticAnalyzerAction.run_from_main_action
         Actions::CodeStaticAnalyzerAction.is_pmd_installed unless Actions::CodeStaticAnalyzerAction.checked_pmd
         work_dir = Actions::CodeStaticAnalyzerAction.work_dir
-
         # checking files for analysing
         files_to_exclude = params[:cpd_files_to_exclude]
         files_to_inspect = params[:cpd_files_to_inspect]
@@ -22,7 +21,7 @@ module Fastlane
         # prepare script and metadata for saving results
         result_dir_path = "#{work_dir}#{params[:result_dir]}"
         FileUtils.mkdir_p(result_dir_path) unless File.exist?(result_dir_path)
-        temp_result_file = "#{result_dir_path}/temp_copypaste.xml"
+        temp_result_file = "#{result_dir_path}/cpd.xml"
         result_file = "#{result_dir_path}/codeAnalysResults_cpd.xml"
         tokens = params[:tokens]
         files = Actions::CodeStaticAnalyzerAction.add_root_path(work_dir, files_to_inspect, true)
@@ -52,9 +51,12 @@ module Fastlane
           status = 43
         else
           status = 0 if File.read(temp_result_file).empty?
-          xml_content = JunitParser.parse_xml(temp_result_file)
-          junit_xml = JunitParser.add_testsuite('copypaste', xml_content)
-          JunitParser.create_junit_xml(junit_xml, result_file)
+          if params[:use_junit_format]
+   		    UI.message 'CPD analyzer generates result in JUnit format'
+            xml_content = JunitParser.parse_xml(temp_result_file)
+            junit_xml = JunitParser.add_testsuite('copypaste', xml_content)
+            JunitParser.create_junit_xml(junit_xml, result_file)
+          end
         end
         Actions.lane_context[SharedValues::CPD_ANALYZER_STATUS] = status
       end
@@ -83,6 +85,12 @@ module Fastlane
                         optional: true,
                         type: String,
                         default_value: 'artifacts'),
+          FastlaneCore::ConfigItem.new(key: :use_junit_format,
+                        env_name: "FL_CPD_ANALYZER_USE_JUNIT_RESULTS",
+                        description: "Generate results in JUnit format.",
+                        optional: true,
+                        type: BOOL,
+                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :tokens,
                         env_name: "FL_CPD_ANALYZER_TOKENS",
                         description: "The min number of words in code that is detected as copy paste",

data/lib/fastlane/plugin/code_static_analyzer/actions/ruby_analyzer.rb

@@ -18,10 +18,15 @@ module Fastlane
         # prepare script and metadata for saving results
         result_dir_path = "#{work_dir}#{params[:result_dir]}"
         FileUtils.mkdir_p(result_dir_path) unless File.exist?(result_dir_path)
-        temp_result_file = "#{result_dir_path}/temp_ruby.json"
         result_file = "#{result_dir_path}/codeAnalysResults_ruby.xml"
         files = Actions::CodeStaticAnalyzerAction.add_root_path(work_dir, files_to_inspect, true)
-        run_script = "bundle exec rubocop -f j -a #{files}"
+        if params[:use_junit_format]
+          temp_result_file = "#{result_dir_path}/ruby.json"
+          run_script = "bundle exec rubocop -f j -a #{files}"
+        else
+          temp_result_file = "#{result_dir_path}/ruby.log"
+          run_script = "bundle exec rubocop -a #{files}"
+        end
         run_script_path = File.join CodeStaticAnalyzer::ROOT, "assets/run_script.sh"
         run_script = "#{run_script_path} \"#{run_script}\" '#{temp_result_file}'"
         # use analyzer
@@ -40,9 +45,12 @@ module Fastlane
           status = 43
         else
           status = 0 if File.read(temp_result_file).empty?
-          xml_content = JunitParser.parse_json(temp_result_file)
-          junit_xml = JunitParser.add_testsuite('rubocop', xml_content)
-          JunitParser.create_junit_xml(junit_xml, result_file)
+          if params[:use_junit_format]
+   		    UI.message 'Ruby analyzer generates result in JUnit format'
+            xml_content = JunitParser.parse_json(temp_result_file)
+            junit_xml = JunitParser.add_testsuite('rubocop', xml_content)
+            JunitParser.create_junit_xml(junit_xml, result_file)
+          end
         end
         Actions.lane_context[SharedValues::RUBY_ANALYZER_STATUS] = status
       end
@@ -76,7 +84,13 @@ module Fastlane
                         env_name: "FL_RUBY_ANALYZER_FILES_TO_INSPECT",
                         description: "List of path (relative to work directory) to ruby files to be inspected",
                         optional: true,
-                        type: Array)
+                        type: Array),
+          FastlaneCore::ConfigItem.new(key: :use_junit_format,
+                        env_name: "FL_RUBY_ANALYZER_USE_JUNIT_RESULTS",
+                        description: "Generate results in JUnit format.",
+                        optional: true,
+                        type: BOOL,
+                        default_value: true)
         ]
       end
 

data/lib/fastlane/plugin/code_static_analyzer/actions/warning_analyzer.rb

@@ -31,7 +31,7 @@ module Fastlane
 
         status_static_arr = []
         xml_content = ''
-        temp_result_file = "#{result_dir_path}/temp_warnings.log"
+       # temp_result_file = "#{result_dir_path}/warnings.log"
         result_file = "#{result_dir_path}/codeAnalysResults_warning.xml"
 
         # use analyzer and collect results
@@ -39,6 +39,7 @@ module Fastlane
         project_workspace = workspace if is_workspace
         Actions::CodeStaticAnalyzerAction.start_xml_content unless Actions::CodeStaticAnalyzerAction.run_from_main_action
         targets.each do |target|
+          temp_result_file = "#{result_dir_path}/warnings_#{target}.log"
           Formatter.xcode_format(target)
           run_script = "#{run_script_path} #{project_workspace} #{target} '#{temp_result_file}' #{is_workspace}"
           FastlaneCore::CommandExecutor.execute(command: run_script.to_s,
@@ -52,7 +53,7 @@ module Fastlane
           if Dir.glob(temp_result_file).empty?
             Actions::CodeStaticAnalyzerAction.add_xml_content("#{result_dir_path}/", 'iOS Warning', temp_result_file, '')
             Actions::CodeStaticAnalyzerAction.create_analyzers_run_result("#{result_dir_path}/") unless Actions::CodeStaticAnalyzerAction.run_from_main_action
-            status_static_arr.push(1)
+            status_static_arr.push(2)
           else
             file = File.read(temp_result_file)
             UI.important "wrong profiles. Code isn't checked" if file =~ /BCEROR/
@@ -62,14 +63,17 @@ module Fastlane
             else
               status_static_arr.push(0)
             end
-            xml_content += JunitParser.parse_xcode_log(temp_result_file, target, is_warnings)
+            xml_content += JunitParser.parse_xcode_log(temp_result_file, target, is_warnings) if params[:use_junit_format]
           end
         end
 
         # prepare results
-        unless Dir.glob(temp_result_file).empty?
-          junit_xml = JunitParser.add_testsuite('xcode warnings', xml_content)
-          JunitParser.create_junit_xml(junit_xml, result_file)
+        if params[:use_junit_format]
+          UI.message 'Warning analyzer generates results in JUnit format'
+          unless status_static_arr.include? '2'
+            junit_xml = JunitParser.add_testsuite('xcode warnings', xml_content)
+            JunitParser.create_junit_xml(junit_xml, result_file)
+          end
         end
         status = if status_static_arr.any? { |x| x > 0 }
                    1
@@ -98,29 +102,35 @@ module Fastlane
         # Define all options your action supports.
         [
           FastlaneCore::ConfigItem.new(key: :result_dir,
-                           env_name: "FL_WARNING_ANALYZER_RESULT_DIR",
-                           description: "Directory's name for storing  analysis results",
-                           optional: true,
-                           type: String,
-                           default_value: 'artifacts'),
+                           	env_name: "FL_WARNING_ANALYZER_RESULT_DIR",
+                           	description: "Directory's name for storing  analysis results",
+                           	optional: true,
+                           	type: String,
+                           	default_value: 'artifacts'),
+          FastlaneCore::ConfigItem.new(key: :use_junit_format,
+                           	env_name: "FL_WARNING_ANALYZER_USE_JUNIT_RESULTS",
+                           	description: "Generate results in JUnit format.",
+                        	optional: true,
+                        	type: BOOL,
+                        	default_value: true),
           FastlaneCore::ConfigItem.new(key: :xcode_project_name,
-                           env_name: "FL_WARNING_ANALYZER_PROJECT_NAME",
-                           description: "Xcode project name in work directory",
-                           optional: false,
-                           type: String,
-                           verify_block: proc do |value|
-                             UI.user_error!("No project name for WarningAnalyzerAction given, pass using `xcode_project_name` parameter") unless value and !value.empty?
-                           end),
+                           	env_name: "FL_WARNING_ANALYZER_PROJECT_NAME",
+                           	description: "Xcode project name in work directory",
+                           	optional: false,
+                           	type: String,
+                           	verify_block: proc do |value|
+                              UI.user_error!("No project name for WarningAnalyzerAction given, pass using `xcode_project_name` parameter") unless value and !value.empty?
+                           	end),
           FastlaneCore::ConfigItem.new(key: :xcode_workspace_name,
-                           env_name: "FL_WARNING_ANALYZER_WORKSPACE_NAME",
-                           description: "Xcode workspace name in work directory. Set it if you use different project & workspace names",
-                           optional: true,
-                           type: String),
+                           	env_name: "FL_WARNING_ANALYZER_WORKSPACE_NAME",
+                           	description: "Xcode workspace name in work directory. Set it if you use different project & workspace names",
+                           	optional: true,
+                           	type: String),
           FastlaneCore::ConfigItem.new(key: :xcode_targets,
-                           env_name: "FL_WARNING_ANALYZER_TARGETS",
-                           description: "List of Xcode targets to inspect. By default used all project targets",
-                           optional: true,
-                           type: Array)
+                           	env_name: "FL_WARNING_ANALYZER_TARGETS",
+                           	description: "List of Xcode targets to inspect. By default used all project targets",
+                           	optional: true,
+                           	type: Array)
         ]
       end
 

data/lib/fastlane/plugin/code_static_analyzer/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module CodeStaticAnalyzer
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-code_static_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Olga Kniazska
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack