Merge pull request #993 from mulkieran/version-3.5.2

Version 3.5.3

Author: mulkieran

CHANGES.txt

@@ -1,10 +1,33 @@
+stratis-cli 3.5.3
+=================
+Required stratisd version: 3.5.0
+
+Recommended development environment: Fedora 38
+Lowest supported Python interpreter: 3.9.16
+
+- Cherry-picked commits:
+  * Allow for error string if encryption info inconsistent
+  * Mock getpass for better coverage
+  * Use unittest.mock for monkey patching tests
+
+- Tidies and Maintenance:
+  * Add list of cherry-picked commits to changelog for version 3.5.2
+
+
 stratis-cli 3.5.2
 =================
 Required stratisd version: 3.5.0
 
 Recommended development environment: Fedora 38
 Lowest supported Python interpreter: 3.9.16
 
+- Cherry-picked commits:
+  * Add man page field for blockdev UUID
+  * Advance current development environment to Fedora 38
+  * Use SPDX license format
+  * Add legacy package testing
+  * Use setup configuration file
+
 - Set up patch branch:
   https://github.com/stratis-storage/stratis-cli/pull/985
 

Makefile

@@ -61,25 +61,14 @@ coverage-no-html:
 	python3 -m coverage --version
 	python3 -m coverage run --timid --branch -m unittest discover --quiet --top-level-directory ./tests/whitebox --start-directory ./tests/whitebox/integration >& /dev/null
 	python3 -m coverage run --timid --branch -a -m unittest discover --quiet --start-directory ./tests/whitebox/unittest
-	python3 -m coverage run --timid --branch -a -m unittest --quiet tests.whitebox.monkey_patching.test_keyboard_interrupt.KeyboardInterruptTestCase
-	python3 -m coverage run --timid --branch -a -m unittest --quiet tests.whitebox.monkey_patching.test_stratisd_version.StratisdVersionTestCase
 	python3 -m coverage report -m --fail-under=100 --show-missing --include="./src/*"
 
 .PHONY: coverage
 coverage: coverage-no-html
 	python3 -m coverage html --include="./src/*"
 
-keyboard-interrupt-test:
-	python3 -m unittest ${UNITTEST_OPTS} tests.whitebox.monkey_patching.test_keyboard_interrupt.KeyboardInterruptTestCase
-
-stratisd-version-test:
-	python3 -m unittest ${UNITTEST_OPTS} tests.whitebox.monkey_patching.test_stratisd_version.StratisdVersionTestCase
-
-.PHONY: sim-tests
-sim-tests: dbus-tests keyboard-interrupt-test stratisd-version-test
-
 .PHONY: all-tests
-all-tests: unittest-tests sim-tests
+all-tests: unittest-tests dbus-tests
 
 .PHONY: yamllint
 yamllint:

src/stratis_cli/_actions/_list_pool.py

@@ -67,11 +67,13 @@ def _non_existent_or_inconsistent_to_str(
     :returns: a string to print
     :rtype: str
     """
-    (consistent, (exists, value)) = value
+    (consistent, tuple_or_err_str) = value
 
     if not consistent:  # pragma: no cover
         return inconsistent_str
 
+    (exists, value) = tuple_or_err_str
+
     if not exists:
         return non_existent_str
 

src/stratis_cli/_actions/_top.py

@@ -70,7 +70,7 @@ def _add_update_key(proxy, key_desc, capture_key, *, keyfile_path):
     # pylint: disable=import-outside-toplevel
     from ._data import Manager
 
-    if capture_key:  # pragma: no cover
+    if capture_key:
         password = getpass(prompt="Enter key data followed by the return key: ")
 
         (read, write) = os.pipe()
@@ -91,7 +91,7 @@ def _add_update_key(proxy, key_desc, capture_key, *, keyfile_path):
         {"key_desc": key_desc, "key_fd": file_desc},
     )
 
-    if fd_is_pipe:  # pragma: no cover
+    if fd_is_pipe:
         os.close(write)
     else:
         os.close(file_desc)

src/stratis_cli/_version.py

@@ -17,5 +17,5 @@
     .. moduleauthor::  mulhern  <amulhern@redhat.com>
 """
 
-__version_info__ = (3, 5, 2)
+__version_info__ = (3, 5, 3)
 __version__ = ".".join(str(x) for x in __version_info__)

tests/whitebox/integration/key/test_set.py

@@ -15,8 +15,12 @@
 Test 'set'.
 """
 
+# isort: STDLIB
+from unittest.mock import patch
+
 # isort: LOCAL
 from stratis_cli import StratisCliErrorCodes
+from stratis_cli._actions import _top
 from stratis_cli._errors import (
     StratisCliEngineError,
     StratisCliKeyfileNotFoundError,
@@ -69,3 +73,11 @@ def test_set_key_filename_missing(self):
         """
         command_line = self._MENU + [self._KEYNAME, "--keyfile-path", "/bogus"]
         self.check_error(StratisCliKeyfileNotFoundError, command_line, _ERROR)
+
+    def test_set_key_capture_key(self):
+        """
+        Test specifying a key via the --capture-key option.
+        """
+        command_line = self._MENU + [self._KEYNAME, "--capture-key"]
+        with patch.object(_top, "getpass", return_value="totally_secret"):
+            TEST_RUNNER(command_line)

tests/whitebox/integration/test_stratis.py

@@ -15,11 +15,15 @@
 Test 'stratisd'.
 """
 
+# isort: STDLIB
+from unittest.mock import patch
+
 # isort: THIRDPARTY
 import dbus
 
 # isort: LOCAL
-from stratis_cli import StratisCliErrorCodes
+from stratis_cli import StratisCliErrorCodes, run
+from stratis_cli._errors import StratisCliStratisdVersionError
 
 from ._misc import RUNNER, TEST_RUNNER, RunTestCase, SimTestCase
 
@@ -60,3 +64,55 @@ def test_not_propagate(self):
         command_line = ["daemon", "version"]
         with self.assertRaises(SystemExit):
             RUNNER(command_line)
+
+
+class StratisdVersionTestCase(SimTestCase):
+    """
+    Test behavior of stratis on incompatible versions of stratisd.
+    """
+
+    def test_outdated_stratisd_version(self):
+        """
+        Verify that an outdated version of stratisd will produce a
+        StratisCliStratisdVersionError.
+        """
+        # pylint: disable=import-outside-toplevel
+        # isort: LOCAL
+        from stratis_cli._actions import _data
+
+        command_line = ["--propagate", "daemon", "version"]
+
+        # pylint: disable=protected-access
+        with patch.object(
+            _data.Manager0.Properties.Version,
+            "Get",
+            return_value="1.0.0",
+        ):
+            self.check_error(StratisCliStratisdVersionError, command_line, _ERROR)
+
+
+class KeyboardInterruptTestCase(SimTestCase):
+    """
+    Test behavior of stratis on KeyboardInterrupt.
+    """
+
+    def test_catch_keyboard_exception(self):
+        """
+        Verify that the KeyboardInterrupt is propagated by the run() method.
+        ./bin/stratis contains a try block at the outermost level which
+        then catches the KeyboardInterrupt and exits with an error message.
+        The KeyboardInterrupt is most likely raised in the dbus-python
+        method which is actually communicating on the D-Bus, but it is
+        fairly difficult to get at that method. Instead settle for getting
+        at the calling method generated by dbus-python-client-gen.
+        """
+
+        # pylint: disable=import-outside-toplevel
+        # isort: LOCAL
+        from stratis_cli._actions import _data
+
+        with patch.object(
+            _data.Manager0.Properties.Version, "Get", side_effect=KeyboardInterrupt()
+        ):
+            with self.assertRaises(KeyboardInterrupt):
+                run()(["daemon", "version"])