nextmv 1.0.0.dev6__tar.gz → 1.0.0.dev7__tar.gz

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.0.0.dev6
+Version: 1.0.0.dev7
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://nextmv-py.docs.nextmv.io/en/latest/nextmv/
@@ -230,7 +230,7 @@ Provides-Extra: dev
 Requires-Dist: build>=1.0.3; extra == 'dev'
 Requires-Dist: folium>=0.20.0; extra == 'dev'
 Requires-Dist: mlflow>=2.19.0; extra == 'dev'
-Requires-Dist: nextpipe>=0.6.0.dev0; extra == 'dev'
+Requires-Dist: nextpipe>=0.6.0; extra == 'dev'
 Requires-Dist: nextroute>=1.11.1; extra == 'dev'
 Requires-Dist: openpyxl>=3.1.5; extra == 'dev'
 Requires-Dist: pandas>=2.2.3; extra == 'dev'

nextmv-1.0.0.dev7/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v1.0.0.dev7"

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/nextmv/cloud/application/_acceptance.py

@@ -9,6 +9,7 @@ import requests
 from nextmv.cloud.acceptance_test import AcceptanceTest, Metric
 from nextmv.cloud.batch_experiment import BatchExperimentRun, ExperimentStatus
 from nextmv.polling import DEFAULT_POLLING_OPTIONS, PollingOptions, poll
+from nextmv.safe import safe_id
 
 if TYPE_CHECKING:
     from . import Application
@@ -163,8 +164,8 @@ class ApplicationAcceptanceMixin:
         self: "Application",
         candidate_instance_id: str,
         baseline_instance_id: str,
-        id: str,
         metrics: list[Metric | dict[str, Any]],
+        id: str | None = None,
         name: str | None = None,
         input_set_id: str | None = None,
         description: str | None = None,
@@ -185,8 +186,8 @@ class ApplicationAcceptanceMixin:
             ID of the candidate instance.
         baseline_instance_id : str
             ID of the baseline instance.
-        id : str
-            ID of the acceptance test.
+        id : str | None, default=None
+            ID of the acceptance test. Will be generated if not provided.
         metrics : list[Union[Metric, dict[str, Any]]]
             List of metrics to use for the acceptance test.
         name : Optional[str], default=None
@@ -210,6 +211,11 @@ class ApplicationAcceptanceMixin:
             If the batch experiment ID does not match the acceptance test ID.
         """
 
+        # Generate ID if not provided
+        if id is None or id == "":
+            id = safe_id("acceptance")
+
+        # Use ID as name if name not provided
         if name is None or name == "":
             name = id
 
@@ -265,11 +271,10 @@ class ApplicationAcceptanceMixin:
             "metrics": payload_metrics,
             "experiment_id": batch_experiment_id,
             "name": name,
+            "id": id,
         }
         if description is not None:
             payload["description"] = description
-        if id is not None:
-            payload["id"] = id
 
         response = self.client.request(
             method="POST",
@@ -283,8 +288,8 @@ class ApplicationAcceptanceMixin:
         self: "Application",
         candidate_instance_id: str,
         baseline_instance_id: str,
-        id: str,
         metrics: list[Metric | dict[str, Any]],
+        id: str | None = None,
         name: str | None = None,
         input_set_id: str | None = None,
         description: str | None = None,
@@ -302,8 +307,8 @@ class ApplicationAcceptanceMixin:
             ID of the candidate instance.
         baseline_instance_id : str
             ID of the baseline instance.
-        id : str
-            ID of the acceptance test.
+        id : str | None, default=None
+            ID of the acceptance test. Will be generated if not provided.
         metrics : list[Union[Metric, dict[str, Any]]]
             List of metrics to use for the acceptance test.
         name : Optional[str], default=None

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/nextmv/cloud/application/_switchback.py

@@ -217,7 +217,7 @@ class ApplicationSwitchbackMixin:
         payload = {
             "id": switchback_test_id,
             "name": name,
-            "comparison": comparison,
+            "comparison": comparison.to_dict(),
             "generate_random_plan": {
                 "unit_duration_minutes": unit_duration_minutes,
                 "units": units,

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/nextmv/cloud/integration.py

@@ -225,12 +225,12 @@ class Integration(BaseModel):
     def new(  # noqa: C901
         cls,
         client: Client,
-        name: str,
         integration_type: IntegrationType | str,
         exec_types: list[ManifestType | str],
         provider: IntegrationProvider | str,
         provider_config: dict[str, Any],
         integration_id: str | None = None,
+        name: str | None = None,
         description: str | None = None,
         is_global: bool = False,
         application_ids: list[str] | None = None,
@@ -243,8 +243,6 @@ class Integration(BaseModel):
         ----------
         client : Client
             Client to use for interacting with the Nextmv Cloud API.
-        name : str
-            The name of the integration.
         integration_type : IntegrationType | str
             The type of the integration. Please refer to the `IntegrationType`
             enum for possible values.
@@ -259,6 +257,9 @@ class Integration(BaseModel):
         integration_id : str, optional
             The unique identifier of the integration. If not provided,
             it will be generated automatically.
+        name : str | None, optional
+            The name of the integration. If not provided, the integration ID
+            will be used as the name.
         description : str, optional
             An optional description of the integration.
         is_global : bool, optional, default=False
@@ -302,8 +303,10 @@ class Integration(BaseModel):
         elif not is_global and application_ids is None:
             raise ValueError("A non-global integration must have specific application IDs.")
 
-        if integration_id is None:
+        if integration_id is None or integration_id == "":
             integration_id = safe_id("integration")
+        if name is None or name == "":
+            name = integration_id
 
         if exist_ok:
             try:

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/nextmv/cloud/switchback.py

@@ -45,6 +45,8 @@ class TestComparisonSingle(BaseModel):
         ID of the candidate instance for comparison.
     """
 
+    __test__ = False  # Prevents pytest from collecting this class as a test case
+
     baseline_instance_id: str
     """ID of the baseline instance for comparison."""
     candidate_instance_id: str

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/pyproject.toml

@@ -80,7 +80,7 @@ dev = [
     "folium>=0.20.0",
     "plotly>=6.0.1",
     "pytest>=9.0.2",
-    "nextpipe>=0.6.0.dev0",
+    "nextpipe>=0.6.0",
 ]
 
 [tool.hatch.version]

{nextmv-1.0.0.dev6 → nextmv-1.0.0.dev7}/tests/integration/cloud/test_integration_cloud.py

@@ -447,9 +447,10 @@ class CloudIntegrationWorkflow(FlowSpec):
         # We can delete a shadow test.
         app.delete_shadow_test(shadow_test_id=shadow_test.shadow_test_id)
 
-    @needs(predecessors=[init_app, instances])
+    # We make switchback a successor of shadow tests to reuse the instances.
+    @needs(predecessors=[init_app, instances, shadow_tests])
     @step
-    def switchback_tests(app: cloud.Application, instances: tuple[cloud.Instance, cloud.Instance]) -> None:
+    def switchback_tests(app: cloud.Application, instances: tuple[cloud.Instance, cloud.Instance], __unused) -> None:
         """
         Performs switchback test operations.
 
@@ -467,7 +468,7 @@ class CloudIntegrationWorkflow(FlowSpec):
         switchback_test = app.new_switchback_test(
             comparison=TestComparisonSingle(
                 baseline_instance_id=inst1.id,
-                treatment_instance_id=inst2.id,
+                candidate_instance_id=inst2.id,
             ),
             unit_duration_minutes=1,
             units=1,
@@ -522,6 +523,208 @@ class CloudIntegrationWorkflow(FlowSpec):
         # We can delete a switchback test.
         app.delete_switchback_test(switchback_test_id=switchback_test.switchback_test_id)
 
+    @needs(predecessors=[init_app, instances, input_sets])
+    @step
+    def acceptance_tests(
+        app: cloud.Application,
+        instances: tuple[cloud.Instance, cloud.Instance],
+        input_set: cloud.InputSet,
+    ) -> None:
+        """
+        Performs acceptance test operations.
+
+        Parameters
+        ----------
+        app : cloud.Application
+            The application to perform acceptance test operations on.
+        instances : tuple[cloud.Instance, cloud.Instance]
+            The instances to use for the acceptance test.
+        input_set : cloud.InputSet
+            The input set to use for the acceptance test.
+        """
+
+        inst1, inst2 = instances
+
+        # We can create an acceptance test.
+        acceptance = app.new_acceptance_test_with_result(
+            baseline_instance_id=inst1.id,
+            candidate_instance_id=inst2.id,
+            metrics=[
+                cloud.Metric(
+                    field="result.value",
+                    metric_type=cloud.MetricType.direct_comparison,
+                    params=cloud.MetricParams(
+                        operator=cloud.Comparison.equal_to,
+                        tolerance=cloud.MetricTolerance(
+                            type=cloud.MetricToleranceType.absolute,
+                            value=0.01,
+                        ),
+                    ),
+                    statistic=cloud.StatisticType.mean,
+                ),
+            ],
+            input_set_id=input_set.id,
+        )
+        assert acceptance is not None
+
+        # We can list acceptance tests.
+        acceptance_tests = app.list_acceptance_tests()
+        assert len(acceptance_tests) >= 1
+        acceptance_test_ids = {a.id for a in acceptance_tests}
+        assert acceptance.id in acceptance_test_ids
+
+        # We can get an acceptance test.
+        acceptance = app.acceptance_test(acceptance_test_id=acceptance.id)
+        assert acceptance is not None
+
+        # We can update an acceptance test.
+        name = "Hoppy Acceptance & Light"
+        description = "An acceptance test for hoppy bunnies"
+        acceptance = app.update_acceptance_test(
+            acceptance_test_id=acceptance.id,
+            name=name,
+            description=description,
+        )
+        assert acceptance.name == name
+        assert acceptance.description == description
+
+        # We can delete an acceptance test.
+        app.delete_acceptance_test(acceptance_test_id=acceptance.id)
+
+    @needs(predecessors=[init_app, community_push])
+    @step
+    def secrets(app: cloud.Application, __unused) -> None:
+        """
+        Performs secret operations.
+
+        Parameters
+        ----------
+        app : cloud.Application
+            The application to perform secret operations on.
+        """
+
+        # We can create a secrets collection.
+        secrets = [
+            cloud.Secret(
+                secret_type=cloud.SecretType.ENV,
+                location="BURROW_ENTRANCE",
+                value="Make 2 lefts and a hop forward",
+            )
+        ]
+        summary = app.new_secrets_collection(
+            secrets=secrets,
+        )
+
+        # We can get a secrets collection.
+        collection = app.secrets_collection(secrets_collection_id=summary.collection_id)
+        assert collection is not None
+        assert len(collection.secrets) == 1
+        assert collection.secrets[0].location == secrets[0].location
+        assert collection.secrets[0].value == secrets[0].value
+
+        # We can list secret collections.
+        collections = app.list_secrets_collections()
+        assert len(collections) >= 1
+        collection_ids = {c.collection_id for c in collections}
+        assert summary.collection_id in collection_ids
+
+        # We can update a secrets collection.
+        name = "Bunny Secrets"
+        description = "Secrets for bunny application"
+        summary = app.update_secrets_collection(
+            secrets_collection_id=summary.collection_id,
+            name=name,
+            description=description,
+        )
+        assert summary.name == name
+        assert summary.description == description
+
+        # We can start a run using the secrets collection.
+        input_data = {"name": "world", "radius": 6378, "distance": 147.6}
+        app.new_run(
+            input=input_data,
+            configuration=nextmv.RunConfiguration(
+                secrets_collection_id=summary.collection_id,
+            ),
+        )
+
+        # We can delete a secrets collection.
+        app.delete_secrets_collection(secrets_collection_id=summary.collection_id)
+
+    @needs(predecessors=[init_app, instances])
+    @step
+    def ensembles(app: cloud.Application, instances: tuple[cloud.Instance, cloud.Instance]) -> None:
+        """
+        Performs ensemble operations.
+
+        Parameters
+        ----------
+        app : cloud.Application
+            The application to perform ensemble operations on.
+        instances : tuple[cloud.Instance, cloud.Instance]
+            The instances to use for the ensemble definition.
+        """
+
+        inst1, _ = instances
+
+        # We can create an ensemble definition.
+        definition = app.new_ensemble_definition(
+            run_groups=[
+                cloud.RunGroup(
+                    id="run-group-1",
+                    instance_id=inst1.id,
+                ),
+            ],
+            rules=[
+                cloud.EvaluationRule(
+                    id="eval-rule-1",
+                    statistics_path="result.value",
+                    objective=cloud.RuleObjective.MAXIMIZE,
+                    tolerance=cloud.RuleTolerance(
+                        value=0.01,
+                        type=cloud.RuleToleranceType.ABSOLUTE,
+                    ),
+                    index=0,
+                ),
+            ],
+        )
+
+        # We can get an ensemble definition.
+        definition = app.ensemble_definition(ensemble_definition_id=definition.id)
+        assert definition is not None
+
+        # We can list ensemble definitions.
+        definitions = app.list_ensemble_definitions()
+        assert len(definitions) >= 1
+        definition_ids = {d.id for d in definitions}
+        assert definition.id in definition_ids
+
+        # We can update an ensemble definition.
+        name = "Bunny Ensemble"
+        description = "Ensemble for bunny runs"
+        definition = app.update_ensemble_definition(
+            id=definition.id,
+            name=name,
+            description=description,
+        )
+        assert definition.name == name
+        assert definition.description == description
+
+        # We can start an ensemble run.
+        input_data = {"name": "world", "radius": 6378, "distance": 147.6}
+        app.new_run(
+            input=input_data,
+            configuration=nextmv.RunConfiguration(
+                run_type=nextmv.RunTypeConfiguration(
+                    run_type=nextmv.RunType.ENSEMBLE,
+                    definition_id=definition.id,
+                ),
+            ),
+        )
+
+        # We can delete an ensemble definition.
+        app.delete_ensemble_definition(ensemble_definition_id=definition.id)
+
     # For this step, all other steps are predecessors to make sure there are no
     # on-going processes before cleanup.
     @needs(
@@ -534,6 +737,9 @@ class CloudIntegrationWorkflow(FlowSpec):
             scenario_tests,
             shadow_tests,
             switchback_tests,
+            acceptance_tests,
+            secrets,
+            ensembles,
         ]
     )
     @step
@@ -546,6 +752,9 @@ class CloudIntegrationWorkflow(FlowSpec):
         __unused2,
         __unused3,
         __unused4,
+        __unused5,
+        __unused6,
+        __unused7,
     ) -> None:
         """Performs cleanup operations."""
 

nextmv-1.0.0.dev6/nextmv/__about__.py

@@ -1 +0,0 @@
-__version__ = "v1.0.0.dev6"