spec_tracker 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42ee99ae0c565daf509758ee4f166d7fc0cb0ecd2e8916029563d8ed6b2daef8
+  data.tar.gz: 7c4f953579382b0f7f32d626951a389f3027da048c349984c634f87f8dd27908
+SHA512:
+  metadata.gz: 1a6be4b413f8a5d3b725895a4dd18cdc625b6f3f758083256bc444372ff4b009ac5447aaecd7465c421fd769268ca20b75c01bbd7d3f7beaceb7335f8bf7c4bc
+  data.tar.gz: 93668917bb48db7f6ec84549d58c88d518bfecd6426edf04e41e0e96f8a4afc4036fa869061fa1d34b8ab2a2220127528607410072ca12759b2c6acd5becf598

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/test/reports/
+/tmp/
+.byebug_history
+.idea

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.0] - 2019-02-13
+### Added
+- dependency to cucumber
+- Gherkin support for csv specifications
+- Configuration parameter `spec_type` to select specification type. csv by default but gherkin is also accepted.
+
+### Changed
+- Moved scenario_id_header and scenario_name_header in csv specification parser
+- License is now MIT instead of Apache 2.0
+- Fix random fail in configuration tests
+
+## [1.1.0] - 2019-01-27
+### Added
+- dev dependency to active support to write rails-like test
+- base class for test that extends the active support extension that defines test(name, &block)
+- CSV specifications for project
+
+### Changed
+- test syntax
+- default header for scenario IDs is now Scenario ID
+- default regexp ID must now be a ruby regex
+
+## [1.0.0] - 2019-01-25
+### Added
+- Support multiple CSV specification files
+- Support single JUnit report file
+- Configuration parameters
+- CLI with report command including options
+- tests for CSV parser, JUnit mapper and spec_tracker
+- minitest-reporters test dependency
+- CHANGELOG
+
+
+### Changed
+- Output title is the name of the corresponding CSV specification file
+- Compatibility with Ruby ~> 2.3
+- Usage instructions in README
+
+
+### Removed
+- YAML configuration
+- spec tracker script

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 joanna.vigne@fabernovel.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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in spec_tracker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    spec_tracker (1.1.0)
+      cucumber (~> 3.1)
+      gemoji (~> 3.0)
+      nokogiri (~> 1.10)
+      terminal-table (~> 1.8)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    backports (3.11.4)
+    builder (3.2.3)
+    byebug (9.1.0)
+    concurrent-ruby (1.1.4)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    gemoji (3.0.0)
+    gherkin (5.1.0)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    minitest-reporters (1.3.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0, < 6.0)
+  bundler (~> 1.17)
+  byebug (~> 9.0)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3)
+  rake (~> 10.0)
+  spec_tracker!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,24 @@
+* Copyright (c) 2012, Applidium
+* All rights reserved.
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of Applidium nor the names of its contributors may
+*       be used to endorse or promote products derived from this software
+*       without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,84 @@
+# SpecTracker
+
+Parse CSV specifications, match them with JUnit reports and print the corresponding traceability matrix in the terminal.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spec_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spec_tracker
+
+## Usage
+
+### Configuration
+
+| Parameter | Default value | Description |
+| --------- | ----- | ------- |
+| `spec_path` | 'specifications' | Path to the specification file(s). Expects a relative path to a file or a director |
+| `spec_type` | 'csv' | Type of specification files. Available values : csv, gherkin |
+| `scenario_id_header` | 'Scenario ID' | Header of the CSV column that contains the scenario names |
+| `scenario_name_header` | 'Name/Rule' | Header of the CSV column that contains the scenario IDs |
+| `scenario_id_regex` | `/\[([a-zA-Z\-]+)\]/` | Regexp to find scenario IDs in the test names. Default is kebab-case words |
+| `test_report_path` | 'test/reports' | Path to the test reports. Expects a relative path to a file or a directory |
+| `locale` | 'fr' | Locale for text output. Available values : fr, en |
+
+### Test result symbols
+
+| Symbol | Meaning |
+| ---------: | ------- |
+| ✅ | There is a test for this scenario and it PASSES |
+| 😶 | No tests were found for this scenario |
+| ❌ | There is a test for this scenario and if FAILS |
+
+### CLI
+
+    
+    $ spec_tracker report
+    +---------------------------+-------------------------------------+----------------+
+    |                            some_specification_file.csv          |                |
+    +---------------------------+-------------------------------------+----------------+
+    | Identifiant du scénario   | Nom du scénario                     | Statut du test |
+    +---------------------------+-------------------------------------+----------------+
+    |    sign-up                | [MyProject] Scenario 4.1.1          |     ✅         |
+    |    login                  | [MyProject] Scenario 4.2.1          |     ✅         |
+    |    logout                 | [MyProject] Scenario 4.3.1          |     😶         |
+    |    delete-account         | [MyProject] Scenario 5.1.1          |     ❌         |
+    |    news-feed              | [MyProject] Scenario 5.1.2          |     ✅         |
+    |    like-news              | [MyProject] Scenario 5.1.3          |     ✅         |
+    |    unlike-news            | [MyProject] Scenario 5.1.4          |     ❌         |
+    |    topics                 | [MyProject] Scenario 5.1.5          |     😶         |
+    |    subscribe-topic        | [MyProject] Scenario 5.1.6          |     😶         |
+    |    unsubscribe-topic      | [MyProject] Scenario 6.1.1          |     😶         |
+    |    account-information    | [MyProject] Scenario 6.1.2          |     😶         |
+    |    reset-password         | [MyProject] Scenario 6.1.3          |     😶         |
+    +---------------------------+-------------------------------------+----------------+
+    |    Progression            |                                     |     33%        |
+    +---------------------------+-------------------------------------+----------------+
+    
+
+
+Help to configure the report command :
+
+    
+    $ spec_tracker help report
+    
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jvigne/spec_tracker.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spec_tracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/spec_tracker

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'spec_tracker'
+
+SpecTracker::CLI.start(ARGV)

data/lib/spec_tracker.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+require 'csv'
+require 'yaml'
+require 'nokogiri'
+require 'terminal-table'
+require 'gemoji'
+require 'thor'
+require 'gherkin/parser'
+
+require 'spec_tracker/version'
+require 'spec_tracker/config/configuration'
+require 'spec_tracker/test_status'
+require 'spec_tracker/cli'
+
+require 'spec_tracker/spec_parser/scenario'
+require 'spec_tracker/spec_parser/specification'
+require 'spec_tracker/spec_parser/base_parser'
+require 'spec_tracker/spec_parser/csv_parser'
+require 'spec_tracker/spec_parser/gherkin_parser'
+
+require 'spec_tracker/test_report_parser/test_result'
+require 'spec_tracker/test_report_parser/base_mapper'
+require 'spec_tracker/test_report_parser/base_parser'
+require 'spec_tracker/test_report_parser/j_unit/mapper'
+require 'spec_tracker/test_report_parser/j_unit/parser'
+
+require 'spec_tracker/reporter/status_ui'
+require 'spec_tracker/reporter/base_ui_mapper'
+require 'spec_tracker/reporter/base_reporter'
+require 'spec_tracker/reporter/terminal/ui_mapper'
+require 'spec_tracker/reporter/terminal/reporter'
+
+require 'spec_tracker/reporter/report_datum'
+require 'spec_tracker/reporter/report'
+require 'spec_tracker/reporter/report_mapper'
+
+require 'spec_tracker/report_task'
+
+module SpecTracker
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end