swiftrail 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 644bf67a0db0447a400e42b54b8e956941d6368ac8a0955ce93309117301c1fc
+  data.tar.gz: a20f2a2931a777420512d0f739a9f4e3ce8817bb7fa0ce3164eb7b8c39768020
+SHA512:
+  metadata.gz: 9341f64cb2a50454c6c045da1839d86958a4d87d00b0b7793411d6d3a289602737d49da9ba0a2840da92093947dd6843dc297974f61dab443f533f5f71b98dea
+  data.tar.gz: 1697f0c9be55a206d276e75f06efa1d2c2fe11ab4c80f11081582bfcef42c228862ac88e4487bc039cf8cc492396f474973139cdf4dde12bd067ff244b9dcbce

data/.gitignore

@@ -0,0 +1,198 @@
+
+# Created by https://www.gitignore.io/api/ruby,rubymine,rubymine+all
+# Edit at https://www.gitignore.io/?templates=ruby,rubymine,rubymine+all
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+# JetBrains templates
+**___jb_tmp___
+
+### RubyMine Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### RubyMine+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+
+# Generated files
+
+# Sensitive or high-churn files
+
+# Gradle
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# CMake
+
+# Mongo Explorer plugin
+
+# File-based project format
+
+# IntelliJ
+
+# mpeltonen/sbt-idea plugin
+
+# JIRA plugin
+
+# Cursive Clojure plugin
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+
+# Editor-based Rest Client
+
+# Android studio 3.1+ serialized cache file
+
+# JetBrains templates
+
+### RubyMine+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+
+# End of https://www.gitignore.io/api/ruby,rubymine,rubymine+all

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 170
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at slavko.krucaj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swiftrail.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    swiftrail (0.1.2)
+      nokogiri (~> 1.10)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  swiftrail!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Slavko Krucaj
+
+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,102 @@
+# Swiftrail
+
+A gem command line tool to help with assembling test reports and pairing them with the [testrail](https://www.gurock.com/testrail) test cases
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swiftrail'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+## Usage
+
+### Options
+
+Mandatory options for all of the commands are
+ 
+    - `--test_classes=''` - regex for the path to swift tests
+    - `--test_rail_username=''` - username for TestRail account
+    - `--test_rail_password=''` - password for TestRail account
+    - `--test_rail_url=''` -  url for TestRail account
+    - `--run_id=''` - run_id for which you want to run the command
+
+When running report you additionaly have to pass location of the test_reports
+    - `--test-reports=''`
+
+### Marking test cases
+
+In your `swift` projects you can mark any test class or specific test with any number of TestRail test cases. To mark them
+specify the `//testrail` and after that just list the corresponding **case**-ids. Example
+
+```swift
+//testrail C12344
+class MyTests: XCTestCase {
+
+    //testrail C12344, C3267231
+    func test_first() {
+    }
+
+    //testrail C15
+    func test_second() {
+    }
+
+    func test_third() {
+    }
+}
+
+class MyOtherTests: XCTestCase {
+
+    //testrail C5555
+    func test_four() {
+    }
+
+    //testrail C15
+    func test_five() {
+    }
+
+    func test_six() {
+    }
+}
+```
+### Report
+
+To be able to report the results of the tests, you need to first generate xml junit reports. Once you have those, running
+```
+swiftrail report --test-reports='path/to/test/reports' --run_id:123 (all the other options should also be listed)
+```
+will report the results to TestRail. Dependent on success/failure the tests on TestRail will be marked accordingly.
+
+### Coverage
+
+Coverage report will give you the percentage of test cases covered by your ui/unit/... tests.
+
+```
+swiftrail coverage --run_id:123 (all the other options should also be listed)
+```
+
+### Lint
+
+Lint will give you outadet case_ids that you have marked on your ui/unit tests, but no longer exist as test cases on TestRail.
+
+```
+swiftrail lint --run_id:123 (all the other options should also be listed)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/slavkokrucaj/swiftrail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Swiftrail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/slavkokrucaj/swiftrail/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/swiftrail

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'swiftrail/cli'
+require 'swiftrail/testrail/coverage'
+require 'swiftrail/testrail/lint'
+
+begin
+  Swiftrail::Cli.start
+rescue Swiftrail::Errors::Base => e
+  warn e
+  exit(false)
+end

data/lib/swiftrail/cli.rb

@@ -0,0 +1,71 @@
+require 'thor'
+require 'swiftrail'
+require 'swiftrail/config/reader'
+
+module Swiftrail
+  class Cli < Thor
+    private
+
+    def self.defaults
+      @defaults ||= Config::Reader.new.defaults
+    end
+
+    public
+
+    class_option :test_classes, type: :string, default: defaults['test_classes'], desc: 'Regex to match your tests.'
+    class_option :test_rail_username, type: :string, default: defaults['test_rail_username'], desc: 'Username for your test rail account.'
+    class_option :test_rail_password, type: :string, default: defaults['test_rail_password'], desc: 'Password for your test rail account.'
+    class_option :test_rail_url, type: :string, default: defaults['test_rail_url'], desc: 'Base url for your testrail account.'
+    class_option :run_id, type: :string, default: defaults['run_id'], desc: 'Test Rail run id for which you\'re executing an action'
+
+    desc 'report', 'Reports success/failure to test rail, based on the results of your tests'
+    method_option :test_reports, type: :string, aliases: '-reports', default: defaults['reports'], desc: 'Regex to match your junit report files.'
+    def report
+      if swiftrail_reporter.report_results(options[:run_id])
+        puts 'Successfully reported the results'
+      else
+        puts 'There was an issue while reporting the results'
+      end
+    end
+
+    desc 'coverage', 'Reports coverage of all the tests on testrail account'
+    def coverage
+      puts(swiftrail_coverage.coverage_report(options[:run_id]))
+    end
+
+    desc 'lint', 'Reports case ids that are missing on testrail account'
+    def lint
+      puts(swiftrail_lint.lint_report(options[:run_id]))
+    end
+
+    private
+
+    def swiftrail_reporter
+      Swiftrail::Testrail::Reporter.new(
+        [options['test_reports']],
+        [options['test_classes']],
+        options['test_rail_username'],
+        options['test_rail_password'],
+        options['test_rail_url']
+      )
+    end
+
+    def swiftrail_coverage
+      Swiftrail::Testrail::Coverage.new(
+        [options['test_classes']],
+        options['test_rail_username'],
+        options['test_rail_password'],
+        options['test_rail_url']
+      )
+    end
+
+    def swiftrail_lint
+      Swiftrail::Testrail::Lint.new(
+        [options['test_classes']],
+        options['test_rail_username'],
+        options['test_rail_password'],
+        options['test_rail_url']
+      )
+    end
+  end
+end

data/lib/swiftrail/config/errors.rb

@@ -0,0 +1,13 @@
+require 'swiftrail/errors/error'
+
+module Swiftrail
+  module Config
+    module Error
+      class InvalidFile < Errors::Base
+        def initialize(file)
+          super("Config file (#{file}) for swiftrail is not valid")
+        end
+      end
+    end
+  end
+end

data/lib/swiftrail/config/reader.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+module Swiftrail
+  module Config
+    class Reader
+      def defaults
+        raise Error::InvalidFile(defaults_file_name) unless valid_file?
+
+        base_defaults.merge(file_defaults)
+      end
+
+      private
+
+      def valid_file?
+        file_defaults.is_a?(Hash)
+      end
+
+      def base_defaults
+        {
+          reports: '',
+          test_classes: '',
+          test_rail_username: '',
+          test_rail_password: '',
+          test_rail_url: ''
+        }
+      end
+
+      def file_defaults
+        @file_defaults ||= if File.exist?(defaults_file_name)
+                             YAML.safe_load(File.read(defaults_file_name))
+                           else
+                             {}
+                           end
+      end
+
+      def defaults_file_name
+        '.swiftrail.yml'
+      end
+    end
+  end
+end

data/lib/swiftrail/errors/error.rb

@@ -0,0 +1,6 @@
+module Swiftrail
+  module Errors
+    class Base < StandardError
+    end
+  end
+end

data/lib/swiftrail/junit/parser.rb

@@ -0,0 +1,57 @@
+require 'nokogiri'
+require 'swiftrail/junit/report'
+
+module Swiftrail
+  module Junit
+    class Parser
+      def initialize(junit_patterns)
+        @junit_patterns = junit_patterns
+      end
+
+      def parse
+        all_files.map(&method(:test_suites)).flatten
+      end
+
+      private
+
+      attr_reader :junit_patterns
+
+      def all_files
+        junit_patterns.map do |junit_pattern|
+          Dir[junit_pattern]
+        end.flatten.uniq
+      end
+
+      def test_suites(file)
+        read_report(file).xpath('//testsuite').map(&method(:create_test_suite))
+      end
+
+      def read_report(file)
+        Nokogiri::XML(IO.read(file))
+      end
+
+      def create_test_suite(test_suite)
+        TestSuite.new(
+          test_suite[:name],
+          test_cases(test_suite)
+        )
+      end
+
+      def test_cases(test_suite)
+        test_suite.xpath('.//testcase').map do |test_case|
+          TestCase.new(
+            test_case[:classname],
+            test_case[:classname].split('.').last,
+            test_case[:name],
+            failures(test_case),
+            test_case[:time].to_f
+          )
+        end
+      end
+
+      def failures(test_case)
+        test_case.children.select { |child| child.name == 'failure' }.map { |failure| failure.content }
+      end
+    end
+  end
+end