Update pre-commit, py 3.10 support and support for vmotion work-in-pr…

…ogress (#392) * Initial updates to pre-commit and test * Added vmotion_disable, vmotion_enable and updated get_vmotion_enabled * Added changelog entry for issue 350 * Updated 3.10 to "3.10" so last 0 gets recognized * Updated tests for formatting issues with new pre-commit * Added Python 3.10 and updated version of pytest-salt-factories * Updated pre-commit for recent versions of utilities * Updated bandit in pre-commit to allow for weak MD4, MD5 or SHA1 hash * Changed test version from Salt 3005.1 to 3006.4 * Updated creation of url with f-strings * Updated coverage in noxfile * Updated coverage to 6.5 * Updated to need 3006 and disabled Sphinx coverage till 7.3.0 which has fix for divide by zero * Updated pytest-salt-factories version per reviewer comments --------- Co-authored-by: David Murphy < [email protected]>
saltstack · Nov 21, 2023 · 2a5b0f7 · 2a5b0f7
1 parent ac69963
commit 2a5b0f7
Show file tree

Hide file tree

Showing 14 changed files with 489 additions and 136 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -11,7 +11,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: "3.10"
     - name: Set Cache Key
       run: echo "PY=$(python --version --version | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
     - name: Install System Deps
@@ -36,7 +36,7 @@ jobs:
     - name: Set up Python 3.7 For Nox
       uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: "3.10"
 
     - name: Install Nox
       run: |
@@ -67,8 +67,9 @@ jobs:
           - 3.7
           - 3.8
           - 3.9
+          - "3.10"
         salt-version:
-          - 3005.1
+          - 3006.4
 
     steps:
     - uses: actions/checkout@v2
@@ -184,9 +185,9 @@ jobs:
       max-parallel: 3
       matrix:
         python-version:
-          - 3.7
+          - "3.10"
         salt-version:
-          - 3005.1
+          - 3006.4
 
     steps:
     - uses: actions/checkout@v2
@@ -307,9 +308,9 @@ jobs:
       max-parallel: 3
       matrix:
         python-version:
-          - 3.9
+          - "3.10"
         salt-version:
-          - 3005.1
+          - 3006.4
 
     steps:
     - uses: actions/checkout@v2

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,20 +1,59 @@
 ---
-minimum_pre_commit_version: 1.15.2
+default_language_version:
+  python: python3
+
+exclude: ^(doc/_static/.*|doc/_themes/.*)$
+minimum_pre_commit_version: 2.4.0
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.1.0
+    rev: v4.4.0
     hooks:
       - id: check-merge-conflict  # Check for files that contain merge conflict strings.
       - id: trailing-whitespace   # Trims trailing whitespace.
         args: [--markdown-linebreak-ext=md]
+        exclude: >
+          (?x)^(
+            pkg/macos/pkg-resources/.*\.rtf
+          )$
+
       - id: mixed-line-ending     # Replaces or checks mixed line ending.
         args: [--fix=auto]
       - id: end-of-file-fixer     # Makes sure files end in a newline and only a newline.
         exclude: changelog/.*
       - id: check-merge-conflict  # Check for files that contain merge conflict strings.
       - id: check-ast             # Simply check whether files parse as valid python.
+        exclude: >
+          (?x)^(
+            templates/.*
+          )$
+      - id: check-case-conflict   # Check for files with names that would conflict on a
+                                  # case-insensitive filesystem like MacOS HFS+ or Windows FAT.
+      - id: check-json            # Attempts to load all json files to verify syntax.
+      - id: check-symlinks        # Checks for symlinks which do not point to anything.
+      - id: debug-statements      # Check for debugger imports and py37+ breakpoint() calls in python source.
+        exclude: >
+          (?x)^(
+            templates/.*
+          )$
+      - id: fix-byte-order-marker # removes UTF-8 byte order marker
+      - id: forbid-submodules     # forbids any submodules in the repository.
+      - id: fix-encoding-pragma   # Remove `# -*- coding: utf-8 -*-` from the top of python files.
+        args:
+          - --remove
+        exclude: >
+          (?x)^(
+            salt/ext/.*
+          )$
 
   # ----- Formatting ---------------------------------------------------------------------------->
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.37.2
+    hooks:
+      - id: pyupgrade
+        name: Rewrite Code to be Py3.7+, drop six usage and Py2 support
+        args: [--py3-plus, --keep-mock]
+        exclude: src/saltext/vcenter/version.py
+
   - repo: https://github.com/saltstack/pre-commit-remove-import-headers
     rev: 1.1.0
     hooks:
@@ -38,36 +77,22 @@ repos:
 
   - repo: https://github.com/s0undt3ch/salt-rewrite
     # Automatically rewrite code with known rules
-    rev: 1.3.2
+    rev: "2.2.0"
     hooks:
       - id: salt-rewrite
         alias: rewrite-docstrings
         name: Salt extensions docstrings auto-fixes
         files: ^src/saltext/vcenter/.*\.py$
-        args: [--silent]
+        args: [--silent, -F, fix_docstrings]
 
-  - repo: https://github.com/s0undt3ch/salt-rewrite
-    # Automatically rewrite code with known rules
-    rev: 1.3.2
-    hooks:
       - id: salt-rewrite
         alias: rewrite-tests
-        name: Rewrite the test suite
+        name: Rewrite Salt's Test Suite
         files: ^tests/.*\.py$
-        args: [--silent, -E, fix_docstrings]
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v2.10.0
-    hooks:
-      - id: pyupgrade
-        name: Rewrite Code to be Py3.7+
-        args: [
-          --py3-plus
-        ]
-        exclude: src/saltext/vcenter/version.py
+        args: [--silent, -E, fix_asserts, -E, fix_docstrings]
 
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.4.0
+    rev: v3.10.0
     hooks:
       - id: reorder-python-imports
         args: [
@@ -76,7 +101,7 @@ repos:
         exclude: src/saltext/vcenter/version.py
 
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.6.0
     hooks:
       - id: black
         args: [-l 100]
@@ -103,21 +128,21 @@ repos:
 
   # ----- Security ------------------------------------------------------------------------------>
   - repo: https://github.com/PyCQA/bandit
-    rev: "1.7.0"
+    rev: "1.7.4"
     hooks:
       - id: bandit
         alias: bandit-salt
         name: Run bandit against the code base
-        args: [--silent, -lll, --skip, B701]
+        args: [--silent, -lll, --skip, "B701,B324"]
         exclude: src/saltext/vcenter/version.py
         additional_dependencies: ['importlib_metadata<5']
   - repo: https://github.com/PyCQA/bandit
-    rev: "1.7.0"
+    rev: "1.7.4"
     hooks:
       - id: bandit
         alias: bandit-tests
         name: Run bandit against the test suite
-        args: [--silent, -lll, --skip, B701]
+        args: [--silent, -lll, --skip, "B701,B324"]
         files: ^tests/.*
         additional_dependencies: ['importlib_metadata<5']
   # <---- Security -------------------------------------------------------------------------------
@@ -131,6 +156,7 @@ repos:
 #        alias: lint-src
 #        name: Lint Source Code
 #        files: ^((setup|noxfile)|src/.*)\.py$
+#        require_serial: True
 #        args:
 #          - -e
 #          - lint-code-pre-commit
@@ -143,6 +169,7 @@ repos:
 #        alias: lint-tests
 #        name: Lint Tests
 #        files: ^tests/.*\.py$
+#        require_serial: True
 #        args:
 #          - -e
 #          - lint-tests-pre-commit
@@ -151,7 +178,7 @@ repos:
 
   # ----- Static Test Requirements -------------------------------------------------------------->
   - repo: https://github.com/saltstack/pip-tools-compile-impersonate
-    rev: dff9089c1003af49665064067ff63c75b9b69dcd
+    rev: '4.8'
     hooks:
       - id: pip-tools-compile
         alias: compile-3.7-test-requirements
@@ -185,6 +212,17 @@ repos:
           - --py-version=3.9
           - --platform=linux
           - requirements/tests.in
+
+      - id: pip-tools-compile
+        alias: compile-3.10-test-requirements
+        name: Py3.10 Test Requirements
+        files: ^requirements/tests.in$
+        pass_filenames: false
+        args:
+          - -v
+          - --py-version=3.10
+          - --platform=linux
+          - requirements/tests.in
   # <---- Static Test Requirements ---------------------------------------------------------------
 
   # ----- Static Lint Requirements -------------------------------------------------------------->
@@ -220,6 +258,17 @@ repos:
           - --py-version=3.9
           - --platform=linux
           - requirements/lint.in
+
+      - id: pip-tools-compile
+        alias: compile-3.10-test-requirements
+        name: Py3.10 Lint Requirements
+        files: ^requirements/lint.in$
+        pass_filenames: false
+        args:
+          - -v
+          - --py-version=3.10
+          - --platform=linux
+          - requirements/lint.in
   # <---- Static Lint Requirements ---------------------------------------------------------------
 
   # ----- Static Docs Requirements -------------------------------------------------------------->
@@ -255,4 +304,15 @@ repos:
           - --py-version=3.9
           - --platform=linux
           - requirements/docs.in
+
+      - id: pip-tools-compile
+        alias: compile-3.10-test-requirements
+        name: Py3.10 Docs Requirements
+        files: ^requirements/docs.in$
+        pass_filenames: false
+        args:
+          - -v
+          - --py-version=3.10
+          - --platform=linux
+          - requirements/docs.in
   # <---- Static Docs Requirements ---------------------------------------------------------------
diff --git a/changelog/350.added b/changelog/350.added
@@ -0,0 +1 @@
+Added support for vmotion_configured and its supporting functionality
diff --git a/noxfile.py b/noxfile.py
@@ -1,3 +1,9 @@
+"""
+noxfile
+~~~~~~~
+
+Nox configuration script
+"""
 # pylint: disable=missing-module-docstring,import-error,protected-access,missing-function-docstring
 import datetime
 import json
@@ -7,6 +13,15 @@
 import sys
 import tempfile
 
+# fmt: off
+if __name__ == "__main__":
+    sys.stderr.write(
+        "Do not execute this file directly. Use nox instead, it will know how to handle this file\n"
+    )
+    sys.stderr.flush()
+    exit(1)
+# fmt: on
+
 import nox
 from nox.command import CommandFailed
 from nox.virtualenv import VirtualEnv
@@ -24,11 +39,11 @@
     os.environ.get("JENKINS_URL") or os.environ.get("CI") or os.environ.get("DRONE") is not None
 )
 PIP_INSTALL_SILENT = CI_RUN is False
-SKIP_REQUIREMENTS_INSTALL = "SKIP_REQUIREMENTS_INSTALL" in os.environ
+SKIP_REQUIREMENTS_INSTALL = os.environ.get("SKIP_REQUIREMENTS_INSTALL", "0") == "1"
 EXTRA_REQUIREMENTS_INSTALL = os.environ.get("EXTRA_REQUIREMENTS_INSTALL")
+COVERAGE_VERSION_REQUIREMENT = "coverage==6.5"  # 7.x dropped support for Py 3.7
 
-COVERAGE_VERSION_REQUIREMENT = "coverage==5.2"
-SALT_REQUIREMENT = os.environ.get("SALT_REQUIREMENT") or "salt>=3005"
+SALT_REQUIREMENT = os.environ.get("SALT_REQUIREMENT") or "salt>=3006"
 if SALT_REQUIREMENT == "salt==master":
     SALT_REQUIREMENT = "git+https://github.com/saltstack/salt.git@master"
 
@@ -355,7 +370,11 @@ def docs(session):
     os.chdir("docs/")
     session.run("make", "clean", external=True)
     session.run("make", "linkcheck", "SPHINXOPTS=-Wn --keep-going", external=True)
-    session.run("make", "coverage", "SPHINXOPTS=-Wn --keep-going", external=True)
+
+    ## Disabling till sphinx 7.3.0 is released with fix for divide by zero, i
+    ## see Sphinx https://github.com/sphinx-doc/sphinx/commit/bb74aec2b6aa1179868d83134013450c9ff9d4d6
+    ## session.run("make", "coverage", "SPHINXOPTS=-Wn --keep-going", external=True)
+
     docs_coverage_file = os.path.join("_build", "html", "python.txt")
     if os.path.exists(docs_coverage_file):
         with open(docs_coverage_file) as rfh:

diff --git a/setup.cfg b/setup.cfg
@@ -21,6 +21,7 @@ classifiers =
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
     Development Status :: 4 - Beta
     Intended Audience :: Developers
     License :: OSI Approved :: Apache Software License
@@ -38,7 +39,7 @@ setup_requires =
     setuptools>=50.3.2
     setuptools-declarative-requirements
 install_requires =
-    salt>=3005
+    salt>=3006
     pyvmomi==7.0.3
     importlib_metadata; python_version < "3.8"
     jinja2>=3.1.0
@@ -47,7 +48,7 @@ install_requires =
 tests =
   pytest>=6.1.0
   pytest-cov
-  pytest-salt-factories>=0.121.1
+  pytest-salt-factories>=1.0.0rc27
 dev =
   nox
   towncrier==21.9.0rc1