derivepassphrase.git

1) # SPDX-FileCopyrightText: 2024 Marco Ricci <software@the13thletter.info>

2) #
3) # SPDX-License-Identifier: MIT
4) 

5) from __future__ import annotations
6) 

7) import contextlib

8) import errno

9) import json
10) import os

11) import shutil

12) import socket

13) from typing import TYPE_CHECKING

14) 

15) import click.testing
16) import pytest

17) from typing_extensions import NamedTuple
18) 

19) import tests

20) from derivepassphrase import _types, cli, ssh_agent, vault

21) 
22) if TYPE_CHECKING:
23)     from collections.abc import Callable
24) 
25)     from typing_extensions import Any

26) 

27) DUMMY_SERVICE = tests.DUMMY_SERVICE
28) DUMMY_PASSPHRASE = tests.DUMMY_PASSPHRASE
29) DUMMY_CONFIG_SETTINGS = tests.DUMMY_CONFIG_SETTINGS
30) DUMMY_RESULT_PASSPHRASE = tests.DUMMY_RESULT_PASSPHRASE
31) DUMMY_RESULT_KEY1 = tests.DUMMY_RESULT_KEY1
32) DUMMY_PHRASE_FROM_KEY1_RAW = tests.DUMMY_PHRASE_FROM_KEY1_RAW
33) DUMMY_PHRASE_FROM_KEY1 = tests.DUMMY_PHRASE_FROM_KEY1
34) 
35) DUMMY_KEY1 = tests.DUMMY_KEY1
36) DUMMY_KEY1_B64 = tests.DUMMY_KEY1_B64
37) DUMMY_KEY2 = tests.DUMMY_KEY2

38) DUMMY_KEY2_B64 = tests.DUMMY_KEY2_B64
39) DUMMY_KEY3 = tests.DUMMY_KEY3
40) DUMMY_KEY3_B64 = tests.DUMMY_KEY3_B64

41) 
42) 
43) class IncompatibleConfiguration(NamedTuple):
44)     other_options: list[tuple[str, ...]]
45)     needs_service: bool | None

46)     input: str | None

47) 

48) 

49) class SingleConfiguration(NamedTuple):
50)     needs_service: bool | None

51)     input: str | None

52)     check_success: bool
53) 

54) 

55) class OptionCombination(NamedTuple):
56)     options: list[str]
57)     incompatible: bool
58)     needs_service: bool | None

59)     input: str | None

60)     check_success: bool
61) 

62) 

63) PASSWORD_GENERATION_OPTIONS: list[tuple[str, ...]] = [

64)     ('--phrase',),
65)     ('--key',),
66)     ('--length', '20'),
67)     ('--repeat', '20'),
68)     ('--lower', '1'),
69)     ('--upper', '1'),
70)     ('--number', '1'),
71)     ('--space', '1'),
72)     ('--dash', '1'),
73)     ('--symbol', '1'),

74) ]
75) CONFIGURATION_OPTIONS: list[tuple[str, ...]] = [

76)     ('--notes',),
77)     ('--config',),
78)     ('--delete',),
79)     ('--delete-globals',),
80)     ('--clear',),

81) ]
82) CONFIGURATION_COMMANDS: list[tuple[str, ...]] = [

83)     ('--notes',),
84)     ('--delete',),
85)     ('--delete-globals',),
86)     ('--clear',),

87) ]

88) STORAGE_OPTIONS: list[tuple[str, ...]] = [('--export', '-'), ('--import', '-')]

89) INCOMPATIBLE: dict[tuple[str, ...], IncompatibleConfiguration] = {
90)     ('--phrase',): IncompatibleConfiguration(

91)         [('--key',), *CONFIGURATION_COMMANDS, *STORAGE_OPTIONS],

92)         True,
93)         DUMMY_PASSPHRASE,
94)     ),

95)     ('--key',): IncompatibleConfiguration(

96)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
97)     ),

98)     ('--length', '20'): IncompatibleConfiguration(

99)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
100)     ),

101)     ('--repeat', '20'): IncompatibleConfiguration(

102)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
103)     ),

104)     ('--lower', '1'): IncompatibleConfiguration(

105)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
106)     ),

107)     ('--upper', '1'): IncompatibleConfiguration(

108)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
109)     ),

110)     ('--number', '1'): IncompatibleConfiguration(

111)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
112)     ),

113)     ('--space', '1'): IncompatibleConfiguration(

114)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
115)     ),

116)     ('--dash', '1'): IncompatibleConfiguration(

117)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
118)     ),

119)     ('--symbol', '1'): IncompatibleConfiguration(

120)         CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
121)     ),

122)     ('--notes',): IncompatibleConfiguration(

123)         [
124)             ('--config',),
125)             ('--delete',),
126)             ('--delete-globals',),
127)             ('--clear',),
128)             *STORAGE_OPTIONS,
129)         ],
130)         True,
131)         None,
132)     ),

133)     ('--config', '-p'): IncompatibleConfiguration(

134)         [('--delete',), ('--delete-globals',), ('--clear',), *STORAGE_OPTIONS],
135)         None,
136)         DUMMY_PASSPHRASE,
137)     ),

138)     ('--delete',): IncompatibleConfiguration(

139)         [('--delete-globals',), ('--clear',), *STORAGE_OPTIONS], True, None
140)     ),

141)     ('--delete-globals',): IncompatibleConfiguration(

142)         [('--clear',), *STORAGE_OPTIONS], False, None
143)     ),

144)     ('--clear',): IncompatibleConfiguration(STORAGE_OPTIONS, False, None),
145)     ('--export', '-'): IncompatibleConfiguration(

146)         [('--import', '-')], False, None
147)     ),
148)     ('--import', '-'): IncompatibleConfiguration([], False, None),

149) }
150) SINGLES: dict[tuple[str, ...], SingleConfiguration] = {
151)     ('--phrase',): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
152)     ('--key',): SingleConfiguration(True, None, False),
153)     ('--length', '20'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
154)     ('--repeat', '20'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
155)     ('--lower', '1'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
156)     ('--upper', '1'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
157)     ('--number', '1'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
158)     ('--space', '1'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
159)     ('--dash', '1'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
160)     ('--symbol', '1'): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
161)     ('--notes',): SingleConfiguration(True, None, False),
162)     ('--config', '-p'): SingleConfiguration(None, DUMMY_PASSPHRASE, False),
163)     ('--delete',): SingleConfiguration(True, None, False),
164)     ('--delete-globals',): SingleConfiguration(False, None, True),
165)     ('--clear',): SingleConfiguration(False, None, True),
166)     ('--export', '-'): SingleConfiguration(False, None, True),

167)     ('--import', '-'): SingleConfiguration(False, '{"services": {}}', True),

168) }
169) INTERESTING_OPTION_COMBINATIONS: list[OptionCombination] = []

170) config: IncompatibleConfiguration | SingleConfiguration

171) for opt, config in INCOMPATIBLE.items():
172)     for opt2 in config.other_options:
173)         INTERESTING_OPTION_COMBINATIONS.extend([

174)             OptionCombination(
175)                 options=list(opt + opt2),
176)                 incompatible=True,
177)                 needs_service=config.needs_service,
178)                 input=config.input,
179)                 check_success=False,
180)             ),
181)             OptionCombination(
182)                 options=list(opt2 + opt),
183)                 incompatible=True,
184)                 needs_service=config.needs_service,
185)                 input=config.input,
186)                 check_success=False,
187)             ),

188)         ])
189) for opt, config in SINGLES.items():
190)     INTERESTING_OPTION_COMBINATIONS.append(

191)         OptionCombination(
192)             options=list(opt),
193)             incompatible=False,
194)             needs_service=config.needs_service,
195)             input=config.input,
196)             check_success=config.check_success,
197)         )
198)     )

199) 
200) 

201) class TestCLI:

202)     def test_200_help_output(self, monkeypatch: pytest.MonkeyPatch) -> None:

203)         runner = click.testing.CliRunner(mix_stderr=False)

204)         with tests.isolated_config(
205)             monkeypatch=monkeypatch,
206)             runner=runner,
207)         ):

208)             _result = runner.invoke(

209)                 cli.derivepassphrase_vault, ['--help'], catch_exceptions=False

210)             )

211)             result = tests.ReadableResult.parse(_result)
212)         assert result.clean_exit(
213)             empty_stderr=True, output='Password generation:\n'
214)         ), 'expected clean exit, and option groups in help text'
215)         assert result.clean_exit(
216)             empty_stderr=True, output='Use NUMBER=0, e.g. "--symbol 0"'
217)         ), 'expected clean exit, and option group epilog in help text'

218) 

219)     @pytest.mark.parametrize(
220)         'charset_name', ['lower', 'upper', 'number', 'space', 'dash', 'symbol']
221)     )

222)     def test_201_disable_character_set(

223)         self, monkeypatch: pytest.MonkeyPatch, charset_name: str

224)     ) -> None:
225)         monkeypatch.setattr(cli, '_prompt_for_passphrase', tests.auto_prompt)
226)         option = f'--{charset_name}'

227)         charset = vault.Vault._CHARSETS[charset_name].decode('ascii')

228)         runner = click.testing.CliRunner(mix_stderr=False)

229)         with tests.isolated_config(
230)             monkeypatch=monkeypatch,
231)             runner=runner,
232)         ):

233)             _result = runner.invoke(

234)                 cli.derivepassphrase_vault,

235)                 [option, '0', '-p', DUMMY_SERVICE],
236)                 input=DUMMY_PASSPHRASE,
237)                 catch_exceptions=False,
238)             )

239)             result = tests.ReadableResult.parse(_result)
240)         assert result.clean_exit(empty_stderr=True), 'expected clean exit:'

241)         for c in charset:

242)             assert (
243)                 c not in result.output
244)             ), f'derived password contains forbidden character {c!r}'

245) 

246)     def test_202_disable_repetition(
247)         self, monkeypatch: pytest.MonkeyPatch
248)     ) -> None:

249)         monkeypatch.setattr(cli, '_prompt_for_passphrase', tests.auto_prompt)
250)         runner = click.testing.CliRunner(mix_stderr=False)

251)         with tests.isolated_config(
252)             monkeypatch=monkeypatch,
253)             runner=runner,
254)         ):

255)             _result = runner.invoke(

256)                 cli.derivepassphrase_vault,

257)                 ['--repeat', '0', '-p', DUMMY_SERVICE],
258)                 input=DUMMY_PASSPHRASE,
259)                 catch_exceptions=False,
260)             )

261)             result = tests.ReadableResult.parse(_result)
262)         assert result.clean_exit(
263)             empty_stderr=True
264)         ), 'expected clean exit and empty stderr'
265)         passphrase = result.output.rstrip('\r\n')

266)         for i in range(len(passphrase) - 1):

267)             assert passphrase[i : i + 1] != passphrase[i + 1 : i + 2], (

268)                 f'derived password contains repeated character '

269)                 f'at position {i}: {result.output!r}'

270)             )

271) 

272)     @pytest.mark.parametrize(
273)         'config',
274)         [
275)             pytest.param(
276)                 {
277)                     'global': {'key': DUMMY_KEY1_B64},
278)                     'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS},
279)                 },
280)                 id='global',
281)             ),
282)             pytest.param(
283)                 {

284)                     'global': {'phrase': DUMMY_PASSPHRASE.rstrip('\n')},

285)                     'services': {
286)                         DUMMY_SERVICE: {
287)                             'key': DUMMY_KEY1_B64,
288)                             **DUMMY_CONFIG_SETTINGS,
289)                         }
290)                     },
291)                 },
292)                 id='service',
293)             ),
294)         ],
295)     )

296)     def test_204a_key_from_config(

297)         self,

298)         monkeypatch: pytest.MonkeyPatch,

299)         config: _types.VaultConfig,

300)     ) -> None:
301)         runner = click.testing.CliRunner(mix_stderr=False)

302)         with tests.isolated_vault_config(

303)             monkeypatch=monkeypatch, runner=runner, config=config
304)         ):
305)             monkeypatch.setattr(

306)                 vault.Vault, 'phrase_from_key', tests.phrase_from_key

307)             )

308)             _result = runner.invoke(

309)                 cli.derivepassphrase_vault,
310)                 [DUMMY_SERVICE],
311)                 catch_exceptions=False,

312)             )

313)         result = tests.ReadableResult.parse(_result)
314)         assert result.clean_exit(
315)             empty_stderr=True
316)         ), 'expected clean exit and empty stderr'
317)         assert _result.stdout_bytes
318)         assert (
319)             _result.stdout_bytes.rstrip(b'\n') != DUMMY_RESULT_PASSPHRASE
320)         ), 'known false output: phrase-based instead of key-based'
321)         assert (
322)             _result.stdout_bytes.rstrip(b'\n') == DUMMY_RESULT_KEY1
323)         ), 'expected known output'

324) 

325)     def test_204b_key_from_command_line(
326)         self, monkeypatch: pytest.MonkeyPatch
327)     ) -> None:

328)         runner = click.testing.CliRunner(mix_stderr=False)

329)         with tests.isolated_vault_config(

330)             monkeypatch=monkeypatch,
331)             runner=runner,
332)             config={'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS}},
333)         ):
334)             monkeypatch.setattr(
335)                 cli, '_get_suitable_ssh_keys', tests.suitable_ssh_keys
336)             )
337)             monkeypatch.setattr(

338)                 vault.Vault, 'phrase_from_key', tests.phrase_from_key

339)             )

340)             _result = runner.invoke(

341)                 cli.derivepassphrase_vault,

342)                 ['-k', DUMMY_SERVICE],

343)                 input='1\n',

344)                 catch_exceptions=False,
345)             )

346)         result = tests.ReadableResult.parse(_result)
347)         assert result.clean_exit(), 'expected clean exit'
348)         assert _result.stdout_bytes, 'expected program output'
349)         last_line = _result.stdout_bytes.splitlines(True)[-1]
350)         assert (
351)             last_line.rstrip(b'\n') != DUMMY_RESULT_PASSPHRASE
352)         ), 'known false output: phrase-based instead of key-based'
353)         assert (
354)             last_line.rstrip(b'\n') == DUMMY_RESULT_KEY1
355)         ), 'expected known output'

356) 

357)     @pytest.mark.parametrize(
358)         'config',
359)         [
360)             pytest.param(
361)                 {
362)                     'global': {'key': DUMMY_KEY1_B64},
363)                     'services': {DUMMY_SERVICE: {}},
364)                 },
365)                 id='global_config',
366)             ),
367)             pytest.param(
368)                 {'services': {DUMMY_SERVICE: {'key': DUMMY_KEY2_B64}}},
369)                 id='service_config',
370)             ),
371)             pytest.param(
372)                 {
373)                     'global': {'key': DUMMY_KEY1_B64},
374)                     'services': {DUMMY_SERVICE: {'key': DUMMY_KEY2_B64}},
375)                 },
376)                 id='full_config',
377)             ),
378)         ],
379)     )
380)     @pytest.mark.parametrize('key_index', [1, 2, 3], ids=lambda i: f'index{i}')
381)     def test_204c_key_override_on_command_line(
382)         self,

383)         monkeypatch: pytest.MonkeyPatch,

384)         running_ssh_agent: str,

385)         config: dict[str, Any],
386)         key_index: int,
387)     ) -> None:

388)         with monkeypatch.context():
389)             monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)
390)             monkeypatch.setattr(
391)                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

392)             )

393)             monkeypatch.setattr(ssh_agent.SSHAgentClient, 'sign', tests.sign)

394)             runner = click.testing.CliRunner(mix_stderr=False)
395)             with tests.isolated_vault_config(
396)                 monkeypatch=monkeypatch, runner=runner, config=config
397)             ):
398)                 _result = runner.invoke(
399)                     cli.derivepassphrase_vault,
400)                     ['-k', DUMMY_SERVICE],
401)                     input=f'{key_index}\n',
402)                 )

403)         result = tests.ReadableResult.parse(_result)
404)         assert result.clean_exit(), 'expected clean exit'
405)         assert result.output, 'expected program output'
406)         assert result.stderr, 'expected stderr'
407)         assert (
408)             'Error:' not in result.stderr
409)         ), 'expected no error messages on stderr'

410) 

411)     def test_205_service_phrase_if_key_in_global_config(

412)         self,

413)         monkeypatch: pytest.MonkeyPatch,

414)         running_ssh_agent: str,

415)     ) -> None:

416)         with monkeypatch.context():
417)             monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)
418)             monkeypatch.setattr(
419)                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

420)             )

421)             monkeypatch.setattr(ssh_agent.SSHAgentClient, 'sign', tests.sign)
422)             runner = click.testing.CliRunner(mix_stderr=False)
423)             with tests.isolated_vault_config(
424)                 monkeypatch=monkeypatch,
425)                 runner=runner,
426)                 config={
427)                     'global': {'key': DUMMY_KEY1_B64},
428)                     'services': {
429)                         DUMMY_SERVICE: {
430)                             'phrase': DUMMY_PASSPHRASE.rstrip('\n'),
431)                             **DUMMY_CONFIG_SETTINGS,
432)                         }
433)                     },
434)                 },
435)             ):
436)                 _result = runner.invoke(
437)                     cli.derivepassphrase_vault,
438)                     [DUMMY_SERVICE],
439)                     catch_exceptions=False,
440)                 )

441)         result = tests.ReadableResult.parse(_result)
442)         assert result.clean_exit(), 'expected clean exit'
443)         assert _result.stdout_bytes, 'expected program output'
444)         last_line = _result.stdout_bytes.splitlines(True)[-1]
445)         assert (

446)             last_line.rstrip(b'\n') != DUMMY_RESULT_PASSPHRASE
447)         ), 'known false output: phrase-based instead of key-based'

448)         assert (

449)             last_line.rstrip(b'\n') == DUMMY_RESULT_KEY1

450)         ), 'expected known output'

451) 

452)     @pytest.mark.parametrize(
453)         'option',
454)         [
455)             '--lower',
456)             '--upper',
457)             '--number',
458)             '--space',
459)             '--dash',
460)             '--symbol',
461)             '--repeat',
462)             '--length',
463)         ],
464)     )

465)     def test_210_invalid_argument_range(

466)         self, monkeypatch: pytest.MonkeyPatch, option: str

467)     ) -> None:

468)         runner = click.testing.CliRunner(mix_stderr=False)

469)         with tests.isolated_config(
470)             monkeypatch=monkeypatch,
471)             runner=runner,
472)         ):
473)             for value in '-42', 'invalid':

474)                 _result = runner.invoke(

475)                     cli.derivepassphrase_vault,

476)                     [option, value, '-p', DUMMY_SERVICE],
477)                     input=DUMMY_PASSPHRASE,
478)                     catch_exceptions=False,
479)                 )

480)                 result = tests.ReadableResult.parse(_result)
481)                 assert result.error_exit(
482)                     error='Error: Invalid value'
483)                 ), 'expected error exit and known error message'

484) 
485)     @pytest.mark.parametrize(
486)         ['options', 'service', 'input', 'check_success'],

487)         [
488)             (o.options, o.needs_service, o.input, o.check_success)
489)             for o in INTERESTING_OPTION_COMBINATIONS
490)             if not o.incompatible
491)         ],

492)     )
493)     def test_211_service_needed(

494)         self,

495)         monkeypatch: pytest.MonkeyPatch,

496)         options: list[str],
497)         service: bool | None,

498)         input: str | None,

499)         check_success: bool,

500)     ) -> None:
501)         monkeypatch.setattr(cli, '_prompt_for_passphrase', tests.auto_prompt)
502)         runner = click.testing.CliRunner(mix_stderr=False)

503)         with tests.isolated_vault_config(

504)             monkeypatch=monkeypatch,
505)             runner=runner,
506)             config={'global': {'phrase': 'abc'}, 'services': {}},
507)         ):

508)             _result = runner.invoke(

509)                 cli.derivepassphrase_vault,

510)                 options if service else [*options, DUMMY_SERVICE],
511)                 input=input,
512)                 catch_exceptions=False,
513)             )

514)             result = tests.ReadableResult.parse(_result)

515)             if service is not None:

516)                 err_msg = (

517)                     ' requires a SERVICE'

518)                     if service

519)                     else ' does not take a SERVICE argument'

520)                 )

521)                 assert result.error_exit(
522)                     error=err_msg
523)                 ), 'expected error exit and known error message'

524)             else:

525)                 assert result.clean_exit(
526)                     empty_stderr=True
527)                 ), 'expected clean exit'

528)         if check_success:

529)             with tests.isolated_vault_config(

530)                 monkeypatch=monkeypatch,
531)                 runner=runner,
532)                 config={'global': {'phrase': 'abc'}, 'services': {}},
533)             ):
534)                 monkeypatch.setattr(
535)                     cli, '_prompt_for_passphrase', tests.auto_prompt
536)                 )

537)                 _result = runner.invoke(

538)                     cli.derivepassphrase_vault,

539)                     [*options, DUMMY_SERVICE] if service else options,
540)                     input=input,
541)                     catch_exceptions=False,

542)                 )

543)                 result = tests.ReadableResult.parse(_result)
544)             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

545) 
546)     @pytest.mark.parametrize(

547)         ['options', 'service'],

548)         [
549)             (o.options, o.needs_service)
550)             for o in INTERESTING_OPTION_COMBINATIONS
551)             if o.incompatible
552)         ],

553)     )

554)     def test_212_incompatible_options(

555)         self,

556)         monkeypatch: pytest.MonkeyPatch,

557)         options: list[str],
558)         service: bool | None,

559)     ) -> None:
560)         runner = click.testing.CliRunner(mix_stderr=False)

561)         with tests.isolated_config(
562)             monkeypatch=monkeypatch,
563)             runner=runner,
564)         ):

565)             _result = runner.invoke(

566)                 cli.derivepassphrase_vault,

567)                 [*options, DUMMY_SERVICE] if service else options,
568)                 input=DUMMY_PASSPHRASE,
569)                 catch_exceptions=False,
570)             )

571)         result = tests.ReadableResult.parse(_result)
572)         assert result.error_exit(
573)             error='mutually exclusive with '
574)         ), 'expected error exit and known error message'

575) 

576)     def test_213_import_bad_config_not_vault_config(

577)         self,

578)         monkeypatch: pytest.MonkeyPatch,

579)     ) -> None:
580)         runner = click.testing.CliRunner(mix_stderr=False)

581)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

582)             _result = runner.invoke(

583)                 cli.derivepassphrase_vault,

584)                 ['--import', '-'],

585)                 input='null',

586)                 catch_exceptions=False,

587)             )

588)         result = tests.ReadableResult.parse(_result)
589)         assert result.error_exit(
590)             error='Invalid vault config'
591)         ), 'expected error exit and known error message'

592) 

593)     def test_213a_import_bad_config_not_json_data(

594)         self,

595)         monkeypatch: pytest.MonkeyPatch,

596)     ) -> None:
597)         runner = click.testing.CliRunner(mix_stderr=False)

598)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

599)             _result = runner.invoke(

600)                 cli.derivepassphrase_vault,

601)                 ['--import', '-'],

602)                 input='This string is not valid JSON.',

603)                 catch_exceptions=False,

604)             )

605)         result = tests.ReadableResult.parse(_result)
606)         assert result.error_exit(
607)             error='cannot decode JSON'
608)         ), 'expected error exit and known error message'

609) 

610)     def test_213b_import_bad_config_not_a_file(

611)         self,

612)         monkeypatch: pytest.MonkeyPatch,

613)     ) -> None:
614)         runner = click.testing.CliRunner(mix_stderr=False)

615)         # `isolated_vault_config` validates the configuration.  So, to
616)         # pass an actual broken configuration, we must open the
617)         # configuration file ourselves afterwards, inside the context.
618)         # We also might as well use `isolated_config` instead.
619)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

620)             with open(

621)                 cli._config_filename(subsystem='vault'), 'w', encoding='UTF-8'

622)             ) as outfile:

623)                 print('This string is not valid JSON.', file=outfile)

624)             dname = cli._config_filename(subsystem=None)

625)             _result = runner.invoke(

626)                 cli.derivepassphrase_vault,

627)                 ['--import', os.fsdecode(dname)],

628)                 catch_exceptions=False,

629)             )

630)         result = tests.ReadableResult.parse(_result)
631)         assert result.error_exit(
632)             error=os.strerror(errno.EISDIR)
633)         ), 'expected error exit and known error message'

634) 
635)     def test_214_export_settings_no_stored_settings(

636)         self,

637)         monkeypatch: pytest.MonkeyPatch,

638)     ) -> None:
639)         runner = click.testing.CliRunner(mix_stderr=False)

640)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

641)             with contextlib.suppress(FileNotFoundError):

642)                 os.remove(cli._config_filename(subsystem='vault'))

643)             _result = runner.invoke(

644)                 cli.derivepassphrase_vault,
645)                 ['--export', '-'],
646)                 catch_exceptions=False,

647)             )

648)         result = tests.ReadableResult.parse(_result)
649)         assert result.clean_exit(empty_stderr=True), 'expected clean exit'

650) 

651)     def test_214a_export_settings_bad_stored_config(

652)         self,

653)         monkeypatch: pytest.MonkeyPatch,

654)     ) -> None:
655)         runner = click.testing.CliRunner(mix_stderr=False)

656)         with tests.isolated_vault_config(

657)             monkeypatch=monkeypatch, runner=runner, config={}
658)         ):

659)             _result = runner.invoke(

660)                 cli.derivepassphrase_vault,

661)                 ['--export', '-'],

662)                 input='null',

663)                 catch_exceptions=False,

664)             )

665)         result = tests.ReadableResult.parse(_result)
666)         assert result.error_exit(
667)             error='Cannot load config'
668)         ), 'expected error exit and known error message'

669) 

670)     def test_214b_export_settings_not_a_file(

671)         self,

672)         monkeypatch: pytest.MonkeyPatch,

673)     ) -> None:
674)         runner = click.testing.CliRunner(mix_stderr=False)

675)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

676)             with contextlib.suppress(FileNotFoundError):

677)                 os.remove(cli._config_filename(subsystem='vault'))
678)             os.makedirs(cli._config_filename(subsystem='vault'))

679)             _result = runner.invoke(

680)                 cli.derivepassphrase_vault,

681)                 ['--export', '-'],

682)                 input='null',

683)                 catch_exceptions=False,

684)             )

685)         result = tests.ReadableResult.parse(_result)
686)         assert result.error_exit(
687)             error='Cannot load config'
688)         ), 'expected error exit and known error message'

689) 

690)     def test_214c_export_settings_target_not_a_file(

691)         self,

692)         monkeypatch: pytest.MonkeyPatch,

693)     ) -> None:
694)         runner = click.testing.CliRunner(mix_stderr=False)

695)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

696)             dname = cli._config_filename(subsystem=None)

697)             _result = runner.invoke(

698)                 cli.derivepassphrase_vault,

699)                 ['--export', os.fsdecode(dname)],

700)                 input='null',

701)                 catch_exceptions=False,

702)             )

703)         result = tests.ReadableResult.parse(_result)
704)         assert result.error_exit(
705)             error='Cannot store config'
706)         ), 'expected error exit and known error message'

707) 

708)     def test_214d_export_settings_settings_directory_not_a_directory(
709)         self,

710)         monkeypatch: pytest.MonkeyPatch,

711)     ) -> None:
712)         runner = click.testing.CliRunner(mix_stderr=False)

713)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):

714)             with contextlib.suppress(FileNotFoundError):
715)                 shutil.rmtree('.derivepassphrase')
716)             with open('.derivepassphrase', 'w', encoding='UTF-8') as outfile:
717)                 print('Obstruction!!', file=outfile)

718)             _result = runner.invoke(

719)                 cli.derivepassphrase_vault,

720)                 ['--export', '-'],

721)                 input='null',

722)                 catch_exceptions=False,
723)             )

724)         result = tests.ReadableResult.parse(_result)
725)         assert result.error_exit(
726)             error='Cannot load config'
727)         ), 'expected error exit and known error message'

728) 

729)     def test_220_edit_notes_successfully(
730)         self, monkeypatch: pytest.MonkeyPatch
731)     ) -> None:

732)         edit_result = """

733) 
734) # - - - - - >8 - - - - - >8 - - - - - >8 - - - - - >8 - - - - -
735) contents go here

736) """

737)         runner = click.testing.CliRunner(mix_stderr=False)

738)         with tests.isolated_vault_config(

739)             monkeypatch=monkeypatch,
740)             runner=runner,
741)             config={'global': {'phrase': 'abc'}, 'services': {}},
742)         ):
743)             monkeypatch.setattr(click, 'edit', lambda *a, **kw: edit_result)  # noqa: ARG005

744)             _result = runner.invoke(

745)                 cli.derivepassphrase_vault,
746)                 ['--notes', 'sv'],
747)                 catch_exceptions=False,

748)             )

749)             result = tests.ReadableResult.parse(_result)
750)             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

751)             with open(
752)                 cli._config_filename(subsystem='vault'), encoding='UTF-8'
753)             ) as infile:

754)                 config = json.load(infile)

755)             assert config == {
756)                 'global': {'phrase': 'abc'},
757)                 'services': {'sv': {'notes': 'contents go here'}},
758)             }

759) 

760)     def test_221_edit_notes_noop(
761)         self, monkeypatch: pytest.MonkeyPatch
762)     ) -> None:

763)         runner = click.testing.CliRunner(mix_stderr=False)

764)         with tests.isolated_vault_config(

765)             monkeypatch=monkeypatch,
766)             runner=runner,
767)             config={'global': {'phrase': 'abc'}, 'services': {}},
768)         ):
769)             monkeypatch.setattr(click, 'edit', lambda *a, **kw: None)  # noqa: ARG005

770)             _result = runner.invoke(

771)                 cli.derivepassphrase_vault,
772)                 ['--notes', 'sv'],
773)                 catch_exceptions=False,

774)             )

775)             result = tests.ReadableResult.parse(_result)
776)             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

777)             with open(
778)                 cli._config_filename(subsystem='vault'), encoding='UTF-8'
779)             ) as infile:

780)                 config = json.load(infile)
781)             assert config == {'global': {'phrase': 'abc'}, 'services': {}}
782) 

783)     def test_222_edit_notes_marker_removed(
784)         self, monkeypatch: pytest.MonkeyPatch
785)     ) -> None:

786)         runner = click.testing.CliRunner(mix_stderr=False)

787)         with tests.isolated_vault_config(

788)             monkeypatch=monkeypatch,
789)             runner=runner,
790)             config={'global': {'phrase': 'abc'}, 'services': {}},
791)         ):
792)             monkeypatch.setattr(click, 'edit', lambda *a, **kw: 'long\ntext')  # noqa: ARG005

793)             _result = runner.invoke(

794)                 cli.derivepassphrase_vault,
795)                 ['--notes', 'sv'],
796)                 catch_exceptions=False,

797)             )

798)             result = tests.ReadableResult.parse(_result)
799)             assert result.clean_exit(empty_stderr=True), 'expected clean exit'

800)             with open(
801)                 cli._config_filename(subsystem='vault'), encoding='UTF-8'
802)             ) as infile:

803)                 config = json.load(infile)

804)             assert config == {
805)                 'global': {'phrase': 'abc'},
806)                 'services': {'sv': {'notes': 'long\ntext'}},
807)             }

808) 

809)     def test_223_edit_notes_abort(
810)         self, monkeypatch: pytest.MonkeyPatch
811)     ) -> None:

812)         runner = click.testing.CliRunner(mix_stderr=False)

813)         with tests.isolated_vault_config(

814)             monkeypatch=monkeypatch,
815)             runner=runner,
816)             config={'global': {'phrase': 'abc'}, 'services': {}},
817)         ):
818)             monkeypatch.setattr(click, 'edit', lambda *a, **kw: '\n\n')  # noqa: ARG005

819)             _result = runner.invoke(

820)                 cli.derivepassphrase_vault,
821)                 ['--notes', 'sv'],
822)                 catch_exceptions=False,

823)             )

824)             result = tests.ReadableResult.parse(_result)
825)             assert result.error_exit(
826)                 error='user aborted request'
827)             ), 'expected known error message'

828)             with open(
829)                 cli._config_filename(subsystem='vault'), encoding='UTF-8'
830)             ) as infile:

831)                 config = json.load(infile)
832)             assert config == {'global': {'phrase': 'abc'}, 'services': {}}
833) 

834)     @pytest.mark.parametrize(
835)         ['command_line', 'input', 'result_config'],
836)         [
837)             (
838)                 ['--phrase'],

839)                 'my passphrase\n',

840)                 {'global': {'phrase': 'my passphrase'}, 'services': {}},
841)             ),
842)             (
843)                 ['--key'],

844)                 '1\n',

845)                 {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},
846)             ),
847)             (
848)                 ['--phrase', 'sv'],

849)                 'my passphrase\n',

850)                 {
851)                     'global': {'phrase': 'abc'},
852)                     'services': {'sv': {'phrase': 'my passphrase'}},
853)                 },
854)             ),
855)             (
856)                 ['--key', 'sv'],

857)                 '1\n',

858)                 {
859)                     'global': {'phrase': 'abc'},
860)                     'services': {'sv': {'key': DUMMY_KEY1_B64}},
861)                 },
862)             ),
863)             (
864)                 ['--key', '--length', '15', 'sv'],

865)                 '1\n',

866)                 {
867)                     'global': {'phrase': 'abc'},
868)                     'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},
869)                 },
870)             ),
871)         ],
872)     )

873)     def test_224_store_config_good(

874)         self,

875)         monkeypatch: pytest.MonkeyPatch,

876)         command_line: list[str],

877)         input: str,

878)         result_config: Any,
879)     ) -> None:
880)         runner = click.testing.CliRunner(mix_stderr=False)

881)         with tests.isolated_vault_config(

882)             monkeypatch=monkeypatch,
883)             runner=runner,
884)             config={'global': {'phrase': 'abc'}, 'services': {}},
885)         ):
886)             monkeypatch.setattr(
887)                 cli, '_get_suitable_ssh_keys', tests.suitable_ssh_keys
888)             )

889)             _result = runner.invoke(

890)                 cli.derivepassphrase_vault,

891)                 ['--config', *command_line],
892)                 catch_exceptions=False,
893)                 input=input,
894)             )

895)             result = tests.ReadableResult.parse(_result)
896)             assert result.clean_exit(), 'expected clean exit'

897)             with open(
898)                 cli._config_filename(subsystem='vault'), encoding='UTF-8'
899)             ) as infile:

900)                 config = json.load(infile)

901)             assert (
902)                 config == result_config
903)             ), 'stored config does not match expectation'

904) 

905)     @pytest.mark.parametrize(
906)         ['command_line', 'input', 'err_text'],
907)         [

908)             ([], '', 'Cannot update global settings without actual settings'),

909)             (
910)                 ['sv'],

911)                 '',
912)                 'Cannot update service settings without actual settings',

913)             ),

914)             (['--phrase', 'sv'], '', 'No passphrase given'),
915)             (['--key'], '', 'No valid SSH key selected'),

916)         ],
917)     )

918)     def test_225_store_config_fail(

919)         self,

920)         monkeypatch: pytest.MonkeyPatch,

921)         command_line: list[str],

922)         input: str,
923)         err_text: str,

924)     ) -> None:
925)         runner = click.testing.CliRunner(mix_stderr=False)

926)         with tests.isolated_vault_config(

927)             monkeypatch=monkeypatch,
928)             runner=runner,
929)             config={'global': {'phrase': 'abc'}, 'services': {}},
930)         ):
931)             monkeypatch.setattr(
932)                 cli, '_get_suitable_ssh_keys', tests.suitable_ssh_keys
933)             )

934)             _result = runner.invoke(

935)                 cli.derivepassphrase_vault,

936)                 ['--config', *command_line],
937)                 catch_exceptions=False,
938)                 input=input,
939)             )

940)         result = tests.ReadableResult.parse(_result)
941)         assert result.error_exit(
942)             error=err_text
943)         ), 'expected error exit and known error message'

944) 
945)     def test_225a_store_config_fail_manual_no_ssh_key_selection(

946)         self,

947)         monkeypatch: pytest.MonkeyPatch,

948)     ) -> None:
949)         runner = click.testing.CliRunner(mix_stderr=False)

950)         with tests.isolated_vault_config(

951)             monkeypatch=monkeypatch,
952)             runner=runner,
953)             config={'global': {'phrase': 'abc'}, 'services': {}},
954)         ):

955)             custom_error = 'custom error message'

956) 

957)             def raiser() -> None:

958)                 raise RuntimeError(custom_error)

959) 

960)             monkeypatch.setattr(cli, '_select_ssh_key', raiser)

961)             _result = runner.invoke(

962)                 cli.derivepassphrase_vault,

963)                 ['--key', '--config'],
964)                 catch_exceptions=False,
965)             )

966)         result = tests.ReadableResult.parse(_result)
967)         assert result.error_exit(
968)             error=custom_error
969)         ), 'expected error exit and known error message'

970) 

971)     def test_225b_store_config_fail_manual_no_ssh_agent(
972)         self,

973)         monkeypatch: pytest.MonkeyPatch,

974)         skip_if_no_af_unix_support: None,

975)     ) -> None:

976)         del skip_if_no_af_unix_support

977)         runner = click.testing.CliRunner(mix_stderr=False)

978)         with tests.isolated_vault_config(

979)             monkeypatch=monkeypatch,
980)             runner=runner,
981)             config={'global': {'phrase': 'abc'}, 'services': {}},
982)         ):
983)             monkeypatch.delenv('SSH_AUTH_SOCK', raising=False)

984)             _result = runner.invoke(

985)                 cli.derivepassphrase_vault,

986)                 ['--key', '--config'],
987)                 catch_exceptions=False,
988)             )

989)         result = tests.ReadableResult.parse(_result)
990)         assert result.error_exit(
991)             error='Cannot find running SSH agent'
992)         ), 'expected error exit and known error message'

993) 
994)     def test_225c_store_config_fail_manual_bad_ssh_agent_connection(
995)         self,

996)         monkeypatch: pytest.MonkeyPatch,

997)     ) -> None:
998)         runner = click.testing.CliRunner(mix_stderr=False)

999)         with tests.isolated_vault_config(

1000)             monkeypatch=monkeypatch,
1001)             runner=runner,
1002)             config={'global': {'phrase': 'abc'}, 'services': {}},
1003)         ):
1004)             monkeypatch.setenv('SSH_AUTH_SOCK', os.getcwd())

1005)             _result = runner.invoke(

1006)                 cli.derivepassphrase_vault,

1007)                 ['--key', '--config'],
1008)                 catch_exceptions=False,
1009)             )

1010)         result = tests.ReadableResult.parse(_result)
1011)         assert result.error_exit(
1012)             error='Cannot connect to SSH agent'
1013)         ), 'expected error exit and known error message'

1014) 
1015)     @pytest.mark.parametrize('try_race_free_implementation', [True, False])
1016)     def test_225d_store_config_fail_manual_read_only_file(
1017)         self,

1018)         monkeypatch: pytest.MonkeyPatch,

1019)         try_race_free_implementation: bool,
1020)     ) -> None:
1021)         runner = click.testing.CliRunner(mix_stderr=False)

1022)         with tests.isolated_vault_config(

1023)             monkeypatch=monkeypatch,
1024)             runner=runner,
1025)             config={'global': {'phrase': 'abc'}, 'services': {}},
1026)         ):
1027)             tests.make_file_readonly(

1028)                 cli._config_filename(subsystem='vault'),

1029)                 try_race_free_implementation=try_race_free_implementation,
1030)             )

1031)             _result = runner.invoke(

1032)                 cli.derivepassphrase_vault,

1033)                 ['--config', '--length=15', DUMMY_SERVICE],
1034)                 catch_exceptions=False,
1035)             )

1036)         result = tests.ReadableResult.parse(_result)
1037)         assert result.error_exit(
1038)             error='Cannot store config'
1039)         ), 'expected error exit and known error message'

1040) 
1041)     def test_225e_store_config_fail_manual_custom_error(
1042)         self,

1043)         monkeypatch: pytest.MonkeyPatch,

1044)     ) -> None:
1045)         runner = click.testing.CliRunner(mix_stderr=False)

1046)         with tests.isolated_vault_config(

1047)             monkeypatch=monkeypatch,
1048)             runner=runner,
1049)             config={'global': {'phrase': 'abc'}, 'services': {}},
1050)         ):
1051)             custom_error = 'custom error message'
1052) 
1053)             def raiser(config: Any) -> None:
1054)                 del config
1055)                 raise RuntimeError(custom_error)
1056) 
1057)             monkeypatch.setattr(cli, '_save_config', raiser)

1058)             _result = runner.invoke(

1059)                 cli.derivepassphrase_vault,

1060)                 ['--config', '--length=15', DUMMY_SERVICE],
1061)                 catch_exceptions=False,
1062)             )

1063)         result = tests.ReadableResult.parse(_result)
1064)         assert result.error_exit(
1065)             error=custom_error
1066)         ), 'expected error exit and known error message'

1067) 

1068)     def test_226_no_arguments(self, monkeypatch: pytest.MonkeyPatch) -> None:

1069)         runner = click.testing.CliRunner(mix_stderr=False)

1070)         with tests.isolated_config(
1071)             monkeypatch=monkeypatch,
1072)             runner=runner,
1073)         ):

1074)             _result = runner.invoke(

1075)                 cli.derivepassphrase_vault, [], catch_exceptions=False

1076)             )

1077)         result = tests.ReadableResult.parse(_result)
1078)         assert result.error_exit(
1079)             error='SERVICE is required'
1080)         ), 'expected error exit and known error message'

1081) 

1082)     def test_226a_no_passphrase_or_key(
1083)         self, monkeypatch: pytest.MonkeyPatch
1084)     ) -> None:

1085)         runner = click.testing.CliRunner(mix_stderr=False)

1086)         with tests.isolated_config(
1087)             monkeypatch=monkeypatch,
1088)             runner=runner,
1089)         ):

1090)             _result = runner.invoke(

1091)                 cli.derivepassphrase_vault,
1092)                 [DUMMY_SERVICE],
1093)                 catch_exceptions=False,

1094)             )

1095)         result = tests.ReadableResult.parse(_result)
1096)         assert result.error_exit(
1097)             error='No passphrase or key given'
1098)         ), 'expected error exit and known error message'

1099) 

1100)     def test_230_config_directory_nonexistant(
1101)         self, monkeypatch: pytest.MonkeyPatch
1102)     ) -> None:

1103)         """https://github.com/the-13th-letter/derivepassphrase/issues/6"""

1104)         runner = click.testing.CliRunner(mix_stderr=False)
1105)         with tests.isolated_config(
1106)             monkeypatch=monkeypatch,
1107)             runner=runner,
1108)         ):

1109)             shutil.rmtree('.derivepassphrase')

1110)             os_makedirs_called = False
1111)             real_os_makedirs = os.makedirs
1112) 
1113)             def makedirs(*args: Any, **kwargs: Any) -> Any:
1114)                 nonlocal os_makedirs_called
1115)                 os_makedirs_called = True
1116)                 return real_os_makedirs(*args, **kwargs)
1117) 
1118)             monkeypatch.setattr(os, 'makedirs', makedirs)

1119)             _result = runner.invoke(

1120)                 cli.derivepassphrase_vault,

1121)                 ['--config', '-p'],
1122)                 catch_exceptions=False,
1123)                 input='abc\n',
1124)             )

1125)             result = tests.ReadableResult.parse(_result)
1126)             assert result.clean_exit(), 'expected clean exit'

1127)             assert (

1128)                 result.stderr == 'Passphrase:'

1129)             ), 'program unexpectedly failed?!'
1130)             assert os_makedirs_called, 'os.makedirs has not been called?!'

1131)             with open(
1132)                 cli._config_filename(subsystem='vault'), encoding='UTF-8'
1133)             ) as infile:

1134)                 config_readback = json.load(infile)
1135)             assert config_readback == {
1136)                 'global': {'phrase': 'abc'},
1137)                 'services': {},
1138)             }, 'config mismatch'
1139) 

1140)     def test_230a_config_directory_not_a_file(
1141)         self, monkeypatch: pytest.MonkeyPatch
1142)     ) -> None:

1143)         """https://github.com/the-13th-letter/derivepassphrase/issues/6"""

1144)         runner = click.testing.CliRunner(mix_stderr=False)
1145)         with tests.isolated_config(
1146)             monkeypatch=monkeypatch,
1147)             runner=runner,
1148)         ):
1149)             _save_config = cli._save_config
1150) 
1151)             def obstruct_config_saving(*args: Any, **kwargs: Any) -> Any:
1152)                 with contextlib.suppress(FileNotFoundError):
1153)                     shutil.rmtree('.derivepassphrase')
1154)                 with open(
1155)                     '.derivepassphrase', 'w', encoding='UTF-8'
1156)                 ) as outfile:
1157)                     print('Obstruction!!', file=outfile)
1158)                 monkeypatch.setattr(cli, '_save_config', _save_config)
1159)                 return _save_config(*args, **kwargs)
1160) 
1161)             monkeypatch.setattr(cli, '_save_config', obstruct_config_saving)

1162)             _result = runner.invoke(

1163)                 cli.derivepassphrase_vault,

1164)                 ['--config', '-p'],
1165)                 catch_exceptions=False,
1166)                 input='abc\n',
1167)             )

1168)             result = tests.ReadableResult.parse(_result)
1169)             assert result.error_exit(
1170)                 error='Cannot store config'
1171)             ), 'expected error exit and known error message'

1172) 

1173)     def test_230b_store_config_custom_error(
1174)         self, monkeypatch: pytest.MonkeyPatch
1175)     ) -> None:

1176)         runner = click.testing.CliRunner(mix_stderr=False)
1177)         with tests.isolated_config(
1178)             monkeypatch=monkeypatch,
1179)             runner=runner,
1180)         ):

1181)             custom_error = 'custom error message'

1182) 

1183)             def raiser(config: Any) -> None:
1184)                 del config
1185)                 raise RuntimeError(custom_error)

1186) 

1187)             monkeypatch.setattr(cli, '_save_config', raiser)

1188)             _result = runner.invoke(

1189)                 cli.derivepassphrase_vault,

1190)                 ['--config', '-p'],
1191)                 catch_exceptions=False,
1192)                 input='abc\n',
1193)             )

1194)             result = tests.ReadableResult.parse(_result)
1195)             assert result.error_exit(

1196)                 error=custom_error

1197)             ), 'expected error exit and known error message'

1198) 

1199)     @pytest.mark.parametrize(

1200)         ['command_line', 'input', 'warning_message'],

1201)         [
1202)             pytest.param(
1203)                 ['--import', '-'],
1204)                 json.dumps({
1205)                     'global': {'phrase': 'Du\u0308sseldorf'},
1206)                     'services': {},
1207)                 }),
1208)                 'the global passphrase is not NFC-normalized',
1209)                 id='global-NFC',
1210)             ),
1211)             pytest.param(
1212)                 ['--import', '-'],
1213)                 json.dumps({
1214)                     'services': {
1215)                         DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS.copy(),
1216)                         'weird entry name': {'phrase': 'Du\u0308sseldorf'},
1217)                     }
1218)                 }),
1219)                 (
1220)                     "the services.'weird entry name' passphrase "
1221)                     'is not NFC-normalized'
1222)                 ),
1223)                 id='service-weird-name-NFC',
1224)             ),
1225)             pytest.param(
1226)                 ['--config', '-p', DUMMY_SERVICE],
1227)                 'Du\u0308sseldorf',
1228)                 (
1229)                     f'the services.{DUMMY_SERVICE} passphrase '
1230)                     f'is not NFC-normalized'
1231)                 ),
1232)                 id='config-NFC',
1233)             ),
1234)             pytest.param(
1235)                 ['-p', DUMMY_SERVICE],
1236)                 'Du\u0308sseldorf',
1237)                 'the interactive passphrase is not NFC-normalized',
1238)                 id='direct-input-NFC',
1239)             ),
1240)             pytest.param(
1241)                 ['--import', '-'],
1242)                 json.dumps({
1243)                     'global': {
1244)                         'unicode_normalization_form': 'NFD',
1245)                         'phrase': 'D\u00fcsseldorf',
1246)                     },
1247)                     'services': {},
1248)                 }),
1249)                 'the global passphrase is not NFD-normalized',
1250)                 id='global-NFD',
1251)             ),
1252)             pytest.param(
1253)                 ['--import', '-'],
1254)                 json.dumps({
1255)                     'global': {
1256)                         'unicode_normalization_form': 'NFD',
1257)                     },
1258)                     'services': {
1259)                         DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS.copy(),
1260)                         'weird entry name': {'phrase': 'D\u00fcsseldorf'},

1261)                     },

1262)                 }),
1263)                 (
1264)                     "the services.'weird entry name' passphrase "
1265)                     'is not NFD-normalized'
1266)                 ),
1267)                 id='service-weird-name-NFD',
1268)             ),
1269)         ],
1270)     )
1271)     def test_300_unicode_normalization_form_warning(
1272)         self,

1273)         monkeypatch: pytest.MonkeyPatch,

1274)         command_line: list[str],
1275)         input: str | None,

1276)         warning_message: str,

1277)     ) -> None:
1278)         runner = click.testing.CliRunner(mix_stderr=False)

1279)         with tests.isolated_vault_config(

1280)             monkeypatch=monkeypatch,
1281)             runner=runner,
1282)             config={'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS.copy()}},
1283)         ):

1284)             _result = runner.invoke(

1285)                 cli.derivepassphrase_vault,

1286)                 command_line,
1287)                 catch_exceptions=False,
1288)                 input=input,
1289)             )

1290)         result = tests.ReadableResult.parse(_result)
1291)         assert result.clean_exit(), 'expected clean exit'
1292)         assert (
1293)             warning_message in result.stderr
1294)         ), 'expected known warning message in stderr'

1295) 

1296)     def test_400_missing_af_unix_support(
1297)         self,
1298)         monkeypatch: pytest.MonkeyPatch,
1299)     ) -> None:
1300)         runner = click.testing.CliRunner(mix_stderr=False)
1301)         with tests.isolated_vault_config(
1302)             monkeypatch=monkeypatch,
1303)             runner=runner,
1304)             config={'global': {'phrase': 'abc'}, 'services': {}},
1305)         ):
1306)             monkeypatch.setenv(
1307)                 'SSH_AUTH_SOCK', "the value doesn't even matter"
1308)             )
1309)             monkeypatch.delattr(socket, 'AF_UNIX', raising=False)
1310)             _result = runner.invoke(
1311)                 cli.derivepassphrase_vault,
1312)                 ['--key', '--config'],
1313)                 catch_exceptions=False,
1314)             )
1315)         result = tests.ReadableResult.parse(_result)
1316)         assert result.error_exit(
1317)             error='does not support UNIX domain sockets'
1318)         ), 'expected error exit and known error message'
1319) 

1320) 

1321) class TestCLIUtils:

1322)     @pytest.mark.parametrize(
1323)         'config',
1324)         [
1325)             {'global': {'phrase': 'my passphrase'}, 'services': {}},
1326)             {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},
1327)             {
1328)                 'global': {'phrase': 'abc'},
1329)                 'services': {'sv': {'phrase': 'my passphrase'}},
1330)             },
1331)             {
1332)                 'global': {'phrase': 'abc'},
1333)                 'services': {'sv': {'key': DUMMY_KEY1_B64}},
1334)             },
1335)             {
1336)                 'global': {'phrase': 'abc'},
1337)                 'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},
1338)             },
1339)         ],
1340)     )
1341)     def test_100_load_config(
1342)         self, monkeypatch: pytest.MonkeyPatch, config: Any
1343)     ) -> None:
1344)         runner = click.testing.CliRunner()
1345)         with tests.isolated_vault_config(
1346)             monkeypatch=monkeypatch, runner=runner, config=config
1347)         ):
1348)             config_filename = cli._config_filename(subsystem='vault')
1349)             with open(config_filename, encoding='UTF-8') as fileobj:
1350)                 assert json.load(fileobj) == config
1351)             assert cli._load_config() == config
1352) 
1353)     def test_110_save_bad_config(

1354)         self, monkeypatch: pytest.MonkeyPatch
1355)     ) -> None:

1356)         runner = click.testing.CliRunner()

1357)         with (

1358)             tests.isolated_vault_config(

1359)                 monkeypatch=monkeypatch, runner=runner, config={}
1360)             ),
1361)             pytest.raises(ValueError, match='Invalid vault config'),

1362)         ):

1363)             cli._save_config(None)  # type: ignore[arg-type]

1364) 

1365)     def test_111_prompt_for_selection_multiple(self) -> None:

1366)         @click.command()
1367)         @click.option('--heading', default='Our menu:')
1368)         @click.argument('items', nargs=-1)

1369)         def driver(heading: str, items: list[str]) -> None:

1370)             # from https://montypython.fandom.com/wiki/Spam#The_menu
1371)             items = items or [
1372)                 'Egg and bacon',
1373)                 'Egg, sausage and bacon',
1374)                 'Egg and spam',
1375)                 'Egg, bacon and spam',
1376)                 'Egg, bacon, sausage and spam',
1377)                 'Spam, bacon, sausage and spam',
1378)                 'Spam, egg, spam, spam, bacon and spam',
1379)                 'Spam, spam, spam, egg and spam',

1380)                 (
1381)                     'Spam, spam, spam, spam, spam, spam, baked beans, '
1382)                     'spam, spam, spam and spam'
1383)                 ),
1384)                 (
1385)                     'Lobster thermidor aux crevettes with a mornay sauce '
1386)                     'garnished with truffle paté, brandy '
1387)                     'and a fried egg on top and spam'
1388)                 ),

1389)             ]
1390)             index = cli._prompt_for_selection(items, heading=heading)
1391)             click.echo('A fine choice: ', nl=False)
1392)             click.echo(items[index])
1393)             click.echo('(Note: Vikings strictly optional.)')

1394) 

1395)         runner = click.testing.CliRunner(mix_stderr=True)

1396)         _result = runner.invoke(driver, [], input='9')
1397)         result = tests.ReadableResult.parse(_result)
1398)         assert result.clean_exit(
1399)             output="""\

1400) Our menu:
1401) [1] Egg and bacon
1402) [2] Egg, sausage and bacon
1403) [3] Egg and spam
1404) [4] Egg, bacon and spam
1405) [5] Egg, bacon, sausage and spam
1406) [6] Spam, bacon, sausage and spam
1407) [7] Spam, egg, spam, spam, bacon and spam
1408) [8] Spam, spam, spam, egg and spam
1409) [9] Spam, spam, spam, spam, spam, spam, baked beans, spam, spam, spam and spam
1410) [10] Lobster thermidor aux crevettes with a mornay sauce garnished with truffle paté, brandy and a fried egg on top and spam
1411) Your selection? (1-10, leave empty to abort): 9
1412) A fine choice: Spam, spam, spam, spam, spam, spam, baked beans, spam, spam, spam and spam
1413) (Note: Vikings strictly optional.)

1414) """  # noqa: E501

1415)         ), 'expected clean exit'
1416)         _result = runner.invoke(

1417)             driver, ['--heading='], input='', catch_exceptions=True
1418)         )

1419)         result = tests.ReadableResult.parse(_result)
1420)         assert result.error_exit(
1421)             error=IndexError
1422)         ), 'expected error exit and known error type'

1423)         assert (

1424)             result.output

1425)             == """\

1426) [1] Egg and bacon
1427) [2] Egg, sausage and bacon
1428) [3] Egg and spam
1429) [4] Egg, bacon and spam
1430) [5] Egg, bacon, sausage and spam
1431) [6] Spam, bacon, sausage and spam
1432) [7] Spam, egg, spam, spam, bacon and spam
1433) [8] Spam, spam, spam, egg and spam
1434) [9] Spam, spam, spam, spam, spam, spam, baked beans, spam, spam, spam and spam
1435) [10] Lobster thermidor aux crevettes with a mornay sauce garnished with truffle paté, brandy and a fried egg on top and spam

1436) Your selection? (1-10, leave empty to abort):\x20
1437) """  # noqa: E501

1438)         ), 'expected known output'

1439) 

1440)     def test_112_prompt_for_selection_single(self) -> None:

1441)         @click.command()
1442)         @click.option('--item', default='baked beans')
1443)         @click.argument('prompt')

1444)         def driver(item: str, prompt: str) -> None:

1445)             try:

1446)                 cli._prompt_for_selection(
1447)                     [item], heading='', single_choice_prompt=prompt
1448)                 )

1449)             except IndexError:

1450)                 click.echo('Boo.')

1451)                 raise

1452)             else:
1453)                 click.echo('Great!')

1454) 

1455)         runner = click.testing.CliRunner(mix_stderr=True)

1456)         _result = runner.invoke(

1457)             driver, ['Will replace with spam. Confirm, y/n?'], input='y'
1458)         )

1459)         result = tests.ReadableResult.parse(_result)
1460)         assert result.clean_exit(
1461)             output="""\

1462) [1] baked beans
1463) Will replace with spam. Confirm, y/n? y
1464) Great!

1465) """

1466)         ), 'expected clean exit'
1467)         _result = runner.invoke(

1468)             driver,
1469)             ['Will replace with spam, okay? ' '(Please say "y" or "n".)'],
1470)             input='',
1471)         )

1472)         result = tests.ReadableResult.parse(_result)
1473)         assert result.error_exit(
1474)             error=IndexError
1475)         ), 'expected error exit and known error type'

1476)         assert (

1477)             result.output

1478)             == """\

1479) [1] baked beans

1480) Will replace with spam, okay? (Please say "y" or "n".):\x20

1481) Boo.

1482) """

1483)         ), 'expected known output'

1484) 

1485)     def test_113_prompt_for_passphrase(

1486)         self, monkeypatch: pytest.MonkeyPatch
1487)     ) -> None:

1488)         monkeypatch.setattr(
1489)             click,
1490)             'prompt',
1491)             lambda *a, **kw: json.dumps({'args': a, 'kwargs': kw}),
1492)         )

1493)         res = json.loads(cli._prompt_for_passphrase())

1494)         err_msg = 'missing arguments to passphrase prompt'
1495)         assert 'args' in res, err_msg
1496)         assert 'kwargs' in res, err_msg
1497)         assert res['args'][:1] == ['Passphrase'], err_msg
1498)         assert res['kwargs'].get('default') == '', err_msg
1499)         assert not res['kwargs'].get('show_default', True), err_msg
1500)         assert res['kwargs'].get('err'), err_msg
1501)         assert res['kwargs'].get('hide_input'), err_msg

1502) 

1503)     @pytest.mark.parametrize(
1504)         ['command_line', 'config', 'result_config'],
1505)         [
1506)             (
1507)                 ['--delete-globals'],
1508)                 {'global': {'phrase': 'abc'}, 'services': {}},
1509)                 {'services': {}},
1510)             ),
1511)             (
1512)                 ['--delete', DUMMY_SERVICE],
1513)                 {
1514)                     'global': {'phrase': 'abc'},
1515)                     'services': {DUMMY_SERVICE: {'notes': '...'}},
1516)                 },
1517)                 {'global': {'phrase': 'abc'}, 'services': {}},
1518)             ),
1519)             (
1520)                 ['--clear'],
1521)                 {
1522)                     'global': {'phrase': 'abc'},
1523)                     'services': {DUMMY_SERVICE: {'notes': '...'}},
1524)                 },
1525)                 {'services': {}},
1526)             ),
1527)         ],
1528)     )

1529)     def test_203_repeated_config_deletion(

1530)         self,

1531)         monkeypatch: pytest.MonkeyPatch,

1532)         command_line: list[str],

1533)         config: _types.VaultConfig,
1534)         result_config: _types.VaultConfig,

1535)     ) -> None:
1536)         runner = click.testing.CliRunner(mix_stderr=False)
1537)         for start_config in [config, result_config]:

1538)             with tests.isolated_vault_config(

1539)                 monkeypatch=monkeypatch, runner=runner, config=start_config
1540)             ):

1541)                 _result = runner.invoke(

1542)                     cli.derivepassphrase_vault,
1543)                     command_line,
1544)                     catch_exceptions=False,

1545)                 )

1546)                 result = tests.ReadableResult.parse(_result)
1547)                 assert result.clean_exit(
1548)                     empty_stderr=True
1549)                 ), 'expected clean exit'

1550)                 with open(
1551)                     cli._config_filename(subsystem='vault'), encoding='UTF-8'
1552)                 ) as infile:

1553)                     config_readback = json.load(infile)
1554)                 assert config_readback == result_config
1555) 
1556)     def test_204_phrase_from_key_manually(self) -> None:
1557)         assert (

1558)             vault.Vault(

1559)                 phrase=DUMMY_PHRASE_FROM_KEY1, **DUMMY_CONFIG_SETTINGS
1560)             ).generate(DUMMY_SERVICE)
1561)             == DUMMY_RESULT_KEY1

1562)         )
1563) 

1564)     @pytest.mark.parametrize(
1565)         ['vfunc', 'input'],
1566)         [
1567)             (cli._validate_occurrence_constraint, 20),
1568)             (cli._validate_length, 20),
1569)         ],
1570)     )

1571)     def test_210a_validate_constraints_manually(
1572)         self,
1573)         vfunc: Callable[[click.Context, click.Parameter, Any], int | None],
1574)         input: int,
1575)     ) -> None:

1576)         ctx = cli.derivepassphrase_vault.make_context(cli.PROG_NAME, [])
1577)         param = cli.derivepassphrase_vault.params[0]

1578)         assert vfunc(ctx, param, input) == input
1579) 

1580)     @pytest.mark.parametrize('conn_hint', ['none', 'socket', 'client'])

1581)     def test_227_get_suitable_ssh_keys(

1582)         self,

1583)         monkeypatch: pytest.MonkeyPatch,

1584)         running_ssh_agent: str,

1585)         conn_hint: str,

1586)     ) -> None:

1587)         with monkeypatch.context():
1588)             monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)
1589)             monkeypatch.setattr(
1590)                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys
1591)             )
1592)             hint: ssh_agent.SSHAgentClient | socket.socket | None

1593)             # Use match/case here once Python 3.9 becomes unsupported.
1594)             if conn_hint == 'client':
1595)                 hint = ssh_agent.SSHAgentClient()
1596)             elif conn_hint == 'socket':
1597)                 hint = socket.socket(family=socket.AF_UNIX)
1598)                 hint.connect(running_ssh_agent)
1599)             else:
1600)                 assert conn_hint == 'none'
1601)                 hint = None

1602)             exception: Exception | None = None
1603)             try:
1604)                 list(cli._get_suitable_ssh_keys(hint))
1605)             except RuntimeError:  # pragma: no cover
1606)                 pass
1607)             except Exception as e:  # noqa: BLE001 # pragma: no cover
1608)                 exception = e
1609)             finally:
1610)                 assert (
1611)                     exception is None
1612)                 ), 'exception querying suitable SSH keys'

1613) 
1614) 
1615) class TestCLITransition:
1616)     def test_100_help_output(self, monkeypatch: pytest.MonkeyPatch) -> None:
1617)         runner = click.testing.CliRunner(mix_stderr=False)
1618)         with tests.isolated_config(
1619)             monkeypatch=monkeypatch,
1620)             runner=runner,
1621)         ):
1622)             _result = runner.invoke(
1623)                 cli.derivepassphrase, ['--help'], catch_exceptions=False
1624)             )
1625)             result = tests.ReadableResult.parse(_result)
1626)         assert result.clean_exit(
1627)             empty_stderr=True, output='currently implemented subcommands'
1628)         ), 'expected clean exit, and known help text'
1629) 
1630)     def test_101_help_output_export(
1631)         self, monkeypatch: pytest.MonkeyPatch
1632)     ) -> None:
1633)         runner = click.testing.CliRunner(mix_stderr=False)
1634)         with tests.isolated_config(
1635)             monkeypatch=monkeypatch,
1636)             runner=runner,
1637)         ):
1638)             _result = runner.invoke(
1639)                 cli.derivepassphrase,
1640)                 ['export', '--help'],
1641)                 catch_exceptions=False,
1642)             )
1643)             result = tests.ReadableResult.parse(_result)
1644)         assert result.clean_exit(
1645)             empty_stderr=True, output='only available subcommand'
1646)         ), 'expected clean exit, and known help text'
1647) 
1648)     def test_102_help_output_export_vault(
1649)         self, monkeypatch: pytest.MonkeyPatch
1650)     ) -> None:
1651)         runner = click.testing.CliRunner(mix_stderr=False)
1652)         with tests.isolated_config(
1653)             monkeypatch=monkeypatch,
1654)             runner=runner,
1655)         ):
1656)             _result = runner.invoke(
1657)                 cli.derivepassphrase,
1658)                 ['export', 'vault', '--help'],
1659)                 catch_exceptions=False,
1660)             )
1661)             result = tests.ReadableResult.parse(_result)
1662)         assert result.clean_exit(
1663)             empty_stderr=True, output='Read the vault-native configuration'
1664)         ), 'expected clean exit, and known help text'
1665) 
1666)     def test_103_help_output_vault(
1667)         self, monkeypatch: pytest.MonkeyPatch
1668)     ) -> None:
1669)         runner = click.testing.CliRunner(mix_stderr=False)
1670)         with tests.isolated_config(
1671)             monkeypatch=monkeypatch,
1672)             runner=runner,
1673)         ):
1674)             _result = runner.invoke(
1675)                 cli.derivepassphrase,
1676)                 ['vault', '--help'],
1677)                 catch_exceptions=False,
1678)             )
1679)             result = tests.ReadableResult.parse(_result)
1680)         assert result.clean_exit(
1681)             empty_stderr=True, output='Password generation:\n'
1682)         ), 'expected clean exit, and option groups in help text'
1683)         assert result.clean_exit(
1684)             empty_stderr=True, output='Use NUMBER=0, e.g. "--symbol 0"'
1685)         ), 'expected clean exit, and option group epilog in help text'
1686) 

1687)     @pytest.mark.parametrize(
1688)         'config',
1689)         [
1690)             {'global': {'phrase': 'my passphrase'}, 'services': {}},
1691)             {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},
1692)             {
1693)                 'global': {'phrase': 'abc'},
1694)                 'services': {'sv': {'phrase': 'my passphrase'}},
1695)             },
1696)             {
1697)                 'global': {'phrase': 'abc'},
1698)                 'services': {'sv': {'key': DUMMY_KEY1_B64}},
1699)             },
1700)             {
1701)                 'global': {'phrase': 'abc'},
1702)                 'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},
1703)             },
1704)         ],
1705)     )
1706)     def test_110_load_config_backup(
1707)         self, monkeypatch: pytest.MonkeyPatch, config: Any
1708)     ) -> None:
1709)         runner = click.testing.CliRunner()
1710)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):
1711)             config_filename = cli._config_filename()
1712)             with open(config_filename, 'w', encoding='UTF-8') as fileobj:
1713)                 print(json.dumps(config, indent=2), file=fileobj)
1714)             assert cli._migrate_and_load_old_config()[0] == config
1715) 
1716)     @pytest.mark.parametrize(
1717)         'config',
1718)         [
1719)             {'global': {'phrase': 'my passphrase'}, 'services': {}},
1720)             {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},
1721)             {
1722)                 'global': {'phrase': 'abc'},
1723)                 'services': {'sv': {'phrase': 'my passphrase'}},
1724)             },
1725)             {
1726)                 'global': {'phrase': 'abc'},
1727)                 'services': {'sv': {'key': DUMMY_KEY1_B64}},
1728)             },
1729)             {
1730)                 'global': {'phrase': 'abc'},
1731)                 'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},
1732)             },
1733)         ],
1734)     )
1735)     def test_111_migrate_config(
1736)         self, monkeypatch: pytest.MonkeyPatch, config: Any
1737)     ) -> None:
1738)         runner = click.testing.CliRunner()
1739)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):
1740)             config_filename = cli._config_filename()
1741)             with open(config_filename, 'w', encoding='UTF-8') as fileobj:
1742)                 print(json.dumps(config, indent=2), file=fileobj)
1743)             assert cli._migrate_and_load_old_config() == (config, None)
1744) 
1745)     @pytest.mark.parametrize(
1746)         'config',
1747)         [
1748)             {'global': {'phrase': 'my passphrase'}, 'services': {}},
1749)             {'global': {'key': DUMMY_KEY1_B64}, 'services': {}},
1750)             {
1751)                 'global': {'phrase': 'abc'},
1752)                 'services': {'sv': {'phrase': 'my passphrase'}},
1753)             },
1754)             {
1755)                 'global': {'phrase': 'abc'},
1756)                 'services': {'sv': {'key': DUMMY_KEY1_B64}},
1757)             },
1758)             {
1759)                 'global': {'phrase': 'abc'},
1760)                 'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},
1761)             },
1762)         ],
1763)     )
1764)     def test_112_migrate_config_error(
1765)         self, monkeypatch: pytest.MonkeyPatch, config: Any
1766)     ) -> None:
1767)         runner = click.testing.CliRunner()
1768)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):
1769)             config_filename = cli._config_filename()
1770)             with open(config_filename, 'w', encoding='UTF-8') as fileobj:
1771)                 print(json.dumps(config, indent=2), file=fileobj)
1772)             os.mkdir(cli._config_filename(subsystem='vault'))
1773)             config2, err = cli._migrate_and_load_old_config()
1774)             assert config2 == config
1775)             assert isinstance(err, OSError)
1776)             assert err.errno == errno.EISDIR
1777) 
1778)     @pytest.mark.parametrize(
1779)         'config',
1780)         [
1781)             {'global': '', 'services': {}},
1782)             {'global': 0, 'services': {}},
1783)             {
1784)                 'global': {'phrase': 'abc'},
1785)                 'services': False,
1786)             },
1787)             {
1788)                 'global': {'phrase': 'abc'},
1789)                 'services': True,
1790)             },
1791)             {
1792)                 'global': {'phrase': 'abc'},
1793)                 'services': None,
1794)             },
1795)         ],
1796)     )
1797)     def test_113_migrate_config_error_bad_config_value(
1798)         self, monkeypatch: pytest.MonkeyPatch, config: Any
1799)     ) -> None:
1800)         runner = click.testing.CliRunner()
1801)         with tests.isolated_config(monkeypatch=monkeypatch, runner=runner):
1802)             config_filename = cli._config_filename()
1803)             with open(config_filename, 'w', encoding='UTF-8') as fileobj:
1804)                 print(json.dumps(config, indent=2), file=fileobj)
1805)             with pytest.raises(ValueError, match=cli._INVALID_VAULT_CONFIG):
1806)                 cli._migrate_and_load_old_config()
1807) 

1808)     def test_200_forward_export_vault_path_parameter(
1809)         self, monkeypatch: pytest.MonkeyPatch
1810)     ) -> None:
1811)         pytest.importorskip('cryptography', minversion='38.0')
1812)         runner = click.testing.CliRunner(mix_stderr=False)
1813)         with tests.isolated_vault_exporter_config(
1814)             monkeypatch=monkeypatch,
1815)             runner=runner,
1816)             vault_config=tests.VAULT_V03_CONFIG,
1817)             vault_key=tests.VAULT_MASTER_KEY,
1818)         ):
1819)             monkeypatch.setenv('VAULT_KEY', tests.VAULT_MASTER_KEY)
1820)             _result = runner.invoke(
1821)                 cli.derivepassphrase,
1822)                 ['export', 'VAULT_PATH'],
1823)             )
1824)         result = tests.ReadableResult.parse(_result)
1825)         assert result.clean_exit(empty_stderr=False), 'expected clean exit'

1826)         assert (
1827)             result.stderr
1828)             == f"""\

1829) {cli.PROG_NAME}: Deprecation warning: A subcommand will be required in v1.0. See --help for available subcommands.
1830) {cli.PROG_NAME}: Warning: Defaulting to subcommand "vault".
1831) """  # noqa: E501

1832)         )

1833)         assert json.loads(result.output) == tests.VAULT_V03_CONFIG_DATA
1834) 
1835)     @pytest.mark.parametrize(
1836)         'charset_name', ['lower', 'upper', 'number', 'space', 'dash', 'symbol']
1837)     )
1838)     def test_210_forward_vault_disable_character_set(
1839)         self, monkeypatch: pytest.MonkeyPatch, charset_name: str
1840)     ) -> None:
1841)         monkeypatch.setattr(cli, '_prompt_for_passphrase', tests.auto_prompt)
1842)         option = f'--{charset_name}'

1843)         charset = vault.Vault._CHARSETS[charset_name].decode('ascii')

1844)         runner = click.testing.CliRunner(mix_stderr=False)
1845)         with tests.isolated_config(
1846)             monkeypatch=monkeypatch,
1847)             runner=runner,
1848)         ):
1849)             _result = runner.invoke(
1850)                 cli.derivepassphrase,
1851)                 [option, '0', '-p', DUMMY_SERVICE],
1852)                 input=DUMMY_PASSPHRASE,
1853)                 catch_exceptions=False,
1854)             )
1855)             result = tests.ReadableResult.parse(_result)
1856)         assert result.clean_exit(empty_stderr=False), 'expected clean exit'

1857)         assert (
1858)             result.stderr
1859)             == f"""\

1860) {cli.PROG_NAME}: Deprecation warning: A subcommand will be required in v1.0. See --help for available subcommands.
1861) {cli.PROG_NAME}: Warning: Defaulting to subcommand "vault".
1862) """  # noqa: E501

1863)         )

1864)         for c in charset:
1865)             assert (
1866)                 c not in result.output
1867)             ), f'derived password contains forbidden character {c!r}'