Merge pull request #33 from softwareone-platform/MPT-8308_align_config_with_operations_api

MPT-8308 align config with operations api

Author: ffaraone

app/core/config.py

@@ -9,8 +9,8 @@ class Settings(BaseSettings):
     # Base
     jwt_secret: str
     jwt_leeway: float = 30.0
-    optscale_auth_api_url: str
-    optscale_rest_api_url: str
+    optscale_auth_api_base_url: str
+    optscale_rest_api_base_url: str
     optscale_cluster_secret: str
     debug: bool = False
     default_request_timeout: int = 10  # API Client

app/optscale_api/auth_api.py

@@ -6,10 +6,11 @@
 from app.core.api_client import APIClient
 from app.core.exceptions import UserAccessTokenError, raise_api_response_exception
 
-AUTH_TOKEN_ENDPOINT = "/auth/v2/tokens"  # nosec B105
-AUTH_TOKEN_AUTHORIZE_ENDPOINT = "/auth/v2/authorize"  # nosec B105"
 logger = logging.getLogger(__name__)
 
+AUTH_TOKEN_ENDPOINT = "/tokens"  # nosec B105
+AUTH_TOKEN_AUTHORIZE_ENDPOINT = "/authorize"  # nosec B105"
+
 
 def build_admin_api_key_header(admin_api_key: str) -> dict[str, str]:
     """
@@ -33,7 +34,7 @@ def build_bearer_token_header(bearer_token: str) -> dict[str, str]:
 
 class OptScaleAuth:
     def __init__(self):
-        self.api_client = APIClient(base_url=settings.optscale_auth_api_url)
+        self.api_client = APIClient(base_url=settings.optscale_auth_api_base_url)
 
     async def check_user_allowed_to_create_cloud_account(
         self, bearer_token: str, org_id: str

app/optscale_api/cloud_accounts.py

@@ -10,12 +10,13 @@
 )
 
 logger = logging.getLogger(__name__)
-CLOUD_ACCOUNT_ENDPOINT = "/restapi/v2/organizations"
+
+CLOUD_ACCOUNT_ENDPOINT = "/organizations"
 
 
 class OptScaleCloudAccountAPI:
     def __init__(self):
-        self.api_client = APIClient(base_url=settings.optscale_rest_api_url)
+        self.api_client = APIClient(base_url=settings.optscale_rest_api_base_url)
 
     async def link_cloud_account_with_org(
         self, user_access_token: str, org_id: str, conf: dict[str, str]

app/optscale_api/invitation_api.py

@@ -12,13 +12,14 @@
     build_bearer_token_header,
 )
 
-INVITATION_ENDPOINT = "/restapi/v2/invites"
 logger = logging.getLogger(__name__)
 
+INVITATION_ENDPOINT = "/invites"
+
 
 class OptScaleInvitationAPI:
     def __init__(self):
-        self.api_client = APIClient(base_url=settings.optscale_rest_api_url)
+        self.api_client = APIClient(base_url=settings.optscale_rest_api_base_url)
 
     async def decline_invitation(self, user_access_token: str, invitation_id: str):
         """

app/optscale_api/orgs_api.py

@@ -17,17 +17,17 @@
     get_user_access_token,
 )
 
-ORG_ENDPOINT = "/restapi/v2/organizations"
 logger = logging.getLogger(__name__)
 
-ORG_CREATION_ERROR = "An error occurred creating an organization for user {}."
+ORG_ENDPOINT = "/organizations"
 
+ORG_CREATION_ERROR = "An error occurred creating an organization for user {}."
 ORG_FETCHING_ERROR = "An error occurred getting organizations for user {}."
 
 
 class OptScaleOrgAPI:
     def __init__(self):
-        self.api_client = APIClient(base_url=settings.optscale_rest_api_url)
+        self.api_client = APIClient(base_url=settings.optscale_rest_api_base_url)
 
     async def get_user_org_list(
         self, user_access_token: str

app/optscale_api/users_api.py

@@ -8,13 +8,14 @@
 
 from .auth_api import build_admin_api_key_header
 
-AUTH_USERS_ENDPOINT = "/auth/v2/users"
 logger = logging.getLogger(__name__)
 
+AUTH_USERS_ENDPOINT = "/users"
+
 
 class OptScaleUserAPI:
     def __init__(self):
-        self.api_client = APIClient(base_url=settings.optscale_auth_api_url)
+        self.api_client = APIClient(base_url=settings.optscale_auth_api_base_url)
 
     # todo: check the password lenght and strength
     async def create_user(

env.example

@@ -2,8 +2,8 @@
 # BASE
 FFC_MODIFIER_DEBUG=True
 # CLoudSpend API
-FFC_MODIFIER_OPTSCALE_AUTH_API_URL="https://your-optscaledomain.com"
-FFC_MODIFIER_OPTSCALE_REST_API_URL="https://your-optscaledomain.com"
+FFC_MODIFIER_OPTSCALE_AUTH_API_BASE_URL="https://your-optscaledomain.com/auth/v2"
+FFC_MODIFIER_OPTSCALE_REST_API_BASE_URL="https://your-optscaledomain.com/restapi/v2"
 FFC_MODIFIER_OPTSCALE_CLUSTER_SECRET="your cluster secret here"
 # JWT TOKEN
 FFC_MODIFIER_JWT_SECRET="my_super_secret_here"

tests/test_external_services.py

@@ -112,7 +112,7 @@ async def test_create_duplicate_user(caplog, optscale_api, test_data: dict, mock
                 admin_api_key="test_key",
             )
             mock_post.assert_called_once_with(
-                endpoint="/auth/v2/users",
+                endpoint="/users",
                 data={
                     "email": EMAIL,
                     "display_name": DISPLAY_NAME,

tests/test_optscale_cloud_accounts_api.py

@@ -42,7 +42,7 @@ async def test_create_cloud_account(
 
     # Assert that mock_post was called with expected arguments
     mock_api_client_post.assert_called_once_with(
-        endpoint="/restapi/v2/organizations/ABC-101-DEF-1001/cloud_accounts",
+        endpoint="/organizations/ABC-101-DEF-1001/cloud_accounts",
         data=payload,
         headers={"Authorization": "Bearer good token"},
     )

tests/test_optscale_organizations_api.py

@@ -84,7 +84,7 @@ async def test_create_user_org(
 
     # Assert that mock_post was called with expected arguments
     mock_api_client_post.assert_called_once_with(
-        endpoint="/restapi/v2/organizations",
+        endpoint="/organizations",
         data={"name": "MyOrg", "currency": "USD"},
         headers={"Authorization": "Bearer good token"},
     )
@@ -146,7 +146,7 @@ async def test_get_user_org_empty_response(
     )
     assert result == {"organizations": []}
     mock_api_client_get.assert_called_once_with(
-        endpoint="/restapi/v2/organizations",
+        endpoint="/organizations",
         headers={"Authorization": "Bearer good token"},
     )