hiptest-publisher 1.19.3 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765218578a5dfc56c5751613ac4ef105f43139292eec99f5e56c2ed7d3e4d582
-  data.tar.gz: 197b47e4014cbd2ed6d4515b07cb28898e9ae9607c8b28df275272abca18a6c8
+  metadata.gz: f866fbfa2e3015b67eb9393099403394457cf9f4b17932df59ada6b5a8942ba9
+  data.tar.gz: 7f0c99647bd42c3a08b803c13f5679233cfd32a2354f4dbe19128ef89bc2cc0a
 SHA512:
-  metadata.gz: 237c9fa64ee70fbc12dc96034fc44ba395a7b8264b6d79708c6de3fa8ed8ada08ead39bc46a15f60c81e3be85cea6e3cfe5f396a05c58b0172feb4c44df018e6
-  data.tar.gz: 94370a43383081bb3f07216fca919dc9decb8ec831b5964a38a422e4fd59051e400ecb7dd0f200a597c988f0a74349db70041bc9a4f7a147e97c71f9507bbc00
+  metadata.gz: e118cbccabea2ca7d845d9fd94a206c3f29547a61019165f70ca6216f0db3479fec8cf38b6359dca9ff43762e0963ab69857bcc59819b2a958654ccd7f527cf7
+  data.tar.gz: 0edc4eaec30b1041d4113616a0de356056d6b05a2d1fe9601c4eb33cfc5a781ef2193acc7aeb9b28fb6d6ffc4a18365ca2836f1d5c7e7cb54fe0bbd7c77fc017

data/README.md

@@ -1,4 +1,4 @@
-Hiptest Publisher
+HipTest Publisher
 ==============
 
 [![Build Status Linux](https://travis-ci.org/hiptest/hiptest-publisher.svg?branch=master)](https://travis-ci.org/hiptest/hiptest-publisher)
@@ -44,7 +44,7 @@ Note: for Windows users, take a look at [this Windows installation guide](docs/I
 Exporting a project
 -------------------
 
-Go to one of your [Hiptest projects](https://app.hiptest.com/projects) and select the Settings tab.
+Go to one of your [HipTest projects](https://app.hiptest.com/projects) and select the Settings tab.
 This tab is available only for projects you own.
 From there, copy the secret token and run this command line:
 
@@ -91,7 +91,7 @@ hiptest-publisher --help
 You could obtain for example:
 
 ```shell
-Exports tests from Hiptest for automation.
+Exports tests from HipTest for automation.
 
 Specific options:
     -t, --token=TOKEN                Secret token (available in your project settings)
@@ -105,7 +105,7 @@ Specific options:
         --test-run-name=NAME         Export data from a test run identified by its name
         --only=CATEGORIES            Restrict export to given file categories (--only=list to list them)
         --without=CATEGORIES         Exclude file categories from import (--only=list to list them)
-    -x, --xml-file=PROJECT_XML       XML file to use instead of fetching it from Hiptest
+    -x, --xml-file=PROJECT_XML       XML file to use instead of fetching it from HipTest
         --tests-only                 (deprecated) alias for --only=tests (default: false)
         --actionwords-only           (deprecated) alias for --only=actionwords (default: false)
         --actionwords-signature      Export actionwords signature (default: false)
@@ -129,13 +129,13 @@ Specific options:
         --global-failure-on-missing-reports
                                      When there is no results file to push, report a global failure (default: false)
         --push-format=tap            Format of the test results (cucumber-json, junit, nunit, robot, tap) (default: tap)
-        --sort=[id,order,alpha]      Sorting of tests in output: id will sort them by age, order will keep the same order than in hiptest (only with --with-folders option, will fallback to id otherwise), alpha will sort them by name (default: order)
+        --sort=[id,order,alpha]      Sorting of tests in output: id will sort them by age, order will keep the same order than in HipTest (only with --with-folders option, will fallback to id otherwise), alpha will sort them by name (default: order)
         --[no-]uids                  Export UIDs (note: can be disabled only for Gherkin-based exports, may cause issue when pushing results back) (default: true)
         --[no-]parent-folders-tags   Export tags from parent folder (note: if set to false, those tags are never rendered. Only available for Gherkin base exports) (default: true)
         --parameter-delimiter        Parameter delimiter (for Gherkin based export only) (default: ")
         --with-dataset-names         Export dataset name when creating feature files (note: available only for Gherkin-based exports) (default: false)
-        --keep-filenames             Keep the same name as in Hiptest for the test files (note: may cause encoding issues) (default: false)
-        --keep-foldernames           Keep the same name as in Hiptest for the folders (note: may cause encoding issues) (default: false)
+        --keep-filenames             Keep the same name as in HipTest for the test files (note: may cause encoding issues) (default: false)
+        --keep-foldernames           Keep the same name as in HipTest for the folders (note: may cause encoding issues) (default: false)
         --filter-on-scenario-ids=IDS Filter on scenario ids (use commas to separate ids when fetching multiple scenarios)
         --filter-on-folder-ids=IDS   Filter on folder ids (use commas to separate ids when fetching multiple folders)
         --filter-on-scenario-name=NAME
@@ -187,11 +187,11 @@ If username and password are required:
 http_proxy=http://<username>:<password>@<proxy_host>:<proxy_port>
 ```
 
-Posting results to Hiptest
+Posting results to HipTest
 --------------------------
 
-You can use the options --push to push the results back to Hiptest. For this, you first need to generate the test code from a Test run by specifying option ``--test-run-id=<xxx>`` during code generation (or add it to the configuration file).
-The tests must then generate a test report that is supported by Hiptest. Currently four types of test results are handled:
+You can use the options --push to push the results back to HipTest. For this, you first need to generate the test code from a Test run by specifying option ``--test-run-id=<xxx>`` during code generation (or add it to the configuration file).
+The tests must then generate a test report that is supported by HipTest. Currently four types of test results are handled:
  - jUnit XML format
  - [NUnit XML v2 format](https://github.com/nunit/docs/wiki/XML-Formats#v2-test-results)
  - [TAP (Test Anything Protocol)](https://testanything.org/)

data/lib/hiptest-publisher.rb

@@ -82,7 +82,7 @@ module Hiptest
     end
 
     def fetch_xml_file
-      reporter.with_status_message "Fetching data from Hiptest" do
+      reporter.with_status_message "Fetching data from HipTest" do
         @client.fetch_project_export
       end
     rescue ClientError => err
@@ -277,11 +277,11 @@ module Hiptest
     end
 
     def report_hiptest_api_error(response)
-      reporter.failure_message("Hiptest API returned error #{response.code}")
+      reporter.failure_message("HipTest API returned error #{response.code}")
       if response.code == "422" && response.body.start_with?("Unknown format")
         STDERR.print response.body.chomp + "\n"
       elsif response.code == "404"
-        STDERR.print "Did you specify the project token of an existing Hiptest project?\n"
+        STDERR.print "Did you specify the project token of an existing HipTest project?\n"
       end
     end
 

data/lib/hiptest-publisher/cli_options_checker.rb

@@ -23,6 +23,7 @@ module Hiptest
       check_secret_token
       check_filters
       check_status_filter
+      check_meta
 
       if cli_options.push?
         check_push_file
@@ -90,7 +91,7 @@ module Hiptest
           raise CliOptionError, [
             "Missing argument --token: you must specify project secret token with --token=<project-token>",
             "",
-            "The project secret token can be found on Hiptest in the settings section, under",
+            "The project secret token can be found on HipTest in the settings section, under",
             "'Publication settings'. It is a sequence of numbers uniquely identifying your",
             "project.",
             "",
@@ -193,13 +194,27 @@ module Hiptest
           next if tag_compatible?(val.strip)
 
           raise CliOptionError, [
-            "#{option_name} should be a list of comma separated tags in Hiptest",
+            "#{option_name} should be a list of comma separated tags in HipTest",
             "",
             "Found: #{val.strip.inspect}"
           ].join("\n")
       end
     end
 
+    def check_meta
+      value = cli_options.meta
+      return if absent?(value)
+
+      value.split(',').each do |val|
+          next if meta_compatible?(val.strip)
+
+          raise CliOptionError, [
+            "meta should be a list of comma separated key:value items (eg. OS:Linux,CI:Jenkins)",
+            "",
+            "Found: #{val.strip.inspect}"
+          ].join("\n")
+      end    end
+
     def check_language_and_only
       if present?(cli_options.language)
         begin
@@ -249,6 +264,10 @@ module Hiptest
       value =~ /\A[a-zA-Z0-9_-]*(: ?[a-zA-Z0-9_-]*)?\z/
     end
 
+    def meta_compatible?(value)
+      value =~ /\A[a-zA-Z0-9_-]*: ?[a-zA-Z0-9_-]*\z/
+    end
+
     def formatted_categories(categories)
       formatted_categories = categories.map(&:inspect)
       if formatted_categories.length == 1

data/lib/hiptest-publisher/client.rb

@@ -122,7 +122,7 @@ module Hiptest
         if cli_options.test_run_id?
           cli_options.test_run_id
         else
-          raise ClientError, "Cannot get the list of available test runs from Hiptest. Try using --test-run-id instead of --test-run-name"
+          raise ClientError, "Cannot get the list of available test runs from HipTest. Try using --test-run-id instead of --test-run-name"
         end
       else
         matching_test_run = available_test_runs.find { |test_run| test_run[key] == searched_value }

data/lib/hiptest-publisher/formatters/console_formatter.rb

@@ -21,7 +21,7 @@ class ConsoleFormatter
 
   def show_options(options, message = nil)
     return unless verbose
-    message ||= "Running Hiptest-publisher #{hiptest_publisher_version} with:"
+    message ||= "Running hiptest-publisher #{hiptest_publisher_version} with:"
     puts message.yellow
     options.each { |k, v| puts " - #{k}: #{v.inspect}" }
   end

data/lib/hiptest-publisher/options_parser.rb

@@ -217,7 +217,7 @@ class OptionsParser
       Option.new(nil, 'test-run-name=NAME', '', String, "Export data from a test run identified by its name", :test_run_name),
       Option.new(nil, 'only=CATEGORIES', nil, String, "Restrict export to given file categories (--only=list to list them)", :only),
       Option.new(nil, 'without=CATEGORIES', nil, String, "Exclude file categories from import (--only=list to list them)", :without),
-      Option.new('x', 'xml-file=PROJECT_XML', nil, String, "XML file to use instead of fetching it from Hiptest", :xml_file),
+      Option.new('x', 'xml-file=PROJECT_XML', nil, String, "XML file to use instead of fetching it from HipTest", :xml_file),
       Option.new(nil, 'tests-only', false, nil, "(deprecated) alias for --only=tests", :tests_only),
       Option.new(nil, 'actionwords-only', false, nil, "(deprecated) alias for --only=actionwords", :actionwords_only),
       Option.new(nil, 'actionwords-signature', false, nil, "Export actionwords signature", :actionwords_signature),
@@ -242,8 +242,8 @@ class OptionsParser
       Option.new(nil, '[no-]parent-folder-tags', true, nil, 'Export tags from parent folders (note: if set to false, those tags are never rendered. Only available for Gherkin base exports)', :parent_folder_tags),
       Option.new(nil, 'parameter-delimiter', '"', String, 'Parameter delimiter (for Gherkin based export only)', :parameter_delimiter),
       Option.new(nil, 'with-dataset-names', false, nil, 'Export dataset name when creating feature files (note: available only for Gherkin-based exports)', :with_dataset_names),
-      Option.new(nil, 'keep-filenames', false, nil, "Keep the same name as in Hiptest for the test files (note: may cause encoding issues)", :keep_filenames),
-      Option.new(nil, 'keep-foldernames', false, nil, "Keep the same name as in Hiptest for the folders (note: may cause encoding issues)", :keep_foldernames),
+      Option.new(nil, 'keep-filenames', false, nil, "Keep the same name as in HipTest for the test files (note: may cause encoding issues)", :keep_filenames),
+      Option.new(nil, 'keep-foldernames', false, nil, "Keep the same name as in HipTest for the folders (note: may cause encoding issues)", :keep_foldernames),
       Option.new(nil, 'filter-on-scenario-ids=IDS', '', String, "Filter on scenario ids (use commas to separate ids when fetching multiple scenarios)", :filter_on_scenario_ids),
       Option.new(nil, 'filter-on-folder-ids=IDS', '', String, "Filter on folder ids (use commas to separate ids when fetching multiple folders)", :filter_on_folder_ids),
       Option.new(nil, 'filter-on-scenario-name=NAME', '', String, "Filter on scenario name (only one name is accepted)", :filter_on_scenario_name),
@@ -251,6 +251,7 @@ class OptionsParser
       Option.new(nil, 'filter-on-tags=TAGS', '', String, "Filter on scenarios and folder tags (use commas to separate tags when using multiple tags)", :filter_on_tags),
       Option.new(nil, 'filter-on-status=STATUS', '', String, "Filter on test status in last build (use in conjunction with a test run)", :filter_on_status),
       Option.new(nil, 'not-recursive', false, nil, "Used in conjunction with filter-on-folder-ids or filter-on-folder-name: only exports those folders, not their children", :not_recursive),
+      Option.new(nil, 'meta=META', '', String, "Meta informations that can be used for customizing templates", :meta),
       Option.new(nil, 'check-version', false, nil, "Check if a new release of hiptest-publisher is available", :check_version),
       Option.new(nil, 'force', false, nil, "Force overwrite of existing files (do not apply to test files)", :force_overwrite),
       Option.new('v', 'verbose', false, nil, "Run verbosely", :verbose)
@@ -263,7 +264,7 @@ class OptionsParser
       opts.version = hiptest_publisher_version if hiptest_publisher_version
       opts.banner = "Usage: ruby publisher.rb [options]"
       opts.separator ""
-      opts.separator "Exports tests from Hiptest for automation."
+      opts.separator "Exports tests from HipTest for automation."
       opts.separator ""
       opts.separator "Specific options:"
 
@@ -566,6 +567,7 @@ class LanguageGroupConfig
       node: node,
       call_prefix: @language_group_params[:call_prefix],
       package: @language_group_params[:package],
+      meta: @language_group_params[:meta],
       parameter_delimiter: @user_params[:parameter_delimiter],
       namespace: @language_group_params[:namespace],
       uids: @user_params[:uids],
@@ -700,6 +702,21 @@ class LanguageConfigParser
     name.send(get_key_from_group('actionwords', 'naming_convention'))
   end
 
+  def meta
+    treated = {}
+    meta_opt = @cli_options.meta || ""
+
+    meta_opt.split(',').each do |m|
+      key, value = m.split(':')
+      value = true if value == 'true'
+      value = false if value == 'false'
+
+      treated[key.strip] = value
+    end
+
+    treated
+  end
+
   private
 
   def get_key_from_group(group, key)
@@ -719,6 +736,7 @@ class LanguageConfigParser
     # List of options that can be set in the config file but not in command line
     non_visible_options = {
       package: @cli_options.package,
+      meta: meta,
       namespace: @cli_options.namespace,
       test_export_dir: @cli_options.test_export_dir,
       tests_ouput_dir: @cli_options.tests_ouput_dir,

data/lib/templates/gherkin/scenarios.hbs

@@ -1,3 +1,3 @@
 # To export your project to Gherkin correctly, you can add the option
 # --with-folders when calling hiptest-publisher. It will keep the
-#  Hiptest folders hierarchy of your project.
+#  HipTest folders hierarchy of your project.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 1.19.3
+  version: 1.20.0
 platform: ruby
 authors:
-- Hiptest R&D
+- HipTest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2019-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -667,5 +667,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Export your tests from Hiptest into executable tests.
+summary: Export your tests from HipTest into executable tests.
 test_files: []