cucumber-zephyr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e57f034d52221d5c57301ce8300eafa1bd363e8f26f279e6f73251aa77f2fae3
-  data.tar.gz: 4c67f6432fb3c64d3b20882c014cd1162d91ce38ae55518f89ce1beb9d999cb1
+  metadata.gz: d3a9ff7479455e0f2a23b87215b97e6485061d23163ac7e94dc168a923bb0f7a
+  data.tar.gz: 7dd733adb7cc1dd8cf5aa518977bfd6474ac823e01a1d81f92f98e6a9dc8761e
 SHA512:
-  metadata.gz: f5d932b7dc370f4fce7acd4020352dd1bd783ecdf799e977e91a220c747984042f0df4a61799ed2c45120804e84a8b13e8866934943b17ebac5d1baae3b40403
-  data.tar.gz: 477a6b8f2782d0c54d9150094c56a2b948646491db8b786b68bc42fb444d69cbaebab75a4c33a0098b044400be46db49e570553b0f5b25cc2b4bb167a16da171
+  metadata.gz: 6814bad1b4bc0df926173d404565df6d7a4674f1a004d714a82347e9129e601ca4d7c0f59c6569e1b790d88204704062de6c29628fc34c7cd661ea8bd87eeeb7
+  data.tar.gz: a4351bf8769c8ac81526a78c076e7e2bd82d641cc60e1521c161583d633c92c361ae28c090327b5b9aa7c275ce70dd9dc59aeec9d59e817e05f6f7c7ba55fcef

data/.rubocop.yml

@@ -8,3 +8,10 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 21

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in cucumber-zephyr.gemspec
 gemspec
 
+gem "cucumber", "~> 4.0"
 gem "rake", "~> 13.0"
 gem "rubocop", "~> 0.80"
-# gem "zephyr_cli"
+gem "zephyr_cli"
+gem "zephyr_ruby"

data/README.md

@@ -1,8 +1,6 @@
 # CucumberZephyr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cucumber-zephyr`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is the custom cucumber formatter.
 
 ## Installation
 
@@ -20,9 +18,56 @@ Or install it yourself as:
 
     $ gem install cucumber-zephyr
 
+### Important Note:
+You will need to set your zephyr API access token in your environment i.e.
+
+    $ $ZEPHYR_API_KEY='YOUR-API-KEY'
+
 ## Usage
 
-TODO: Write usage instructions here
+To use this customer cucumber formatter you will either need to register this formatter in either your cucumber.yml file or via command line.
+
+To register via your formatter simple add this line to your default settings:
+```yml
+default: --format zephyr
+```
+
+To register via command line:
+```
+cucumber --format zephyr
+```
+
+### Example
+Assuming our example cucumber framework has the following structure:
+```
+my_cucumber_project/
+├── features/
+│   ├── step_definitions/
+│   │   └── guess_the_word_steps.rb
+│   ├── support/
+│   │   └── env.rb
+│   └── guess_the_word.feature
+├── Gemfile
+└── Gemfile.lock
+```
+
+Here is an example implementation of the zephyr custom formatter. We start with an example feature file with zephyr test fase tags added to the scenario we want: 
+```gherkin
+# my_cucumber_project/features/guess_the_word.feature
+
+Feature: Guess the word
+
+  @SBX-1234 # @{zephyr_project_id}-1234
+  Scenario: Maker starts a game
+    When the Maker starts a game
+    Then the Maker waits for a Breaker to join
+```
+
+Important Note: Make sure to import this gem into your `env.rb` file.
+
+Then, run the example feature file:
+
+    $ cucumber features/guess_the_word.feature --format zephyr --results_format junit --project_id SBX --file path/to/results/file --auto_close_cycle --auto_create_test_cases --name 'New Automated Test Cycle' --description 'This is the description of my new automated test cycle'
 
 ## Development
 

data/cucumber-zephyr.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/cucumber-zephyr/version"
+require_relative "lib/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cucumber-zephyr"

data/lib/cucumber_zephyr.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "cucumber/formatter/console"
+require "cucumber/formatter/io"
+require "cucumber/formatter/pretty"
+require "cucumber/cli/options"
+require "cucumber/formatter/legacy_api/adapter"
+require "zephyr_ruby"
+
+@zephyr_client = ZephyrRuby::Client.new(ENV["ZEPHYR_API_KEY"])
+
+module Cucumber
+  module Formatter
+    # This class is the formatter for the Zephyr plugin
+    class CucumberZephyr
+      include console
+      include Io
+
+      def initialize(config)
+        @io = Cucumber::Formatter::Io.new(config.out_stream, config.default_path, "upload-to-zephyr")
+        @project_id = config.options[:project_id]
+        @results_format = config.options[:results_format]
+        @path_to_file = config.options[:path_to_file]
+        @auto_close_cycle = config.options[:auto_close_cycle] ? true : false
+        @auto_create_test_cases = config.options[:auto_create_test_cases] ? true : false
+        @name = config.options[:name]
+        @description = config.options[:description]
+
+        at_exit { upload_results }
+      end
+
+      def before_feature(feature)
+        @current_feature = feature
+      end
+
+      def before_scenario(scenario)
+        @current_scenario = scenario
+      end
+
+      def upload_results
+        system("zephyr_cli test_cycles " \
+       "--#{@results_format} " \
+       "--project_id=#{@project_id} " \
+       "--file=#{@path_to_file} " \
+       "--auto_close_cycle=#{@auto_close_cycle} " \
+       "--auto_create_test_cases=#{@auto_create_test_cases}" \
+       "--name=#{@name} " \
+       "--description=#{@description}")
+      end
+    end
+  end
+end
+
+# Register the formatter
+Cucumber::Cli::Options::FORMATTERS["zephyr"] = Cucumber::Formatter::CucumberZephyr

data/lib/{cucumber-zephyr/version.rb → version.rb}

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CucumberZephyr
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-zephyr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Davis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-08-03 00:00:00.000000000 Z
 dependencies: []
 description: Cucumber formatter for Zephyr
 email:
@@ -24,9 +24,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- cucumber-zephyr-0.1.0.gem
 - cucumber-zephyr.gemspec
-- lib/cucumber-zephyr.rb
-- lib/cucumber-zephyr/version.rb
+- lib/cucumber_zephyr.rb
+- lib/version.rb
 homepage: https://github.com/cdavis-personal/cucumber-zephyr
 licenses: []
 metadata:

data/lib/cucumber-zephyr.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "zephyr/version"
-
-module CucumberZephyr
-  class Error < StandardError; end
-  # Your code goes here...
-end