hiptest-publisher 2.1.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +310 -0
  3. data/LICENSE +1 -2
  4. data/README.md +38 -22
  5. data/bin/hiptest-publisher +11 -7
  6. data/config/locales/en.yml +16 -14
  7. data/lib/config/cucumber-typescript.conf +41 -41
  8. data/lib/config/cucumber_legacy-groovy.conf +40 -0
  9. data/lib/config/cucumber_legacy-java.conf +24 -0
  10. data/lib/config/cucumber_legacy-typescript.conf +41 -0
  11. data/lib/hiptest-publisher.rb +1 -1
  12. data/lib/hiptest-publisher/client.rb +61 -10
  13. data/lib/hiptest-publisher/formatters/console_formatter.rb +1 -0
  14. data/lib/hiptest-publisher/handlebars_helper.rb +1 -1
  15. data/lib/hiptest-publisher/options_parser.rb +44 -8
  16. data/lib/hiptest-publisher/renderer.rb +5 -1
  17. data/lib/hiptest-publisher/renderer_addons/gherkin_addon.rb +21 -0
  18. data/lib/templates/common/_gherkin_typed_pattern.hbs +1 -0
  19. data/lib/templates/cucumber/groovy/step-definitions/actionword.hbs +1 -1
  20. data/lib/templates/cucumber/groovy/step-definitions/actionwords.hbs +3 -2
  21. data/lib/templates/cucumber/groovy/step-definitions/library.hbs +3 -2
  22. data/lib/templates/cucumber/groovy/step-definitions/libraryactionword.hbs +1 -1
  23. data/lib/templates/cucumber/java/actionword.hbs +1 -1
  24. data/lib/templates/cucumber/java/actionwords.hbs +2 -2
  25. data/lib/templates/cucumber/typescript/actionword.hbs +1 -1
  26. data/lib/templates/cucumber/typescript/libraryactionword.hbs +1 -1
  27. data/lib/templates/cucumber_legacy/groovy/step-definitions/actionword.hbs +5 -0
  28. data/lib/templates/cucumber_legacy/groovy/step-definitions/actionwords.hbs +10 -0
  29. data/lib/templates/cucumber_legacy/groovy/step-definitions/library.hbs +10 -0
  30. data/lib/templates/cucumber_legacy/groovy/step-definitions/libraryactionword.hbs +5 -0
  31. data/lib/templates/cucumber_legacy/java/actionword.hbs +6 -0
  32. data/lib/templates/cucumber_legacy/java/actionwords.hbs +12 -0
  33. data/lib/templates/cucumber_legacy/typescript/actionword.hbs +5 -0
  34. data/lib/templates/cucumber_legacy/typescript/libraryactionword.hbs +5 -0
  35. data/lib/templates/gherkin/scenarios.hbs +1 -1
  36. data/lib/templates/groovy/_scenario.hbs +1 -1
  37. metadata +64 -35
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 92594c83a779b66b0e20d2b894a1509199fecee0b47afee44e57284f37eb094c
4
- data.tar.gz: 410db2501af2e304eb3135ed3302f36a453d1cc292789e423bc0757e0d6e5720
3
+ metadata.gz: a708e30e3007211ecf6488870ac94158413bebbd64900587826cc2222bbc3bd9
4
+ data.tar.gz: 44ce6d4d70537980d53c56b106a121a43eeade99be8c950a6605e6a07c5d1f3d
5
5
  SHA512:
6
- metadata.gz: c781fd1c8ce9ca8f9a857e6e5989fde3c033f1014479dbf324fcc26157190daa90c410735bb8b2529ce336f46e80115d0d45319de19b9b79fa5f0e5898daa1a8
7
- data.tar.gz: 40ea3a9a05459ab6d796757196da3bece8a39f160f53b0c9338eebc032a7797bca8eb4030eb2fb98e3b970143f44edf65267b6120b869b3eaf698bc0086c1a5a
6
+ metadata.gz: 2de0510ccad7aed57ed719554ff69d2fece1db8e87af27e1b760d69a55bafad22b72a2f0f5e73b0db7c5b89151b27d1c9be522e29109ca04b0c9287ed2d99373
7
+ data.tar.gz: d9ebccc4646780dfc526465ec91c78fa4987422ec2f17de9b53bea0bfcc882b6890b586489870265713ebcdbf504ebbc1ea931f8f479d9de20b5b0639bb74f61
data/CHANGELOG.md ADDED
@@ -0,0 +1,310 @@
1
+ HipTest Publisher Changelog
2
+ ===========================
3
+
4
+ [Unreleased]
5
+ ------------
6
+
7
+ - Add `--overriden-language-configs` command line option (#205 by tenpaiyomi)
8
+ - Add support for Cucumber Expression in Java and Groovy (#205 by tenpaiyomi)
9
+ - Fix possible duplication of actionwords in export (#232 by tenpaiyomi)
10
+ - 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)
11
+ - Breaking change: Drop support for ruby 2.3 and ruby 2.4 as they have reached end of life
12
+ - Rename HipTest as CucumberStudio in user messages
13
+ - Properly escape new lines in datatables (#109)
14
+
15
+ [2.4.0]
16
+ -------
17
+
18
+ - Add support for asynchronous export of projects from Cucumber Studio
19
+
20
+ [2.3.1]
21
+ -------
22
+
23
+ - `--indentation` option is now available to customize the indentation of the output
24
+
25
+ [2.3.0]
26
+ -------
27
+
28
+ - No test uids in datatables by default for feature files, add them when test run is used (#201)
29
+
30
+ [2.2.0]
31
+ -------
32
+
33
+ - 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])
34
+
35
+ [2.1.0]
36
+ -------
37
+
38
+ - Do not try to colorize output when not in a `tty`
39
+
40
+ - Add `--[no-]color` option to allow disabling colored output
41
+
42
+ [2.0.0]
43
+ -------
44
+
45
+ - 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/))
46
+
47
+ - Drop Ruby 2.2 support.
48
+
49
+ - Update Nokogiri to 1.10
50
+
51
+ [1.31.0]
52
+ --------
53
+
54
+ - Follow redirections when doing HTTP requests.
55
+
56
+ [1.30.0]
57
+ --------
58
+
59
+ - Upgrade `ruby-handlebars` to 0.4. `each` and `join` helpers now support the `as` notation.
60
+
61
+ - Add support for Swift/XCTest ([#134](https://github.com/hiptest/hiptest-publisher/pull/134) [bangroot])
62
+
63
+ - Add cache for the XML downloaded from CucumberStudio.
64
+ By default, files will be valid for 60 seconds but can be changed by using `--cache-duration=120` for example.
65
+
66
+ [1.29.2]
67
+ --------
68
+
69
+ - 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))
70
+
71
+ [1.29.1]
72
+ --------
73
+
74
+ - Allow any characters for the meta value ([#155](https://github.com/hiptest/hiptest-publisher/issues/155))
75
+
76
+
77
+ [1.29.0]
78
+ --------
79
+
80
+ - Make `rake install` work with ruby 2.6
81
+ - `--parameter-delimiter` option now accepts empty string
82
+
83
+ [1.28.0]
84
+ --------
85
+
86
+ - Fix bug where parameter-delimiter value was not recognized in command line ([#147](https://github.com/hiptest/hiptest-publisher/issues/147))
87
+ - Add option --http-proxy to specify proxy to use ([#132](https://github.com/hiptest/hiptest-publisher/issues/132))
88
+
89
+ [1.27.1]
90
+ --------
91
+
92
+ - Add CodeceptJS to language list in OptionsParser.languages
93
+
94
+ [1.27.0]
95
+ --------
96
+
97
+ - Enable accessing scenario tags in datasets
98
+ ([#142](https://github.com/hiptest/hiptest-publisher/pull/142) [nono0481])
99
+
100
+ - Added support for CodeceptJS testing framework
101
+ ([#130](https://github.com/hiptest/hiptest-publisher/pull/130) [DavertMik])
102
+
103
+ [1.26.0]
104
+ --------
105
+
106
+ - Shared actionwords handling for Cucumber/Typescript
107
+
108
+ [1.25.0]
109
+ --------
110
+
111
+ - Shared actionwords handling for Behave
112
+
113
+ [1.24.0]
114
+ --------
115
+
116
+ - Add #case, #when and #when_includes handlebars helpers
117
+ - Modify #if_includes handlebars helper to work with strings
118
+
119
+ [1.23.5]
120
+ --------
121
+
122
+ - Load i18n path also when used as a library
123
+
124
+ [1.23.4]
125
+ --------
126
+
127
+ - Add I18n to enable localizing (and clearing the code)
128
+
129
+ [1.23.3]
130
+ --------
131
+
132
+ - Update multipart-post to 2.1.1 to handle issues with Ruby < 2.5
133
+ (see: https://github.com/socketry/multipart-post/issues/61)
134
+
135
+ [1.23.2]
136
+ --------
137
+
138
+ - Force Nokogiri < 1.10 to keep support for Ruby 2.2
139
+ - Add deprecation notifications for Ruby 2.2
140
+
141
+ [1.23.1]
142
+ --------
143
+
144
+ - Handle new shared actionword architecture
145
+
146
+ [1.22.0]
147
+ --------
148
+
149
+ - Add support for Cucumber/Typescript
150
+ - Unlock Nokogiri update to 1.9.1
151
+
152
+ [1.21.0]
153
+ --------
154
+
155
+ - Add option --execution-environment to push results in the specified execution environment name
156
+
157
+ [1.20.0]
158
+ --------
159
+
160
+ - Add --meta option to add more flexibility in code generation
161
+ (see: https://github.com/hiptest/hiptest-publisher/blob/master/docs/Using%20meta%20data.md#using-meta-data)
162
+
163
+ [1.19.3]
164
+ --------
165
+
166
+ - Do not leave trailing whitespaces with {{comment}} helper
167
+
168
+ [1.19.2]
169
+ --------
170
+ - Fix description in Gherkin exports
171
+
172
+ [1.19.1]
173
+ --------
174
+ - Fix description in Gherkin exports
175
+
176
+ [1.19.0]
177
+ --------
178
+ - Do not comment description in Gherkin exports
179
+
180
+ [1.18.1]
181
+ --------
182
+ - Show message when calling an actionword using an unknown UID
183
+
184
+ [1.18.0]
185
+ --------
186
+ - Add option [no-]parent-folders-tags to choose if parent tags are rendered in feature files
187
+
188
+ [1.17.2]
189
+ --------
190
+ - Fix UIDCall handling for shared actionwords
191
+
192
+ [1.17.1]
193
+ --------
194
+ - update version number
195
+
196
+ [1.16.6]
197
+ --------
198
+ - Add the if_includes handlebars helper
199
+ - Add options "parameter-delimiter" allowing to remove quotes around parameters in Gherkin export
200
+ (or replace it by anything else in fact)
201
+
202
+ [1.16.5]
203
+ --------
204
+ - Fix UIDCall handling for behat
205
+
206
+ [1.16.4]
207
+ --------
208
+ - Handling tags for shared actionwords
209
+
210
+ [1.16.3]
211
+ --------
212
+ - Fix behat rendering of shared actionwords
213
+
214
+ [1.16.2]
215
+ --------
216
+ - Remove unnecessary templates for cucumber/groovy
217
+
218
+ [1.16.0]
219
+ --------
220
+ - Shared actionwords handling for behat
221
+
222
+ [1.15.0]
223
+ --------
224
+ - Shared actionwords handling for groovy/spock
225
+
226
+ [1.14.0]
227
+ --------
228
+
229
+ - Shared actionwords handling for cucumber/groovy
230
+
231
+ [1.13.0]
232
+ --------
233
+
234
+ - Add Cucumber/Groovy support
235
+ ([#54](https://github.com/hiptest/hiptest-publisher/issues/54))
236
+
237
+ [1.12.0]
238
+ --------
239
+
240
+ - Add JBehave support
241
+ ([#38](https://github.com/hiptest/hiptest-publisher/issues/38))
242
+
243
+ - Add option --with-dataset-names
244
+ ([#105](https://github.com/hiptest/hiptest-publisher/issues/105))
245
+
246
+ - Reorder steps by regexp length for Behave
247
+ ([#104](https://github.com/hiptest/hiptest-publisher/issues/104))
248
+
249
+
250
+ <!-- List of releases -->
251
+ [Unreleased]: https://github.com/hiptest/hiptest-publisher/compare/v2.4.0...master
252
+ [2.4.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.3.1...v2.4.0
253
+ [2.3.1]: https://github.com/hiptest/hiptest-publisher/compare/v2.3.0...v2.3.1
254
+ [2.3.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.2.0...v2.3.0
255
+ [2.2.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.1.0...v2.2.0
256
+ [2.1.0]: https://github.com/hiptest/hiptest-publisher/compare/v2.0.0...v2.1.0
257
+ [2.0.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.31.0...v2.0.0
258
+ [1.31.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.30.0...v1.31.0
259
+ [1.30.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.29.2...v1.30.0
260
+ [1.29.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.29.1...v1.29.2
261
+ [1.29.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.29.0...v1.29.1
262
+ [1.29.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.28.0...v1.29.0
263
+ [1.28.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.27.1...v1.28.0
264
+ [1.27.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.27.0...v1.27.1
265
+ [1.27.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.26.0...v1.27.0
266
+ [1.26.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.25.0...v1.26.0
267
+ [1.25.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.24.0...v1.25.0
268
+ [1.24.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.5...v1.24.0
269
+ [1.23.5]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.4...v1.23.5
270
+ [1.23.4]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.3...v1.23.4
271
+ [1.23.3]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.2...v1.23.3
272
+ [1.23.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.23.1...v1.23.2
273
+ [1.23.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.22.0...v1.23.1
274
+ [1.22.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.21.0...v1.22.0
275
+ [1.21.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.20.0...v1.21.0
276
+ [1.20.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.3...v1.20.0
277
+ [1.19.3]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.2...v1.19.3
278
+ [1.19.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.1...v1.19.2
279
+ [1.19.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.19.0...v1.19.1
280
+ [1.19.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.18.1...v1.19.0
281
+ [1.18.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.18.0...v1.18.1
282
+ [1.18.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.17.2...v1.18.0
283
+ [1.17.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.17.1...v1.17.2
284
+ [1.17.1]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.6...v1.17.1
285
+ [1.16.6]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.5...v1.16.6
286
+ [1.16.5]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.4...v1.16.5
287
+ [1.16.4]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.3...v1.16.4
288
+ [1.16.3]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.2...v1.16.3
289
+ [1.16.2]: https://github.com/hiptest/hiptest-publisher/compare/v1.16.0...v1.16.2
290
+ [1.16.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.15.0...v1.16.0
291
+ [1.15.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.14.0...v1.15.0
292
+ [1.14.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.13.0...v1.14.0
293
+ [1.13.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.12.0...v1.13.0
294
+ [1.12.0]: https://github.com/hiptest/hiptest-publisher/compare/v1.11.1...v1.12.0
295
+
296
+
297
+ <!-- List of contributors -->
298
+ [atulhm]: https://github.com/atulhm
299
+ [bangroot]: https://github.com/bangroot
300
+ [ClaudiaJ]: https://github.com/ClaudiaJ
301
+ [daniel-kun]: https://github.com/daniel-kun
302
+ [DavertMik]: https://github.com/DavertMik
303
+ [etorreborre]: https://github.com/etorreborre
304
+ [Jesterovskiy]: https://github.com/Jesterovskiy
305
+ [lostiniceland]: https://github.com/lostiniceland
306
+ [mhfrantz]: https://github.com/mhfrantz
307
+ [nono0481]: https://github.com/nono0481
308
+ [tenpaiyomi]: https://github.com/tenpaiyomi
309
+ [tikolakin]: https://github.com/tikolakin
310
+ [weeksghost]: https://github.com/weeksghost
data/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) Hiptest
3
+ Copyright (c) SmartBear Software Inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
19
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
20
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
22
-
data/README.md CHANGED
@@ -1,14 +1,15 @@
1
1
  HipTest Publisher
2
2
  ==============
3
3
 
4
- [![CircleCI](https://circleci.com/gh/hiptest/hiptest-publisher.svg?style=svg)](https://circleci.com/gh/hiptest/hiptest-publisher)
5
- [![Build Status Linux](https://travis-ci.org/hiptest/hiptest-publisher.svg?branch=master)](https://travis-ci.org/hiptest/hiptest-publisher)
4
+ [![GitHub Actions status](https://github.com/hiptest/hiptest-publisher/workflows/Tests/badge.svg)](https://github.com/hiptest/hiptest-publisher/actions?query=workflow%3ATests)
6
5
  [![Build Status Windows](https://ci.appveyor.com/api/projects/status/ciahcci0ayr1oihr/branch/master?svg=true)](https://ci.appveyor.com/project/hiptest/hiptest-publisher)
7
6
  [![Gem Version](https://badge.fury.io/rb/hiptest-publisher.svg)](http://badge.fury.io/rb/hiptest-publisher)
8
7
  [![Code Climate](https://codeclimate.com/github/hiptest/hiptest-publisher/badges/gpa.svg)](https://codeclimate.com/github/hiptest/hiptest-publisher)
9
8
  [![Test Coverage](https://codeclimate.com/github/hiptest/hiptest-publisher/badges/coverage.svg)](https://codeclimate.com/github/hiptest/hiptest-publisher)
10
9
 
11
10
 
11
+ 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.
12
+
12
13
  Installing
13
14
  ----------
14
15
 
@@ -45,8 +46,8 @@ Note: for Windows users, take a look at [this Windows installation guide](docs/I
45
46
  Exporting a project
46
47
  -------------------
47
48
 
48
- Go to one of your [HipTest projects](https://app.hiptest.com/projects) and select the Settings tab.
49
- This tab is available only for projects you own.
49
+ Go to [CucumberStudio projects list](https://studio.cucumber.io/projects), pick one project, and select the Settings tab.
50
+ This tab is available only for projects you're admin of.
50
51
  From there, copy the secret token and run this command line:
51
52
 
52
53
  ```shell
@@ -55,13 +56,22 @@ hiptest-publisher --token=<YOUR TOKEN>
55
56
 
56
57
  This will create a Ruby tests suite. For the moment, we support the following languages and frameworks:
57
58
 
58
- - Ruby (rspec / minitest)
59
- - Cucumber Ruby
60
- - Python (unittest)
61
- - Java (JUnit / TestNg)
59
+ - Behat
60
+ - Behave
61
+ - CSharp (NUnit)
62
+ - Cucumber (Groovy / Java / Javascript / Ruby / TypeScript)
63
+ - Cucumber Legacy (Groovy / Java / TypeScript) (previous Cucumber versions)
64
+ - Groovy (Spock)
65
+ - Java (Espresso / JUnit / TestNg)
66
+ - JavaScript (CodeceptJS / Jasmine / Mocha / Protractor / QUnit)
67
+ - JBehave
68
+ - PHP (PHPUnit)
69
+ - Python (UnitTest)
62
70
  - Robot Framework
71
+ - Ruby (MiniTest / RSpec)
63
72
  - Selenium IDE
64
- - Javascript (qUnit / Jasmine)
73
+ - SpecFlow
74
+ - Swift (XCTest)
65
75
 
66
76
  You can specify the output language and framework in the command line, for example:
67
77
 
@@ -74,7 +84,7 @@ When publishing, you'll notice a file called ``actionwords_signature.yaml``. Sto
74
84
  Exporting a test run
75
85
  --------------------
76
86
 
77
- 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://app.hiptest.com/projects/1234/testRuns/6941`, then your test run id is `6941`. You can generate your tests from your test with this command line:
87
+ 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:
78
88
 
79
89
  ```shell
80
90
  hiptest-publisher --token=<YOUR TOKEN> --test-run-id=6941
@@ -92,7 +102,7 @@ hiptest-publisher --help
92
102
  You could obtain for example:
93
103
 
94
104
  ```shell
95
- Exports tests from HipTest for automation.
105
+ Exports tests from CucumberStudio for automation.
96
106
 
97
107
  Specific options:
98
108
  -t, --token=TOKEN Secret token (available in your project settings)
@@ -102,11 +112,13 @@ Specific options:
102
112
  --filename-pattern=PATTERN Filename pattern (containing %s)
103
113
  -c, --config-file=PATH Configuration file
104
114
  --overriden-templates=PATH Folder for overriden templates
115
+ --overriden-language-configs=PATH
116
+ Folder for overriden language configs
105
117
  --test-run-id=ID Export data from a test run identified by its id
106
118
  --test-run-name=NAME Export data from a test run identified by its name
107
119
  --only=CATEGORIES Restrict export to given file categories (--only=list to list them)
108
120
  --without=CATEGORIES Exclude file categories from import (--only=list to list them)
109
- -x, --xml-file=PROJECT_XML XML file to use instead of fetching it from HipTest
121
+ -x, --xml-file=PROJECT_XML XML file to use instead of fetching it from CucumberStudio
110
122
  --tests-only (deprecated) alias for --only=tests (default: false)
111
123
  --actionwords-only (deprecated) alias for --only=actionwords (default: false)
112
124
  --actionwords-signature Export actionwords signature (default: false)
@@ -125,7 +137,7 @@ Specific options:
125
137
  --empty-folders Export empty folders (default: false)
126
138
  --split-scenarios Export each scenario in a single file (except for Gherkin based languages) (default: false)
127
139
  --leafless-export Use only last level action word (default: false)
128
- -s, --site=SITE Site to fetch from (default: https://app.hiptest.com)
140
+ -s, --site=SITE Site to fetch from (default: https://studio.cucumber.io)
129
141
  -p, --push=FILE.TAP Push a results file to the server
130
142
  --global-failure-on-missing-reports
131
143
  When there is no results file to push, report a global failure (default: false)
@@ -136,8 +148,8 @@ Specific options:
136
148
  --[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)
137
149
  --parameter-delimiter Parameter delimiter (for Gherkin based export only) (default: ")
138
150
  --with-dataset-names Export dataset name when creating feature files (note: available only for Gherkin-based exports) (default: false)
139
- --keep-filenames Keep the same name as in HipTest for the test files (note: may cause encoding issues) (default: false)
140
- --keep-foldernames Keep the same name as in HipTest for the folders (note: may cause encoding issues) (default: false)
151
+ --keep-filenames Keep the same name as in CucumberStudio for the test files (note: may cause encoding issues) (default: false)
152
+ --keep-foldernames Keep the same name as in CucumberStudio for the folders (note: may cause encoding issues) (default: false)
141
153
  --filter-on-scenario-ids=IDS Filter on scenario ids (use commas to separate ids when fetching multiple scenarios)
142
154
  --filter-on-folder-ids=IDS Filter on folder ids (use commas to separate ids when fetching multiple folders)
143
155
  --filter-on-scenario-name=NAME
@@ -179,6 +191,8 @@ package = 'com.youcompany'
179
191
 
180
192
  Note that options from command line arguments override options from config file.
181
193
 
194
+ 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.
195
+
182
196
  ### Using hiptest-publisher behind a http proxy
183
197
 
184
198
  To use hiptest-publisher behind a http proxy, set an environment variable named http_proxy
@@ -190,17 +204,19 @@ If username and password are required:
190
204
  http_proxy=http://<username>:<password>@<proxy_host>:<proxy_port>
191
205
  ```
192
206
 
193
- Posting results to HipTest
194
- --------------------------
207
+ Posting results to CucumberStudio
208
+ ---------------------------------
209
+
210
+ 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).
195
211
 
196
- 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).
197
- The tests must then generate a test report that is supported by HipTest. Currently four types of test results are handled:
212
+ The tests must then generate a test report that is supported by CucumberStudio. Currently four types of test results are handled:
213
+ - Cucumber JSON format
198
214
  - jUnit XML format
199
215
  - [NUnit XML v2 format](https://github.com/nunit/docs/wiki/XML-Formats#v2-test-results)
200
- - [TAP (Test Anything Protocol)](https://testanything.org/)
201
216
  - Robot framework XML output
217
+ - [TAP (Test Anything Protocol)](https://testanything.org/)
202
218
 
203
- 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.
219
+ 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.
204
220
 
205
221
  You can push multiple files at once (using wildcard) but in that case, do not forget to add quotes. For examples:
206
222
 
@@ -214,7 +230,7 @@ Development
214
230
  While developing, you can install the gem locally by issuing
215
231
 
216
232
  ```
217
- rake install
233
+ bundle exec rake install
218
234
  ```
219
235
 
220
236
  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: