fastlane-plugin-allure_zephyr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a25396053c7f6f8015b037196ddd86685dc5c3b7205db0d3e6a29c9e3a0ddb50
+  data.tar.gz: 6e19659ac3d9450aaf948ba6735e2f31fbd801606ba12723a011a46b5fae9ba7
+SHA512:
+  metadata.gz: 4d0e8233821aa0f8b5704eb05da8baf1f4c817d5e6da19ed6716812a06b1a46d5affaeca285fc6cea79d362e3c9bd48dd4efc383b498945370f52e3237c75d23
+  data.tar.gz: 3ac38be85392f245493d388efb4c72ccb04941fcd89d5376e995d108d166482a8f16f569811fde05cacec9fb794d4d42a65ad67f342966d0aed77d0c0ad52a7f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nikita Ianenko <yanenko@hotmail.com>
+
+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,48 @@
+# allure_zephyr plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-allure_zephyr)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-allure_zephyr`, add it to your project by running:
+
+```bash
+fastlane add_plugin allure_zephyr
+```
+
+## About allure_zephyr
+
+Publish Allure results to Zephyr
+
+## 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`.
+
+## 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
+
+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/fastlane/plugin/allure_zephyr.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/allure_zephyr/version'
+
+module Fastlane
+  module AllureZephyr
+    # 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::AllureZephyr.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/allure_zephyr/actions/allure_zephyr_action.rb

@@ -0,0 +1,98 @@
+require 'fastlane/action'
+require_relative '../helper/allure_zephyr_helper'
+
+module Fastlane
+  module Actions
+    class AllureZephyrAction < Action
+      def self.run(params)
+        report_path = File.expand_path(params[:report_path])
+
+        helper = Helper::AllureZephyrHelper.new(
+          project: params[:project], 
+          jira_api: params[:jira_api_url], 
+          zephyr_api: params[:zephyr_api_url], 
+          credentials: { username: params[:jira_username], password: params[:jira_password] },
+          report_path: report_path,
+          limit_by_project: params[:limit_by_project]
+        )
+        helper.execute_all(version: params[:version], cycle: params[:cycle])
+      end
+
+      def self.description
+        "Publish Allure results to Zephyr"
+      end
+
+      def self.authors
+        ["Nikita Ianenko"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "This plugin publishes test results from Allure to Zephyr, for those tests that have links included."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :report_path,
+                               description: "Path to Allure report directory",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :project,
+                               description: "JIRA project ID",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :jira_api_url,
+                               description: "JIRA API URL (e.g. https://jira.example.com/rest/api/2)",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :zephyr_api_url,
+                               description: "Zephyr API URL (e.g. https://jira.example.com/rest/zapi/latest)",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :jira_username,
+                               description: "JIRA user name to log in",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :jira_password,
+                               description: "JIRA password to log in",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :version,
+                               description: "Version of the app that tests run against",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :cycle,
+                               description: "Test cycle name",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :limit_by_project,
+                               description: "Project name to limit links by. By default, all links are parsed, even if they belong to different JIRA projects",
+                                  optional: true,
+                                 is_string: true,
+                                      type: String,
+                             default_value: nil),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/allure_zephyr/helper/allure_zephyr_helper.rb

@@ -0,0 +1,175 @@
+require 'fastlane_core/ui/ui'
+require 'HTTParty'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class AllureZephyrHelper
+      def initialize(project:, jira_api:, zephyr_api:, credentials:, report_path:, limit_by_project: nil)
+        @tests = Hash.new
+        @project = project
+        @jira_api = jira_api
+        @zephyr_api = zephyr_api
+        @credentials = credentials
+        get_all_statuses(report_path: report_path, limit_by_project: limit_by_project)
+      end
+
+      def get_all_statuses(report_path:, limit_by_project: nil)
+        UI.message("Getting statuses of all tests from '#{report_path}'...")
+        regex_status = /status": "(\w+)"/
+        regex_url = limit_by_project.nil? ? /url.*\/([\w\d\-]+)"/ : /url.*(#{limit_by_project}-\d+)/
+        pattern_links = "links"
+        pattern_links_end = "]"
+
+        path = "#{report_path}/data/test-cases"
+
+        Dir.each_child(path) do |file|
+          status = nil
+          links_found = nil
+
+          IO.foreach("#{path}/#{file}") do |line|
+            if status.nil?
+              status_match = line.match(regex_status)
+              status = status_match[1].to_sym unless status_match.nil?
+            elsif links_found.nil?
+              links_found = true if line.include?(pattern_links)
+            else
+              url_match = line.match(regex_url)
+              unless url_match.nil?
+                key = url_match[1]
+                @tests[key] = [status, nil] if @tests[key].nil? || (@tests[key][0] != status && @tests[key][0] == :passed)
+                break if line.include?(pattern_links_end)
+              end
+            end
+          end
+        end
+      end
+
+      def execute_all(version:, cycle:)
+        statuses = Hash.new
+
+        version_id = get_version_id(version_name: version)
+        cycle_id = get_cycle_id(cycle_name: cycle, version_id: version_id) || create_cycle(cycle_name: cycle, version_id: version_id)
+
+        @tests.each do |ticket, value|
+          execution = create_execution(
+            ticket_number: ticket, 
+            cycle_id: cycle_id, 
+            version_id: version_id
+          )
+          @tests[ticket][1] = execution
+          statuses[value[0]] = [] if statuses[value[0]].nil?
+          statuses[value[0]] << execution
+        end
+
+        statuses.each do |status, executions|
+          case status
+          when :passed
+            status_code = 1
+          when :failed
+            status_code = 2
+          else
+            status_code = 5
+          end
+          UI.message("Setting execution status for all '#{status}' tests...")
+          execute(executions: executions, status: status_code)
+        end
+      end
+
+      def create_execution(ticket_number:, cycle_id:, version_id:)
+        UI.message("Creating execution for #{ticket_number}...")
+        path = "#{@zephyr_api}/execution"
+
+        ticket_id = get_ticket_id(ticket_number: ticket_number)
+        body = {
+          cycleId: cycle_id,
+          issueId: ticket_id,
+          projectId: @project,
+          versionId: version_id,
+        }
+      
+        response = HTTParty.post(path, { basic_auth: @credentials, headers: { "Content-Type": "application/json" }, body: body.to_json })
+        UI.user_error!("Can't create execution for #{cycle_id} cycle. Expected code 200, got #{response.code}") unless response.code == 200
+        parsed = JSON.parse(response.body)
+
+        return parsed.keys[0]
+      end
+
+      def execute(executions:, status:)
+        path = "#{@zephyr_api}/execution/updateBulkStatus"
+
+        body = {
+          executions: executions,
+          status: status
+        }
+
+        response = HTTParty.put(path, { basic_auth: @credentials, headers: { "Content-Type": "application/json" }, body: body.to_json })
+        UI.user_error!("Can't create execution for #{cycle_id} cycle. Expected code 200, got #{response.code}") unless response.code == 200
+      end
+
+      def get_version_id(version_name:)
+        UI.message("Getting ID of version named '#{version_name}'...")
+        return -1 if version_name == "Unscheduled"
+      
+        path = "#{@jira_api}/project/#{@project}/versions"
+      
+        response = HTTParty.get(path, { basic_auth: @credentials })
+        UI.user_error!("Can't get versions of project #{@project}. Expected code 200, got #{response.code}") unless response.code == 200
+        parsed = JSON.parse(response.body)
+      
+        parsed.each do |version|
+          return version["id"] if version["name"] == version_name
+        end
+      
+        UI.user_error!("Version '#{version_name}' couldn't be found!")
+      end
+
+      def get_cycle_id(cycle_name:, version_id:)
+        UI.message("Checking if '#{cycle_name}' cycle already exists...")
+        path = "#{@zephyr_api}/cycle?projectId=#{@project}&versionId=#{version_id}"
+      
+        response = HTTParty.get(path, { basic_auth: @credentials })
+        UI.user_error!("Can't get cycles of project #{@project} with version #{version_id}. Expected code 200, got #{response.code}") unless response.code == 200
+        parsed = JSON.parse(response.body)
+      
+        parsed.each do |id, cycle|
+          next if id == "recordsCount"
+          return id if cycle["name"] == cycle_name
+        end
+      
+        return nil
+      end
+
+      def create_cycle(cycle_name:, version_id:)
+        UI.message("Creating cycle '#{cycle_name}'...")
+        path = "#{@zephyr_api}/cycle"
+      
+        today = Time.now.strftime("%e/%b/%y")
+        body = {
+          name: cycle_name,
+          projectId: @project,
+          versionId: version_id,
+          startDate: today,
+          endDate: today,
+        }
+      
+        response = HTTParty.post(path, { basic_auth: @credentials, headers: { "Content-Type": "application/json" }, body: body.to_json })
+        UI.user_error!("Can't create cycle '#{cycle_name}'. Expected code 200, got #{response.code}") unless response.code == 200
+        parsed = JSON.parse(response.body)
+      
+        return parsed["id"]
+      end
+      
+      def get_ticket_id(ticket_number:)
+        path = "#{@jira_api}/issue/#{ticket_number}"
+      
+        response = HTTParty.get(path, { basic_auth: @credentials })
+        UI.user_error!("Can't get ticket ID of '#{ticket_number}'. Expected code 200, got #{response.code}") unless response.code == 200
+        parsed = JSON.parse(response.body)
+      
+        return parsed["id"]
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-allure_zephyr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikita Ianenko
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-24 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.170.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.170.0
+description:
+email: yanenko@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/allure_zephyr.rb
+- lib/fastlane/plugin/allure_zephyr/actions/allure_zephyr_action.rb
+- lib/fastlane/plugin/allure_zephyr/helper/allure_zephyr_helper.rb
+- lib/fastlane/plugin/allure_zephyr/version.rb
+homepage: https://github.com/sokecze/fastlane-plugin-allure_zephyr
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Publish Allure results to Zephyr
+test_files: []