fastlane-plugin-forsis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a499e26fa89aecf81bff1f092e457f5186536b5
+  data.tar.gz: ede699091b2c249e8e04525a3c0daae990b8f97d
+SHA512:
+  metadata.gz: 37f3ff83e608a82270eaa581866f4a8ec431831663759b5e71549d3bc21ca7ac0dfd48615bdd21f54f8dcb14e291322a17265f4267240879c9845bcfc26d8a1d
+  data.tar.gz: 4e9671d65a7c7db11e3abd878063be472b80eb16354ac0f1aea26c7ded99992c984e8a0eb620642437f0058175809b33312f7779efbca63a9583dd2f8ef41af9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Azohra/forsis
+
+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,105 @@
+# forsis plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-forsis)
+
+**forsis** is a [_fastlane_](https://github.com/fastlane/fastlane) plugin that will be helpful to those swift developers who use SonarQube to analyze their code. forsis uses JUnit test reports generated by fastlane to produce generic test execution reports supported by SonarQube.
+
+If you have used SonarQube for analyzing Swift projects, you've probably noticed that other than the code coverage, you don't get any information related to the unit tests appearing on the project dashboard. This plugin, however, will help you get more visibility on the unit tests by generating a test report that can be analyzed by SonarQube. By sending such a test report to SonarQube, the total number of unit tests will be displayed on the project dashboard as shown in the following image.
+
+<img src="docs/SonarQube-dashboard.png" />
+
+In addidtion, you can see a breakdown of test results under project Measures > Coverage > Tests. Alternatively, you can select the test count on the dashbord (by clicking it) to see the test results as shown in the image below.
+
+<img src="docs/test-results.png" />
+
+## Getting Started
+
+ To get started with `fastlane-plugin-forsis`, add it to your project by running:
+
+```bash
+fastlane add_plugin forsis
+```
+ Start using the plugin by adding this example 'lane' to your Fastfile:
+
+ ```ruby
+lane :sonarqube_test_report do
+	forsis(
+	    junit_report_file: './fastlane/report.junit',
+	    sonar_report_directory: 'path_to_a_directory_to_store_sonarqube_report'
+    )
+end
+ ```
+ * `junit_report_file` is the path to the JUnit test report generated by fastlane
+ * `sonar_report_directory` is the directory to store the generated SonarQube report. This parameter is optional and the defaut value is the fastlane directory in the main repo (*i.e.*, `./fastlane`).
+
+**Note:** This plugin uses the fastlane JUnit test report named `report.junit`. This report is generated by running tests through fastlane using `run_tests` or `scan` actions. Therefore, in your Fastfile, the forsis lane must be run after the lane that runs the tests.  Including the test lane, your Fastfile would look like the example below.
+
+```ruby
+lane :run_unit_tests do
+  run_tests(
+      workspace: 'path_to_the_xcworkspace_directory',
+      scheme: 'path_to_the_project_test_scheme',
+      devices: ["iPhone 6s"],
+      # output_types: 'junit',
+      output_directory: './fastlane/test_output',
+    )
+end
+    
+lane :sonarqube_test_report do
+	forsis(
+	    junit_report_file: './fastlane/test_output/report.junit',
+	    sonar_report_directory: './fastlane'
+    )
+end
+```
+
+The `run_tests` action generates a test report in two different formats by default (html and junit). (Note: the `scan` method is an alias for the `run_tests` method.) If you would not like to get the html report, you can override this default behavior by setting the parameter `output_types` to only 'junit'. In the example `:run_unit_tests` lane above, uncomment the line for output_types to only get a JUnit test report. Test reports are then found in the fastlane directory or in the `output_directory` if it has been set. To learn more about how to run tests through fastlane, check out the [fastlane documentation] (https://docs.fastlane.tools/getting-started/ios/running-tests/).
+
+## How to use the SonarQube test report generated by forsis?
+This plugin creates an XML test report called `Test_sonarqube_report.xml`. To get benefit from this report, you need to feed it to SonarQube properly. To do so, you need to set the two following SonarQube analysis parameters:
+
+  * `sonar.tests` is the path to the directory that contains tests
+  * `sonar.testExecutionReportPaths` is the path to the SonarQube test report file generated by the plugin *i.e.*, the value of the `sonar_report_directory` in the forsis action followed by the name of the XML file that contains the report. This would be `fastlane/Test_sonarqube_report.xml`, if sonar_report_directory was not set.
+
+If you need help setting up analysis parameters for SonarQube, refer to the [SonarQube Analysis Parameters](https://docs.sonarqube.org/latest/analysis/analysis-parameters/) documentation.
+## 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
+```
+
+## 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).
+This software is available as open source under the terms of the MIT License.
+
+## Contribution
+
+Bug reports and suggestions for improvements are always welcome. PRs are even better!! 
+
+If you run into any issues, before submitting a new GitHub issue, please make sure to
+
+* Check out the entire README on this repo 
+* Search for [existing GitHub issues](https://github.com/azohra/forsis/issues)
+
+If the above doesn't help, please submit an issue on [GitHub](https://github.com/azohra/forsis/issues). When reporting a bug, please make sure to include a spec that highlights the bug.
+  
+## License
+
+This software is available as open source under the terms of the MIT License.
+

data/lib/fastlane/plugin/forsis.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/forsis/version'
+
+module Fastlane
+  module Forsis
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Forsis.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/forsis/actions/forsis_action.rb

@@ -0,0 +1,65 @@
+require 'fastlane/action'
+require_relative '../helper/forsis_helper'
+
+module Fastlane
+  module Actions
+    class ForsisAction < Action
+
+      def self.run(params)
+        junit_report_path = params[:junit_report_file]
+        sonarqube_report_path = params[:sonar_report_directory]
+        UI.message("Generating the Sonarqube generic test execution report!")
+        Fastlane::Helper::ForsisHelper::Generator.generate(junit_report_path, sonarqube_report_path)
+      end
+
+      def self.description
+        "This plugin converts the fastlane-generated junit test report to a sonarqube generic test execution report"
+      end
+
+      def self.authors
+        ["Azadeh Bagheri"]
+      end
+
+      def self.details
+        "This plugin uses junit test reports generated by fastlane and converts them into the sonarqube generic test execution reports"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :junit_report_file,
+            env_name: "forsis_JUNIT_REPORT",
+            description: "The path of the junit test report file used to generate the generic test execution file for sonarqube ",
+            optional: false,
+            type: String,
+            display_in_shell: false,
+            verify_block: proc do |path|
+              if path == ""
+                UI.user_error!("'forsis' action missing the key 'junit_report_path' or its value.")
+              else
+                UI.user_error!("ERROR: junit report not found at path: #{path}") unless File.exist?(path)
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :sonar_report_directory,
+            env_name: "forsis_SONAR_GENERATED_REPORT",
+            description: "The path of the sonarqube test execution report generated from the junit test report",
+            optional: true,
+            default_value: './fastlane',
+            type: String,
+            verify_block: proc do |path|
+              FileUtils.mkdir_p(path) unless File.directory?(path)
+            end
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+        true
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/forsis/helper/forsis_helper.rb

@@ -0,0 +1,54 @@
+require 'nokogiri'
+
+module Fastlane
+  module Helper
+    module ForsisHelper
+      class Generator
+        def self.generate(junit_report_path, sonarqube_report_path)
+          junit_file = Nokogiri::XML(File.open(junit_report_path))
+          sonarqube_file = File.open(sonarqube_report_path + "/Test_sonarqube_report.xml", 'w')
+          test_suites = junit_file.xpath("//testsuite")
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.testExecutions({ version: :"1" }) do
+              test_suites.each do |test_file|
+                file_name = `echo #{test_file["name"]}| cut -d'.' -f 2`.gsub(/\n/, '')
+                file_path = get_test_file_path(file_name)
+                test_cases = []
+                test_file.children.each do |child|
+                  test_cases << child if child.class == Nokogiri::XML::Element
+                end
+                xml.file({ path: :"#{file_path}" }) do
+                  test_cases.each do |test|
+                    test_duration = (test["time"].to_f * 1000).round
+                    test_failures = []
+                    test.children.each do |test_child|
+                      test_failures << test_child if test_child.class == Nokogiri::XML::Element
+                    end
+                    xml.testCase({ name: :"#{test["name"]}", duration: :"#{test_duration}" }) do
+                      test_failures.each do |failure|
+                        failure_type = failure.name
+                        failure_message = failure["message"]
+                        failure_description = failure.text
+                        xml.send(failure_type, failure_description, message: failure_message)
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+          sonarqube_file.puts(builder.to_xml)
+          sonarqube_file.close
+        end
+
+        def self.get_test_file_path(file_name)
+          `find . -iname "#{file_name}.swift"`.gsub(/\n/, '')
+        end
+      end
+
+      def self.show_message
+        UI.message("Hello from the forsis plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-forsis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Azadeh Bagheri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.111.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.111.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.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: 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: 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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: simplecov
+  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'
+description: 
+email: Azadeh.Bagheri@loblaw.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/forsis.rb
+- lib/fastlane/plugin/forsis/actions/forsis_action.rb
+- lib/fastlane/plugin/forsis/helper/forsis_helper.rb
+- lib/fastlane/plugin/forsis/version.rb
+homepage: https://github.com/azohra/forsis
+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.6.11
+signing_key: 
+specification_version: 4
+summary: This plugin converts junit test reports to gthe sonarqube generic test execution
+  report
+test_files: []