fastlane-plugin-code_static_analyzer 0.1.0

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

@@ -0,0 +1,112 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      RUBY_ANALYZER_STATUS = :RUBY_ANALYZER_STATUS
+    end
+
+    class RubyAnalyzerAction < Action
+      def self.run(params)
+        UI.header 'Ruby analyzer' if Actions::CodeStaticAnalyzerAction.run_from_main_action
+        work_dir = Actions::CodeStaticAnalyzerAction.work_dir
+
+        # checking files for analysing
+        files_to_inspect = params[:ruby_files]
+
+        UI.message '[!] Ruby analyzer will be run for all ruby files in work directory'.blue if !files_to_inspect or files_to_inspect.empty?
+        Actions::CodeStaticAnalyzerAction.check_file_exist(work_dir, files_to_inspect, 'ruby_files')
+
+        # 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}"
+        run_script_path = File.join CodeStaticAnalyzer::ROOT, "assets/run_script.sh"
+        run_script = "#{run_script_path} \"#{run_script}\" '#{temp_result_file}'"
+        # use analyzer
+        FastlaneCore::CommandExecutor.execute(command: run_script.to_s,
+                                            print_all: false,
+                                            error: proc do |error_output|
+                                                     # handle error here
+                                                   end)
+        status = $?.exitstatus
+        # prepare results
+        if Dir.glob(temp_result_file).empty?
+          info = (status == 2) ? 'Rubocop return 2: terminates abnormally due to invalid configuration, invalid CLI options, or an internal error' : ''
+          Actions::CodeStaticAnalyzerAction.start_xml_content unless Actions::CodeStaticAnalyzerAction.run_from_main_action
+          Actions::CodeStaticAnalyzerAction.add_xml_content("#{result_dir_path}/", 'Ruby', temp_result_file, info)
+          Actions::CodeStaticAnalyzerAction.create_analyzers_run_result("#{result_dir_path}/") unless Actions::CodeStaticAnalyzerAction.run_from_main_action
+          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)
+        end
+        Actions.lane_context[SharedValues::RUBY_ANALYZER_STATUS] = status
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "This analyzer detect warnings, errors and check syntax in ruby files. This is based on rubocop"
+      end
+
+      def self.details
+        # Optional:
+        # this is your chance to provide a more detailed description of this action
+        # "You can use this action to do cool things..."
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+
+        # Below a few examples
+        [
+          FastlaneCore::ConfigItem.new(key: :result_dir,
+                        env_name: "FL_RUBY_ANALYZER_RESULT_DIR",
+                        description: "Directory's name for storing  analysis results",
+                        optional: true,
+                        type: String,
+                        default_value: 'artifacts'),
+          FastlaneCore::ConfigItem.new(key: :ruby_files,
+                        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)
+        ]
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+        [
+          ['RUBY_ANALYZER_STATUS', 'Ruby analyzer result status (0 - success, any other value - failed)']
+        ]
+      end
+
+      def self.return_value
+        # If you method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ["olgakn"]
+      end
+
+      def self.is_supported?(platform)
+        # you can do things like
+        #
+        #  true
+        #
+        #  platform == :ios
+        #
+        #  [:ios, :mac].include?(platform)
+        #
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,156 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      WARNING_ANALYZER_STATUS = :WARNING_ANALYZER_STATUS
+    end
+
+    class WarningAnalyzerAction < Action
+      def self.run(params)
+        UI.header 'iOS warning analyzer' if Actions::CodeStaticAnalyzerAction.run_from_main_action
+        work_dir = Actions::CodeStaticAnalyzerAction.work_dir
+
+        # checking files for analysing
+        workspace = params[:xcode_workspace_name]
+        project = params[:xcode_project_name]
+        targets = params[:xcode_targets]
+        unless Actions::CodeStaticAnalyzerAction.run_from_main_action
+          checked_params = Actions::CodeStaticAnalyzerAction.xcode_check_parameters(work_dir, project, workspace, targets)
+          project = checked_params[0]
+          workspace = checked_params[1]
+          targets = checked_params[2]
+        end
+        is_workspace = false
+        is_workspace = true if workspace and !workspace.empty?
+
+        # 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)
+        # lib_path = File.join(Helper.gem_path('fastlane-plugin-code_static_analyzer'), "lib")
+        # File.join(lib_path, "assets/code_analys.sh")
+        run_script_path = File.join CodeStaticAnalyzer::ROOT, "assets/code_analys.sh"
+
+        status_static_arr = []
+        xml_content = ''
+        temp_result_file = "#{result_dir_path}/temp_warnings.log"
+        result_file = "#{result_dir_path}/codeAnalysResults_warning.xml"
+
+        # use analyzer and collect results
+        project_workspace = project
+        project_workspace = workspace if is_workspace
+        Actions::CodeStaticAnalyzerAction.start_xml_content unless Actions::CodeStaticAnalyzerAction.run_from_main_action
+        targets.each do |target|
+          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,
+                                        print_all: false,
+                                        print_command: false,
+                                        error: proc do |error_output|
+                                          # handle error here
+                                        end)
+
+          Actions::CodeStaticAnalyzerAction.start_xml_content unless Actions::CodeStaticAnalyzerAction.run_from_main_action
+          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)
+          else
+            file = File.read(temp_result_file)
+            UI.important "wrong profiles. Code isn't checked" if file =~ /BCEROR/
+            is_warnings = file =~ /warning:|error:|BCEROR/
+            if is_warnings
+              status_static_arr.push(1)
+            else
+              status_static_arr.push(0)
+            end
+            xml_content += JunitParser.parse_xcode_log(temp_result_file, target, is_warnings)
+          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)
+        end
+        status = if status_static_arr.any? { |x| x > 0 }
+                   1
+                 else
+                   0
+                 end
+
+        Actions.lane_context[SharedValues::WARNING_ANALYZER_STATUS] = status
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "This analyzer detect warnings in Xcode projects."
+      end
+
+      def self.details
+        # Optional:
+        # this is your chance to provide a more detailed description of this action
+        # "You can use this action to do cool things..."
+      end
+
+      def self.available_options
+        # 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'),
+          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),
+          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),
+          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)
+        ]
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+        [
+          ['WARNING_ANALYZER_STATUS', 'Warning analyzer result status (0 - success, any other value - failed)']
+        ]
+      end
+
+      def self.return_value
+        # If you method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ["olgakn"]
+      end
+
+      def self.is_supported?(platform)
+        # you can do things like
+        #
+        #  true
+        #
+        #  platform == :ios
+        #
+        #  [:ios, :mac].include?(platform)
+        #
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/code_static_analyzer/helper/code_static_analyzer_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class CodeStaticAnalyzerHelper
+      # class methods that you define here become available in your action
+      # as `Helper::CodeStaticAnalyzerHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the code_static_analyzer plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-code_static_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olga Kniazska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xcpretty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: 
+email: olgak.kiev@ukr.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/assets/code_analys.sh
+- lib/assets/formatter.rb
+- lib/assets/junit_parser.rb
+- lib/assets/run_script.sh
+- lib/fastlane/plugin/code_static_analyzer.rb
+- lib/fastlane/plugin/code_static_analyzer/actions/code_static_analyzer_action.rb
+- lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb
+- lib/fastlane/plugin/code_static_analyzer/actions/ruby_analyzer.rb
+- lib/fastlane/plugin/code_static_analyzer/actions/warning_analyzer.rb
+- lib/fastlane/plugin/code_static_analyzer/helper/code_static_analyzer_helper.rb
+- lib/fastlane/plugin/code_static_analyzer/version.rb
+homepage: https://github.com/knolga/fastlane-plugin-code_static_analyzer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Runs different Static Analyzers and generate report
+test_files: []