Merge pull request #627 from mulkieran/develop-2.1.0-2.1.1

Develop 2.1.0 2.1.1

Author: mulkieran

.travis.yml

@@ -10,33 +10,33 @@ addons:
 branches:
   only:
     - master
-    - develop-2.0.1
+    - develop-2.1.0
 
 jobs:
   include:
 
     # MANDATORY CHECKS USING CURRENT DEVELOPMENT INTERPRETER
-    - name: "run pylint using Python 3.7.6"
-      python: "3.7.6"
+    - name: "run pylint using Python 3.7.7"
+      python: "3.7.7"
       install:
         - >
           pip
           install
-          pylint==2.3.1
+          pylint==2.4.4
           dbus-client-gen==0.4
           dbus-python-client-gen==0.7
           justbytes==0.11
           python-dateutil==2.8.0
-          wcwidth==0.1.7
-          psutil==5.4.3
+          wcwidth==0.1.9
+          psutil==5.6.7
           semantic_version==2.6.0
       script: PYTHONPATH=./src make -f Makefile lint
-    - name: "check formatting using Python 3.7.6"
-      python: "3.7.6"
-      install: pip install black==19.3b0 isort==4.3.4
+    - name: "check formatting using Python 3.7.7"
+      python: "3.7.7"
+      install: pip install black==19.10b0 isort==4.3.21
       env: TASK=fmt-travis
-    - name: "run tests that do not require stratisd using Python 3.7.6"
-      python: "3.7.6"
+    - name: "run tests that do not require stratisd using Python 3.7.7"
+      python: "3.7.7"
       install:
         - >
           pip
@@ -45,32 +45,31 @@ jobs:
           dbus-python-client-gen==0.7
           justbytes==0.11
           python-dateutil==2.8.0
-          wcwidth==0.1.7
-          psutil==5.4.3
+          wcwidth==0.1.9
+          psutil==5.6.7
           semantic_version==2.6.0
       script: PYTHONPATH=./src make -f Makefile test-travis
 
     # MANDATORY CHECKS USING LOWEST SUPPORTED INTERPRETER
-    - name: "run pylint using Python 3.6.8"
+    - name: "run pylint using Python 3.6.8, omit optional wcwidth dependency"
       python: "3.6.8"
       install:
         - >
           pip
           install
-          pylint==2.3.1
+          pylint==2.4.4
           dbus-client-gen==0.4
           dbus-python-client-gen==0.7
           justbytes==0.11
-          python-dateutil
-          wcwidth
-          psutil
+          python-dateutil==2.6.1
+          psutil==5.4.3
           semantic_version==2.6.0
       script: PYTHONPATH=./src make -f Makefile lint
 
     # VERIFICATION OF TEST INFRASTRUCTURE
-    - name: "run yamllint on .travis.yml"
-      python: "3.7.6"
-      install: pip install yamllint
-      script: yamllint .travis.yml
+    - name: "run yamllint 1.23.0 on .travis.yml"
+      python: "3.7.7"
+      install: pip install yamllint==1.23.0
+      env: TASK=yamllint
 
 script: make -f Makefile $TASK

CHANGES.txt

@@ -1,3 +1,35 @@
+stratis-cli 2.1.1
+=================
+Recommended Python interpreter: 3.7.7
+Lowest supported Python interpreter: 3.6.8
+Python linter: pylint (2.4.4)
+Python auto-formatter: black (19.10b0)
+Python import sorter: isort (4.3.21)
+YAML linter: yamllint (1.23.0)
+
+- Do not terminate pool unlocking on failure to unlock one pool in a list:
+  https://github.com/stratis-storage/stratis-cli/issues/618
+  https://github.com/stratis-storage/stratis-cli/pull/624
+
+- Expand man page entry on --keyfile-path and --capture-key options:
+  https://github.com/stratis-storage/stratis-cli/pull/625
+
+- Improve error message if no stratisd process running:
+  https://github.com/stratis-storage/stratis-cli/issues/613
+  https://github.com/stratis-storage/stratis-cli/pull/614
+
+- Extend blackbox tests:
+  https://github.com/stratis-storage/stratis-cli/pull/610
+
+- Tidies and Maintenance:
+  https://github.com/stratis-storage/stratis-cli/pull/623
+  https://github.com/stratis-storage/stratis-cli/pull/620
+  https://github.com/stratis-storage/stratis-cli/pull/616
+  https://github.com/stratis-storage/stratis-cli/pull/615
+  https://github.com/stratis-storage/stratis-cli/pull/608
+  https://github.com/stratis-storage/stratis-cli/pull/603
+
+
 stratis-cli 2.1.0
 =================
 Recommended Python interpreter: 3.7.6

check.py

@@ -53,19 +53,6 @@
     ],
 }
 
-# FIXME: omit once disabling the new lint in the source # pylint: disable=fixme
-# See https://github.com/stratis-storage/project/issues/175
-try:
-    import pylint
-
-    if pylint.__pkginfo__.numversion == (2, 4, 4):
-        ARG_MAP["src/stratis_cli"].append("--disable=import-outside-toplevel")
-        ARG_MAP["tests/whitebox"].append("--disable=import-outside-toplevel")
-except ImportError:
-    # Must be running on Travis, and check.py is running outside the virtual
-    # environment
-    pass
-
 
 def get_parser():
     """

docs/stratis.txt

@@ -73,11 +73,9 @@ blockdev list [pool_name]::
 	 List all blockdevs that make up the specified pool, or all pools, if
 	 no pool name is given.
 key set <(--keyfile-path <path> | --capture-key)> <key_desc>::
-     Set a key in the kernel keyring for use with encryption either from a keyfile
-     or captured interactively from user input.
+     Set a key in the kernel keyring for use with encryption.
 key reset <(--keyfile-path <path> | --capture-key)> <key_desc>::
-     Reset the key data of an existing key in the kernel keyring either from a keyfile
-     or captured interactively from user input.
+     Reset the key data of an existing key in the kernel keyring.
 key unset <key_desc>::
      Unset a key in the kernel keyring so it is no longer available for encryption
      operations.
@@ -99,6 +97,16 @@ OPTIONS
         The key description of the key that should be used to encrypt the
         created pool. The key description must correspond to a key
         set in the kernel keyring with the *key* command.
+--keyfile-path <path> | --capture-key::
+	These mutually exclusive options allow a user to specify a key used
+        for encryption in one of two ways. The *--keyfile-path* option requires
+        an argument, the path to a file containing the key. If the
+        *--capture-key* option is selected instead, the user must enter the key
+        at the ensuing prompt. The key value is terminated at the first newline
+        character that the user enters, and does not include the newline
+        character. On the other hand, if the file specified as an argument for
+        the *--keyfile-path* option contains a newline character anywhere, the
+        newline character will be included in the key value.
 
 ENVIRONMENT VARIABLES
 ---------------------

setup.py

@@ -49,6 +49,7 @@ def local_file(name):
         "dbus-client-gen>=0.4",
         "dbus-python-client-gen>=0.7",
         "justbytes>=0.14",
+        "psutil",
         "python-dateutil",
         "semantic_version",
         "wcwidth",

src/stratis_cli/__init__.py

@@ -14,6 +14,6 @@
 """
 Top level of CLI.
 """
-from ._main import run
 from ._errors import StratisCliEnvironmentError
 from ._exit import StratisCliErrorCodes, exit_
+from ._main import run

src/stratis_cli/_actions/__init__.py

@@ -15,9 +15,7 @@
 Package mediating dbus actions.
 """
 
-from ._constants import BLOCKDEV_INTERFACE
-from ._constants import FILESYSTEM_INTERFACE
-from ._constants import POOL_INTERFACE
+from ._constants import BLOCKDEV_INTERFACE, FILESYSTEM_INTERFACE, POOL_INTERFACE
 from ._logical import LogicalActions
 from ._physical import PhysicalActions
 from ._stratis import StratisActions

src/stratis_cli/_actions/_logical.py

@@ -46,6 +46,8 @@ def create_volumes(namespace):
         :raises StratisCliPartialChangeError:
         """
         # pylint: disable=too-many-locals
+
+        # pylint: disable=import-outside-toplevel
         from ._data import MOFilesystem
         from ._data import ObjectManager
         from ._data import Pool
@@ -101,6 +103,7 @@ def list_volumes(namespace):
         """
         List the volumes in a pool.
         """
+        # pylint: disable=import-outside-toplevel
         from ._data import FetchProperties
         from ._data import MOFilesystem
         from ._data import MOPool
@@ -185,6 +188,8 @@ def destroy_volumes(namespace):
         :raises StratisCliPartialChangeError:
         """
         # pylint: disable=too-many-locals
+
+        # pylint: disable=import-outside-toplevel
         from ._data import MOFilesystem
         from ._data import ObjectManager
         from ._data import Pool
@@ -251,6 +256,7 @@ def snapshot_filesystem(namespace):
         :raises StratisCliEngineError:
         :raises StratisCliNoChangeError:
         """
+        # pylint: disable=import-outside-toplevel
         from ._data import ObjectManager
         from ._data import Pool
         from ._data import filesystems
@@ -289,6 +295,7 @@ def rename_fs(namespace):
         :raises StratisCliEngineError:
         :raises StratisCliNoChangeError:
         """
+        # pylint: disable=import-outside-toplevel
         from ._data import ObjectManager
         from ._data import Filesystem
         from ._data import filesystems

src/stratis_cli/_actions/_physical.py

@@ -37,6 +37,7 @@ def list_devices(namespace):
         List devices. If a pool is specified in the namespace, list devices
         for that pool. Otherwise, list all devices for all pools.
         """
+        # pylint: disable=import-outside-toplevel
         from ._data import devs
         from ._data import pools
         from ._data import FetchProperties

src/stratis_cli/_actions/_stratis.py

@@ -38,6 +38,7 @@ def list_stratisd_version(_namespace):
         """
         List the stratisd version.
         """
+        # pylint: disable=import-outside-toplevel
         from ._data import Manager
 
         print("%s" % Manager.Properties.Version.Get(get_object(TOP_OBJECT)))