Skip to content

Commit 11c072b

Browse files
robinkrahld-e-s-o
robinkrahl
authored and
d-e-s-o
committed
Add snapshot tests for the help output
As a preparation for the migration from structopt to clap 3.0.0, we add tests for the help output of all commands.
1 parent 5735b53 commit 11c072b

File tree

65 files changed

+1796
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+1796
-0
lines changed

‎Cargo.lock‎

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ version = "1.5.5"
7777
[dependencies.toml]
7878
version = "0.5.6"
7979

80+
[dev-dependencies.insta]
81+
version = "1.8"
82+
8083
[dev-dependencies.nitrokey-test]
8184
version = "0.5"
8285

‎src/tests/run.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ fn help_options() {
4343
args.insert(0, "nitrocli");
4444
assert!(s.starts_with(&args.join("-")), "{}", s);
4545
assert!(s.contains("USAGE:\n"), "{}", s);
46+
47+
insta::assert_snapshot!(format!("{}_{}", args.join("_"), help), s);
4648
}
4749

4850
fn test(args: &[&str]) {

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_--help.snap‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli 0.4.1
7+
A top-level command for nitrocli
8+
9+
USAGE:
10+
nitrocli [FLAGS] [OPTIONS] <SUBCOMMAND>
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-V, --version Prints version information
16+
-v, --verbose Increases the log level (can be supplied multiple times)
17+
18+
OPTIONS:
19+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
20+
storage]
21+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
22+
times to allow multiple serial numbers
23+
--usb-path <usb-path> Sets the USB path of the device to connect to
24+
25+
SUBCOMMANDS:
26+
config Reads or writes the device configuration
27+
encrypted Interacts with the device's encrypted volume
28+
fill Fills the SD card with random data
29+
help Prints this message or the help of the given subcommand(s)
30+
hidden Interacts with the device's hidden volume
31+
list Lists the attached Nitrokey devices
32+
lock Locks the connected Nitrokey device
33+
otp Accesses one-time passwords
34+
pin Manages the Nitrokey PINs
35+
pws Accesses the password safe
36+
reset Performs a factory reset
37+
status Prints the status of the connected Nitrokey device
38+
unencrypted Interacts with the device's unencrypted volume
39+

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_-h.snap‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli 0.4.1
7+
A top-level command for nitrocli
8+
9+
USAGE:
10+
nitrocli [FLAGS] [OPTIONS] <SUBCOMMAND>
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-V, --version Prints version information
16+
-v, --verbose Increases the log level (can be supplied multiple times)
17+
18+
OPTIONS:
19+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
20+
storage]
21+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
22+
times to allow multiple serial numbers
23+
--usb-path <usb-path> Sets the USB path of the device to connect to
24+
25+
SUBCOMMANDS:
26+
config Reads or writes the device configuration
27+
encrypted Interacts with the device's encrypted volume
28+
fill Fills the SD card with random data
29+
help Prints this message or the help of the given subcommand(s)
30+
hidden Interacts with the device's hidden volume
31+
list Lists the attached Nitrokey devices
32+
lock Locks the connected Nitrokey device
33+
otp Accesses one-time passwords
34+
pin Manages the Nitrokey PINs
35+
pws Accesses the password safe
36+
reset Performs a factory reset
37+
status Prints the status of the connected Nitrokey device
38+
unencrypted Interacts with the device's unencrypted volume
39+

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_config_--help.snap‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli-config 0.4.1
7+
Reads or writes the device configuration
8+
9+
USAGE:
10+
nitrocli config [FLAGS] [OPTIONS] <SUBCOMMAND>
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-V, --version Prints version information
16+
-v, --verbose Increases the log level (can be supplied multiple times)
17+
18+
OPTIONS:
19+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
20+
storage]
21+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
22+
times to allow multiple serial numbers
23+
--usb-path <usb-path> Sets the USB path of the device to connect to
24+
25+
SUBCOMMANDS:
26+
get Prints the Nitrokey configuration
27+
help Prints this message or the help of the given subcommand(s)
28+
set Changes the Nitrokey configuration
29+

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_config_-h.snap‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli-config 0.4.1
7+
Reads or writes the device configuration
8+
9+
USAGE:
10+
nitrocli config [FLAGS] [OPTIONS] <SUBCOMMAND>
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-V, --version Prints version information
16+
-v, --verbose Increases the log level (can be supplied multiple times)
17+
18+
OPTIONS:
19+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
20+
storage]
21+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
22+
times to allow multiple serial numbers
23+
--usb-path <usb-path> Sets the USB path of the device to connect to
24+
25+
SUBCOMMANDS:
26+
get Prints the Nitrokey configuration
27+
help Prints this message or the help of the given subcommand(s)
28+
set Changes the Nitrokey configuration
29+

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_config_get_--help.snap‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli-config-get 0.4.1
7+
Prints the Nitrokey configuration
8+
9+
USAGE:
10+
nitrocli config get [FLAGS] [OPTIONS]
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-V, --version Prints version information
16+
-v, --verbose Increases the log level (can be supplied multiple times)
17+
18+
OPTIONS:
19+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
20+
storage]
21+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
22+
times to allow multiple serial numbers
23+
--usb-path <usb-path> Sets the USB path of the device to connect to
24+

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_config_get_-h.snap‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli-config-get 0.4.1
7+
Prints the Nitrokey configuration
8+
9+
USAGE:
10+
nitrocli config get [FLAGS] [OPTIONS]
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-V, --version Prints version information
16+
-v, --verbose Increases the log level (can be supplied multiple times)
17+
18+
OPTIONS:
19+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
20+
storage]
21+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
22+
times to allow multiple serial numbers
23+
--usb-path <usb-path> Sets the USB path of the device to connect to
24+

‎src/tests/snapshots/nitrocli__tests__run__nitrocli_config_set_--help.snap‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
source: src/tests/run.rs
3+
expression: s
4+
5+
---
6+
nitrocli-config-set 0.4.1
7+
Changes the Nitrokey configuration
8+
9+
USAGE:
10+
nitrocli config set [FLAGS] [OPTIONS]
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
--no-cache Disables the cache for all secrets
15+
-C, --no-caps-lock Unsets the Caps Lock option
16+
-N, --no-num-lock Unsets the Num Lock option
17+
-O, --no-otp-pin Allows one-time password generation without PIN
18+
-S, --no-scroll-lock Unsets the Scroll Lock option
19+
-o, --otp-pin Requires the user PIN to generate one-time passwords
20+
-V, --version Prints version information
21+
-v, --verbose Increases the log level (can be supplied multiple times)
22+
23+
OPTIONS:
24+
-c, --caps-lock <caps-lock> Sets the Cap Lock option to the given HOTP slot
25+
-m, --model <model> Selects the device model to connect to [possible values: librem, pro,
26+
storage]
27+
-n, --num-lock <num-lock> Sets the Num Lock option to the given HOTP slot
28+
-s, --scroll-lock <scroll-lock> Sets the Scroll Lock option to the given HOTP slot
29+
--serial-number <serial-numbers>... Sets the serial number of the device to connect to. Can be set multiple
30+
times to allow multiple serial numbers
31+
--usb-path <usb-path> Sets the USB path of the device to connect to
32+

0 commit comments

Comments
 (0)