reorder and extend pre-commit hooks

This change mainly just reorders the hooks
to be easier ot read and hopefully slightly
more efficent to run locally.

a number of extra useful hooks are added
such as the detect-private-key hook and
the check-shebang-scripts-are-executable

Thise were already available before but disabled.
finally the check-docstring-first is added
and the relevent module docs strings moved
if required.

Change-Id: I19a9e2adc9a029f4fbb819af1f128b874a5907e9

.pre-commit-config.yaml

@@ -3,41 +3,61 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
+      # whitespace
       - id: trailing-whitespace
       - id: mixed-line-ending
         args: ['--fix', 'lf']
         exclude: '.*\.(svg)$'
+      # file format and permissions
       - id: fix-byte-order-marker
       - id: check-executables-have-shebangs
-      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
-      - id: debug-statements
-        # nova/cmd/manage.py imports pdb on purpose.
-        exclude: 'nova/cmd/manage.py'
       - id: check-json
         files: .*\.json$
       - id: check-yaml
         files: .*\.(yaml|yml)$
+      # git
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: detect-private-key
+        exclude: '^doc/api_samples/.*|^nova/tests/.*'
+      # python
+      - id: debug-statements
+        # nova/cmd/manage.py imports pdb on purpose.
+        exclude: 'nova/cmd/manage.py'
+      - id: check-docstring-first
+        exclude: 'nova/virt/ironic/ironic_states.py'
+
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.5.5
     hooks:
       - id: remove-tabs
         exclude: '.*\.(svg)$'
+
+  - repo: https://github.com/hhatto/autopep8
+    rev: v2.3.2
+    hooks:
+      - id: autopep8
+        files: '^.*\.py$'
+
+  # run hacking after autopep8 so that if it can fix
+  # it it will. note it will still fail in ci because
+  # fixing an issue changes the code and that should
+  # not happen in ci.
   - repo: https://opendev.org/openstack/hacking
     rev: 7.0.0
     hooks:
       - id: hacking
         additional_dependencies: []
         exclude: '^(doc|releasenotes|tools)/.*$'
-  - repo: https://github.com/hhatto/autopep8
+
-    rev: v2.3.2
-    hooks:
-      - id: autopep8
-        files: '^.*\.py$'
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:
       - id: codespell
         args: ['--ignore-words=doc/dictionary.txt']
+
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.15.0
     hooks:
@@ -72,6 +92,7 @@ repos:
             | nova/virt/libvirt/host.py
             | nova/virt/libvirt/utils.py
           )
+
   - repo: https://github.com/sphinx-contrib/sphinx-lint
     rev: v1.0.0
     hooks:

nova/accelerator/cyborg.py

@@ -12,17 +12,6 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-from oslo_log import log as logging
-
-from keystoneauth1 import exceptions as ks_exc
-
-from nova import exception
-from nova.i18n import _
-from nova import objects
-from nova.scheduler import utils as schedutils
-from nova import service_auth
-from nova import utils
-
 """
    Note on object relationships:
    1 device profile (DP) has D >= 1 request groups (just as a flavor
@@ -52,6 +41,17 @@ from nova import utils
    See cyborg/cyborg/objects/device_profile.py for more details.
 """
 
+from oslo_log import log as logging
+
+from keystoneauth1 import exceptions as ks_exc
+
+from nova import exception
+from nova.i18n import _
+from nova import objects
+from nova.scheduler import utils as schedutils
+from nova import service_auth
+from nova import utils
+
 LOG = logging.getLogger(__name__)
 
 

nova/tests/unit/api/openstack/test_requestlog.py

@@ -13,13 +13,6 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-from unittest import mock
-
-import fixtures as fx
-import testtools
-
-from nova.tests import fixtures
-
 """Test request logging middleware under various conditions.
 
 The request logging middleware is needed when running under something
@@ -33,6 +26,13 @@ All these tests use GET / to hit an endpoint that doesn't require the
 database setup. We have to do a bit of mocking to make that work.
 """
 
+from unittest import mock
+
+import fixtures as fx
+import testtools
+
+from nova.tests import fixtures
+
 
 class TestRequestLogMiddleware(testtools.TestCase):