Merge pull request #24 from softwareone-platform/MPT-10788_fix_ff_params_for_billing

MPT-10788 set billedPercentage param as text

Author: ffaraone

.env.sample

@@ -4,11 +4,11 @@ MPT_PORTAL_BASE_URL=http://devmock:8000
 MPT_API_BASE_URL=http://devmock:8000
 MPT_API_TOKEN=<vendor-api-token>
 MPT_ORDERS_API_POLLING_INTERVAL_SECS=120
+MPT_NOTIFY_CATEGORIES={"ORDERS": "NTC-0000-0006"}
 EXT_WEBHOOKS_SECRETS={"PRD-1111-1111": "<super-jwt-secret>"}
 EXT_MSTEAMS_WEBHOOK_URL=https://whatever.webhook.office.com/webhookb2/<...>
 EXT_FFC_SUB=FTKN-1111-1111
 EXT_FFC_OPERATIONS_API_BASE_URL=https://api.finops.s1.show/ops
 EXT_FFC_OPERATIONS_SECRET=supersecret
-MPT_NOTIFY_CATEGORIES={"ORDERS": "NTC-0000-0006"}
-DEFAULT_TRIAL_PERIOD_DURATION_DAYS=30
-DEFAULT_BILLED_PERCENTAGE=4
+EXT_DEFAULT_TRIAL_PERIOD_DURATION_DAYS=30
+EXT_DEFAULT_BILLED_PERCENTAGE=4

ffc/flows/steps/finops.py

@@ -31,9 +31,7 @@ def __call__(self, client, context, next_step):
         try:
             employee = ffc_client.get_employee(administrator["email"])
             context.order = set_is_new_user(context.order, True)
-            update_order(
-                client, context.order["id"], parameters=context.order["parameters"]
-            )
+            update_order(client, context.order["id"], parameters=context.order["parameters"])
             logger.info(f"{context}: employee exists {employee['id']}")
         except FinOpsNotFoundError:
             employee = ffc_client.create_employee(
@@ -88,9 +86,7 @@ def __call__(self, client, context, next_step):
         order = context.order
         agreement_id = order["agreement"]["id"]
 
-        organizations = ffc_client.get_organizations_by_external_id(
-            agreement_id=agreement_id
-        )
+        organizations = ffc_client.get_organizations_by_external_id(agreement_id=agreement_id)
         organization = organizations and organizations[0]
 
         if organization and organization["status"] != DELETED_ORGANIZATION:

ffc/flows/steps/order.py

@@ -133,9 +133,7 @@ def __call__(self, client, context, next_step):
         ]:
             parameter = get_ordering_parameter(order, param_name)
             if not parameter.get("value"):
-                order = set_ordering_parameter_error(
-                    order, param_name, errors[param_name]
-                )
+                order = set_ordering_parameter_error(order, param_name, errors[param_name])
                 context.validation_succeeded = False
 
         next_step(client, context)
@@ -198,8 +196,8 @@ def _get_parameter_updates(order):
         updates = {}
 
         if not get_fulfillment_parameter(order, PARAM_BILLED_PERCENTAGE).get("value"):
-            updates[PARAM_BILLED_PERCENTAGE] = int(
-                settings.EXTENSION_CONFIG.get("DEFAULT_BILLED_PERCENTAGE")
+            updates[PARAM_BILLED_PERCENTAGE] = settings.EXTENSION_CONFIG.get(
+                "DEFAULT_BILLED_PERCENTAGE", "4"
             )
 
         trial_start_date = get_fulfillment_parameter(order, PARAM_TRIAL_START_DATE).get("value")
@@ -209,7 +207,7 @@ def _get_parameter_updates(order):
 
         if not get_fulfillment_parameter(order, PARAM_TRIAL_END_DATE).get("value"):
             trail_end_date = datetime.strptime(trial_start_date, "%Y-%m-%d").date() + timedelta(
-                days=int(settings.EXTENSION_CONFIG.get("DEFAULT_TRIAL_PERIOD_DURATION_DAYS"))
+                days=int(settings.EXTENSION_CONFIG.get("DEFAULT_TRIAL_PERIOD_DURATION_DAYS", "30"))
             )
             updates[PARAM_TRIAL_END_DATE] = trail_end_date.strftime("%Y-%m-%d")
 
@@ -247,12 +245,9 @@ def __call__(self, client, context, next_step):
         current_template_id = context.order.get("template", {}).get("id")
         if template["id"] != current_template_id:
             context.order = set_template(context.order, template)
-            update_order(
-                client, context.order["id"], template=context.order["template"]
-            )
+            update_order(client, context.order["id"], template=context.order["template"])
             logger.info(
-                f"{context}: processing template set to {self.template_name} "
-                f"({template['id']})"
+                f"{context}: processing template set to {self.template_name} " f"({template['id']})"
             )
         logger.info(f"{context}: processing template is ok, continue")
 

ffc/flows/steps/subscription.py

@@ -33,7 +33,6 @@ def __call__(self, client, context, next_step):
                     subscription,
                 )
                 logger.info(
-                    f'{context}: subscription {line["id"]} '
-                    f'({subscription["id"]}) created'
+                    f'{context}: subscription {line["id"]} ' f'({subscription["id"]}) created'
                 )
         next_step(client, context)

tests/ffc/flows/steps/test_finops.py

@@ -24,9 +24,7 @@ def test_create_employee_exists(
 ):
     mocked_ffc_client = mocker.MagicMock()
     mocked_ffc_client.get_employee.return_value = ffc_employee
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
     mocked_update_order = mocker.patch("ffc.flows.steps.finops.update_order")
 
     ctx = OrderContext(order=processing_purchase_order)
@@ -57,9 +55,7 @@ def test_create_employee(
     mocked_ffc_client = mocker.MagicMock()
     mocked_ffc_client.get_employee.side_effect = FinOpsNotFoundError("not-found")
     mocked_ffc_client.create_employee.return_value = ffc_employee
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
     mocked_update_order = mocker.patch("ffc.flows.steps.finops.update_order")
 
     ctx = OrderContext(order=processing_purchase_order)
@@ -94,9 +90,7 @@ def test_create_organization(
     mocked_ffc_client = mocker.MagicMock()
     mocked_ffc_client.create_organization.return_value = ffc_organization
     mocked_ffc_client.get_organizations_by_external_id.return_value = []
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
 
     ctx = OrderContext(order=processing_purchase_order)
     ctx.employee = ffc_employee
@@ -134,9 +128,7 @@ def test_create_organization_exists(
 ):
     mocked_ffc_client = mocker.MagicMock()
     mocked_ffc_client.get_organizations_by_external_id.return_value = [ffc_organization]
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
 
     ctx = OrderContext(order=processing_purchase_order)
     ctx.employee = ffc_employee
@@ -162,9 +154,7 @@ def test_delete_organization(
     mocked_ffc_client = mocker.MagicMock()
     mocked_ffc_client.delete_organization.return_value = None
     mocked_ffc_client.get_organizations_by_external_id.return_value = [ffc_organization]
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
 
     ctx = OrderContext(order=processing_termination_order)
     step = DeleteOrganization()
@@ -175,9 +165,7 @@ def test_delete_organization(
     mocked_ffc_client.get_organizations_by_external_id.assert_called_once_with(
         agreement_id=processing_termination_order["agreement"]["id"],
     )
-    mocked_ffc_client.delete_organization.assert_called_once_with(
-        ffc_organization["id"]
-    )
+    mocked_ffc_client.delete_organization.assert_called_once_with(ffc_organization["id"])
 
 
 def test_delete_organization_deleted_or_not_found(
@@ -190,9 +178,7 @@ def test_delete_organization_deleted_or_not_found(
     ffc_organization["status"] = "deleted"
     mocked_ffc_client = mocker.MagicMock()
     mocked_ffc_client.get_organizations_by_external_id.return_value = [ffc_organization]
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
 
     ctx = OrderContext(order=processing_termination_order)
     step = DeleteOrganization()
@@ -207,9 +193,7 @@ def test_delete_organization_deleted_or_not_found(
     mocked_ffc_client.delete_organization.assert_not_called()
 
     mocked_ffc_client.get_organizations_by_external_id.return_value = []
-    mocker.patch(
-        "ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client
-    )
+    mocker.patch("ffc.flows.steps.finops.get_ffc_client", return_value=mocked_ffc_client)
 
     step(mpt_client, ctx, mocked_next_step)
 

tests/ffc/flows/steps/test_order.py

@@ -344,9 +344,9 @@ def test_setup_fulfillment_parameters_empty_values(
     processing_purchase_order,
 ):
     param_defaults = {
-        'trialStartDate': '2025-01-01',
-        'trialEndDate': '2025-01-31',
-        'billedPercentage': 4,
+        "trialStartDate": "2025-01-01",
+        "trialEndDate": "2025-01-31",
+        "billedPercentage": "4",
     }
     for param in processing_purchase_order["parameters"]["fulfillment"]:
         if param["externalId"] in param_defaults:

tests/ffc/test_parameters.py

@@ -31,10 +31,7 @@ def test_get_parameter(processing_purchase_order):
 
 
 def test_get_parameter_does_not_exist(processing_purchase_order):
-    assert (
-        get_parameter("fulfillment", processing_purchase_order, "unknownParameter")
-        == {}
-    )
+    assert get_parameter("fulfillment", processing_purchase_order, "unknownParameter") == {}
 
 
 def test_set_ordering_parameter_error(processing_purchase_order):

tests/test_apps.py

@@ -38,6 +38,4 @@ def test_webhook_secret_not_defined(settings):
     with pytest.raises(ImproperlyConfigured) as e:
         app.ready()
 
-    assert "Please, specify it in EXT_WEBHOOKS_SECRETS environment variable." in str(
-        e.value
-    )
+    assert "Please, specify it in EXT_WEBHOOKS_SECRETS environment variable." in str(e.value)

tests/test_extension.py

@@ -32,9 +32,9 @@ def test_jwt_secret_callback(mocker, settings, mpt_client, webhook):
         "ffc.extension.get_webhook",
         return_value=webhook,
     )
-    assert jwt_secret_callback(
-        mpt_client, {"webhook_id": "WH-123-123"}
-    ) == get_for_product(settings, "WEBHOOKS_SECRETS", "PRD-1111-1111")
+    assert jwt_secret_callback(mpt_client, {"webhook_id": "WH-123-123"}) == get_for_product(
+        settings, "WEBHOOKS_SECRETS", "PRD-1111-1111"
+    )
     mocked_webhook.assert_called_once_with(mpt_client, "WH-123-123")