Pulumi: Migrate pyproject to PyPA standard and hatch

.github/workflows/lint_code.yaml

@@ -53,12 +53,14 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - name: Install requirements
-        shell: bash
-        run: pip install flake8
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: Install hatch
+        run: pip install hatch
       - name: Lint Python
-        shell: bash
-        run: flake8 . --statistics --count
+        run: hatch run lint:all
 
   lint_shell:
     runs-on: ubuntu-latest

data_safe_haven/__about__.py

@@ -0,0 +1,2 @@
+__version_info__ = ("5", "0", "0")
+__version__ = ".".join(__version_info__)

data_safe_haven/__init__.py

@@ -1,4 +1,5 @@
 """Data Safe Haven"""
-import pkg_resources
 
-__version__ = pkg_resources.get_distribution("data-safe-haven").version
+from data_safe_haven.version import __version__, __version_info__
+
+__all__ = ["__version__", "__version_info__"]

data_safe_haven/administration/users/__init__.py

@@ -1,3 +1,3 @@
-from .user_handler import UserHandler
+from data_safe_haven.administration.users.user_handler import UserHandler
 
 __all__ = ["UserHandler"]

data_safe_haven/administration/users/active_directory_users.py

@@ -1,15 +1,17 @@
 """Interact with users in an Azure Active Directory"""
 # Standard library imports
 import pathlib
-from typing import Any, Optional, Sequence
+from collections.abc import Sequence
+from typing import Any
+
+from data_safe_haven.administration.users.research_user import ResearchUser
 
 # Local imports
 from data_safe_haven.config import Config
 from data_safe_haven.external import AzureApi
 from data_safe_haven.functions import b64encode
 from data_safe_haven.pulumi import PulumiSHMStack
 from data_safe_haven.utility import FileReader, Logger
-from .research_user import ResearchUser
 
 
 class ActiveDirectoryUsers:
@@ -25,19 +27,13 @@ def __init__(
         shm_stack = PulumiSHMStack(config)
         self.azure_api = AzureApi(config.subscription_name)
         self.logger = Logger()
-        self.resource_group_name = shm_stack.output("domain_controllers")[
-            "resource_group_name"
-        ]
-        self.resources_path = (
-            pathlib.Path(__file__).parent.parent.parent / "resources"
-        ).resolve()
+        self.resource_group_name = shm_stack.output("domain_controllers")["resource_group_name"]
+        self.resources_path = (pathlib.Path(__file__).parent.parent.parent / "resources").resolve()
         self.vm_name = shm_stack.output("domain_controllers")["vm_name"]
 
     def add(self, new_users: Sequence[ResearchUser]) -> None:
         """Add list of users to local Active Directory"""
-        add_users_script = FileReader(
-            self.resources_path / "active_directory" / "add_users.ps1"
-        )
+        add_users_script = FileReader(self.resources_path / "active_directory" / "add_users.ps1")
         csv_contents = ["SamAccountName;GivenName;Surname;Mobile;Email;Country"]
         for user in new_users:
             if (
@@ -70,11 +66,9 @@ def add(self, new_users: Sequence[ResearchUser]) -> None:
         for line in output.split("\n"):
             self.logger.parse(line)
 
-    def list(self, sre_name: Optional[str] = None) -> Sequence[ResearchUser]:
+    def list(self, sre_name: str | None = None) -> Sequence[ResearchUser]:
         """List users in a local Active Directory"""
-        list_users_script = FileReader(
-            self.resources_path / "active_directory" / "list_users.ps1"
-        )
+        list_users_script = FileReader(self.resources_path / "active_directory" / "list_users.ps1")
         script_params = {"SREName": sre_name} if sre_name else {}
         output = self.azure_api.run_remote_script(
             self.resource_group_name,
@@ -100,9 +94,7 @@ def list(self, sre_name: Optional[str] = None) -> Sequence[ResearchUser]:
 
     def register(self, sre_name: str, usernames: Sequence[str]) -> None:
         """Add usernames to SRE security group"""
-        register_users_script = FileReader(
-            self.resources_path / "active_directory" / "add_users_to_group.ps1"
-        )
+        register_users_script = FileReader(self.resources_path / "active_directory" / "add_users_to_group.ps1")
         output = self.azure_api.run_remote_script(
             self.resource_group_name,
             register_users_script.file_contents(),
@@ -114,9 +106,7 @@ def register(self, sre_name: str, usernames: Sequence[str]) -> None:
 
     def remove(self, users: Sequence[ResearchUser]) -> None:
         """Remove list of users from local Active Directory"""
-        remove_users_script = FileReader(
-            self.resources_path / "active_directory" / "remove_users.ps1"
-        )
+        remove_users_script = FileReader(self.resources_path / "active_directory" / "remove_users.ps1")
         usernames_b64 = b64encode("\n".join(user.username for user in users))
         output = self.azure_api.run_remote_script(
             self.resource_group_name,
@@ -136,9 +126,7 @@ def set(self, users: Sequence[ResearchUser]) -> None:
 
     def unregister(self, sre_name: str, usernames: Sequence[str]) -> None:
         """Remove usernames from SRE security group"""
-        register_users_script = FileReader(
-            self.resources_path / "active_directory" / "remove_users_from_group.ps1"
-        )
+        register_users_script = FileReader(self.resources_path / "active_directory" / "remove_users_from_group.ps1")
         output = self.azure_api.run_remote_script(
             self.resource_group_name,
             register_users_script.file_contents(),

data_safe_haven/administration/users/azure_ad_users.py

@@ -1,12 +1,14 @@
 """Interact with users in an Azure Active Directory"""
 # Standard library imports
-from typing import Any, Sequence
+from collections.abc import Sequence
+from typing import Any
+
+from data_safe_haven.administration.users.research_user import ResearchUser
 
 # Local imports
 from data_safe_haven.external import GraphApi
 from data_safe_haven.functions import password
 from data_safe_haven.utility import Logger
-from .research_user import ResearchUser
 
 
 class AzureADUsers:
@@ -25,11 +27,7 @@ def __init__(
     def add(self, new_users: Sequence[ResearchUser]) -> None:
         """Add list of users to AzureAD"""
         # Get the default domain
-        default_domain = [
-            domain["id"]
-            for domain in self.graph_api.read_domains()
-            if domain["isDefault"]
-        ][0]
+        default_domain = [domain["id"] for domain in self.graph_api.read_domains() if domain["isDefault"]][0]
         for user in new_users:
             request_json = {
                 "accountEnabled": user.account_enabled,
@@ -41,12 +39,8 @@ def add(self, new_users: Sequence[ResearchUser]) -> None:
                 "userPrincipalName": f"{user.username}@{default_domain}",
             }
             if user.email_address and user.phone_number:
-                self.graph_api.create_user(
-                    request_json, user.email_address, user.phone_number
-                )
-            self.logger.info(
-                f"Ensured user '{user.preferred_username}' exists in AzureAD"
-            )
+                self.graph_api.create_user(request_json, user.email_address, user.phone_number)
+            self.logger.info(f"Ensured user '{user.preferred_username}' exists in AzureAD")
         # Decorate all users with the Linux schema
         self.set_user_attributes()
         # # Ensure that all users belong to an associated group the same name and UID
@@ -63,11 +57,7 @@ def list(self) -> Sequence[ResearchUser]:
                 account_enabled=user_details["accountEnabled"],
                 email_address=user_details["mail"],
                 given_name=user_details["givenName"],
-                phone_number=(
-                    user_details["businessPhones"][0]
-                    if len(user_details["businessPhones"])
-                    else None
-                ),
+                phone_number=(user_details["businessPhones"][0] if len(user_details["businessPhones"]) else None),
                 sam_account_name=(
                     user_details["onPremisesSamAccountName"]
                     if user_details["onPremisesSamAccountName"]
@@ -77,10 +67,7 @@ def list(self) -> Sequence[ResearchUser]:
                 user_principal_name=user_details["userPrincipalName"],
             )
             for user_details in user_list
-            if (
-                user_details["onPremisesSamAccountName"]
-                or user_details["isGlobalAdmin"]
-            )
+            if (user_details["onPremisesSamAccountName"] or user_details["isGlobalAdmin"])
         ]
 
     def remove(self, users: Sequence[ResearchUser]) -> None:

data_safe_haven/administration/users/guacamole_users.py

@@ -1,12 +1,14 @@
 # Standard library imports
 import pathlib
-from typing import Any, Optional, Sequence
+from collections.abc import Sequence
+from typing import Any
+
+from data_safe_haven.administration.users.research_user import ResearchUser
 
 # Local imports
 from data_safe_haven.config import Config
 from data_safe_haven.external import AzurePostgreSQLDatabase
 from data_safe_haven.pulumi import PulumiSREStack
-from .research_user import ResearchUser
 
 
 class GuacamoleUsers:
@@ -20,12 +22,9 @@ def __init__(self, config: Config, sre_name: str, *args: Any, **kwargs: Any):
             sre_stack.output("remote_desktop")["resource_group_name"],
             config.subscription_name,
         )
-        self.users_: Optional[Sequence[ResearchUser]] = None
+        self.users_: Sequence[ResearchUser] | None = None
         self.postgres_script_path: pathlib.Path = (
-            pathlib.Path(__file__).parent.parent.parent
-            / "resources"
-            / "remote_desktop"
-            / "postgresql"
+            pathlib.Path(__file__).parent.parent.parent / "resources" / "remote_desktop" / "postgresql"
         )
         self.sre_name = sre_name
         self.group_name = f"Data Safe Haven Users SRE {sre_name}"

data_safe_haven/administration/users/research_user.py

@@ -1,18 +1,18 @@
 # Standard library imports
-from typing import Any, Optional
+from typing import Any
 
 
 class ResearchUser:
     def __init__(
         self,
-        account_enabled: Optional[bool] = None,
-        country: Optional[str] = None,
-        email_address: Optional[str] = None,
-        given_name: Optional[str] = None,
-        phone_number: Optional[str] = None,
-        sam_account_name: Optional[str] = None,
-        surname: Optional[str] = None,
-        user_principal_name: Optional[str] = None,
+        account_enabled: bool | None = None,
+        country: str | None = None,
+        email_address: str | None = None,
+        given_name: str | None = None,
+        phone_number: str | None = None,
+        sam_account_name: str | None = None,
+        surname: str | None = None,
+        user_principal_name: str | None = None,
     ) -> None:
         self.account_enabled = account_enabled
         self.country = country