hiptest-publisher-fork 3.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a3f53167dc3f83f91c0ac374527d580eeec9f4ce690d8a51b6c8537f7b98b6a
+  data.tar.gz: 01daaed30e6e4cf04bcb72c660842b4306db69c4dd2899cc9a6a12ceb1d181f4
+SHA512:
+  metadata.gz: 5b3770a9f610e2cb01b193c89c65b320749fbd235a05791d1dd0c3467d3d4c401e3f88ab0e804148a0f67dac555618c3ce9c641eb24eb82796da5dd281cdc1ce
+  data.tar.gz: '01582058bd0f7a4092f73bd909c8602d8668f38218979c775ffcbd95c1c0394f60fd446b2e5e3d71f0ff0e6f5d9e9c2792e5114dc0ff1fd1e1436c81114e8822'

data/CHANGELOG.md

@@ -0,0 +1,295 @@
+# HipTest Publisher Changelog
+
+## [3.3.0]
+
+- Adding support for ruby 3.2.0
+
+## [3.2.0]
+
+- Dropping support for ruby < 2.7
+- Adding support for ruby 3.0
+
+## [3.1.0]
+
+- Add options related to builds (or execution cycles) in CucumberStudio:
+- `--build-id`: allows to specify the build in which the results will be pushed
+- `--build-name`: allows to name the build which will be created to store the results
+
+## [3.0.0]
+
+- Add `--overriden-language-configs` command line option (#205 by tenpaiyomi)
+- Add support for Cucumber Expression in Java and Groovy (#205 by tenpaiyomi)
+- Fix possible duplication of actionwords in export (#232 by tenpaiyomi)
+- Breaking change: Export with cucumber expressions are now the default when specifying `--language=cucumber` for TypeScript, Java, and GroovySet. Use `--language=cucumber_legacy` to keep previous export behavior (#205 by tenpaiyomi) (#205 by tenpaiyomi)
+- Breaking change: Drop support for ruby 2.3 and ruby 2.4 as they have reached end of life
+- Rename HipTest as CucumberStudio in user messages
+- Properly escape new lines in datatables (#109)
+
+## [2.4.0]
+
+- Add support for asynchronous export of projects from Cucumber Studio
+
+## [2.3.1]
+
+- `--indentation` option is now available to customize the indentation of the output
+
+## [2.3.0]
+
+- No test uids in datatables by default for feature files, add them when test run is used (#201)
+
+## [2.2.0]
+
+- Add support for Cucumber expressions w/ Typescript ([#173](https://github.com/hiptest/hiptest-publisher/pull/173) [#184](https://github.com/hiptest/hiptest-publisher/pull/184) [tenpaiyomi])
+
+## [2.1.0]
+
+- Do not try to colorize output when not in a `tty`
+
+- Add `--[no-]color` option to allow disabling colored output
+
+## [2.0.0]
+
+- Deprecate support for Ruby 2.3 ([Ruby 2.3 EOL](https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/))
+
+- Drop Ruby 2.2 support.
+
+- Update Nokogiri to 1.10
+
+## [1.31.0]
+
+- Follow redirections when doing HTTP requests.
+
+## [1.30.0]
+
+- Upgrade `ruby-handlebars` to 0.4. `each` and `join` helpers now support the `as` notation.
+
+- Add support for Swift/XCTest ([#134](https://github.com/hiptest/hiptest-publisher/pull/134) [bangroot])
+
+- Add cache for the XML downloaded from CucumberStudio.
+  By default, files will be valid for 60 seconds but can be changed by using `--cache-duration=120` for example.
+
+## [1.29.2]
+
+- Fix escaping in string literals for Java and C# ([#157](https://github.com/hiptest/hiptest-publisher/issues/157) - [hiptest#195](https://github.com/hiptest/hiptest-issue-tracker/issues/195))
+
+## [1.29.1]
+
+- Allow any characters for the meta value ([#155](https://github.com/hiptest/hiptest-publisher/issues/155))
+
+## [1.29.0]
+
+- Make `rake install` work with ruby 2.6
+- `--parameter-delimiter` option now accepts empty string
+
+## [1.28.0]
+
+- Fix bug where parameter-delimiter value was not recognized in command line ([#147](https://github.com/hiptest/hiptest-publisher/issues/147))
+- Add option --http-proxy to specify proxy to use ([#132](https://github.com/hiptest/hiptest-publisher/issues/132))
+
+## [1.27.1]
+
+- Add CodeceptJS to language list in OptionsParser.languages
+
+## [1.27.0]
+
+- Enable accessing scenario tags in datasets
+  ([#142](https://github.com/hiptest/hiptest-publisher/pull/142) [nono0481])
+
+- Added support for CodeceptJS testing framework
+  ([#130](https://github.com/hiptest/hiptest-publisher/pull/130) [DavertMik])
+
+## [1.26.0]
+
+- Shared actionwords handling for Cucumber/Typescript
+
+## [1.25.0]
+
+- Shared actionwords handling for Behave
+
+## [1.24.0]
+
+- Add #case, #when and #when_includes handlebars helpers
+- Modify #if_includes handlebars helper to work with strings
+
+## [1.23.5]
+
+- Load i18n path also when used as a library
+
+## [1.23.4]
+
+- Add I18n to enable localizing (and clearing the code)
+
+## [1.23.3]
+
+- Update multipart-post to 2.1.1 to handle issues with Ruby < 2.5
+  (see: https://github.com/socketry/multipart-post/issues/61)
+
+## [1.23.2]
+
+- Force Nokogiri < 1.10 to keep support for Ruby 2.2
+- Add deprecation notifications for Ruby 2.2
+
+## [1.23.1]
+
+- Handle new shared actionword architecture
+
+## [1.22.0]
+
+- Add support for Cucumber/Typescript
+- Unlock Nokogiri update to 1.9.1
+
+## [1.21.0]
+
+- Add option --execution-environment to push results in the specified execution environment name
+
+## [1.20.0]
+
+- Add --meta option to add more flexibility in code generation
+  (see: https://github.com/hiptest/hiptest-publisher/blob/master/docs/Using%20meta%20data.md#using-meta-data)
+
+## [1.19.3]
+
+- Do not leave trailing whitespaces with {{comment}} helper
+
+## [1.19.2]
+
+- Fix description in Gherkin exports
+
+## [1.19.1]
+
+- Fix description in Gherkin exports
+
+## [1.19.0]
+
+- Do not comment description in Gherkin exports
+
+## [1.18.1]
+
+- Show message when calling an actionword using an unknown UID
+
+## [1.18.0]
+
+- Add option [no-]parent-folders-tags to choose if parent tags are rendered in feature files
+
+## [1.17.2]
+
+- Fix UIDCall handling for shared actionwords
+
+## [1.17.1]
+
+- update version number
+
+## [1.16.6]
+
+- Add the if_includes handlebars helper
+- Add options "parameter-delimiter" allowing to remove quotes around parameters in Gherkin export
+  (or replace it by anything else in fact)
+
+## [1.16.5]
+
+- Fix UIDCall handling for behat
+
+## [1.16.4]
+
+- Handling tags for shared actionwords
+
+## [1.16.3]
+
+- Fix behat rendering of shared actionwords
+
+## [1.16.2]
+
+- Remove unnecessary templates for cucumber/groovy
+
+## [1.16.0]
+
+- Shared actionwords handling for behat
+
+## [1.15.0]
+
+- Shared actionwords handling for groovy/spock
+
+## [1.14.0]
+
+- Shared actionwords handling for cucumber/groovy
+
+## [1.13.0]
+
+- Add Cucumber/Groovy support
+  ([#54](https://github.com/hiptest/hiptest-publisher/issues/54))
+
+## [1.12.0]
+
+- Add JBehave support
+  ([#38](https://github.com/hiptest/hiptest-publisher/issues/38))
+
+- Add option --with-dataset-names
+  ([#105](https://github.com/hiptest/hiptest-publisher/issues/105))
+
+- Reorder steps by regexp length for Behave
+  ([#104](https://github.com/hiptest/hiptest-publisher/issues/104))
+
+<!-- List of releases -->
+
+[Unreleased]: https://github.com/hiptest/hiptest-publisher/compare/v3.1.0...master
+[3.1.0]: https://github.com/hiptest/hiptest-publisher/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.4.0...v3.0.0
+[2.4.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.3.1...v2.4.0
+[2.3.1]: https://github.com/hiptest/hiptest-publisher/compare/v2.3.0...v2.3.1
+[2.3.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.1.0...v2.2.0
+[2.1.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.31.0...v2.0.0
+[1.31.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.30.0...v1.31.0
+[1.30.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.29.2...v1.30.0
+[1.29.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.29.1...v1.29.2
+[1.29.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.29.0...v1.29.1
+[1.29.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.28.0...v1.29.0
+[1.28.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.27.1...v1.28.0
+[1.27.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.27.0...v1.27.1
+[1.27.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.26.0...v1.27.0
+[1.26.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.25.0...v1.26.0
+[1.25.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.24.0...v1.25.0
+[1.24.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.5...v1.24.0
+[1.23.5]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.4...v1.23.5
+[1.23.4]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.3...v1.23.4
+[1.23.3]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.2...v1.23.3
+[1.23.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.1...v1.23.2
+[1.23.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.22.0...v1.23.1
+[1.22.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.21.0...v1.22.0
+[1.21.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.20.0...v1.21.0
+[1.20.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.3...v1.20.0
+[1.19.3]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.2...v1.19.3
+[1.19.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.1...v1.19.2
+[1.19.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.0...v1.19.1
+[1.19.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.18.1...v1.19.0
+[1.18.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.18.0...v1.18.1
+[1.18.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.17.2...v1.18.0
+[1.17.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.17.1...v1.17.2
+[1.17.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.6...v1.17.1
+[1.16.6]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.5...v1.16.6
+[1.16.5]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.4...v1.16.5
+[1.16.4]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.3...v1.16.4
+[1.16.3]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.2...v1.16.3
+[1.16.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.0...v1.16.2
+[1.16.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.15.0...v1.16.0
+[1.15.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.14.0...v1.15.0
+[1.14.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.13.0...v1.14.0
+[1.13.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.12.0...v1.13.0
+[1.12.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.11.1...v1.12.0
+
+<!-- List of contributors -->
+
+[atulhm]: https://github.com/atulhm
+[bangroot]: https://github.com/bangroot
+[ClaudiaJ]: https://github.com/ClaudiaJ
+[daniel-kun]: https://github.com/daniel-kun
+[DavertMik]: https://github.com/DavertMik
+[etorreborre]: https://github.com/etorreborre
+[Jesterovskiy]: https://github.com/Jesterovskiy
+[lostiniceland]: https://github.com/lostiniceland
+[mhfrantz]: https://github.com/mhfrantz
+[nono0481]: https://github.com/nono0481
+[tenpaiyomi]: https://github.com/tenpaiyomi
+[tikolakin]: https://github.com/tikolakin
+[weeksghost]: https://github.com/weeksghost

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) SmartBear Software Inc.
+
+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,265 @@
+HipTest Publisher
+==============
+
+[![GitHub Actions status](https://github.com/hiptest/hiptest-publisher/workflows/Tests/badge.svg)](https://github.com/hiptest/hiptest-publisher/actions?query=workflow%3ATests)
+[![Gem Version](https://badge.fury.io/rb/hiptest-publisher.svg)](http://badge.fury.io/rb/hiptest-publisher)
+[![Code Climate](https://codeclimate.com/github/hiptest/hiptest-publisher/badges/gpa.svg)](https://codeclimate.com/github/hiptest/hiptest-publisher)
+[![Test Coverage](https://codeclimate.com/github/hiptest/hiptest-publisher/badges/coverage.svg)](https://codeclimate.com/github/hiptest/hiptest-publisher)
+
+
+hiptest-publisher is a tool to read Test Management projects from CucumberStudio (formerly know as HipTest) and publish them as executable test scripts stubs to start automating.
+
+Installing
+----------
+
+### Using docker image
+
+A docker image of hiptest-publisher is built automatically and is available on
+[Docker Hub](https://hub.docker.com/r/hiptest/hiptest-publisher/)
+
+To call hiptest-publisher using this image, run this command:
+```
+docker run -it --rm -u $UID -v $(pwd):/app hiptest/hiptest-publisher <arguments>
+```
+
+A wrapper script is provided in
+[`bin/hiptest-publisher-docker`](https://raw.githubusercontent.com/hiptest/hiptest-publisher/master/bin/hiptest-publisher-docker).
+To use it:
+1. copy `bin/hiptest-publisher-docker` to a location available in your `PATH`
+   like `~/bin` or `/usr/local/bin`
+2. rename it as `hiptest-publisher`
+3. make it executable with `chmod +x hiptest-publisher`
+
+You will then be able to use hiptest-publisher as if it was locally installed.
+
+### Using local installation
+
+You need to have [Ruby installed on your machine](https://www.ruby-lang.org/en/installation/). You can then install it using gem:
+
+```shell
+gem install hiptest-publisher
+```
+
+Note: for Windows users, take a look at [this Windows installation guide](docs/INSTALLING/Windows.md).
+
+Exporting a project
+-------------------
+
+Go to [CucumberStudio projects list](https://studio.cucumber.io/projects), pick one project, and select the Settings tab.
+This tab is available only for projects you're admin of.
+From there, copy the secret token and run this command line:
+
+```shell
+hiptest-publisher --token=<YOUR TOKEN>
+```
+
+This will create a Ruby tests suite. For the moment, we support the following languages and frameworks:
+
+ - Behat
+ - Behave
+ - CSharp (NUnit)
+ - Cucumber (Groovy / Java / Javascript / Ruby / TypeScript)
+ - Cucumber Legacy (Groovy / Java / TypeScript) (previous Cucumber versions)
+ - Groovy (Spock)
+ - Java (Espresso / JUnit / TestNg)
+ - JavaScript (CodeceptJS / Jasmine / Mocha / Protractor / QUnit)
+ - JBehave
+ - PHP (PHPUnit)
+ - Python (UnitTest)
+ - Robot Framework
+ - Ruby (MiniTest / RSpec)
+ - Selenium IDE
+ - SpecFlow
+ - Swift (XCTest)
+
+You can specify the output language and framework in the command line, for example:
+
+```shell
+hiptest-publisher --token=<YOUR TOKEN> --language=ruby --framework=minitest
+```
+
+When publishing, you'll notice a file called ``actionwords_signature.yaml``. Store this file in your code repository, it will be used to [handle updates of the action word](docs/upgrading_actionwords.md).
+
+Exporting a test run
+--------------------
+
+You can generate the test suite from a test run of your project by specifying option `--test-run-id=<xxx>` when calling `hiptest-publisher`. You can find the test run id in the address bar of your browser. If your browser address is `https://studio.cucumber.io/projects/1234/testRuns/6941`, then your test run id is `6941`. You can generate your tests from your test with this command line:
+
+```shell
+hiptest-publisher --token=<YOUR TOKEN> --test-run-id=6941
+```
+
+Available options
+-----------------
+
+For more information on the available options, use the following command:
+
+```shell
+hiptest-publisher --help
+```
+
+You could obtain for example:
+
+```shell
+Exports tests from CucumberStudio for automation.
+
+Specific options:
+    -t, --token=TOKEN                Secret token (available in your project settings)
+    -l, --language=LANG              Target language (default: ruby)
+    -f, --framework=FRAMEWORK        Test framework to use
+    -o, --output-directory=PATH      Output directory (default: .)
+        --filename-pattern=PATTERN   Filename pattern (containing %s)
+    -c, --config-file=PATH           Configuration file
+        --overriden-templates=PATH   Folder for overriden templates
+        --overriden-language-configs=PATH
+                                     Folder for overriden language configs
+        --test-run-id=ID             Export data from a test run identified by its id
+        --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 CucumberStudio
+        --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)
+        --show-actionwords-diff      Show actionwords diff since last update (summary) (default: false)
+        --show-actionwords-diff-as-json
+                                     Show actionwords diff since last update (JSON output) (default: false)
+        --show-actionwords-deleted   Output signature of deleted action words (default: false)
+        --show-actionwords-created   Output code for new action words (default: false)
+        --show-actionwords-renamed   Output signatures of renamed action words (default: false)
+        --show-actionwords-signature-changed
+                                     Output signatures of action words for which signature changed (default: false)
+        --show-actionwords-definition-changed
+                                     Output action words for which definition changed (default: false)
+        --library-name=LIBRARY_NAME  Use in conjunction with show-actionwords-*: show the diff for the specified library
+        --with-folders               Use folders hierarchy to export files in respective directories (default: false)
+        --empty-folders              Export empty folders (default: false)
+        --split-scenarios            Export each scenario in a single file (except for Gherkin based languages) (default: false)
+        --leafless-export            Use only last level action word (default: false)
+    -s, --site=SITE                  Site to fetch from (default: https://studio.cucumber.io)
+    -p, --push=FILE.TAP              Push a results file to the server
+        --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)
+        --execution-environment=NAME Name of the execution environment
+        --build-id=ID                ID of an existing build the results will be added to
+        --build-name=NAME            Name for the build that will be created in CucumberStudio (build names are not unique)
+        --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-folder-tags    Export tags from parent folders (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 CucumberStudio for the test files (note: may cause encoding issues) (default: false)
+        --keep-foldernames           Keep the same name as in CucumberStudio 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
+                                     Filter on scenario name (only one name is accepted)
+        --filter-on-folder-name=NAME Filter on folder name (only one name is accepted)
+        --filter-on-tags=TAGS        Filter on scenarios and folder tags (use commas to separate tags when using multiple tags)
+        --filter-on-status=STATUS    Filter on test status in last build (use in conjunction with a test run)
+        --not-recursive              Used in conjunction with filter-on-folder-ids or filter-on-folder-name: only exports those folders, not their children (default: false)
+        --check-version              Check if a new release of hiptest-publisher is available (default: false)
+        --force                      Force overwrite of existing files (do not apply to test files) (default: false)
+        --[no-]color                 Force [un]use of ANSI color in text output
+    -v, --verbose                    Run verbosely (default: false)
+    -H, --languages-help             Show languages and framework options
+    -h, --help                       Show this message
+```
+
+Configuration
+-------------
+
+You have the possibility to store some configuration in a file named 'config'. Copy the file config.sample provided here and update the values with the values you use.
+
+If you have multiple projects, you can have multiple config files and select one using the --config-file option:
+
+```shell
+# Use the default config file
+hiptest-publisher
+# Use the one to export as minitest
+hiptest-publisher --config-file=config_minitest
+```
+
+For example, for java you can use this config file content:
+
+```
+token = '<YOUR TOKEN>'
+language = 'java'
+output_directory = '<YOUR OUTPUT DIRECTORY>'
+package = 'com.youcompany'
+```
+
+Note that options from command line arguments override options from config file.
+
+If you want to override one of the existing configurations, you can use the --overriden-language-configs option to specify a path that is checked for configuration files prior to looking at the default configuration files.  If one is found, it will use that file instead of the default, otherwise it will use the default configuration for the specified language.
+
+### Using hiptest-publisher behind a http proxy
+
+To use hiptest-publisher behind a http proxy, set an environment variable named http_proxy
+```
+http_proxy=http://<proxy_host>:<proxy_port>
+```
+If username and password are required:
+```
+http_proxy=http://<username>:<password>@<proxy_host>:<proxy_port>
+```
+
+Posting results to CucumberStudio
+---------------------------------
+
+You can use the option `--push` to push the results back to CucumberStudio. 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 CucumberStudio. Currently four types of test results are handled:
+ - Cucumber JSON format
+ - jUnit XML format
+ - [NUnit XML v2 format](https://github.com/nunit/docs/wiki/XML-Formats#v2-test-results)
+ - Robot framework XML output
+ - [TAP (Test Anything Protocol)](https://testanything.org/)
+
+You can specify the type of export when pushing by using the option `--push-format=[cucumber-json|junit|nunit|robot|tap]` or specifying it in the config file.
+
+You can push multiple files at once (using wildcard) but in that case, do not forget to add quotes. For examples:
+
+    hiptest-publisher --config-file=<path to your config file> --push="reports/*.xml"
+
+The number of imported test results will be displayed. For debugging purposes, you can display imported tests individually with the `--verbose` option.
+
+Development
+-----------
+
+While developing, you can install the gem locally by issuing
+
+```
+bundle exec rake install
+```
+
+You can also run the command directly with `bundle exec ruby -I lib bin/hiptest-publisher`. It is handy to define an alias so you can test your code easily:
+
+```
+# this alias will only work when run from the root of the project
+alias hiptest-publisher='bundle exec ruby -I lib bin/hiptest-publisher'
+```
+
+
+Internationalization
+--------------------
+
+To help with internationalization, you can temporarly add the `i18n-tasks` in the Gemfile and run `i18n-tasks health` to check that everything is ok and there are no missing translations. We removed it because of the many dependencies it pulls.
+
+Other useful commands:
+  * `i18n-tasks missing`
+  * `i18n-tasks unused`
+  * `i18n-tasks normalize`
+  * `i18n-tasks check-consistent-interpolations`
+
+
+Adding support for other languages and framework
+------------------------------------------------
+
+See the [CONTRIBUTING](https://github.com/hiptest/hiptest-publisher/blob/master/docs/CONTRIBUTING.md) help page for more information.
+
+Contributors
+------------
+
+The [@hiptest team](https://github.com/hiptest), [@mhfrantz](https://github.com/@mhfrantz), [@tikolakin](https://github.com/@tikolakin), [@atulhm](https://github.com/@atulhm), [@etorreborre](https://github.com/@etorreborre), [@daniel-kun](https://github.com/@daniel-kun), [@weeksghost](https://github.com/@weeksghost), [@lostiniceland](https://github.com/@lostiniceland), [@ClaudiaJ](https://github.com/@ClaudiaJ), [@Jesterovskiy](https://github.com/@Jesterovskiy), [@tenpaiyomi](https://github.com/@tenpaiyomi), [nono0481](https://github.com/nono0481), [DavertMik](https://github.com/DavertMik)

data/bin/hiptest-publisher

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+# Don't try to run this binary directly. Instead:
+#
+#   * `hiptest-publisher` if installed through rubygems, relying on the rubygem
+#     wrapper
+#
+#   * `bundle exec ruby -I lib bin/hiptest-publisher` if doing hiptest-publisher
+#     development. You can define an alias for this command and run it as if
+#     you were running the gem natively.
+#
+#         alias hiptest-publisher='bundle exec ruby -I lib bin/hiptest-publisher'
+#
+
+require 'ruby_version'
+require 'hiptest-publisher/i18n'
+require 'hiptest-publisher/utils'
+
+# Ensure ruby version >= 2.7
+if RubyVersion < '2.7.0'
+  STDERR.puts(I18n.t('ruby_version.required_version', version: '2.7.0'))
+  STDERR.puts(I18n.t('ruby_version.current_version', engine: RUBY_ENGINE, version: RUBY_VERSION))
+  STDERR.puts(I18n.t('ruby_version.use_more_recent'))
+
+  if RubyVersion.is? 2.6
+    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.6.0', year: '2022', month: '03', day: '31'))
+  elsif RubyVersion.is? 2.5
+    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.5.0', year: '2021', month: '03', day: '31'))
+  elsif RubyVersion.is? 2.4
+    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.4.0', year: '2020', month: '03', day: '31'))
+  end
+  exit 1
+end
+
+if RubyVersion < '3.0'
+  STDERR.puts(I18n.t('ruby_version.current_version', engine: RUBY_ENGINE, version: RUBY_VERSION))
+  STDERR.puts(I18n.t('ruby_version.deprecation_warning', version: '2.7'))
+  STDERR.puts(I18n.t('ruby_version.support_ended', version: '2.7', year: '2023', month: '03', day: '31'))
+end
+
+require 'hiptest-publisher'
+begin
+  require 'pry' # only available in development
+rescue StandardError, LoadError
+end
+
+Hiptest::Publisher.new(ARGV).run