Merge pull request #752 from mulkieran/develop-2.3.0-rc

Develop 2.3.0 rc
stratis-storage · Apr 27, 2021 · 50871ff · 50871ff
2 parents 0b441b1 + d2bc506
commit 50871ff
Show file tree

Hide file tree

Showing 43 changed files with 1,825 additions and 3,266 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -6,11 +6,11 @@ on:
   push:
     branches:
       - master
-      - develop-2.2.1
+      - develop-2.3.0
   pull_request:
     branches:
       - master
-      - develop-2.2.1
+      - develop-2.3.0
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -21,29 +21,29 @@ jobs:
       matrix:
         include:
           # MANDATORY CHECKS USING CURRENT DEVELOPMENT INTERPRETER
-          - python-version: 3.7.9
+          - python-version: 3.8.6
             dependencies: >
               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.9
+              wcwidth==0.2.4
               psutil==5.6.7
-              semantic_version==2.6.0
+              semantic_version==2.8.4
             task: PYTHONPATH=./src make -f Makefile lint
-          - python-version: 3.7.9
-            dependencies: black==19.10b0 isort==4.3.21
+          - python-version: 3.8.6
+            dependencies: black==20.8b1 isort==4.3.21
             task: make -f Makefile fmt-travis
-          - python-version: 3.7.9
+          - python-version: 3.8.6
             dependencies: >
               dbus-client-gen==0.4
               dbus-python-client-gen==0.7
               justbytes==0.11
               python-dateutil==2.8.0
-              wcwidth==0.1.9
+              wcwidth==0.2.4
               psutil==5.6.7
-              semantic_version==2.6.0
+              semantic_version==2.8.4
             task: PYTHONPATH=./src make -f Makefile test-travis
           # MANDATORY CHECKS USING LOWEST SUPPORTED INTERPRETER
           - python-version: 3.6.8
@@ -57,10 +57,10 @@ jobs:
               semantic_version==2.6.0
             task: PYTHONPATH=./src make -f Makefile lint
           # VERIFICATION OF TEST INFRASTRUCTURE
-          - python-version: 3.7.9
-            dependencies: yamllint==1.23.0
+          - python-version: 3.8.6
+            dependencies: yamllint==1.26.0
             task: make -f Makefile yamllint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,78 @@
+stratis-cli 2.4.0
+=================
+Required stratisd version: 2.4.0
+
+Recommended Python interpreter: 3.8.6
+Lowest supported Python interpreter: 3.6.8
+Python linter: pylint (2.4.4)
+Python auto-formatter: black (20.8b1)
+Python import sorter: isort (4.3.21)
+YAML linter: yamllint (1.26.0)
+
+- Add support for creating an encrypted pool bound with Clevis or a keyring,
+  and binding and unbinding with either encryption facility:
+  https://github.com/stratis-storage/stratis-cli/issues/733
+  https://github.com/stratis-storage/stratis-cli/pull/749
+  https://github.com/stratis-storage/stratis-cli/pull/748
+  https://github.com/stratis-storage/stratis-cli/pull/743
+  https://github.com/stratis-storage/stratis-cli/pull/736
+  https://github.com/stratis-storage/stratis-cli/pull/735
+
+- Print pool UUID in pool list command:
+  https://github.com/stratis-storage/stratis-cli/pull/695
+
+- Modify report subcommand so that it defaults to 'engine_state_report';
+  guarantee stability of 'engine_state_report' name:
+  https://github.com/stratis-storage/stratis-cli/issues/700
+  https://github.com/stratis-storage/stratis-cli/pull/717
+  https://github.com/stratis-storage/stratis-cli/pull/703
+  https://github.com/stratis-storage/stratis-cli/pull/702
+
+- Make the hyphenated format for UUIDs the default, add a flag to allow
+  reverting to unhyphenated format:
+  https://github.com/stratis-storage/stratis-cli/issues/698
+  https://github.com/stratis-storage/stratis-cli/pull/705
+
+- Expand relative paths to absolute paths in init-cache command,
+  add assertions to all D-Bus commands that take device paths to verify
+  that the device paths are absolute:
+  https://github.com/stratis-storage/stratis-cli/pull/750
+  https://github.com/stratis-storage/stratis-cli/pull/746
+
+- Add an explanation for an exception chain containing a GetManagedObjects()
+  failure, which may occur with a multi-threaded daemon implementation:
+  https://github.com/stratis-storage/stratis-cli/pull/713
+
+- Remove the blackbox tests:
+  https://github.com/stratis-storage/stratis-cli/pull/707
+
+- Update the bash completion script for new commands:
+  https://github.com/stratis-storage/stratis-cli/pull/714
+
+- Tidies and Maintenance:
+  https://github.com/stratis-storage/stratis-cli/pull/742
+  https://github.com/stratis-storage/stratis-cli/pull/740
+  https://github.com/stratis-storage/stratis-cli/pull/739
+  https://github.com/stratis-storage/stratis-cli/pull/737
+  https://github.com/stratis-storage/stratis-cli/pull/732
+  https://github.com/stratis-storage/stratis-cli/pull/729
+  https://github.com/stratis-storage/stratis-cli/pull/728
+  https://github.com/stratis-storage/stratis-cli/pull/726
+  https://github.com/stratis-storage/stratis-cli/pull/723
+  https://github.com/stratis-storage/stratis-cli/pull/719
+  https://github.com/stratis-storage/stratis-cli/pull/718
+  https://github.com/stratis-storage/stratis-cli/pull/716
+  https://github.com/stratis-storage/stratis-cli/pull/712
+  https://github.com/stratis-storage/stratis-cli/pull/709
+  https://github.com/stratis-storage/stratis-cli/pull/708
+  https://github.com/stratis-storage/stratis-cli/pull/706
+  https://github.com/stratis-storage/stratis-cli/pull/704
+  https://github.com/stratis-storage/stratis-cli/pull/699
+  https://github.com/stratis-storage/stratis-cli/pull/697
+  https://github.com/stratis-storage/stratis-cli/pull/696
+  https://github.com/stratis-storage/stratis-cli/pull/694
+
+
 stratis-cli 2.3.0
 =================
 Required stratisd version: 2.3.0
@@ -20,6 +95,7 @@ YAML linter: yamllint (1.23.0)
   https://github.com/stratis-storage/stratis-cli/pull/681
 
 - Tidies and Maintenance:
+  https://github.com/stratis-storage/stratis-cli/pull/692
   https://github.com/stratis-storage/stratis-cli/pull/691
   https://github.com/stratis-storage/stratis-cli/pull/688
   https://github.com/stratis-storage/stratis-cli/pull/678

diff --git a/Makefile b/Makefile
@@ -7,9 +7,6 @@ lint:
 	./check.py developer_tools
 	./check.py bin/stratis
 	./check.py src/stratis_cli
-	./check.py tests/blackbox/stratis_cli_cert.py
-	./check.py tests/blackbox/stratisd_cert.py
-	./check.py tests/blackbox/testlib
 	./check.py tests/whitebox
 
 .PHONY: fmt
@@ -20,7 +17,7 @@ fmt:
 .PHONY: fmt-travis
 fmt-travis:
 	isort --recursive --diff --check-only check.py setup.py bin/stratis src tests
-	black ./bin/stratis . --check
+	black ./bin/stratis ./developer_tools/update_introspection_data . --check
 
 PYREVERSE_OPTS = --output=pdf
 .PHONY: view
@@ -49,15 +46,15 @@ api-docs:
 	sphinx-build-3 -b html api api/_build/html
 
 dbus-tests:
-	python3 -m unittest discover ${UNITTEST_OPTS} --top-level-directory ./tests/whitebox --start-directory ./tests/whitebox/integration > /dev/null
+	python3 -m unittest discover ${UNITTEST_OPTS} --top-level-directory ./tests/whitebox --start-directory ./tests/whitebox/integration
 
 unittest-tests:
 	python3 -m unittest discover ${UNITTEST_OPTS} --start-directory ./tests/whitebox/unittest
 
 .PHONY: coverage-no-html
 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 -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

diff --git a/README.rst b/README.rst
@@ -19,16 +19,21 @@ processing and displaying the results.
 
 Installing
 ----------
+You can install ``stratis-cli`` directly from the ``stratis-cli`` project
+repo.
 
-To install, check out the source, and use the included setup script, as::
+``stratis-cli`` has a number of dependencies that may not already be
+installed. You may choose to allow the setup script to install any missing
+dependencies from PyPi, or you may prefer to install the dependencies using
+your distribution's package manager. All ``stratis-cli``'s direct
+dependencies are listed in ``stratis-cli``'s setup.py file, in the
+``install_requires`` field. If you choose to install the dependencies
+using your installation's package manager, you should do so before you
+run the setup.py script.
 
-   > python setup.py install
-
-You will also need to obtain the following related Stratis repos:
-dbus-client-gen, dbus-python-client-gen, into-dbus-python,
-dbus-signature-pyparsing.
+Finally, run the setup.py script as::
 
-Finally, ensure you have the pyparsing package installed.
+   > python setup.py install
 
 Running
 -------

diff --git a/check.py b/check.py
@@ -33,21 +33,6 @@
         "--ignore=_introspect.py",
         "--msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}'",
     ],
-    "tests/blackbox/stratisd_cert.py": [
-        "--reports=no",
-        "--disable=I",
-        "--msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}'",
-    ],
-    "tests/blackbox/stratis_cli_cert.py": [
-        "--reports=no",
-        "--disable=I",
-        "--msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}'",
-    ],
-    "tests/blackbox/testlib": [
-        "--reports=no",
-        "--disable=I",
-        "--msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}'",
-    ],
     "tests/whitebox": [
         "--reports=no",
         "--disable=I",