treye-semaphore_cucumber_booster_config 1.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 200d92e1ccd177b1527483db55736c4df54b923d
+  data.tar.gz: 77e79d269f66585c805b5f47e9e63634431d7215
+SHA512:
+  metadata.gz: a0c4b4395835c323f1c6dded2188e7cf8b7ff012017d5e154eec13d866fb8501026423f70dc269d92505a6ac264ce0027512791ca30e1e2ac62ea2c461f72d05
+  data.tar.gz: 3c00b31c009d105c45c5cdd0be0981cdbc1663b6f0bb71b46eac8a3768bf0fd1c778a2527c83395ba2932b5492a104964a4053819f7311e41a0d163520756607

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Rendered Text
+
+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,90 @@
+# Cucumber Booster Config
+
+Note: This version is just an updated copy of the original with the new version number.
+
+[![Build Status](https://semaphoreci.com/api/v1/projects/b5ad1293-4dd1-425d-8c00-b42ceca09c75/527737/badge.svg)](https://semaphoreci.com/renderedtext/cucumber_booster_config)
+[![Gem Version](https://badge.fury.io/rb/semaphore_cucumber_booster_config.svg)](https://badge.fury.io/rb/semaphore_cucumber_booster_config)
+
+Injects additional configuration for Cucumber so that it outputs JSON report suitable
+for estimation of the [split configuration](https://github.com/renderedtext/test-boosters#split-configuration) for the next build.
+
+Cucumber Booster Config is primarily used as [Test Boosters gem](https://github.com/renderedtext/test-boosters) dependency.
+Boosters help you with distribution of your test files across many parallel jobs and optimize your build time. Find out more about [Boosters](https://semaphoreci.com/docs/about-boosters.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "semaphore_cucumber_booster_config"
+```
+
+## Usage from the CLI
+
+```
+$ cucumber-booster-config help inject
+Usage:
+  cucumber-booster-config inject PATH
+
+  Options:
+    [--dry-run], [--no-dry-run]
+
+inject Semaphore's Cucumber configuration in project PATH
+```
+
+If you use the `--dry-run` option, output will look like this:
+
+```
+$ cucumber-booster-config inject . --dry-run
+Running in .
+Found Cucumber profile file: ./cucumber.yml
+Content before:
+---
+default: --format pretty features
+---
+Inserting Semaphore configuration at the top
+Appending Semaphore profile to default profile
+Content after:
+---
+semaphoreci: --format json --out=features_report.json
+default: --format pretty features --profile semaphoreci
+---
+```
+
+## Usage from other scripts
+
+You can invoke the injector script programaticaly too:
+
+``` ruby
+current_path = Dir.pwd
+output_report_path = "/tmp/cucumber_report.json"
+
+CucumberBoosterConfig::Injection.new(current_path, output_report_path).run
+```
+
+This is how Test Boosters gem is using it to configure Cucumber.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rspec` 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`.
+
+### How to release a new version
+
+Bump version number in `lib/cucumber_booster_config/version.rb`, commit and
+push your changes.
+
+Semaphore is currently configured to push new versions to Rubygems.
+If version hasn't changed, Rubygems will simply ignore the update.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/renderedtext/cucumber_booster_config.
+
+## License
+
+The gem is available as open source under the terms of the [MIT license](LICENSE).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cucumber_booster_config"
+
+# 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

data/bin/setup

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

data/cucumber_booster_config.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cucumber_booster_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "treye-semaphore_cucumber_booster_config"
+  spec.version       = CucumberBoosterConfig::VERSION
+  spec.authors       = ["Marko Anastasov"]
+  spec.email         = ["marko@renderedtext.com"]
+
+  spec.summary       = %q{Cucumber configuration injection for autoparallelism.}
+  spec.description   = %q{Injects additional configuration for Cucumber so that it outputs JSON suitable for auto-parallelism without affecting stdout.}
+  spec.homepage      = "https://github.com/treye/cucumber_booster_config"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.19.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/exe/cucumber-booster-config

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'cucumber_booster_config'
+CucumberBoosterConfig::CLI.start(ARGV)

data/lib/cucumber_booster_config.rb

@@ -0,0 +1,8 @@
+require "fileutils"
+
+require "cucumber_booster_config/cli"
+require "cucumber_booster_config/injection"
+require "cucumber_booster_config/version"
+
+module CucumberBoosterConfig
+end

data/lib/cucumber_booster_config/cli.rb

@@ -0,0 +1,17 @@
+require "thor"
+
+module CucumberBoosterConfig
+  class CLI < Thor
+
+    desc "inject PATH", "inject Semaphore's Cucumber configuration in project PATH"
+    option :dry_run, :type => :boolean
+    def inject(path)
+      puts "Running in #{path}"
+
+      report_path = "cucumber_report.json"
+
+      Injection.new(path, report_path, :dry_run => options[:dry_run]).run
+    end
+
+  end
+end

data/lib/cucumber_booster_config/cucumber_file.rb

@@ -0,0 +1,88 @@
+module CucumberBoosterConfig
+
+  class CucumberFile
+
+    DEFAULT_PROFILE = "default: --format pretty --profile semaphoreci features"
+
+    def initialize(path, dry_run)
+      @path = path
+      @dry_run = dry_run
+    end
+
+    def configure_for_autoparallelism(report_path)
+      load_file_content
+
+      if dry_run?
+        puts "Content before:"
+        puts "---"
+        puts @original_lines
+        puts "---"
+      end
+
+
+      unless semaphore_profile_defined? && semaphore_profile_included?
+        define_semaphore_profile(report_path)
+        include_semaphore_profile
+      end
+
+      if dry_run?
+        puts "Content after:"
+        puts "---"
+        puts @new_lines
+        puts "---"
+      else
+        save_file
+      end
+    end
+
+    private
+
+    def dry_run?
+      !!@dry_run
+    end
+
+    def load_file_content
+      @original_lines = File.open(@path, "r") { |f| f.readlines }
+      @new_lines = @original_lines
+    end
+
+    def save_file
+      File.open(@path, "w") { |f| @new_lines.each { |line| f.puts line } }
+    end
+
+    def define_semaphore_profile(report_path)
+      puts "Inserting Semaphore configuration for json report"
+      puts "Report path: #{report_path}"
+
+      @new_lines << "semaphoreci: --format json --out=#{report_path}\n"
+    end
+
+    def include_semaphore_profile
+      puts "Appending Semaphore profile to default profile"
+
+      default_profile_found = false
+
+      @new_lines.each_with_index do |line, i|
+        if line =~ /default:/
+          default_profile_found = true
+          line = "#{line.gsub("\n", "")} --profile semaphoreci"
+        end
+
+        @new_lines[i] = line
+      end
+
+      if !default_profile_found
+        puts "No definition for default profile found, inserting new one"
+        @new_lines << DEFAULT_PROFILE
+      end
+    end
+
+    def semaphore_profile_defined?
+      @original_lines.any? { |line| line.include?("semaphoreci:") }
+    end
+
+    def semaphore_profile_included?
+      @original_lines.any? { |line| line.include?("--profile semaphoreci") }
+    end
+  end
+end

data/lib/cucumber_booster_config/injection.rb

@@ -0,0 +1,52 @@
+require "cucumber_booster_config/cucumber_file"
+
+module CucumberBoosterConfig
+
+  class Injection
+
+    CUCUMBER_FILES = [
+      "cucumber.yml",
+      "config/cucumber.yml"
+    ]
+
+    def initialize(path, report_path, options = {})
+      @path = path
+      @report_path = report_path
+      @dry_run = options.fetch(:dry_run, false)
+    end
+
+    def find_profile_files
+      profile_files = []
+
+      CUCUMBER_FILES.map { |file_name| cucumber_file_path(file_name) }.each do |file|
+        if File.exist?(file)
+          puts "Found Cucumber profile file: #{file}"
+          profile_files << file
+        end
+      end
+
+      profile_files
+    end
+
+    def run
+      if no_profile_files?
+        puts "No cucumber profile files found. Creating empty cucumber.yml file"
+        FileUtils.touch("cucumber.yml")
+      end
+
+      find_profile_files.each do |path|
+        CucumberFile.new(path, @dry_run).configure_for_autoparallelism(@report_path)
+      end
+    end
+
+    private
+
+    def no_profile_files?
+      find_profile_files.empty?
+    end
+
+    def cucumber_file_path(file_name)
+      File.join(@path, file_name)
+    end
+  end
+end

data/lib/cucumber_booster_config/version.rb

@@ -0,0 +1,3 @@
+module CucumberBoosterConfig
+  VERSION = "1.4.2".freeze
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: treye-semaphore_cucumber_booster_config
+version: !ruby/object:Gem::Version
+  version: 1.4.2
+platform: ruby
+authors:
+- Marko Anastasov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Injects additional configuration for Cucumber so that it outputs JSON
+  suitable for auto-parallelism without affecting stdout.
+email:
+- marko@renderedtext.com
+executables:
+- cucumber-booster-config
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cucumber_booster_config.gemspec
+- exe/cucumber-booster-config
+- lib/cucumber_booster_config.rb
+- lib/cucumber_booster_config/cli.rb
+- lib/cucumber_booster_config/cucumber_file.rb
+- lib/cucumber_booster_config/injection.rb
+- lib/cucumber_booster_config/version.rb
+homepage: https://github.com/treye/cucumber_booster_config
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Cucumber configuration injection for autoparallelism.
+test_files: []