🚨 Add pre-commit

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 23.10.0
+    hooks:
+    -   id: black
+        args: ["--line-length=79"]
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+    - id: isort
+      args: ["--profile", "black"]
+-   repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+    - id: flake8
+      exclude: migrations/

dev_requirements.txt

@@ -4,3 +4,4 @@ flake8==5.0.4
 pyflakes==2.5.0
 pylint==2.13.9
 PyYAML==6.0.1
+pre-commit

examples/create_aio.bash

@@ -18,4 +18,3 @@ create_aio_vm \
   --search-domain evatt.ingenious.com.au \
   --rhn-user $AIO_RHN_USER \
   --rhn-password $AIO_RHN_PASSWORD
-  

src/tripleo_aio_helpers/create_aio_vm.py

@@ -23,8 +23,12 @@ def parse_args():
     parser.add_argument("--local-hostname", required=True)
     parser.add_argument("--user-data", default=template_path / "user-data.tpl")
     parser.add_argument("--meta-data", default=template_path / "meta-data.tpl")
-    parser.add_argument("--network-data", default=template_path / "network-config.tpl")
+    parser.add_argument(
-    parser.add_argument("--instance-id", required=True, help="Hostname for the new VM")
+        "--network-data", default=template_path / "network-config.tpl"
+    )
+    parser.add_argument(
+        "--instance-id", required=True, help="Hostname for the new VM"
+    )
     parser.add_argument("--output-image", required=True)
     parser.add_argument("--image-size", default="800G")
     parser.add_argument("--input-image", required=True)
@@ -63,15 +67,6 @@ def parse_args():
         print("You must specify a DNS server if you specify any addresses")
         sys.exit(1)
 
-    # if not (args.cidr_1 or args.cidr_2) and (
-    #     args.dns or args.gateway or args.search_domain
-    # ):
-    #     print(
-    #         "There's no point specifying DNS, gateway or search_domain if you"
-    #         " don't specify addresses"
-    #     )
-    #     sys.exit(1)
-
     args.public_key = args.public_key.read()
 
     with open(args.user_data, encoding="utf-8") as user_data:
@@ -153,7 +148,10 @@ def create_image(args):
         print(result)
 
     print("Resizing image")
-    cmd = f"virt-resize --expand /dev/sda3 {args.input_image} {args.output_image}"
+    cmd = (
+        f"virt-resize --expand /dev/sda3 {args.input_image} "
+        f"{args.output_image}"
+    )
 
     result = subprocess.check_output(cmd, shell=True, universal_newlines=True)
 
@@ -212,7 +210,9 @@ def install_packages(args):
     print("installing needed packages...")
 
     if args.verbose:
-        print(subprocess.check_output(cmd, shell=True, universal_newlines=True))
+        print(
+            subprocess.check_output(cmd, shell=True, universal_newlines=True)
+        )
 
 
 def main():

src/tripleo_aio_helpers/os_migrate_setup.py

@@ -35,7 +35,8 @@ def parse_args():
     parser.add_argument("-g", "--gateway")
     parser.add_argument("-C", "--public-network-cidr")
     parser.add_argument(
-        "--ssh-key", help="File containing a public key to inject into the instances"
+        "--ssh-key",
+        help="File containing a public key to inject into the instances",
     )
     parser.add_argument("--private-network-cidr", default="192.168.100.0/24")
     parser.add_argument("--public-net-start")
@@ -76,7 +77,9 @@ def parse_args():
         )
 
     if not args.public_net_end:
-        args.public_net_end = get_from_env("--public-net-end", "AIO_PUBLIC_NET_END")
+        args.public_net_end = get_from_env(
+            "--public-net-end", "AIO_PUBLIC_NET_END"
+        )
 
     if not args.dns_server:
         args.dns_server = get_from_env("--dns-server", "AIO_DNS_SERVER")
@@ -130,7 +133,9 @@ def create_user(args):
 
     cmd = "user list -f json"
     user_exists = [
-        x for x in json.loads(openstack_cmd(cmd, args)) if x["Name"] == args.username
+        x
+        for x in json.loads(openstack_cmd(cmd, args))
+        if x["Name"] == args.username
     ]
 
     if user_exists:
@@ -183,7 +188,8 @@ def create_public_network(args):
         args.public_network_id = network_exists[0]["ID"]
     else:
         cmd = (
-            "network create -f json  --external --provider-physical-network datacentre "
+            "network create -f json  --external "
+            "--provider-physical-network datacentre "
             "--provider-network-type flat public"
         )
         try:
@@ -203,7 +209,8 @@ def create_public_network(args):
             "subnet create public-net -f json "
             f"--subnet-range {args.public_network_cidr} "
             f"--gateway {args.gateway} "
-            f"--allocation-pool start={args.public_net_start},end={args.public_net_end} "
+            f"--allocation-pool start={args.public_net_start},"
+            f"end={args.public_net_end} "
             "--network public "
             f"--host-route destination=0.0.0.0/0,gateway={args.gateway} "
             f"--dns-nameserver {args.dns_server}"
@@ -217,7 +224,8 @@ def create_private_network(args):
 
     network_exists = json.loads(
         openstack_cmd(
-            f"network list -f json --project {args.project_id} --name private", args
+            f"network list -f json --project {args.project_id} --name private",
+            args,
         )
     )
 
@@ -225,13 +233,18 @@ def create_private_network(args):
         print("Private network already exists - skipping")
         args.private_network_id = network_exists[0]["ID"]
     else:
-        cmd = f"network create -f json --internal private --project {args.project_id}"
+        cmd = (
+            f"network create -f json --internal private "
+            f"--project {args.project_id}"
+        )
         args.private_network_id = json.loads(openstack_cmd(cmd, args))["id"]
         print("Private network created.")
 
     subnet_exists = json.loads(
         openstack_cmd(
-            f"subnet list -f json --project {args.project_id} --name private-net", args
+            f"subnet list -f json --project {args.project_id} "
+            f"--name private-net",
+            args,
         )
     )
     if subnet_exists:
@@ -240,7 +253,8 @@ def create_private_network(args):
     else:
         cmd = (
             f"subnet create private-net -f json --project {args.project_id} "
-            f"--subnet-range {args.private_network_cidr} --network {args.private_network_id}"
+            f"--subnet-range {args.private_network_cidr} "
+            f"--network {args.private_network_id}"
         )
         args.private_subnet_id = json.loads(openstack_cmd(cmd, args))
         print("Private subnet created.")
@@ -303,7 +317,6 @@ def create_image(image_name, image_url, disk_size, memory, args):
         return
 
     with tempfile.TemporaryDirectory() as tmp_dir:
-
         # download image to tmpdir
         fname = f"{tmp_dir}/{image_name}.img"
         cmd = f"wget -O {fname} {image_url}"
@@ -314,7 +327,8 @@ def create_image(image_name, image_url, disk_size, memory, args):
             cmd = f"scp {fname} {args.ssh}:{image_name}.img"
             execute_cmd(cmd)
 
-        # create image - note this will only work on a remote ssh host at the moment
+        # create image - note this will only work on a remote ssh host at
+        # the moment
         cmd = f"""
             image create -f json
                 --container-format bare
@@ -379,7 +393,9 @@ def create_instance(args, name, flavor, image, security_group, boot_size):
             "floating ip create -f json public", args, as_json=True
         )
         _ = test_user_openstack_cmd(
-            f"server add floating ip {server['id']} {fip['floating_ip_address']}", args
+            f"server add floating ip {server['id']} "
+            f"{fip['floating_ip_address']}",
+            args,
         )
 
 
@@ -404,7 +420,7 @@ def create_rhel_instance(args):
         args.rhel_flavor,
         args.rhel_image,
         args.sg_id,
-        120
+        120,
     )
 
 
@@ -416,7 +432,7 @@ def create_conversion_instance(args):
         args.rhel_flavor,
         args.rhel_image,
         args.sg_id,
-        120
+        120,
     )
 
 
@@ -425,7 +441,9 @@ def create_keypair(args):
 
     key_exists = [
         kp
-        for kp in json.loads(test_user_openstack_cmd("keypair list -f json ", args))
+        for kp in json.loads(
+            test_user_openstack_cmd("keypair list -f json ", args)
+        )
         if kp["Name"] == "test_keypair"
     ]
 
@@ -440,7 +458,9 @@ def create_keypair(args):
 
             args.keypair_name = json.loads(
                 test_user_openstack_cmd(
-                    f"keypair create -f json --public-key {fname} test_keypair", args
+                    f"keypair create -f json "
+                    f"--public-key {fname} test_keypair",
+                    args,
                 )
             )[
                 "name"
@@ -458,7 +478,9 @@ def create_router(args):
     try:
         router_id = [
             router
-            for router in openstack_cmd("router list -f json", args, as_json=True)
+            for router in openstack_cmd(
+                "router list -f json", args, as_json=True
+            )
             if router["Name"] == "test-router"
         ][0]["ID"]
     except IndexError:
@@ -470,13 +492,17 @@ def create_router(args):
         )["id"]
         print("router created")
 
-    router_info = openstack_cmd(f"router show -f json {router_id}", args, as_json=True)
+    router_info = openstack_cmd(
+        f"router show -f json {router_id}", args, as_json=True
+    )
 
     if router_info["external_gateway_info"]:
         print("router gateway already set")
     else:
         openstack_cmd(
-            f"router set {router_id} --external-gateway {args.public_network_id}", args
+            f"router set {router_id} "
+            f"--external-gateway {args.public_network_id}",
+            args,
         )
         print("router gateway added")
 
@@ -511,8 +537,7 @@ def create_security_group(args):
     else:
         sec_grp = json.loads(
             test_user_openstack_cmd(
-                "security group create test-sg -f json",
+                "security group create test-sg -f json", args
-                args
             )
         )
         args.sg_id = sec_grp["id"]
@@ -526,7 +551,8 @@ def create_security_group(args):
         )
 
         _ = test_user_openstack_cmd(
-            ("security group rule create --protocol icmp " f"{args.sg_id}"), args
+            ("security group rule create --protocol icmp " f"{args.sg_id}"),
+            args,
         )
 
 
@@ -555,7 +581,7 @@ def main():
     create_cirros_instance(args)
     create_rhel_instance(args)
 
-    ## create_os_migrate host
+    # create_os_migrate host
 
 
 if __name__ == "__main__":

src/tripleo_aio_helpers/os_migrate_teardown.py

@@ -60,7 +60,9 @@ def destroy_user(args):
     """Delete the user if it exists"""
     cmd = "user list -f json"
     user_exists = [
-        x for x in json.loads(openstack_cmd(cmd, args)) if x["Name"] == args.username
+        x
+        for x in json.loads(openstack_cmd(cmd, args))
+        if x["Name"] == args.username
     ]
 
     if user_exists:
@@ -78,7 +80,9 @@ def destroy_public_network(args):
 
     public_network_exists = [
         network
-        for network in openstack_cmd("network list -f json", args, as_json=True)
+        for network in openstack_cmd(
+            "network list -f json", args, as_json=True
+        )
         if network["Name"] == "public"
     ]
 
@@ -88,14 +92,14 @@ def destroy_public_network(args):
         )
 
         for router in routers:
-
             router_details = test_user_openstack_cmd(
                 f"router show -f json {router['ID']}", args, as_json=True
             )
 
             for interface in router_details["interfaces_info"]:
                 test_user_openstack_cmd(
-                    f"router remove port {router['ID']} {interface['port_id']}",
+                    f"router remove port {router['ID']} "
+                    f"{interface['port_id']}",
                     args,
                 )
 
@@ -108,7 +112,9 @@ def destroy_private_network(args):
     """Delete the private network"""
     private_network_exists = [
         network
-        for network in openstack_cmd("network list -f json", args, as_json=True)
+        for network in openstack_cmd(
+            "network list -f json", args, as_json=True
+        )
         if network["Name"] == "private"
     ]
 
@@ -176,7 +182,9 @@ def destroy_rhel_instance(args):
 def get_project_id(args):
     """Get the id of the test project"""
     result = openstack_cmd("project list -f json", args, as_json=True)
-    args.project_id = [r for r in result if r["Name"] == args.project_name][0]["ID"]
+    args.project_id = [r for r in result if r["Name"] == args.project_name][0][
+        "ID"
+    ]
 
 
 def main():

src/tripleo_aio_helpers/os_migrate_validate.py

@@ -16,7 +16,9 @@ def parse_args():
     parser = argparse.ArgumentParser()
     # parser.add_argument("-d", "--project-domain", default="default")
     parser.add_argument("-n", "--project-name", default="test-project")
-    # parser.add_argument("-D", "--project-description", default="Test project")
+    # parser.add_argument(
+    #   "-D", "--project-description", default="Test project"
+    #   )
     # parser.add_argument("-u", "--username", default="test-user")
     # parser.add_argument("-p", "--password", default="secrete123")
     # parser.add_argument("-c", "--cloud", default="standalone")
@@ -61,7 +63,9 @@ def validate_user(args):
     """Validate that the user exists"""
     cmd = "user list -f json"
     user_exists = [
-        x for x in json.loads(openstack_cmd(cmd, args)) if x["Name"] == args.username
+        x
+        for x in json.loads(openstack_cmd(cmd, args))
+        if x["Name"] == args.username
     ]
 
     if user_exists:
@@ -75,7 +79,10 @@ def validate_member_role(args):
     Validate that the member role has been assigned to the user.
     """
     print(args)
-    # cmd = f"role add --user {args.username} --project {args.project_id} member"
+    # cmd = (
+    #       f"role add --user {args.username} "
+    #       f"--project {args.project_id} member"
+    #       )
 
     # result = openstack_cmd(cmd, args)
 
@@ -100,13 +107,14 @@ def validate_public_network(args):
         f"start={args.public_net_start},end={args.public_net_end} "
         "--network public"
     )
+    print(cmd)
 
 
 def validate_private_network(args):
     """Coming soon - validate the private network"""
     # pylint: disable=unused-argument,unused-variable
-    cmd = "openstack network create --internal private"
+    _ = "openstack network create --internal private"
-    cmd = (
+    _ = (
         "openstack subnet create private-net "
         f"--subnet-range {args.private_network_cidr} --network private"
     )

src/tripleo_aio_helpers/prepare_deployment.py

@@ -4,6 +4,7 @@ Quick and dirty script to help setup config filers for a RHOSP AIO install
 import argparse
 import os
 import subprocess
+
 import yaml
 
 
@@ -18,7 +19,9 @@ def parse_args():
     parser.add_argument("-a", "--address", required=True)
     parser.add_argument("-i", "--interface", required=True)
     parser.add_argument("-m", "--netmask", default=24)
-    parser.add_argument("-d", "--dns", nargs="+", action="append", required=True)
+    parser.add_argument(
+        "-d", "--dns", nargs="+", action="append", required=True
+    )
     parser.add_argument("-D", "--domain", default="aio")
     parser.add_argument("--using-multiple-nics", action="store_true")
     parser.add_argument("-U", "--deployment-user")
@@ -38,7 +41,8 @@ def parse_args():
     parser.add_argument(
         "--cinder-pool-size",
         default="500280",
-        help="Size of the loopback device allocated to cinder. " "Defaults to 500280",
+        help="Size of the loopback device allocated to cinder. "
+        "Defaults to 500280",
     )
 
     args = parser.parse_args()
@@ -137,12 +141,16 @@ def main():
     args = parse_args()
 
     containers_yaml = build_containers_yaml(args)
-    with open(args.containers_yaml_out, "w", encoding="utf-8") as containers_out:
+    with open(
+        args.containers_yaml_out, "w", encoding="utf-8"
+    ) as containers_out:
         containers_out.write(yaml.dump(containers_yaml))
     print(f"containers yaml written to {args.containers_yaml_out}")
 
     standalone_parameters = get_standalone_parameters(args)
-    with open(args.standalone_yaml_out, "w", encoding="utf-8") as parameters_out:
+    with open(
+        args.standalone_yaml_out, "w", encoding="utf-8"
+    ) as parameters_out:
         parameters_out.write(yaml.dump(standalone_parameters))
     print(f"standalone parameters yaml written to {args.standalone_yaml_out}")
 

src/tripleo_aio_helpers/utils.py

@@ -20,7 +20,9 @@ def get_from_env(name, envvar, required=True):
 
 
 def openstack_cmd(cmd, args, as_json=False):
-    """Utility function to run an openstack command agains the standalone cloud"""
+    """
+    Utility function to run an openstack command agains the standalone cloud
+    """
 
     cmd = cmd.replace("\n", " ")
     cmd = "OS_CLOUD=standalone openstack " + cmd
@@ -34,7 +36,9 @@ def openstack_cmd(cmd, args, as_json=False):
         return None
 
     try:
-        result = subprocess.check_output(cmd, shell=True, universal_newlines=True)
+        result = subprocess.check_output(
+            cmd, shell=True, universal_newlines=True
+        )
 
         if as_json:
             result = json.loads(result)

src/virt-install/user-data.tpl

@@ -25,4 +25,3 @@ runcmd:
   - "echo '***                                                                     ***'"
   - "echo '***************************************************************************'"
   - "reboot"
-