RCTab Models (#35)

* Use rctab_models for usage function

* Use rctab_models for controller function

* Use rctab_models for status function

* Add Type Hints to Usage Function (#33)

* WIP

* Add typing to usage function

* Black formatting (#34)

* Remove black from status deps

* Remove black from controller deps

* Remove black from usage deps

* Update black hook

* Run updated black

* Run black

* Fix test failures

* Run black

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
         args: ["--autofix", "--no-ensure-ascii", "--no-sort-keys"]
       - id: trailing-whitespace
   - repo: https://github.com/psf/black
-    rev: 23.1.0
+    rev: 24.8.0
     hooks:
       - id: black
   - repo: https://github.com/jackdewinter/pymarkdown

controller_function/controller/__init__.py

@@ -1,4 +1,5 @@
 """An Azure Function App to disable subscriptions."""
+
 import logging
 from datetime import datetime
 from typing import Iterable
@@ -7,9 +8,10 @@
 import azure.functions as func
 from azure.core.exceptions import HttpResponseError
 from pydantic import HttpUrl
+from rctab_models import models
 from requests import get
 
-from controller import models, settings
+from controller import settings
 from controller.auth import BearerAuth
 from controller.logutils import add_log_handler_once
 from controller.subscription import disable_subscription, enable_subscription

controller_function/controller/logutils.py

@@ -1,4 +1,5 @@
 """Utils to send logs to Azure Application Insights."""
+
 import logging
 from typing import Optional
 

controller_function/controller/settings.py

@@ -1,4 +1,5 @@
 """Configuration for the app."""
+
 from functools import lru_cache
 from typing import Optional
 

controller_function/controller/subscription.py

@@ -1,4 +1,5 @@
 """Manage subscription life cycle."""
+
 import logging
 from uuid import UUID
 

controller_function/pyproject.toml

@@ -18,9 +18,9 @@ pydantic = "^2.7.1"
 pydantic-settings = "^2.2.1"
 PyJWT = {extras = ["crypto"], version = "^2.8.0"}
 requests = "^2.31.0"
+rctab_models = { git = "https://github.com/alan-turing-institute/rctab-models", tag = "0.1.0" }
 
 [tool.poetry.group.dev.dependencies]
-black = "^24.4.2"
 coverage = "^7.5.1"
 flake8 = "^3.9.2"
 isort = "^5.13.2"

controller_function/run_now.py

@@ -1,4 +1,5 @@
 """Force our Azure function to run, regardless of the time."""
+
 import types
 
 from controller import main

controller_function/tests/test_function_app.py

@@ -1,4 +1,5 @@
 """Tests for controller package."""
+
 import json
 import logging
 from typing import Final
@@ -11,9 +12,9 @@
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
 from pydantic import HttpUrl, TypeAdapter
+from rctab_models.models import DesiredState
 
 import controller
-from controller.models import DesiredState
 
 HTTP_ADAPTER: Final = TypeAdapter(HttpUrl)
 VALID_URL: Final = HTTP_ADAPTER.validate_python("https://my.org")

docs/conf.py

@@ -1,4 +1,5 @@
 """Configuration file for the Sphinx documentation builder."""
+
 import os
 import pathlib
 import sys

status_function/pyproject.toml

@@ -19,9 +19,9 @@ pydantic = "^2.7.1"
 pydantic-settings = "^2.2.1"
 PyJWT = {extras = ["crypto"], version = "^2.8.0"}
 requests = "^2.31.0"
+rctab_models = { git = "https://github.com/alan-turing-institute/rctab-models", tag = "0.1.0" }
 
 [tool.poetry.group.dev.dependencies]
-black = "^24.4.2"
 coverage = "^7.5.1"
 flake8 = "^3.9.2"
 isort = "^5.13.2"

status_function/run_now.py

@@ -1,4 +1,5 @@
 """Force our Azure function to run, regardless of the time."""
+
 import types
 
 from status import main

status_function/status/__init__.py

@@ -6,6 +6,7 @@
         Azure AD graph. See https://docs.microsoft.com/en-us/graph/auth-v2-service#4-get-an-access-token # noqa pylint: disable=C0301
 
 """
+
 import logging
 from datetime import datetime
 from functools import lru_cache
@@ -21,11 +22,11 @@
 from azure.mgmt.subscription import SubscriptionClient
 from msrestazure.azure_exceptions import CloudError
 from pydantic import HttpUrl
+from rctab_models import models
 
-from status import models, settings
+from status import settings
 from status.auth import BearerAuth
 from status.logutils import add_log_handler_once
-from status.models import RoleAssignment
 from status.wrapper import CredentialWrapper
 
 logging.basicConfig(
@@ -254,7 +255,7 @@ def get_role_assignment_models(
 def get_subscription_role_assignment_models(
     subscription: Any,
     graph_client: GraphRbacManagementClient,
-) -> list[RoleAssignment]:
+) -> list[models.RoleAssignment]:
     """Get the role assignment models for each a subscription.
 
     Args:

status_function/status/auth.py

@@ -5,6 +5,7 @@
     ACCESS_TOKEN_EXPIRE_MINUTES: The number of minutes before an access token.
         value is 5.
 """
+
 from datetime import datetime, timedelta
 
 import jwt

status_function/status/logutils.py

@@ -1,4 +1,5 @@
 """Utils to send logs to Azure Application Insights."""
+
 import logging
 from typing import Optional
 

status_function/status/settings.py

@@ -1,4 +1,5 @@
 """Configuration for the app."""
+
 from functools import lru_cache
 from typing import Optional
 from uuid import UUID

status_function/status/wrapper.py

@@ -1,4 +1,5 @@
 """Copied from https://stackoverflow.com/a/64129363/3324095 and slightly modified."""
+
 from typing import Optional
 
 from azure.core.pipeline import PipelineContext, PipelineRequest

status_function/tests/test_function_app.py

@@ -1,4 +1,5 @@
 """Tests for status package."""
+
 import logging
 from datetime import datetime
 from importlib import import_module
@@ -14,9 +15,9 @@
 from cryptography.hazmat.primitives.asymmetric import rsa
 from msrestazure.azure_exceptions import CloudError
 from pydantic import HttpUrl, TypeAdapter
+from rctab_models.models import RoleAssignment, SubscriptionState, SubscriptionStatus
 
 import status
-from status.models import RoleAssignment, SubscriptionState, SubscriptionStatus
 
 HTTP_ADAPTER: Final = TypeAdapter(HttpUrl)
 VALID_URL: Final = HTTP_ADAPTER.validate_python("https://my.org")

usage_function/costmanagement/__init__.py

@@ -1,4 +1,5 @@
 """An Azure function to collect cost-management information."""
+
 import logging
 from datetime import datetime, timedelta
 from typing import Final
@@ -16,9 +17,9 @@
     QueryTimePeriod,
     TimeframeType,
 )
+from rctab_models import models
 
 import utils.settings
-from utils import models
 from utils.auth import BearerAuth
 from utils.logutils import add_log_handler_once
 

usage_function/monthly_usage/__init__.py

@@ -1,4 +1,5 @@
 """An Azure Function App to collect usage information for the previous month."""
+
 import logging
 import time
 from datetime import date, datetime, timedelta