fastlane-plugin-clang_tools 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c973cacd9d7e8c7f6ffb64fd97822317b4e1cfbb44a7e32ec36b7a717b484e71
-  data.tar.gz: 81a60ad8463ee3ea9a5624b77f6f592236c5630bfef07f14b0892dbaf4ee8c25
+  metadata.gz: 4eef3741c5bbfce072759ccf54c9318e43e01afc07211871c8527d7952e94495
+  data.tar.gz: 77643735adb58fcc6c6da0cf2ba9e66e3c66b23b23f035a76328726126b6565d
 SHA512:
-  metadata.gz: 92c022944ee859ec05f21b3a5d287690f3c282abe0d095928d478534d17a588f482f13bfa378cda899cc3742121d30638e33dfa28d00bedb4ee81c35f3c072d5
-  data.tar.gz: 497c467a11adfab75b20c45f96f399baed3750bd2188401e0935fbb3756c85b1ed3d451b2caed2e31f273ea9fb24d7e082ef1a377ffe750793fd22276c5ca029
+  metadata.gz: a9bb793e4eacfd8e83dc59c6deb716937f950038f1bf39ea5d33f2f3be94230e6658e3e2d6ef6a7838c24641b17368eaffcab323b26838624ac084bf3729f9b9
+  data.tar.gz: 4437a709b9848134501ea9f7cd3b624fd7c3f55999b6cd7a8ec0e00236d076bf896e8564df83e56cc2da1041fe6c993e96d503334563b9b3bcc38f9e85b92518

data/lib/fastlane/plugin/clang_tools/actions/clang_analyzer_action.rb

@@ -1,16 +1,16 @@
 require 'nokogiri'
 
 require 'fastlane/action'
-require_relative '../helper/clang_analyzer_helper'
+require_relative '../helper/clang_tools_helper'
 
 module Fastlane
   module Actions
     class ClangAnalyzerAction < Action
       def self.run(params)
         # Parse CLI parameters
-        analyze_params = prepare(params)
+        analyze_params, err_msg = prepare(params)
         if analyze_params.nil?
-          puts('ERROR : Invalid parameters. Exiting ......')
+          puts(Helper::ClangToolsHelper.is_empty?(err_msg) ? 'ERROR : Invalid parameters. Exiting ......' : err_msg)
           return
         end
 
@@ -35,27 +35,42 @@ module Fastlane
       def self.prepare(params)
         if params.nil?
           analyze_params = nil
+          err_msg = 'ERROR : No input parameters. Exiting ......'
         else
           analyze_params = {}
+          err_msg = nil
 
           params.all_keys.each do |item|
-            unless params[item].nil? || params[item].empty?
+            unless Helper::ClangToolsHelper.is_empty?(params[item])
               analyze_params[item] = params[item]
             end
           end
 
+          # Check if only the .xcworkspace specified or only the .xcodeproj specified
+          if analyze_params.key?(:workspace) && analyze_params.key?(:project)
+            return [nil, 'ERROR : ".xcworkspace" and ".xcodeproj" cannot be specified at the same time. Exiting ......']
+          end
+          if !analyze_params.key?(:workspace) && !analyze_params.key?(:project)
+            return [nil, 'ERROR : ".xcworkspace" or ".xcodeproj" must be specified. Exiting ......']
+          end
+
+          unless analyze_params.key?(:configuration)
+            analyze_params[:configuration] = 'Debug'
+          end
+
           # The default output_format is 'plist-html'
           unless analyze_params.key?(:output_format)
             analyze_params[:output_format] = 'plist-html'
           end
           # For CI/CD convenience, this action only supports 'plist' or 'plist-html' as output_format
           unless analyze_params[:output_format].include?('plist')
-            return nil
+            return [nil, 'ERROR : Invalid "output_format". Exiting ......']
           end
 
           # The default output_dir is './static_analysis'
+          project = Helper::ClangToolsHelper.pick_non_empty(params[:workspace], params[:project])
           unless analyze_params.key?(:output_dir)
-            analyze_params[:output_dir] = './static_analysis'
+            analyze_params[:output_dir] = "#{File.dirname(File.realpath(project))}/static_analysis"
           end
           FileUtils.mkdir_p(analyze_params[:output_dir]) unless File.exist?(analyze_params[:output_dir])
           analyze_params[:output_compile_commands] = "#{analyze_params[:output_dir]}/compile_commands.json"
@@ -63,10 +78,10 @@ module Fastlane
           analyze_params[:output_report_dir] = "#{analyze_params[:output_dir]}/report-#{Time.new.strftime('%Y%m%d%H%M%S')}"
           FileUtils.mkdir_p(analyze_params[:output_report_dir]) unless File.exist?(analyze_params[:output_report_dir])
 
-          analyze_params[:output_summary_file] = 'clang_analyzer_summary.xml'
+          analyze_params[:output_summary_file] = 'clang_analysis_report.xml'
         end
 
-        analyze_params
+        [analyze_params, err_msg]
       end
 
       def self.xcode_build(params)
@@ -77,23 +92,21 @@ module Fastlane
         # xcodebuild executive
         cmd_line << (params.key?(:xcodebuild) ? params[:xcodebuild] : 'xcodebuild')
 
+        # -workspace
+        if params.key?(:workspace)
+          cmd_line << "-workspace #{params[:workspace]}"
         # -project
-        if params.key?(:project)
+        elsif params.key?(:project)
           cmd_line << "-project #{params[:project]}"
-        else
-          # -workspace
-          if params.key?(:workspace)
-            cmd_line << "-workspace #{params[:workspace]}"
-          end
+        end
 
-          # -scheme
-          if params.key?(:scheme)
-            cmd_line << "-scheme #{params[:scheme]}"
-          end
+        # -scheme
+        if params.key?(:scheme)
+          cmd_line << "-scheme #{params[:scheme]}"
         end
 
         # xcode configuration
-        cmd_line << (params.key?(:configuration) ? "-configuration #{params[:configuration]}" : '-configuration Debug')
+        cmd_line << "-configuration #{params[:configuration]}"
 
         # build command
         cmd_line << 'clean'
@@ -148,29 +161,45 @@ module Fastlane
         issues = []
         plist_files.each { |plist_file| parse_plist("#{params[:output_report_dir]}/#{plist_file}", issues) }
 
-        ordered_issues = parse_issues(issues)
+        grouped_issues = parse_issues(issues)
         builder = Nokogiri::XML::Builder.new do |xml|
-          xml.IssueList do
-            ordered_issues.values.each do |issue_entry|
-              issue_entry.each do |issue|
-                xml.Issue do
-                  xml.Checker(issue['checker'])
-                  xml.Category(issue['category'])
-                  xml.Type(issue['type'])
-                  xml.Message(issue['message'])
-                  xml.Source(issue['source_file'])
-                  xml.Line(issue['line'])
-                  xml.Col(issue['col'])
-                  xml.Context(issue['context'])
-                  xml.ContextKind(issue['context_kind'])
-                  xml.HtmlAttachments do
-                    issue['html_details'].each do |html|
-                      xml.Attachment(html)
-                    end
-                  end
-                end
+          xml.Report do
+            xml.Summary do
+              project = Helper::ClangToolsHelper.pick_non_empty(params[:workspace], params[:project])
+              if project.nil?
+                raise 'ERROR : Invalid Project!'
               end
+
+              xml.Project(project)
+              xml.ReportDirectory(params[:output_report_dir])
+              xml.ReportFormat(params[:output_format])
+              xml.IssueCount(grouped_issues.size)
             end
+
+            next if Helper::ClangToolsHelper.is_empty?(grouped_issues)
+
+            xml.IssueList do
+              grouped_issues.values.each do |issue_entry|
+                issue_entry.each do |issue|
+                  xml.Issue do
+                    xml.Checker(issue['checker'])
+                    xml.Category(issue['category'])
+                    xml.Type(issue['type'])
+                    xml.Message(issue['message'])
+                    xml.Source(issue['source_file'])
+                    xml.Line(issue['line'])
+                    xml.Col(issue['col'])
+                    xml.Context(issue['context'])
+                    xml.ContextKind(issue['context_kind'])
+                    xml.HtmlAttachments do
+                      issue['html_details'].each do |html|
+                        xml.Attachment(html)
+                      end
+                    end
+                  end # xml.Issue
+                end # issue_entry
+              end # grouped_issues.values
+            end # xml.IssueList
           end
         end
 
@@ -256,12 +285,12 @@ module Fastlane
         # The corresponding source file of the plist file
         # Noted : the length of 'files' will always be 1 now
         plist_files = plist['files']
-        if plist_files.nil? || plist_files.size.zero?
+        if Helper::ClangToolsHelper.is_empty?(plist_files)
           return
         end
 
         plist_diagnostics = plist['diagnostics']
-        if plist_diagnostics.nil? || plist_diagnostics.size.zero?
+        if Helper::ClangToolsHelper.is_empty?(plist_diagnostics)
           return
         end
 
@@ -284,22 +313,22 @@ module Fastlane
       end
 
       def self.parse_issues(issues)
-        ordered_issues = {}
+        grouped_issues = {}
 
-        if issues.nil? || issues.size.zero?
-          return ordered_issues
+        if Helper::ClangToolsHelper.is_empty?(issues)
+          return grouped_issues
         end
 
         issues.each do |issue|
           issue_key = issue['checker']
 
-          unless ordered_issues.key?(issue_key)
-            ordered_issues[issue_key] = []
+          unless grouped_issues.key?(issue_key)
+            grouped_issues[issue_key] = []
           end
-          ordered_issues[issue_key] << issue
+          grouped_issues[issue_key] << issue
         end
 
-        ordered_issues
+        grouped_issues
       end
 
       def self.description
@@ -321,14 +350,14 @@ module Fastlane
 
       def self.available_options
         [
-          FastlaneCore::ConfigItem.new(key: :project,
-                                       description: 'The xcode project',
-                                       optional: true,
-                                       type: String),
           FastlaneCore::ConfigItem.new(key: :workspace,
                                        description: 'The xcode workspace',
                                        optional: true,
                                        type: String),
+          FastlaneCore::ConfigItem.new(key: :project,
+                                       description: 'The xcode project',
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :scheme,
                                        description: 'The scheme of xcode project',
                                        optional: true,

data/lib/fastlane/plugin/clang_tools/helper/clang_tools_helper.rb

@@ -0,0 +1,32 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
+
+  module Helper
+    class ClangToolsHelper
+      def self.is_empty?(obj)
+        if obj.nil?
+          return true
+        end
+
+        case obj
+        when String
+          obj.empty?
+        when Array, Hash
+          obj.size.zero?
+        else
+          false
+        end
+      end
+
+      def self.pick_non_empty(str1, str2)
+        if !is_empty?(str1)
+          str1
+        elsif !is_empty?(str2)
+          str2
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module ClangTools
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-clang_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - squirrel-explorer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !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: rspec_junit_formatter
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +142,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.149.1
+        version: 2.138.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.149.1
+        version: 2.138.0
 description:
 email: xvider.zx@gmail.com
 executables: []
@@ -132,7 +160,7 @@ files:
 - README.md
 - lib/fastlane/plugin/clang_tools.rb
 - lib/fastlane/plugin/clang_tools/actions/clang_analyzer_action.rb
-- lib/fastlane/plugin/clang_tools/helper/clang_analyzer_helper.rb
+- lib/fastlane/plugin/clang_tools/helper/clang_tools_helper.rb
 - lib/fastlane/plugin/clang_tools/version.rb
 homepage: https://github.com/squirrel-explorer/fastlane-plugin-clang_tools
 licenses:

data/lib/fastlane/plugin/clang_tools/helper/clang_analyzer_helper.rb

@@ -1,16 +0,0 @@
-require 'fastlane_core/ui/ui'
-
-module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
-
-  module Helper
-    class ClangToolsHelper
-      # class methods that you define here become available in your action
-      # as `Helper::ClangToolsHelper.your_method`
-      #
-      def self.show_message
-        UI.message('Hello from the clang_tools plugin helper!')
-      end
-    end
-  end
-end