feat: migrate code from googleapis/python-optimization

optimization/snippets/async_api.py

@@ -0,0 +1,59 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START cloudoptimization_async_api]
+
+from google.api_core.exceptions import GoogleAPICallError
+from google.cloud import optimization_v1
+
+# TODO(developer): Uncomment these variables before running the sample.
+# project_id= 'YOUR_PROJECT_ID'
+# request_file_name = 'YOUR_REQUEST_FILE_NAME'
+# request_model_gcs_path = 'gs://YOUR_PROJECT/YOUR_BUCKET/YOUR_REQUEST_MODEL_PATH'
+# model_solution_gcs_path = 'gs://YOUR_PROJECT/YOUR_BUCKET/YOUR_SOLUCTION_PATH'
+
+
+def call_async_api(
+    project_id: str, request_model_gcs_path: str, model_solution_gcs_path_prefix: str
+) -> None:
+    """Call the async api for fleet routing."""
+    # Use the default credentials for the environment to authenticate the client.
+    fleet_routing_client = optimization_v1.FleetRoutingClient()
+    request_file_name = "resources/async_request.json"
+
+    with open(request_file_name, "r") as f:
+        fleet_routing_request = optimization_v1.BatchOptimizeToursRequest.from_json(
+            f.read()
+        )
+        fleet_routing_request.parent = f"projects/{project_id}"
+        for idx, mc in enumerate(fleet_routing_request.model_configs):
+            mc.input_config.gcs_source.uri = request_model_gcs_path
+            model_solution_gcs_path = f"{model_solution_gcs_path_prefix}_{idx}"
+            mc.output_config.gcs_destination.uri = model_solution_gcs_path
+
+        # The timeout argument for the gRPC call is independent from the `timeout`
+        # field in the request's OptimizeToursRequest message(s).
+        operation = fleet_routing_client.batch_optimize_tours(fleet_routing_request)
+        print(operation.operation.name)
+
+        try:
+            # Block to wait for the job to finish.
+            result = operation.result()
+            print(result)
+            # Do you stuff.
+        except GoogleAPICallError:
+            print(operation.operation.error)
+
+
+# [END cloudoptimization_async_api]

optimization/snippets/async_api_test.py

@@ -0,0 +1,49 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import uuid
+
+import google.auth
+from google.cloud import storage
+import pytest
+
+import async_api
+
+
+# TODO(developer): Replace the variables in the file before use.
+# A sample request model can be found at resources/async_request_model.json.
+TEST_UUID = uuid.uuid4()
+BUCKET = f"optimization-ai-{TEST_UUID}"
+OUTPUT_PREFIX = f"code_snippets_test_output_{TEST_UUID}"
+INPUT_URI = "gs://cloud-samples-data/optimization-ai/async_request_model.json"
+BATCH_OUTPUT_URI_PREFIX = "gs://{}/{}/".format(BUCKET, OUTPUT_PREFIX)
+
+
+@pytest.fixture(autouse=True)
+def setup_teardown() -> None:
+    """Create a temporary bucket to store optimization output."""
+    storage_client = storage.Client()
+    bucket = storage_client.create_bucket(BUCKET)
+
+    yield
+
+    bucket.delete(force=True)
+
+
+def test_call_async_api(capsys: pytest.LogCaptureFixture) -> None:
+    _, project_id = google.auth.default()
+    async_api.call_async_api(project_id, INPUT_URI, BATCH_OUTPUT_URI_PREFIX)
+    out, _ = capsys.readouterr()
+
+    assert "operations" in out

optimization/snippets/get_operation.py

@@ -0,0 +1,34 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START cloudoptimization_get_operation]
+from google.cloud import optimization_v1
+
+
+def get_operation(operation_full_id: str) -> None:
+    """Get operation details and status."""
+    # TODO(developer): Uncomment and set the following variables
+    # operation_full_id = \
+    #     "projects/[projectId]/operations/[operationId]"
+
+    client = optimization_v1.FleetRoutingClient()
+    # Get the latest state of a long-running operation.
+    response = client.transport.operations_client.get_operation(operation_full_id)
+
+    print("Name: {}".format(response.name))
+    print("Operation details:")
+    print(response)
+
+
+# [END cloudoptimization_get_operation]

optimization/snippets/get_operation_test.py

@@ -0,0 +1,41 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import google.auth
+from google.cloud import optimization_v1
+import pytest
+
+import get_operation
+
+
+@pytest.fixture(scope="function")
+def operation_id() -> str:
+    fleet_routing_client = optimization_v1.FleetRoutingClient()
+
+    _, project_id = google.auth.default()
+    fleet_routing_request = {"parent": f"projects/{project_id}"}
+
+    # Make the request
+    operation = fleet_routing_client.batch_optimize_tours(fleet_routing_request)
+
+    yield operation.operation.name
+
+
+def test_get_operation_status(
+    capsys: pytest.LogCaptureFixture, operation_id: str
+) -> None:
+    get_operation.get_operation(operation_id)
+    out, _ = capsys.readouterr()
+    assert "Operation details" in out

optimization/snippets/noxfile_config.py

@@ -0,0 +1,42 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Default TEST_CONFIG_OVERRIDE for python repos.
+
+# You can copy this file into your directory, then it will be imported from
+# the noxfile.py.
+
+# The source of truth:
+# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
+
+TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+    "ignored_versions": ["2.7", "3.6"],
+    # Old samples are opted out of enforcing Python type hints
+    # All new samples should feature them
+    "enforce_type_hints": True,
+    # An envvar key for determining the project id to use. Change it
+    # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
+    # build specific Cloud project. You can also use your own string
+    # to use your own Cloud project.
+    "gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
+    # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
+    # If you need to use a specific version of pip,
+    # change pip_version_override to the string representation
+    # of the version number, for example, "20.2.4"
+    "pip_version_override": None,
+    # A dictionary you want to inject into your test. Don't put any
+    # secrets here. These values will override predefined values.
+    "envs": {},
+}

optimization/snippets/requirements-test.txt

@@ -0,0 +1,2 @@
+pytest==7.2.0
+

optimization/snippets/requirements.txt

@@ -0,0 +1,2 @@
+google-cloud-optimization==1.1.3
+google-cloud-storage==2.5.0

optimization/snippets/resources/async_request.json

@@ -0,0 +1,33 @@
+{
+    "parent": "projects/${YOUR_GCP_PROJECT_ID}",
+    "model_configs":[
+        {
+           "input_config":{
+              "gcs_source":{
+                 "uri":"${REQUEST_MODEL_GCS_PATH}"
+              },
+              "data_format":"JSON"
+           },
+           "output_config":{
+              "gcs_destination":{
+                 "uri":"${MODEL_SOLUTION_GCS_PATH}"
+              },
+              "data_format":"JSON"
+           }
+        },
+        {
+           "input_config":{
+              "gcs_source":{
+                 "uri":"${REQUEST_MODEL_GCS_PATH}"
+              },
+              "data_format":"JSON"
+           },
+           "output_config":{
+              "gcs_destination":{
+                 "uri":"${MODEL_SOLUTION_GCS_PATH}"
+              },
+              "data_format":"JSON"
+           }
+        }
+     ]
+  }

optimization/snippets/resources/async_request_model.json

@@ -0,0 +1,114 @@
+{
+    "parent":"${YOUR_GCP_PROJECT_ID}",
+    "allowLargeDeadlineDespiteInterruptionRisk":true,
+    "model":{
+       "shipments":[
+          {
+             "deliveries":[
+                {
+                   "arrivalLocation":{
+                      "latitude":48.880941999999997,
+                      "longitude":2.3238660000000002
+                   },
+                   "duration":"250s",
+                   "timeWindows":[
+                      {
+                         "endTime":"1970-01-01T01:06:40Z",
+                         "startTime":"1970-01-01T00:50:00Z"
+                      }
+                   ]
+                }
+             ],
+             "loadDemands": {
+               "weight": {
+                 "amount": "10"
+               }
+             },
+             "pickups":[
+                {
+                   "arrivalLocation":{
+                      "latitude":48.874507000000001,
+                      "longitude":2.3036099999999999
+                   },
+                   "duration":"150s",
+                   "timeWindows":[
+                      {
+                         "endTime":"1970-01-01T00:33:20Z",
+                         "startTime":"1970-01-01T00:16:40Z"
+                      }
+                   ]
+                }
+             ]
+          },
+          {
+             "deliveries":[
+                {
+                   "arrivalLocation":{
+                      "latitude":48.880940000000002,
+                      "longitude":2.3238439999999998
+                   },
+                   "duration":"251s",
+                   "timeWindows":[
+                      {
+                         "endTime":"1970-01-01T01:06:41Z",
+                         "startTime":"1970-01-01T00:50:01Z"
+                      }
+                   ]
+                }
+             ],
+             "loadDemands": {
+               "weight": {
+                 "amount": "20"
+               }
+             },
+             "pickups":[
+                {
+                   "arrivalLocation":{
+                      "latitude":48.880943000000002,
+                      "longitude":2.3238669999999999
+                   },
+                   "duration":"151s",
+                   "timeWindows":[
+                      {
+                         "endTime":"1970-01-01T00:33:21Z",
+                         "startTime":"1970-01-01T00:16:41Z"
+                      }
+                   ]
+                }
+             ]
+          }
+       ],
+       "vehicles":[
+          {
+             "loadLimits": {
+                "weight": {
+                  "maxLoad": 50
+                }
+             },
+             "endLocation":{
+                "latitude":48.863109999999999,
+                "longitude":2.341205
+             },
+             "startLocation":{
+                "latitude":48.863101999999998,
+                "longitude":2.3412039999999998
+             }
+          },
+          {
+             "loadLimits": {
+                "weight": {
+                  "maxLoad": 60
+                }
+             },
+             "endLocation":{
+                "latitude":48.863120000000002,
+                "longitude":2.341215
+             },
+             "startLocation":{
+                "latitude":48.863112000000001,
+                "longitude":2.3412139999999999
+             }
+          }
+       ]
+    }
+ }