fastlane-plugin-code_static_analyzer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31ca64424721af47394fb63b3f00532811b84bdf
+  data.tar.gz: e12379d050bad5565564d5402ab6b7517b8594a9
+SHA512:
+  metadata.gz: b7925823d710984f81d6b483aa41a010325475e68ecf9792fe6ce79a19e70de027170c7950d18565483b6ac16d6f29ef44b4a39b566cc2c687cd4d108c483b3b
+  data.tar.gz: 5c3fde6b0c8e7179ca53ea4952ff8f1c7fdddc242d79e6d6a598e85f5c22f46fa7cf879d1f812e73ce096caf7ca1545f7c91ae11d916bdc288d1764fe4edac24

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Olga Kniazska <olgak.kiev@ukr.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# code_static_analyzer plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-code_static_analyzer)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-code_static_analyzer`, add it to your project by running:
+
+```bash
+fastlane add_plugin code_static_analyzer
+```
+
+## About code_static_analyzer
+
+This plugins runs different Static Analyzers for checking your code on warnings, copypaste, syntax, etc and generate reports. 
+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.
+
+## 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/)
+- All paths should be relative to work directory. 
+
+### 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 />
+You may run each analyzer separate:<br />
+`cpd_analyzer` - finds copy paste in code (based on CPD from PMD package) <br />
+`ruby_analyzer` - checks your ruby files. Some offenses can be auto-corrected (if you want to save the changes do it manually) <br />
+`warning_analyzer` - this analyzer uses Xcode built-in analyzer mainly to detect warnings<br /> 
+
+## Reference and Example
+
+### `code_static_analyzer` (Run all analyzers)
+
+````ruby
+# minimum configuration
+code_static_analyzer(
+      analyzers: 'all',
+      cpd_language: 'objectivec',
+      xcode_project_name: 'path/to/TestProject',
+    )
+# full configuration
+code_static_analyzer(
+      analyzers: 'all',
+      result_dir: 'result directory',
+      cpd_tokens: '150',
+      cpd_language: 'objectivec',
+      cpd_files_to_inspect: 'path/to/myFiles/', # or list %w('path/to/myFiles/' 'path/to/testFiles/')
+      cpd_files_to_exclude: 'Pods', # or list %w('Pods' 'path/to/filesNotToInspect/file1.m' 'path/to/filesNotToInspect/in/dir')
+      xcode_project_name: 'path/to/TestProject',
+      xcode_workspace_name: 'path/to/testWorkspace',
+      xcode_targets: ['TPClientTarget','TPServerTarget'],
+      ruby_files: 'fastlane/Fastfile'
+    )
+````
+Parameter | Description
+--------- | -----------
+`analyzers` | List of analysers you want to run.  Supported analyzers: "xcodeWar", "rubocop", "CPD", "all"
+`result_dir` | *(optional)* Directory's name for storing  analysis results.
+`cpd_tokens` | *(optional)* The min number of words in code that is detected as copy paste.<br />Default value: 100
+`cpd_language` | *(optional)* Language used in files that will be inspected on copy paste.<br />Supported analyzers: ['python', 'objectivec', 'jsp', 'ecmascript', 'fortran', 'cpp', 'ruby', 'php', 'java', 'matlab', 'scala', 'plsql', 'go', 'cs']. If you need any other language just don't set this parameter. 
+`cpd_files_to_inspect` | *(optional)* List of paths (relative to work directory) to files/directories to be inspected on copy paste. 
+`cpd_files_to_exclude` | *(optional)* List of paths (relative to work directory) to files/directories not to be inspected on copy paste
+`xcode_project_name` | *(required if use warning analyzer)* Xcode project name in work directory
+`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 
+
+### `code_static_analyzer` other examples (full configuration):
+CPD:
+````ruby
+code_static_analyzer(
+      analyzers: 'cpd',
+      result_dir: 'result directory',
+      cpd_tokens: '150',
+      cpd_language: 'objectivec',
+      cpd_files_to_inspect: %w('path/to/myFiles/' 'path/to/testFiles/'),
+      cpd_files_to_exclude: %w('Pods' 'ThirdParty')
+    )
+````
+CPD + ruby:
+````ruby
+code_static_analyzer(
+      analyzers: 'rubocop',
+      result_dir: 'result directory',
+      cpd_tokens: '150',
+      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'
+    )
+````
+CPD + Xcode project warnings:
+````ruby
+code_static_analyzer(
+      analyzers: 'xcodewar',
+      result_dir: 'result directory',
+      cpd_tokens: '150',
+      cpd_language: 'objectivec',
+      cpd_files_to_inspect: %w('path/to/myFiles/' 'path/to/testFiles/'),
+      cpd_files_to_exclude: %w('Pods' 'ThirdParty'),
+      xcode_project_name: 'path/to/TestProject',
+      xcode_workspace_name: 'path/to/testWorkspace',
+      xcode_targets: ['TPClientTarget','TPServerTarget'],
+    )
+````
+
+## 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
+```
+
+## 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 />
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/assets/code_analys.sh

@@ -0,0 +1,27 @@
+#!/bin/bash -o pipefail
+#!/bin/sh -e
+# code_analys.sh
+# @desc Detect code warnings/errors by using static analyzer build in Xcode. 
+# @usage
+# 1. Income parameters
+# WORKSPACE_PROJECT - name of xcode project or workspace (.xcodeproj / .xcworkspace)
+# BUILD_LANE - name of project target
+# LOG - path-name of .log file for temporary usage to store full output of Xcode command
+# IN_WORKSPACE - true if WORKSPACE_PROJECT=.xcworkspace
+
+WORKSPACE_PROJECT=$1
+BUILD_LANE=$2
+LOG=$3
+IN_WORKSPACE=$4
+
+#detect warnings
+#analyze code (build in xcode tools)
+if $IN_WORKSPACE; then
+  xcodebuild -scheme $BUILD_LANE -workspace $WORKSPACE_PROJECT clean analyze |
+  tee "$LOG" | 
+  xcpretty
+else
+  xcodebuild -scheme $BUILD_LANE -project $WORKSPACE_PROJECT clean analyze |
+  tee "$LOG" | 
+  xcpretty
+fi

data/lib/assets/formatter.rb

@@ -0,0 +1,31 @@
+#! /usr/bin/env ruby
+# output_looking.rb
+# @desc Tools for preparing better looking running output
+# @usage
+# in needed file paste string: require './path-to-file/output_looking.rb
+
+# Use to prepare formatted output
+module Formatter
+  def self.return_status(mystatus)
+    puts light_blue(">>> Exit command status: #{mystatus}")
+  end
+
+  def self.xcode_format(scheme)
+    puts ">>> Running Xcode analyze command... on #{scheme}..."
+  end
+
+  def self.cpd_format(tokens, language, exclude, result_file, inspect)
+    puts "files         : #{inspect}"
+    puts "min_tokens    : #{tokens}"
+    puts "language      : #{language}"
+    puts "exclude_files : #{exclude}"
+    puts 'format        : xml'
+    puts "output_file   : #{result_file}"
+  end
+
+  # String colorization
+  # call UI.message Actions::FormatterAction.light_blue(text)
+  def self.light_blue(mytext)
+    "\e[36m#{mytext}\e[0m"
+  end
+end

data/lib/assets/junit_parser.rb

@@ -0,0 +1,225 @@
+#! /usr/bin/env ruby
+# parser.sh
+# @desc Parser
+# @usage
+# 1. Parser 1. Xcode analyze result (.log)
+# 2. Parser 2. Rubocop result (.json)
+# 3. Parser 3. CPD result (.xml)
+
+require 'crack'
+
+module JunitParser
+  #####################################################
+  # ================= For all parsers =================
+  #####################################################
+
+  def self.create_xml(xml_data_custom, result_file_name)
+    xml_data = '<?xml version="1.0" encoding="UTF-8"?>'
+    xml_data += xml_data_custom
+    File.open(result_file_name, 'w') do |f|
+      f.write(xml_data)
+    end
+  end
+
+  def self.create_testsuites(testsuites)
+    "#{xml_level(0)}<testsuites>#{testsuites}#{xml_level(0)}</testsuites>"
+  end
+
+  def self.add_testsuite(name, testcases)
+    "#{xml_level(1)}<testsuite name='#{name}'>" \
+    "#{testcases}" \
+    "#{xml_level(1)}</testsuite>"
+  end
+
+  def self.add_failed_testcase(name, failures)
+    "#{xml_level(2)}<testcase name='#{name}'>" \
+    "#{failures}#{xml_level(2)}</testcase>"
+  end
+
+  def self.add_success_testcase(name)
+    "#{xml_level(2)}<testcase name='#{name}' status='success'/>"
+  end
+
+  def self.add_failure(message, type, text)
+    "#{xml_level(3)}<failure #{insert_attribute('type', type)} status='failed' " \
+    "#{insert_attribute('message', message)}>" \
+  	"#{text}" \
+  	"#{xml_level(3)}</failure>"
+  end
+
+  def self.add_properties(property_array, value_array)
+    properties = "#{xml_level(2)}<properties>"
+    property_array.each_with_index do |property, index|
+      value = value_array[index]
+      unless value.nil?
+        properties += "#{xml_level(3)}<property name='#{property}' value='#{value}' />"
+      end
+    end
+    properties += "#{xml_level(2)}</properties>"
+  end
+
+  def self.construct_failure_mes(attributes, values)
+    properties = xml_level(0).to_s
+    attributes.each_with_index do |property, index|
+      value = values[index]
+      properties += format("#{xml_level(4)}%-18s: %s", property, value) unless value.nil?
+    end
+    properties
+  end
+
+  def self.insert_attribute(attribute, value)
+    value == '' ? '' : "#{attribute}='#{value}'"
+  end
+
+  def self.add_code(codefragment)
+    "<![CDATA[#{codefragment}]]>"
+  end
+
+  def self.get_failure_type(str)
+    failure_type = str[/\[(.*?)\]/, 1]
+    failure_type = '-W' if failure_type.nil?
+    failure_type
+  end
+
+  def self.xml_level(level)
+    levelstr = "\n"
+    i = 1
+    while i < level
+      levelstr += "\s\s"
+      i += 1
+    end
+    levelstr
+  end
+
+  # create root xml content
+  def self.create_junit_xml(testsuite, result_file_name)
+    full_data = create_testsuites(testsuite)
+    create_xml(full_data, result_file_name)
+  end
+
+  #####################################################
+  # ============== Xcode-log Parser ================
+  #####################################################
+
+  def self.parse_xcode_log(file, project, is_warn)
+    if is_warn
+      error_text = ''
+      File.open(file).each do |line|
+        if line =~ /warning:|error:/
+          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", '')]
+            )
+          else
+            error_text += construct_failure_mes(
+              ['Error ClassType', 'Error Message'],
+              ['-W', line.tr("\n", '')]
+            )
+          end
+        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)
+    else
+      add_success_testcase(project)
+    end
+  end
+
+  #####################################################
+  # ============== Rubocop-json Parser ================
+  #####################################################
+
+  def self.parse_json(file)
+    data_read = File.read(file)
+    data_hash = Crack::JSON.parse(data_read)
+
+    keys = data_hash['metadata'].keys.zip(data_hash['summary'].keys).flatten.compact
+    values = data_hash['metadata'].values.zip(data_hash['summary'].values).flatten.compact
+    properties = add_properties(keys, values)
+
+    testcase = parse_main_json(data_hash)
+
+    properties + testcase
+  end
+
+  # create main xml content
+  def self.parse_main_json(data_hash)
+    xml = ''
+    data_hash['files'].each do |inspected_file|
+      error_text = ''
+      errors = inspected_file['offenses']
+      if errors.empty?
+        xml += add_success_testcase((inspected_file['path']).to_s)
+      else
+        errors.each do |error|
+          error_text += construct_failure_mes(
+            ['Error isCorrected', 'Error ClassType', 'Error Line', 'Error Message'],
+            [error['corrected'], "#{error['cop_name']} (#{error['severity']})",
+             parse_location(error['location']), error['message'].tr("\n", '')]
+          )
+        end
+        # TODO: corrected:6 failded:0 (if needed this info)
+        failures = add_failure('lineformat=line:column:length', '', error_text)
+        xml += add_failed_testcase((inspected_file['path']).to_s, failures)
+      end
+    end
+    xml
+  end
+
+  def self.parse_location(location)
+    "#{location['line']}:#{location['column']}:#{location['length']}"
+  end
+
+  #####################################################
+  # ================= CPD-xml Parser ==================
+  #####################################################
+
+  def self.parse_xml(file)
+    data_read = File.read(file)
+    data_hash = Crack::XML.parse(data_read)
+
+    if data_hash.empty? or data_hash['pmd_cpd']==nil
+      puts 'empty data_hash'
+      add_success_testcase('casino duplications')
+    else
+      parse_code_duplications(data_hash)
+    end
+  end
+
+  def self.parse_code_duplications(data_hash)
+    xml = ''
+    duplications = data_hash['pmd_cpd']['duplication']
+    if duplications.kind_of?(Array)
+      index = 1
+      duplications.each do |error|
+        parsed_files = parse_inspected_files(error['file'])
+        failure = add_failure("lines:#{error['lines']} tokens:#{error['tokens']} #{xml_level(3)}files:#{parsed_files}", '', "\n#{add_code(error['codefragment'])}")
+        xml += add_failed_testcase("duplication #{index}", failure)
+        index += 1
+      end
+    else
+      parsed_files = parse_inspected_files(duplications['file'])
+      failure = add_failure("lines:#{duplications['lines']} tokens:#{duplications['tokens']} #{xml_level(3)}files:#{parsed_files}", '',
+                            "\n #{add_code(duplications['codefragment'])}")
+      xml += add_failed_testcase('single duplication', failure)
+    end
+    xml
+  end
+
+  def self.parse_inspected_files(file_list)
+    index = 1
+    file_list_info = []
+    file_list.each do |file|
+      file_list_info.push("File #{index}: #{file['path']}::#{file['line']}")
+      index += 1
+    end
+    file_list_info
+  end
+end