@testiny/cli 1.2.5 → 1.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -4
- package/README.md +89 -89
- package/package.json +21 -21
- package/testiny-importer.js +127 -127
- /package/{LICENSES.txt → licenses.txt} +0 -0
package/LICENSE
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Copyright Mategra GmbH - All rights reserved
|
|
2
|
-
|
|
3
|
-
Intended only for use with Testiny SaaS platform
|
|
4
|
-
https://www.testiny.io/terms-of-use/
|
|
1
|
+
Copyright Mategra GmbH - All rights reserved
|
|
2
|
+
|
|
3
|
+
Intended only for use with Testiny SaaS platform
|
|
4
|
+
https://www.testiny.io/terms-of-use/
|
package/README.md
CHANGED
|
@@ -1,89 +1,89 @@
|
|
|
1
|
-
# Testiny CLI
|
|
2
|
-
|
|
3
|
-
Use the Testiny CLI to import test cases and test runs into your Testiny Organization.
|
|
4
|
-
|
|
5
|
-
- Test cases can be imported from CSV files (see example below)
|
|
6
|
-
- Test runs can be imported from CSV, JUnit and Playwright JSON
|
|
7
|
-
|
|
8
|
-
## Quick Start
|
|
9
|
-
|
|
10
|
-
- Create an API key with write permissions on the project you want to import to
|
|
11
|
-
- Set the API key as the TESTINY_API_KEY environment variable or pass with ``--apikey``
|
|
12
|
-
- Running just ``testiny-importer testcase`` or ``testiny-importer testrun`` command prompts for required options
|
|
13
|
-
|
|
14
|
-
## General Options
|
|
15
|
-
|
|
16
|
-
```plain
|
|
17
|
-
Usage: testiny-importer [options] [command]
|
|
18
|
-
|
|
19
|
-
Options:
|
|
20
|
-
--app <url> App endpoint to use (default: "https://app.testiny.io/")
|
|
21
|
-
-P, --project <nameOrKey> Target project id or key
|
|
22
|
-
-y, --confirm Do not prompt for confirmation before starting import
|
|
23
|
-
--disable-custom-fields Disable custom field import. Will fail if required custom fields
|
|
24
|
-
with no defaults are enabled
|
|
25
|
-
--disable-tc-keys Disable test case import key hints
|
|
26
|
-
--disable-nested-folders Disable nesting of imported folders (flat mode)
|
|
27
|
-
--folder-separator <token> Token for folder name separation (default ' > ')
|
|
28
|
-
--duplicates <duplicate mode> Controls how duplicates are detected (choices: "off", "title",
|
|
29
|
-
"folder_title", default: "folder_title")
|
|
30
|
-
--licenses Show included package licenses
|
|
31
|
-
--apikey <apiKey> The API key to use. Not recommended - use the environment variable
|
|
32
|
-
TESTINY_API_KEY or TESTINY_IMPORT_API_KEY instead
|
|
33
|
-
-h, --help display help for command
|
|
34
|
-
|
|
35
|
-
Commands:
|
|
36
|
-
testcase [options] Import testcases (with folders)
|
|
37
|
-
testrun [options] Import test case results as a testrun
|
|
38
|
-
help [command] display help for command
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Importing Test Cases
|
|
42
|
-
|
|
43
|
-
```plain
|
|
44
|
-
Usage: testiny-importer testcase [options]
|
|
45
|
-
|
|
46
|
-
Import testcases (with folders)
|
|
47
|
-
|
|
48
|
-
Options:
|
|
49
|
-
--csv <file> Import this CSV file
|
|
50
|
-
--csv-encoding <encoding> CSV file encoding (default: "utf8")
|
|
51
|
-
--steps <step mode> Controls how steps are imported (choices: "off", "rows", "newlines", "numbered", "numbered_bracket")
|
|
52
|
-
-h, --help display help for command
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
## Importing Test Runs
|
|
56
|
-
|
|
57
|
-
```plain
|
|
58
|
-
Usage: testiny-importer testrun [options]
|
|
59
|
-
|
|
60
|
-
Import test case results as a testrun
|
|
61
|
-
|
|
62
|
-
Options:
|
|
63
|
-
--csv <file> Import this CSV file
|
|
64
|
-
--csv-encoding <encoding> CSV file encoding (default: "utf8")
|
|
65
|
-
--junit <file> Import this JUnit XML file
|
|
66
|
-
--playwright <file> Import this Playwright JSON file
|
|
67
|
-
--name <test run name> Name of the test run (use %date, %host and %source as placeholders)
|
|
68
|
-
--update Allow run with given name to be updated, otherwise creates a new run with that name (default: false)
|
|
69
|
-
--close Close the testrun after a successful import (default: false)
|
|
70
|
-
--folder <folder name> Override folder name for all created testcases
|
|
71
|
-
--testplan <nameOrKey> Target testplan id or title
|
|
72
|
-
--testcases <tc mode> Controls how testcases are created if no existing TC is found (choices: "ignore", "fail", "create",
|
|
73
|
-
default: "create")
|
|
74
|
-
-h, --help display help for command
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
## Example Files
|
|
78
|
-
|
|
79
|
-
CSV Example for importing test cases
|
|
80
|
-
|
|
81
|
-
```csv
|
|
82
|
-
folder,title,precondition,steps,expected_result
|
|
83
|
-
"Folder Name", "Test case title", "Precondition text, can be empty", "Steps text (depends on step mode setting)", "Expected result, can be empty"
|
|
84
|
-
"Folder Name > Subfolder Name", "Another test case title", "", "Folders can be nested by using the folder separator token", ""
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## Bundled licenses
|
|
88
|
-
|
|
89
|
-
For licenses of bundled dependencies, please see LICENSE.txt in the package directory
|
|
1
|
+
# Testiny CLI
|
|
2
|
+
|
|
3
|
+
Use the Testiny CLI to import test cases and test runs into your Testiny Organization.
|
|
4
|
+
|
|
5
|
+
- Test cases can be imported from CSV files (see example below)
|
|
6
|
+
- Test runs can be imported from CSV, JUnit and Playwright JSON
|
|
7
|
+
|
|
8
|
+
## Quick Start
|
|
9
|
+
|
|
10
|
+
- Create an API key with write permissions on the project you want to import to
|
|
11
|
+
- Set the API key as the TESTINY_API_KEY environment variable or pass with ``--apikey``
|
|
12
|
+
- Running just ``testiny-importer testcase`` or ``testiny-importer testrun`` command prompts for required options
|
|
13
|
+
|
|
14
|
+
## General Options
|
|
15
|
+
|
|
16
|
+
```plain
|
|
17
|
+
Usage: testiny-importer [options] [command]
|
|
18
|
+
|
|
19
|
+
Options:
|
|
20
|
+
--app <url> App endpoint to use (default: "https://app.testiny.io/")
|
|
21
|
+
-P, --project <nameOrKey> Target project id or key
|
|
22
|
+
-y, --confirm Do not prompt for confirmation before starting import
|
|
23
|
+
--disable-custom-fields Disable custom field import. Will fail if required custom fields
|
|
24
|
+
with no defaults are enabled
|
|
25
|
+
--disable-tc-keys Disable test case import key hints
|
|
26
|
+
--disable-nested-folders Disable nesting of imported folders (flat mode)
|
|
27
|
+
--folder-separator <token> Token for folder name separation (default ' > ')
|
|
28
|
+
--duplicates <duplicate mode> Controls how duplicates are detected (choices: "off", "title",
|
|
29
|
+
"folder_title", default: "folder_title")
|
|
30
|
+
--licenses Show included package licenses
|
|
31
|
+
--apikey <apiKey> The API key to use. Not recommended - use the environment variable
|
|
32
|
+
TESTINY_API_KEY or TESTINY_IMPORT_API_KEY instead
|
|
33
|
+
-h, --help display help for command
|
|
34
|
+
|
|
35
|
+
Commands:
|
|
36
|
+
testcase [options] Import testcases (with folders)
|
|
37
|
+
testrun [options] Import test case results as a testrun
|
|
38
|
+
help [command] display help for command
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Importing Test Cases
|
|
42
|
+
|
|
43
|
+
```plain
|
|
44
|
+
Usage: testiny-importer testcase [options]
|
|
45
|
+
|
|
46
|
+
Import testcases (with folders)
|
|
47
|
+
|
|
48
|
+
Options:
|
|
49
|
+
--csv <file> Import this CSV file
|
|
50
|
+
--csv-encoding <encoding> CSV file encoding (default: "utf8")
|
|
51
|
+
--steps <step mode> Controls how steps are imported (choices: "off", "rows", "newlines", "numbered", "numbered_bracket")
|
|
52
|
+
-h, --help display help for command
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Importing Test Runs
|
|
56
|
+
|
|
57
|
+
```plain
|
|
58
|
+
Usage: testiny-importer testrun [options]
|
|
59
|
+
|
|
60
|
+
Import test case results as a testrun
|
|
61
|
+
|
|
62
|
+
Options:
|
|
63
|
+
--csv <file> Import this CSV file
|
|
64
|
+
--csv-encoding <encoding> CSV file encoding (default: "utf8")
|
|
65
|
+
--junit <file> Import this JUnit XML file
|
|
66
|
+
--playwright <file> Import this Playwright JSON file
|
|
67
|
+
--name <test run name> Name of the test run (use %date, %host and %source as placeholders)
|
|
68
|
+
--update Allow run with given name to be updated, otherwise creates a new run with that name (default: false)
|
|
69
|
+
--close Close the testrun after a successful import (default: false)
|
|
70
|
+
--folder <folder name> Override folder name for all created testcases
|
|
71
|
+
--testplan <nameOrKey> Target testplan id or title
|
|
72
|
+
--testcases <tc mode> Controls how testcases are created if no existing TC is found (choices: "ignore", "fail", "create",
|
|
73
|
+
default: "create")
|
|
74
|
+
-h, --help display help for command
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Example Files
|
|
78
|
+
|
|
79
|
+
CSV Example for importing test cases
|
|
80
|
+
|
|
81
|
+
```csv
|
|
82
|
+
folder,title,precondition,steps,expected_result
|
|
83
|
+
"Folder Name", "Test case title", "Precondition text, can be empty", "Steps text (depends on step mode setting)", "Expected result, can be empty"
|
|
84
|
+
"Folder Name > Subfolder Name", "Another test case title", "", "Folders can be nested by using the folder separator token", ""
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Bundled licenses
|
|
88
|
+
|
|
89
|
+
For licenses of bundled dependencies, please see LICENSE.txt in the package directory
|
package/package.json
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@testiny/cli",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "A command-line client for Testiny",
|
|
5
|
-
"main": "./testiny-importer.js",
|
|
6
|
-
"bin": {
|
|
7
|
-
"testiny-importer": "./testiny-importer.js"
|
|
8
|
-
},
|
|
9
|
-
"homepage": "https://www.testiny.io/",
|
|
10
|
-
"engines": {
|
|
11
|
-
"node": ">=16.0.0"
|
|
12
|
-
},
|
|
13
|
-
"keywords": [
|
|
14
|
-
"testiny",
|
|
15
|
-
"testmanagement",
|
|
16
|
-
"testautomation"
|
|
17
|
-
],
|
|
18
|
-
"author": "Mategra GmbH",
|
|
19
|
-
"devDependencies": {},
|
|
20
|
-
"dependencies": {}
|
|
21
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@testiny/cli",
|
|
3
|
+
"version": "1.2.6",
|
|
4
|
+
"description": "A command-line client for Testiny",
|
|
5
|
+
"main": "./testiny-importer.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"testiny-importer": "./testiny-importer.js"
|
|
8
|
+
},
|
|
9
|
+
"homepage": "https://www.testiny.io/",
|
|
10
|
+
"engines": {
|
|
11
|
+
"node": ">=16.0.0"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"testiny",
|
|
15
|
+
"testmanagement",
|
|
16
|
+
"testautomation"
|
|
17
|
+
],
|
|
18
|
+
"author": "Mategra GmbH",
|
|
19
|
+
"devDependencies": {},
|
|
20
|
+
"dependencies": {}
|
|
21
|
+
}
|