swiftrail 0.1.2

data/lib/swiftrail/junit/report.rb

@@ -0,0 +1,10 @@
+module Swiftrail
+  module Junit
+    TestSuite = Struct.new(:suite_name, :test_cases)
+    TestCase = Struct.new(:full_class_name, :class_name, :test_name, :failures, :duration) do
+      def success?
+        failures.empty?
+      end
+    end
+  end
+end

data/lib/swiftrail/swift/parser.rb

@@ -0,0 +1,58 @@
+require 'swiftrail/swift/test'
+
+module Swiftrail
+  module Swift
+    class Parser
+      def initialize(test_patterns)
+        @test_patterns = test_patterns
+      end
+
+      def parse
+        all_files.map do |file_name|
+          collect_test_cases(file_name, IO.read(file_name))
+        end.flatten
+      end
+
+      private
+
+      attr_reader :test_patterns
+      RegexMatch = Struct.new(:case_ids, :class_type?, :name)
+
+      def all_files
+        test_patterns.map do |test_pattern|
+          Dir[test_pattern]
+        end.flatten.uniq
+      end
+
+      # @return [Test]
+      def collect_test_cases(file_name, content)
+        class_cases = []
+        class_name = ''
+        content.scan(cases_regex).map { |match|
+          RegexMatch.new(sanitize(match[1]), match[2] == 'class ', match[3])
+        }.reduce([]) { |result, match|
+          if match.class_type?
+            class_cases = match.case_ids
+            class_name = match.name
+          else
+            result << Test.new(file_name, class_name, match.name, (match.case_ids + class_cases).uniq)
+          end
+          result
+        }
+      end
+
+      def cases_regex
+        %r{(//\s*TESTRAIL\s*([(C(0-9)*)|\s|,]*)$\s*)*(func |class )\s*(\w*)\s*(\(\)|:\s*XCTestCase)}im
+      end
+
+      def sanitize(case_ids)
+        return [] if case_ids.nil? || case_ids.empty?
+
+        case_ids.delete(' ')
+                .split(',')
+                .select { |case_id| case_id.downcase.start_with?('c') }
+                .map { |case_id| case_id[1..-1] }
+      end
+    end
+  end
+end

data/lib/swiftrail/swift/test.rb

@@ -0,0 +1,14 @@
+module Swiftrail
+  module Swift
+    Test = Struct.new(:file_name, :class_name, :test_name, :case_ids) do
+      def to_json(*args)
+        {
+          file_name: file_name,
+          class_name: class_name,
+          test_name: test_name,
+          case_ids: case_ids
+        }
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/api/client.rb

@@ -0,0 +1,82 @@
+require 'net/https'
+require 'uri'
+require 'json'
+
+require 'swiftrail/testrail/api/error'
+require 'swiftrail/testrail/api/test_rail_test'
+
+module Swiftrail
+  module Testrail
+    module Api
+      class Client
+        def initialize(base_url, username, password, run_id)
+          @conn = connection(URI.parse(base_url))
+          @run_id = run_id
+          @username = username
+          @password = password
+        end
+
+        def publish_results(results)
+          response = conn.request(post_request(publish_result_path, results))
+
+          raise Error::InvalidRequest if response.code == '400'
+          raise Error::NoPermission if response.code == '403'
+          raise Error::Unknown, response.code unless response.code == '200'
+
+          true
+        end
+
+        # @return [TestRailTest]
+        def all_tests
+          response = conn.request(get_request(tests_for_run_path))
+
+          raise Error::InvalidRequest if response.code == '400'
+          raise Error::NoPermission if response.code == '403'
+          raise Error::Unknown, response.code unless response.code == '200'
+
+          JSON.parse(response.body).map do |item|
+            TestRailTest.from_json(item)
+          end
+        end
+
+        private
+
+        attr_reader :conn, :run_id, :username, :password
+
+        def connection(url)
+          conn = Net::HTTP.new(url.host, url.port)
+          conn.use_ssl = true
+          conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          conn
+        end
+
+        def post_request(path, results)
+          request = Net::HTTP::Post.new(path)
+          request.body = JSON.dump(post_json(results))
+          request.basic_auth(username, password)
+          request.add_field('Content-Type', 'application/json')
+          request
+        end
+
+        def get_request(path)
+          request = Net::HTTP::Get.new(path)
+          request.basic_auth(username, password)
+          request.add_field('Content-Type', 'application/json')
+          request
+        end
+
+        def post_json(results)
+          { results: results.map(&:to_json) }
+        end
+
+        def publish_result_path
+          "/index.php?/api/v2/add_results_for_cases/#{run_id}"
+        end
+
+        def tests_for_run_path
+          "/index.php?/api/v2/get_tests/#{run_id}"
+        end
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/api/error.rb

@@ -0,0 +1,27 @@
+require 'swiftrail/errors/error'
+
+module Swiftrail
+  module Testrail
+    module Api
+      module Error
+        class InvalidRequest < Errors::Base
+          def initialize
+            super('Invalid or unknown test run/cases')
+          end
+        end
+
+        class NoPermission < Errors::Base
+          def initialize
+            super('No permissions to add test results or no access to the project')
+          end
+        end
+
+        class Unknown < Errors::Base
+          def initialize(status_code)
+            super("There has been an unknown error.rb (status code: #{status_code} while doing api request")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/api/test_case_result.rb

@@ -0,0 +1,38 @@
+module Swiftrail
+  module Testrail
+    module Api
+      # noinspection RubyConstantNamingConvention
+      TestCaseResult = Struct.new(:case_id, :comment, :duration, :status) do
+        def to_json(*_args)
+          {
+            case_id: case_id,
+            status_id: status,
+            comment: comment,
+            elapsed: duration
+          }
+        end
+
+        def self.from(case_id, results)
+          TestCaseResult.new(case_id, comment(results), duration(results), status(results))
+        end
+
+        def self.status(results)
+          results.map(&:success?).all? ? 1 : 5
+        end
+
+        def self.comment(results)
+          comments = results.map do |result|
+            value = " - #{result.success? ? '**SUCCESS**' : '**FAILURE**'}, `#{result.class_name}.#{result.test_name}` in `#{result.file_name}`"
+            value += " with following errors \n" + result.failures.map { |message| "   + `#{message}`"}.join("\n") unless result.success?
+            value
+          end
+          (['#Results:#'] + comments + ['']).join("\n")
+        end
+
+        def self.duration(results)
+          format('%.2fs', results.map(&:duration).sum)
+        end
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/api/test_rail_test.rb

@@ -0,0 +1,19 @@
+module Swiftrail
+  module Testrail
+    module Api
+      TestRailTest = Struct.new(:case_id, :id, :title) do
+        def self.from_json(json)
+          TestRailTest.new(json['case_id'], json['id'], json['title'])
+        end
+
+        def to_json(*_args)
+          {
+            id: id,
+            case_id: case_id,
+            title: title
+          }
+        end
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/assembler.rb

@@ -0,0 +1,51 @@
+require 'swiftrail/testrail/errors'
+require 'swiftrail/testrail/api/test_case_result'
+require 'swiftrail/testrail/intermediate_result'
+
+module Swiftrail
+  module Testrail
+    class Assembler
+      def initialize(swift_tests, junit_test_suites)
+        @swift_tests = swift_tests
+        @junit_test_suites = junit_test_suites
+      end
+
+      def assemble
+        intermediate_results.group_by(&:case_id).map do |k, v|
+          Api::TestCaseResult.from(k, v)
+        end
+      end
+
+      private
+
+      attr_reader :swift_tests, :junit_test_suites
+
+      def intermediate_results
+        junit_test_suites.map(&method(:test_cases)).flatten
+      end
+
+      def test_cases(test_suite)
+        test_suite.test_cases.map do |test_case|
+          swift_test = swift_test_for(test_case)
+          if swift_test.nil?
+            []
+          else
+            swift_test.case_ids.map do |case_id|
+              IntermediateResult.new(swift_test.file_name, swift_test.class_name, swift_test.test_name, test_case.success?, test_case.duration, test_case.failures, case_id)
+            end
+          end
+        end
+      end
+
+      def swift_test_for(junit_test_case)
+        tests = swift_tests.select do |test|
+          test.class_name == junit_test_case.class_name &&
+            test.test_name == junit_test_case.test_name
+        end
+        raise Error::Ambiguity(junit_test_case, tests) if tests.count > 1
+
+        tests.first
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/coverage.rb

@@ -0,0 +1,62 @@
+require 'swiftrail/swift/parser'
+
+module Swiftrail
+  module Testrail
+    class Coverage
+      def initialize(tests_patterns, test_rail_username, test_rail_password, test_rail_base_url)
+        @tests_patterns = tests_patterns
+        @test_rail_username = test_rail_username
+        @test_rail_password = test_rail_password
+        @test_rail_base_url = test_rail_base_url
+      end
+
+      def coverage_report(run_id)
+        coverage_results = test_rail_client(run_id).all_tests.each_with_object({}) do |test, hash|
+          hash[test] = swift_tests_for_case_id(test.case_id)
+        end
+        generate_report(coverage_results)
+      end
+
+      private
+
+      attr_reader :tests_patterns, :test_rail_username, :test_rail_password, :test_rail_base_url
+
+      def swift_tests_for_case_id(case_id)
+        swift_tests.select do |swift_test|
+          swift_test.case_ids.include?(case_id.to_s)
+        end
+      end
+
+      def test_rail_client(run_id)
+        Swiftrail::Testrail::Api::Client.new(test_rail_base_url, test_rail_username, test_rail_password, run_id)
+      end
+
+      # @return json
+      def generate_report(results)
+        {
+          coverage: {
+            covered: results.values.reject { |value| value.nil? || value.empty? }.count.to_f,
+            total_test_cases: results.keys.count.to_f,
+            percentage: results.values.reject { |value| value.nil? || value.empty? }.count.to_f / results.keys.count.to_f
+          },
+          metadata: results.map do |test_rail_test, swift_tests|
+                      {
+                        test_rail: test_rail_test.to_json,
+                        covered_by: [
+                          swift_tests.map(&:to_json)
+                        ]
+                      }
+                    end
+        }
+      end
+
+      def swift_tests
+        @swift_tests ||= swift_test_parser.parse
+      end
+
+      def swift_test_parser
+        Swiftrail::Swift::Parser.new(tests_patterns)
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/errors.rb

@@ -0,0 +1,13 @@
+require 'swiftrail/errors/error'
+
+module Swiftrail
+  module Testrail
+    module Error
+      class Ambiguity < Errors::Base
+        def initialize(test_case, swift_tests)
+          super("Test Case (#{test_case} from junit report, corresponds to multiple swift tests #{swift_tests}")
+        end
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/intermediate_result.rb

@@ -0,0 +1,5 @@
+module Swiftrail
+  module Testrail
+    IntermediateResult = Struct.new(:file_name, :class_name, :test_name, :success?, :duration, :failures, :case_id)
+  end
+end

data/lib/swiftrail/testrail/lint.rb

@@ -0,0 +1,61 @@
+require 'swiftrail/swift/parser'
+
+module Swiftrail
+  module Testrail
+    class Lint
+      def initialize(tests_patterns, test_rail_username, test_rail_password, test_rail_base_url)
+        @tests_patterns = tests_patterns
+        @test_rail_username = test_rail_username
+        @test_rail_password = test_rail_password
+        @test_rail_base_url = test_rail_base_url
+      end
+
+      def lint_report(run_id)
+        missing_cases = all_tests_by_case_id.keys - test_rail_client(run_id).all_tests.map(&:case_id).map(&:to_s)
+        generate_report(missing_cases)
+      end
+
+      private
+
+      attr_reader :tests_patterns, :test_rail_username, :test_rail_password, :test_rail_base_url
+
+      def swift_tests_for_case_id(case_id)
+        swift_tests.select do |swift_test|
+          swift_test.case_ids.include?(case_id.to_s)
+        end
+      end
+
+      def test_rail_client(run_id)
+        Swiftrail::Testrail::Api::Client.new(test_rail_base_url, test_rail_username, test_rail_password, run_id)
+      end
+
+      def generate_report(case_ids)
+        {
+          reporting_invalid_case_ids: case_ids.map do |case_id|
+            { case_id => all_tests_by_case_id[case_id].map(&:to_json) }
+          end
+        }
+      end
+
+      def all_tests_by_case_id
+        @all_tests_by_case_id ||= swift_tests.each_with_object({}) do |test, hash|
+          test.case_ids.map do |case_id|
+            if hash.key?(case_id)
+              hash[case_id] << test
+            else
+              hash[case_id] = [test]
+            end
+          end
+        end
+      end
+
+      def swift_tests
+        swift_test_parser.parse
+      end
+
+      def swift_test_parser
+        Swiftrail::Swift::Parser.new(tests_patterns)
+      end
+    end
+  end
+end

data/lib/swiftrail/testrail/reporter.rb

@@ -0,0 +1,42 @@
+require 'swiftrail/junit/parser'
+require 'swiftrail/swift/parser'
+require 'swiftrail/testrail/assembler'
+require 'swiftrail/testrail/api/client'
+
+module Swiftrail
+  module Testrail
+    class Reporter
+      def initialize(test_report_patterns, tests_patterns, test_rail_username, test_rail_password, test_rail_base_url)
+        @test_report_patterns = test_report_patterns
+        @tests_patterns = tests_patterns
+        @test_rail_username = test_rail_username
+        @test_rail_password = test_rail_password
+        @test_rail_base_url = test_rail_base_url
+      end
+
+      def report_results(run_id)
+        test_rail_client(run_id).publish_results(assembler(swift_test_parser.parse, junit_parser.parse).assemble)
+      end
+
+      private
+
+      attr_reader :test_report_patterns, :tests_patterns, :test_rail_username, :test_rail_password, :test_rail_base_url
+
+      def test_rail_client(run_id)
+        Api::Client.new(test_rail_base_url, test_rail_username, test_rail_password, run_id)
+      end
+
+      def assembler(swift_tests, junit_test_suites)
+        Assembler.new(swift_tests, junit_test_suites)
+      end
+
+      def swift_test_parser
+        Swiftrail::Swift::Parser.new(tests_patterns)
+      end
+
+      def junit_parser
+        Swiftrail::Junit::Parser.new(test_report_patterns)
+      end
+    end
+  end
+end

data/lib/swiftrail/version.rb

@@ -0,0 +1,3 @@
+module Swiftrail
+  VERSION = '0.1.2'.freeze
+end

data/lib/swiftrail.rb

@@ -0,0 +1,9 @@
+require 'swiftrail/version'
+
+require 'swiftrail/junit/parser'
+require 'swiftrail/swift/parser'
+require 'swiftrail/testrail/assembler'
+require 'swiftrail/testrail/reporter'
+require 'swiftrail/testrail/coverage'
+require 'swiftrail/testrail/lint'
+require 'swiftrail/testrail/api/client'

data/swiftrail.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swiftrail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'swiftrail'
+  spec.version       = Swiftrail::VERSION
+  spec.authors       = ['Slavko Krucaj']
+  spec.email         = ['slavko.krucaj@gmail.com']
+
+  spec.summary       = 'Library that manages reporting of swift test results to test rail.'
+  spec.homepage      = 'https://www.github.com/SlavkoKrucaj/swiftrail'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.10'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: swiftrail
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Slavko Krucaj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- slavko.krucaj@gmail.com
+executables:
+- swiftrail
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/swiftrail
+- lib/swiftrail.rb
+- lib/swiftrail/cli.rb
+- lib/swiftrail/config/errors.rb
+- lib/swiftrail/config/reader.rb
+- lib/swiftrail/errors/error.rb
+- lib/swiftrail/junit/parser.rb
+- lib/swiftrail/junit/report.rb
+- lib/swiftrail/swift/parser.rb
+- lib/swiftrail/swift/test.rb
+- lib/swiftrail/testrail/api/client.rb
+- lib/swiftrail/testrail/api/error.rb
+- lib/swiftrail/testrail/api/test_case_result.rb
+- lib/swiftrail/testrail/api/test_rail_test.rb
+- lib/swiftrail/testrail/assembler.rb
+- lib/swiftrail/testrail/coverage.rb
+- lib/swiftrail/testrail/errors.rb
+- lib/swiftrail/testrail/intermediate_result.rb
+- lib/swiftrail/testrail/lint.rb
+- lib/swiftrail/testrail/reporter.rb
+- lib/swiftrail/version.rb
+- swiftrail.gemspec
+homepage: https://www.github.com/SlavkoKrucaj/swiftrail
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Library that manages reporting of swift test results to test rail.
+test_files: []