Merge pull request #349 from rackerlabs/pre-commit

.github/workflows/pre-commit.yml

@@ -0,0 +1,27 @@
+---
+name: pre-commit
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        id: setup-python
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+      - run: pip install pre-commit
+      - name: "run pre-commit"
+        run: |
+          pre-commit run --all-files --show-diff-on-failure

.pre-commit-config.yaml

@@ -3,7 +3,9 @@ repos:
     rev: v4.5.0
     hooks:
       - id: trailing-whitespace
+        exclude: '\.patch'
       - id: end-of-file-fixer
+        exclude: '^docs/overrides'
       - id: fix-byte-order-marker
       - id: mixed-line-ending
       - id: check-yaml
@@ -16,22 +18,6 @@ repos:
     hooks:
       - id: yamllint
         args: [-c, .yamllint.yaml]
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
-        exclude: '^python/'
-        args:
-          - --max-line-length=120
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
-    hooks:
-      - id: black
-        exclude: '^python/'
-        args:
-          - --line-length=120
-          - --check
-          - --diff
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.28.4
     hooks:
@@ -54,10 +40,8 @@ repos:
     rev: v0.5.4
     hooks:
       - id: ruff
-        files: '^python/'
         args: [--fix]
       - id: ruff-format
-        files: '^python/'
   - repo: https://github.com/python-poetry/poetry
     rev: '1.7.1'
     hooks:

components/nautobot/dexauth.py

@@ -21,9 +21,7 @@ def _env_list(field: str, default: str) -> list[str]:
 STAFF_GROUPS = _env_list("DEX_STAFF_GROUPS", "ucadmin")
 
 
-def group_sync(
-    uid, user=None, response=None, *args, **kwargs
-):  # pylint: disable=keyword-arg-before-vararg, unused-argument
+def group_sync(uid, user=None, response=None, *args, **kwargs):  # pylint: disable=keyword-arg-before-vararg, unused-argument
     """Sync the users groups from the response and set staff/superuser as
     appropriate"""
     if user and response and response.get(GROUPS_ATTR_NAME, False):

components/nautobot/nautobot_config.py

@@ -348,7 +348,9 @@
 
 # Send anonymized installation metrics when `nautobot-server post_upgrade` command is run.
 #
-INSTALLATION_METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_INSTALLATION_METRICS_ENABLED", "True"))
+INSTALLATION_METRICS_ENABLED = is_truthy(
+    os.getenv("NAUTOBOT_INSTALLATION_METRICS_ENABLED", "True")
+)
 
 # Storage backend to use for Job input files and Job output files.
 #
@@ -467,7 +469,9 @@ def _read_cred(filename):
 
 
 # configure our SSO login from our secret
-SOCIAL_AUTH_OIDC_OIDC_ENDPOINT = _read_cred("/opt/nautobot/sso/issuer") or os.getenv("SOCIAL_AUTH_OIDC_OIDC_ENDPOINT")
+SOCIAL_AUTH_OIDC_OIDC_ENDPOINT = _read_cred("/opt/nautobot/sso/issuer") or os.getenv(
+    "SOCIAL_AUTH_OIDC_OIDC_ENDPOINT"
+)
 SOCIAL_AUTH_OIDC_KEY = _read_cred("/opt/nautobot/sso/client-id") or "nautobot"
 SOCIAL_AUTH_OIDC_SECRET = _read_cred("/opt/nautobot/sso/client-secret")
 # The “openid”, “profile” and “email” are requested by default,

containers/argo_utils/code/argo_python/__init__.py

@@ -6,7 +6,14 @@
 
 
 class ArgoWorkflow:
-    def __init__(self, namespace: str, name: str, uid: str, api_version="argoproj.io/v1alpha1", config_file=None):
+    def __init__(
+        self,
+        namespace: str,
+        name: str,
+        uid: str,
+        api_version="argoproj.io/v1alpha1",
+        config_file=None,
+    ):
         if config_file:
             config.load_kube_config(config_file)
         else:

containers/bmc-utils/code/bmc_firmware_update.py

@@ -18,8 +18,12 @@
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(prog=os.path.basename(__file__), description="Update BMC firmware")
-    parser.add_argument("--host", required=True, help="The address of the BMC interface")
+    parser = argparse.ArgumentParser(
+        prog=os.path.basename(__file__), description="Update BMC firmware"
+    )
+    parser.add_argument(
+        "--host", required=True, help="The address of the BMC interface"
+    )
     parser.add_argument("--firmware-url", required=True, help="URL of firmware")
 
     args = parser.parse_args()
@@ -41,7 +45,12 @@
         "Content-Type": "multipart/form-data",
     }
 
-    update_data = {"UpdateRepository": True, "UpdateTarget": True, "ETag": "atag", "Section": 0}
+    update_data = {
+        "UpdateRepository": True,
+        "UpdateTarget": True,
+        "ETag": "atag",
+        "Section": 0,
+    }
 
     upd_url = urlparse.urljoin(c._conn._url, updsvc.http_push_uri)
 
@@ -57,7 +66,9 @@
                 ("parameters", json.dumps(update_data)),
                 ("file", (filename, r.raw, "application/octet-stream")),
             ]
-            rsp = c._conn._session.post(upd_url, files=multipart, verify=False, headers=headers)
+            rsp = c._conn._session.post(
+                upd_url, files=multipart, verify=False, headers=headers
+            )
             logger.info(rsp.json())
     except Exception as e:
         logger.error(e)

containers/bmc-utils/code/bmc_sync_creds.py

@@ -19,11 +19,21 @@
 
 
 def redfish_request(
-    host: str, uri: str, username: str, password: str, method: str = "GET", payload: Dict | None = None
+    host: str,
+    uri: str,
+    username: str,
+    password: str,
+    method: str = "GET",
+    payload: Dict | None = None,
 ) -> dict:
     try:
         r = requests.request(
-            method, f"https://{host}{uri}", verify=False, auth=(username, password), timeout=15, json=payload
+            method,
+            f"https://{host}{uri}",
+            verify=False,
+            auth=(username, password),
+            timeout=15,
+            json=payload,
         )
         r.raise_for_status()
         return r.json()
@@ -67,7 +77,13 @@ def get_bmc_accounts(host: str, username: str, password: str) -> List[Dict]:
         raise
 
 
-def set_bmc_creds(host: str, username: str, password: str, expected_username: str, expected_password: str) -> bool:
+def set_bmc_creds(
+    host: str,
+    username: str,
+    password: str,
+    expected_username: str,
+    expected_password: str,
+) -> bool:
     """Find the account associated with the username in question"""
     try:
         accounts = get_bmc_accounts(host, username, password)
@@ -97,9 +113,12 @@ def set_bmc_creds(host: str, username: str, password: str, expected_username: st
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        prog=os.path.basename(__file__), description="Attempts to find the correct BMC credentials for a device"
+        prog=os.path.basename(__file__),
+        description="Attempts to find the correct BMC credentials for a device",
+    )
+    parser.add_argument(
+        "--host", required=True, help="the address of the bmc interface for the device"
     )
-    parser.add_argument("--host", required=True, help="the address of the bmc interface for the device")
 
     args = parser.parse_args()
     host = args.host
@@ -117,17 +136,23 @@ def set_bmc_creds(host: str, username: str, password: str, expected_username: st
         logger.info("BMC credentials are in sync.")
         sys.exit(0)
     else:
-        logger.info("BMC credentials are NOT in sync. Trying known legacy/vendor credentials ...")
+        logger.info(
+            "BMC credentials are NOT in sync. Trying known legacy/vendor credentials ..."
+        )
 
         # iDRAC defaults to blocking an IP address after 3 bad login attempts within 60 second. Since we have the
         # initial attempt above, we will sleep 35 seconds between any additional attempts.
         delay = 60
         username = os.getenv("BMC_LEGACY_USER", "root")
         for password in legacy_passwords:
-            logger.info(f"Delaying for {delay} seconds to prevent failed auth lockouts ...")
+            logger.info(
+                f"Delaying for {delay} seconds to prevent failed auth lockouts ..."
+            )
             time.sleep(delay)
             if verify_auth(host, username, password):
-                if set_bmc_creds(host, username, password, expected_username, expected_password):
+                if set_bmc_creds(
+                    host, username, password, expected_username, expected_password
+                ):
                     logger.info("BMC password has been synced.")
                     sys.exit(0)
 

python/ironic-understack/ironic_understack/conf.py

@@ -1,4 +1,5 @@
 from oslo_config import cfg
+
 CONF = cfg.CONF
 
 

python/ironic-understack/ironic_understack/flavor_spec.py

@@ -61,12 +61,11 @@ def score_machine(self, machine: Machine):
         #     but more memory space it is less desirable than the machine that
         #     matches exactly on both disk and memory.
 
-
         # Rule 1: 100% match gets the highest priority
         if (
-            machine.memory_gb == self.memory_gb and
-            machine.disk_gb in self.drives and
-            machine.cpu in self.cpu_models
+            machine.memory_gb == self.memory_gb
+            and machine.disk_gb in self.drives
+            and machine.cpu in self.cpu_models
         ):
             return 100
 

python/ironic-understack/ironic_understack/machine.py

@@ -10,4 +10,3 @@ class Machine:
     @property
     def memory_gb(self) -> int:
         return self.memory_mb // 1024
-

python/ironic-understack/ironic_understack/redfish_inspect_understack.py

@@ -44,7 +44,7 @@ def inspect_hardware(self, task):
         :returns: The resulting state of inspection.
 
         """
-        upstream_state = super().inspect_hardware(task) # pyright: ignore reportAttributeAccessIssue
+        upstream_state = super().inspect_hardware(task)  # pyright: ignore reportAttributeAccessIssue
 
         inspection_data = get_inspection_data(task.node, task.context)
 

python/ironic-understack/ironic_understack/tests/test_flavor_spec.py

@@ -93,13 +93,12 @@ def test_empty_directory(tmp_path):
     specs = FlavorSpec.from_directory(str(tmp_path))
     assert len(specs) == 0
 
+
 @pytest.fixture
 def machines():
     return [
         # 1024 GB, exact CPU, medium
-        Machine(
-            memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=1000
-        ),
+        Machine(memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=1000),
         # 800 GB, non-matching CPU
         Machine(memory_mb=800000, cpu="Intel Xeon E5-2676 v3", disk_gb=500),
         # 200 GB, exact CPU, medium
@@ -140,19 +139,26 @@ def flavors():
         ),
     ]
 
+
 def test_exact_match(flavors):
-    machine = Machine(memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500)
+    machine = Machine(
+        memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500
+    )
     assert flavors[0].score_machine(machine) == 100
     assert flavors[1].score_machine(machine) == 0
 
 
 def test_memory_too_small(flavors):
-    machine = Machine(memory_mb=51200, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500)
+    machine = Machine(
+        memory_mb=51200, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500
+    )
     assert all(flavor.score_machine(machine) for flavor in flavors) == 0
 
 
 def test_disk_too_small(flavors):
-    machine = Machine(memory_mb=204800, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=100)
+    machine = Machine(
+        memory_mb=204800, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=100
+    )
     assert all(flavor.score_machine(machine) for flavor in flavors) == 0
 
 
@@ -162,51 +168,66 @@ def test_cpu_model_not_matching(flavors):
 
 
 def test_memory_match_but_more_disk(flavors):
-    machine = Machine(memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=1000)
+    machine = Machine(
+        memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=1000
+    )
     assert flavors[0].score_machine(machine) > 0
 
 
 def test_disk_match_but_more_memory(flavors):
-    machine = Machine(memory_mb=204800, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500)
+    machine = Machine(
+        memory_mb=204800, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500
+    )
 
     assert flavors[0].score_machine(machine) > 0
     assert flavors[1].score_machine(machine) == 0
     assert flavors[2].score_machine(machine) == 0
 
+
 # Edge cases
 def test_memory_slightly_less(flavors):
     # Machine with slightly less memory than required by the smallest flavor
-    machine = Machine(memory_mb=102300, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500)
+    machine = Machine(
+        memory_mb=102300, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500
+    )
     # Should not match because memory is slightly less
     assert all(flavor.score_machine(machine) for flavor in flavors) == 0
 
 
 def test_disk_slightly_less(flavors):
     # Machine with slightly less disk space than required by the smallest flavor
-    machine = Machine(memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=499)
+    machine = Machine(
+        memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=499
+    )
     # Should not match because disk space is slightly less
     assert all(flavor.score_machine(machine) for flavor in flavors) == 0
 
 
 def test_memory_exact_disk_slightly_more(flavors):
     # Machine with exact memory but slightly more disk space than required
-    machine = Machine(memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=501)
+    machine = Machine(
+        memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=501
+    )
     assert flavors[0].score_machine(machine) > 0
     assert flavors[1].score_machine(machine) == 0
     assert flavors[2].score_machine(machine) == 0
 
 
 def test_disk_exact_memory_slightly_more(flavors):
     # Machine with exact disk space but slightly more memory than required
-    machine = Machine(memory_mb=102500, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500)
+    machine = Machine(
+        memory_mb=102500, cpu="AMD EPYC 9254 245-Core Processor", disk_gb=500
+    )
     assert flavors[0].score_machine(machine) > 0
     assert flavors[1].score_machine(machine) == 0
     assert flavors[2].score_machine(machine) == 0
 
 
 def test_cpu_model_not_exact_but_memory_and_disk_match(flavors):
     # Machine with exact memory and disk space but CPU model is close but not exact
-    machine = Machine(memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor v2", disk_gb=500)
+    machine = Machine(
+        memory_mb=102400, cpu="AMD EPYC 9254 245-Core Processor v2", disk_gb=500
+    )
     # Should not match because CPU model is not exactly listed
     assert all(flavor.score_machine(machine) for flavor in flavors) == 0