@@ -398,13 +398,13 @@ Common resources that a test might need,
398
398
like e.g. a running MSColab server or a QApplication instance for GUI tests,
399
399
are collected in :mod: `tests.fixtures ` in the form of pytest fixtures that can be requested as needed in tests.
400
400
401
- Testing Keyring Features
402
- =========================
401
+ Keyring Features
402
+ -----------------
403
403
404
- This document outlines step-by-step instructions for testing keyring features using the command line.
404
+ This document outlines step-by-step instructions for using the keyring features using the command line.
405
405
406
406
Prerequisites
407
- -------------
407
+ ..............
408
408
409
409
1. **Confirm the Default Keyring Backend **
410
410
@@ -415,23 +415,29 @@ Prerequisites
415
415
keyring --list-backends
416
416
417
417
Command-Line Commands for Keyring
418
- -----------------------------------
418
+ ..................................
419
419
420
420
1. **Set a Password **
421
421
422
422
Store a password for a specific service and user:
423
-
423
+
424
424
.. code-block :: bash
425
425
426
426
keyring set SERVICE_NAME USERNAME
427
427
428
428
**Example: **
429
429
430
+ - Case 1: Standard Service Name
430
431
.. code-block :: bash
431
432
432
- keyring set MSCOLAB_AUTH_{url} [email protected]
433
+ keyring set http://localhost:8083 myname@mydomain
433
434
434
- - The command will securely prompt you to input a password (e.g., `example_password `).
435
+ - Case 2: Custom Authentication Service
436
+ .. code-block :: bash
437
+
438
+ keyring set MSCOLAB_AUTH_http://localhost:8083 mscolab
439
+
440
+ - The command will securely prompt you to input a password (e.g., `example_password `).
435
441
436
442
2. **Get a Password **
437
443
@@ -443,9 +449,15 @@ Command-Line Commands for Keyring
443
449
444
450
**Example: **
445
451
452
+ - Case 1: Standard Service Name
453
+ .. code-block :: bash
454
+
455
+ keyring get http://localhost:8083 myname@mydomain
456
+
457
+ - Case 2: Custom Authentication Service
446
458
.. code-block :: bash
447
459
448
- keyring get MSCOLAB_AUTH_{url} [email protected]
460
+ keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
449
461
450
462
**Output: **
451
463
@@ -463,16 +475,22 @@ Command-Line Commands for Keyring
463
475
464
476
**Example: **
465
477
478
+ - Case 1: Standard Service Name
466
479
.. code-block :: bash
467
480
468
- keyring delete MSCOLAB_AUTH_{url} [email protected]
481
+ keyring delete http://localhost:8083 myname@mydomain
482
+
483
+ - Case 2: Custom Authentication Service
484
+ .. code-block :: bash
485
+
486
+ keyring delete MSCOLAB_AUTH_http://localhost:8083 mscolab
469
487
470
488
To confirm the deletion, attempt to retrieve the password:
471
489
472
490
.. code-block :: bash
473
491
474
- keyring get MSCOLAB_AUTH_{url} [email protected]
475
-
492
+ keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
493
+
476
494
477
495
Changing the database model
478
496
---------------------------
0 commit comments