fastlane-plugin-ciutils 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 129a95d51b3aad1d32a14f1a19c8d113a7d399c5
-  data.tar.gz: 0c31216415d0084b7423982c088cdc5509d9a70d
+  metadata.gz: 391de8fd98eca2f9a7a20909cf8bebcd236d9397
+  data.tar.gz: 9c7216300bdb4019e642f626253ee10463265e90
 SHA512:
-  metadata.gz: 9133b114e21bc602d6b3494674701161440a0591f4b080472e67f2d8dd86e640e6b2e4eb379d4bf87cb44f0e120c6a412cc31f1f4b2ff082368f39935042cab8
-  data.tar.gz: b9f4e9c1519de1b2b984c8e29dd448154873e516c23e1271483dd24bb5e9fb6b4c8dcb5478b2c3ae5a6175fd07f92d2b121703abb8c8f21271233608cca0898f
+  metadata.gz: 610f9211ffe0be990b2021f2964c9667265a6d08fbcec60f6a8b6921c0b24634554e7a040382d8326b81beda162fdb3320afa29ac9904d43944c75aa99b5e80f
+  data.tar.gz: c7b230623ae24482688346109b6eb212b23ad9abf75cce3e0dcfa34da0b056fc56306b3eb62eeca05f946a5f91631a111a7c2bab345f2995d1b3c0b560f4af0c

data/README.md

@@ -16,21 +16,22 @@ Various utilities for CI and Xcode project configuration.
 
 action                   |description
 -------------------------|-------
-`en_ci_utils_init`            | Initializes several environment variables:  <br>**gym**<br>`GYM_OUTPUT_DIRECTORY`=**`build`**<br> `GYM_BUILDLOG_PATH`=**`build/logs/gym`**  <br><br>**scan**<br>`SCAN_OUTPUT_DIRECTORY`=**`build/reports/unittests`**<br>`SCAN_BUILDLOG_PATH`=**`build/logs/scan/`**<br>`SCAN_DERIVED_DATA_PATH`=**`build/deriveddata`** <br>`SCAN_OUTPUT_TYPES`=**`html,junit,json-compilation-database`**<br><br>**slather**<br>`FL_SLATHER_BUILD_DIRECTORY`=**`build/deriveddata`**<br>`FL_SLATHER_USE_BUNDLE_EXEC`=**`true`**<br>`FL_SLATHER_OUTPUT_DIRECTORY`=**`build/reports/`**<br> `FL_SLATHER_COBERTURA_XML_ENABLED`=**`true`**<br><br>**build number**<br>`BUILD_NUMBER` and `FL_BUILD_NUMBER_BUILD_NUMBER` are initialized with the current build number regardless of CI environment. When run on desktop, it us always `1`<br><br>
-`en_profile_name`    | Returns the provisioning profile name by path or uuid
+`en_ci_utils_init`            | Initializes enviornment variables for **gym**, **scan**, **slather**, **oclint**, **swiftlint** and **lizard**. <br> It forces all these actions to put all outputs to the **build** folder (e.g. derived data, logs, scan reports, slather reports, oclint report, lizard reports and swiftlint reports)
+`en_setup_project` | Updates Xcode projects, Info.plist, Entitlements file and any other plist file using values from the provided yaml file [example `appstore.yml`](Demo/config/appstore.yml)
+`en_create_sonar_reports` | Creates sonarqube reports (unit tests, code coverage, static code analysis with swiftlint, oclint and lizard) to be used with the open source sonarqube plugins for Swift and Objective-C
 `en_build_number`    | Returns the value of current build number regardless of CI environment. If run on desktop, then is always `1`
-`en_setup_keychain`  | Creates a keychain and imports the provided certificate
+`en_setup_keychain`  | Creates a keychain and if provided, it imports the give certificate file. It also updates **match** environment variables to use the new created keychain.
 `en_remove_keychain` | Removes the keychain created by ```en_setup_keychain``` and restores the default keychain
 `en_git_changelog`   | Creates the changelog based on git commits by filtering commit messages by a keyword
 `en_close_simulator` | Quits the simulator
-`en_install_provisioning_profiles` | Copies all provisioning profiles from project folder to `~/Library/MobileDevice/Provisioning Profiles`
-`en_setup_project` | Updates Xcode projects, Info.plist, Entitlements file and any other plist file using values from the provided yaml file.
+`en_install_provisioning_profiles` | Copies all provisioning profiles from project folder to `~/Library/MobileDevice/Provisioning Profiles`. <br> Useful when signing certificates and provisioning profiles are managed directly from the Fastfile.
+`en_profile_name`    | Returns the provisioning profile name by path or uuid
 
 
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+Check out the [example `Fastfile`](fastlane/Fastfile) and [project `FastlaneDemo`](Demo) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane build`.
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/ciutils/actions/en_ci_utils_init_action.rb

@@ -2,27 +2,46 @@ module Fastlane
   module Actions
     class EnCiUtilsInitAction < Action
       def self.run(params)
-        # gym evn variables
-        ENV['GYM_OUTPUT_DIRECTORY'] = "build"
-        ENV['GYM_BUILDLOG_PATH'] = "build/logs/gym"
+        output_path = "./build"
+        reports_path = "#{output_path}/reports"
+        logs_path = "#{output_path}/logs"
 
-        # scan env variables
-        ENV['SCAN_OUTPUT_DIRECTORY'] = "build/reports/unittests"
-        ENV['SCAN_BUILDLOG_PATH'] = "build/logs/scan/"
-        ENV['SCAN_DERIVED_DATA_PATH'] = "build/deriveddata"
+        ENV['ENCI_OUTPUT_PATH'] = output_path
+        ENV['ENCI_REPORTS_PATH'] = reports_path
+        ENV['ENCI_LOGS_PATH'] = logs_path
+
+        # gym: ipa
+        ENV['GYM_OUTPUT_DIRECTORY'] = output_path
+        ENV['GYM_BUILDLOG_PATH'] = "#{logs_path}/gym"
+        ENV['GYM_RESULT_BUNDLE'] = "true"
+        ENV['GYM_DERIVED_DATA_PATH'] = "#{output_path}/deriveddata_gym"
+
+        # scan: unit tests
+        ENV['SCAN_OUTPUT_DIRECTORY'] = "#{reports_path}/unittests"
+        ENV['SCAN_BUILDLOG_PATH'] = "#{logs_path}/scan/"
+        ENV['SCAN_DERIVED_DATA_PATH'] = "#{output_path}/deriveddata_scan"
         ENV['SCAN_OUTPUT_TYPES'] = "html,junit,json-compilation-database"
+        ENV['SCAN_CONFIGURATION'] = "Debug"
+        ENV['SCAN_XCARGS'] = "COMPILER_INDEX_STORE_ENABLE=NO"
 
-        ENV['FL_SLATHER_BUILD_DIRECTORY'] = "build/deriveddata"
-        ENV['FL_SLATHER_OUTPUT_DIRECTORY'] = "build/reports"
+        # slather: code coverage reports
+        ENV['FL_SLATHER_BUILD_DIRECTORY'] = "#{output_path}/deriveddata_scan"
+        ENV['FL_SLATHER_OUTPUT_DIRECTORY'] = "#{reports_path}"
         ENV['FL_SLATHER_COBERTURA_XML_ENABLED'] = "true"
         ENV['FL_SLATHER_USE_BUNDLE_EXEC'] = "true"
         ENV['FL_SLATHER_HTML_ENABLED'] = "false"
+        ENV['FL_SLATHER_INPUT_FORMAT'] = "profdata"
+        ENV['FL_SLATHER_CONFIGURATION'] = "Debug"
+
+        # swiftlint: static code analysis and linter
+        ENV['FL_SWIFTLINT_OUTPUT'] = "#{reports_path}/swiftlint.txt"
 
-        # swiftlint
-        ENV['FL_SWIFTLINT_OUTPUT'] = "./build/reports/swiftlint.txt"
+        # lizard: static code analysis and linter
+        ENV['FL_LIZARD_OUTPUT'] = "#{reports_path}/lizard-report.xml"
 
-        # lizard
-        ENV['FL_LIZARD_OUTPUT'] = "../build/reports/lizard-report.xml"
+        # oclint: static code analysis and linter
+        ENV['FL_OCLINT_REPORT_TYPE'] = "pmd"
+        ENV['FL_OCLINT_ENABLE_CLANG_STATIC_ANALYZER'] = "true"
 
         ENV['BUILD_NUMBER'] = Helper::CiutilsHelper.en_ci_build_number()
         ENV['FL_BUILD_NUMBER_BUILD_NUMBER'] = ENV['BUILD_NUMBER']

data/lib/fastlane/plugin/ciutils/actions/en_create_sonar_reports.rb

@@ -0,0 +1,171 @@
+module Fastlane
+  module Actions
+    class EnCreateSonarReportsAction < Action
+      def self.run(params)
+        build_path = ENV['ENCI_OUTPUT_PATH']
+        reports_path = ENV['ENCI_REPORTS_PATH']
+        logs_path = ENV['ENCI_LOGS_PATH']
+        scan_logs_path = ENV['SCAN_BUILDLOG_PATH']
+        scan_reports_path = ENV['SCAN_OUTPUT_DIRECTORY']
+
+        lizard_output_path = ENV['FL_LIZARD_OUTPUT']
+        swiftlint_output_path = ENV['FL_SWIFTLINT_OUTPUT']
+
+        lizard_extra_args = params[:lizard_extra_args]
+        swiftlint_extra_args = params[:swiftlint_extra_args]
+
+        swiftlint_path_args = self.swiftlint_path_args(params)
+        lizard_path_args = self.lizard_path_args(params)
+
+        unless File.exist?(scan_reports_path)
+          UI.user_error!("Please run scan and slather first.")
+          return
+        end
+
+        FileUtils::mkdir_p(reports_path) unless File.exists?(reports_path)
+
+        # create the junit reports again in such way that can be used by sonar
+        sh("cat '#{scan_logs_path}'/*.log | bundle exec ocunit2junit > /dev/null 2>&1 || exit 0")
+
+        # ocunit2junit creates the reports in local test-reports, it needs to be moved
+        FileUtils::rm_rf("#{scan_reports_path}/test-reports")
+        FileUtils::mv("test-reports", "#{scan_reports_path}")
+
+        if Dir.glob("#{scan_reports_path}/test-reports/*.xml").empty?
+          # ocunit2junit failed?
+          UI.message("ocunit2junit failed, copying the original junit report to test-reports")
+          FileUtils::cp("#{scan_reports_path}/report.junit", "#{scan_reports_path}/test-reports/report.xml")
+        end
+
+        # run static code analysis
+        unless params[:skip_swiftlint_analysis]
+          sh("swiftlint lint #{swiftlint_path_args} --quiet > '#{swiftlint_output_path}' || exit 0")
+        end
+
+        unless params[:skip_lizard_analysis]
+          sh("lizard #{lizard_path_args} -l swift -l objectivec --xml #{lizard_extra_args} > '#{lizard_output_path}' || exit 0")
+        end
+
+        # workaround sonar plugin, it is not picking correctly the path to lizard report
+        # and it is looking at the default path
+        FileUtils::ln_sf(reports_path, "sonar-reports")
+
+        unless params[:skip_oclint_analysis]
+          scan_json_compilation_database = File.expand_path(scan_reports_path) + '/report.json-compilation-database'
+          json_compilation_database = File.expand_path(scan_reports_path) + '/compile_commands.json'
+          FileUtils::cp("#{scan_reports_path}/report.json-compilation-database", json_compilation_database)
+          other_action.oclint(compile_commands: scan_json_compilation_database)
+          FileUtils::mv("./fastlane/oclint_report.pmd", "#{reports_path}/oclint.xml")
+        end
+      end
+
+      def self.normalize_paths(paths)
+        paths.split(",").map { |path| File.expand_path(path.strip) }
+      end
+
+      def self.lizard_path_args(params)
+        include_files = ""
+
+        if params[:include_path]
+          self.normalize_paths(params[:include_path]).each do |path|
+            include_files += " '#{path}' " 
+          end
+        end
+
+        exclude_files = ""
+        if params[:exclude_path]
+          self.normalize_paths(params[:exclude_path]).each do |path|
+            exclude_files += " -x '#{path}/*' "
+          end
+        end
+
+        include_files + exclude_files
+      end
+
+      def self.swiftlint_path_args(params)
+        include_files = ""
+
+        if params[:include_path]
+          self.normalize_paths(params[:include_path]).each do |path|
+            include_files += " --path '#{path}'"
+          end
+        end
+
+        # exclude_files = ""
+        # if params[:exclude_path]
+        #   self.normalize_paths(params[:exclude_path]).each do |path|
+        #     exclude_files += " --force-exclude '#{path}' "
+        #   end
+        # end
+
+        # include_files + exclude_files
+        include_files
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :include_path,
+                                       env_name: "FL_EN_ANALYSIS_INCLUDE_SRC",
+                                       description: 'One or multiple paths comma separated to include into scan report',
+                                       optional: false),
+
+          FastlaneCore::ConfigItem.new(key: :exclude_path,
+                                       env_name: "FL_EN_ANALYSIS_EXCLUDE_SRC",
+                                       description: 'One or multiple paths comma separated to include into scan report',
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :skip_oclint_analysis,
+                                       env_name: "FL_EN_SKIP_OCLINT_ANALYSIS",
+                                       description: "Skip running oclint code analysis",
+                                       is_string: false,
+                                       default_value: false,
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :skip_swiftlint_analysis,
+                                       env_name: "FL_EN_SKIP_SWIFTLINT_ANALYSIS",
+                                       description: "Skip running swiftlint code analysis",
+                                       is_string: false,
+                                       default_value: false,
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :swiftlint_extra_args,
+                                       env_name: "FL_EN_SWIFTLINT_EXTRA ARGS",
+                                       description: 'Extra command line args for swiftlint',
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :skip_lizard_analysis,
+                                       env_name: "FL_EN_SKIP_LIZARD_ANALYSIS",
+                                       description: "Skip running lizard code analysis",
+                                       is_string: false,
+                                       default_value: false,
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :lizard_extra_args,
+                                       env_name: "FL_EN_LIZARD_EXTRA ARGS",
+                                       description: 'Extra command line args for lizard',
+                                       optional: true)
+        ]
+      end
+
+      def self.description
+        "Creates swiftlint, lizard and oclint reports and adjusts junit reports for sonarqube (with the open source swift/objc plugin)"
+      end
+
+      def self.details
+        "Ensure before calling this action ensure en_ci_utils_init_action, scan and slather were executed.
+This action re-uses values for used for scan and env variables set by en_ci_utils_init_action for reports paths.
+The oclint command is executed throug the oclint action. You can change input for that action through oclint action env variables.
+
+The exclude files option doesn't work for swiftlint and oclint. You can exclude files in sonar properties or for swiftlint with .swiftlint.yml"
+      end
+
+      def self.authors
+        ["Nicolae Ghimbovschi"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Ciutils
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-ciutils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nicolae Ghimbovschi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-04 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slather
@@ -162,6 +162,7 @@ files:
 - lib/fastlane/plugin/ciutils/actions/en_build_number.rb
 - lib/fastlane/plugin/ciutils/actions/en_ci_utils_init_action.rb
 - lib/fastlane/plugin/ciutils/actions/en_close_simulator.rb
+- lib/fastlane/plugin/ciutils/actions/en_create_sonar_reports.rb
 - lib/fastlane/plugin/ciutils/actions/en_git_changelog.rb
 - lib/fastlane/plugin/ciutils/actions/en_install_provisioning_profiles.rb
 - lib/fastlane/plugin/ciutils/actions/en_profile_name.rb