REF: Rename project_name to project_id

BREAKING CHANGE: Swap the `project_name` argument with `project_id`

Author: cortadocodes

.github/workflows/python-ci.yml

@@ -58,8 +58,8 @@ jobs:
 
       - name: Run tests
         env:
-          TEST_PROJECT_NAME: ${{ secrets.TEST_PROJECT_NAME }}
-          GOOGLE_CLOUD_PROJECT: ${{ secrets.TEST_PROJECT_NAME }}
+          TEST_PROJECT_ID: ${{ secrets.TEST_PROJECT_ID }}
+          GOOGLE_CLOUD_PROJECT: ${{ secrets.TEST_PROJECT_ID }}
         run: tox -vv -e py
 
       - name: Upload coverage to Codecov

.github/workflows/release.yml

@@ -62,8 +62,8 @@ jobs:
 
       - name: Run tests
         env:
-          TEST_PROJECT_NAME: ${{ secrets.TEST_PROJECT_NAME }}
-          GOOGLE_CLOUD_PROJECT: ${{ secrets.TEST_PROJECT_NAME }}
+          TEST_PROJECT_ID: ${{ secrets.TEST_PROJECT_ID }}
+          GOOGLE_CLOUD_PROJECT: ${{ secrets.TEST_PROJECT_ID }}
         run: tox -vv -e py
 
       - name: Upload coverage to Codecov

README.md

@@ -86,7 +86,7 @@ Then run the tests to check everything's working.
 These environment variables need to be set to run the tests:
 
 - `GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/service/account/file.json`
-- `TEST_PROJECT_NAME=<name-of-google-cloud-project-to-run-pub-sub-tests-on>`
+- `TEST_PROJECT_ID=<id-of-google-cloud-project-to-run-pub-sub-tests-on>`
 
 Then, from the repository root, run
 

octue/cli.py

@@ -101,10 +101,10 @@ def ask():
 )
 @click.option(
     "-p",
-    "--project-name",
+    "--project-id",
     type=str,
     default=None,
-    help="The name of the Google Cloud project the service is deployed in. If not provided, the project name is "
+    help="The ID of the Google Cloud project the service is deployed in. If not provided, the project ID is "
     "detected from the local Google application credentials if present.",
 )
 @click.option(
@@ -122,7 +122,7 @@ def ask():
     "`OCTUE_SERVICE_CONFIGURATION_PATH` environment variable is used if present, otherwise the local path `octue.yaml` "
     "is used.",
 )
-def remote(sruid, input_values, input_manifest, project_name, asynchronous, service_config):
+def remote(sruid, input_values, input_manifest, project_id, asynchronous, service_config):
     """Ask a question to a remote Octue Twined service.
 
     SRUID should be a valid service revision unique identifier for an existing Octue Twined service e.g.
@@ -142,12 +142,12 @@ def remote(sruid, input_values, input_manifest, project_name, asynchronous, serv
     if input_manifest:
         input_manifest = Manifest.deserialise(input_manifest, from_string=True)
 
-    if not project_name:
-        _, project_name = auth.default()
+    if not project_id:
+        _, project_id = auth.default()
 
     child = Child(
         id=sruid,
-        backend={"name": "GCPPubSubBackend", "project_name": project_name},
+        backend={"name": "GCPPubSubBackend", "project_id": project_id},
         service_registries=service_registries,
     )
 
@@ -238,12 +238,12 @@ def local(input_values, input_manifest, attributes, service_config):
         backend = service_backends.get_backend(backend_configuration_values.pop("name"))(**backend_configuration_values)
     else:
         # If no backend details are provided, use Google Pub/Sub with the default project.
-        _, project_name = auth.default()
-        backend = service_backends.get_backend()(project_name=project_name)
+        _, project_id = auth.default()
+        backend = service_backends.get_backend()(project_id=project_id)
 
     answer = answer_question(
         question=question,
-        project_name=backend.project_name,
+        project_id=backend.project_id,
         service_configuration=service_configuration,
     )
 
@@ -555,11 +555,11 @@ def diagnostics(cloud_path, local_path, download_datasets):
 # @click.argument("question_uuid", type=str)
 # @click.option(
 #     "-p",
-#     "--project-name",
+#     "--project-id",
 #     type=str,
 #     default=None,
-#     help="If asking a remote question, the name of the Google Cloud project the service is deployed in. If not "
-#     "provided, the project name is detected from the local Google application credentials if present.",
+#     help="If asking a remote question, the ID of the Google Cloud project the service is deployed in. If not "
+#     "provided, the project ID is detected from the local Google application credentials if present.",
 # )
 # @click.option(
 #     "-c",
@@ -570,17 +570,17 @@ def diagnostics(cloud_path, local_path, download_datasets):
 #     "`OCTUE_SERVICE_CONFIGURATION_PATH` environment variable is used if present, otherwise the local path `octue.yaml` "
 #     "is used.",
 # )
-# def cancel(question_uuid, project_name, service_config):
+# def cancel(question_uuid, project_id, service_config):
 #     """Cancel a question running on an Octue Twined service.
 #
 #     QUESTION_UUID: The question UUID of a running question
 #     """
 #     service_configuration = ServiceConfiguration.from_file(path=service_config)
 #
-#     if not project_name:
-#         _, project_name = auth.default()
+#     if not project_id:
+#         _, project_id = auth.default()
 #
-#     child = Child(id=None, backend={"name": "GCPPubSubBackend", "project_name": project_name})
+#     child = Child(id=None, backend={"name": "GCPPubSubBackend", "project_id": project_id})
 #     child.cancel(question_uuid=question_uuid, event_store_table_id=service_configuration.event_store_table_id)
 
 
@@ -673,8 +673,8 @@ def start(service_config, revision_tag, timeout, no_rm):
         backend = service_backends.get_backend(backend_configuration_values.pop("name"))(**backend_configuration_values)
     else:
         # If no backend details are provided, use Google Pub/Sub with the default project.
-        _, project_name = auth.default()
-        backend = service_backends.get_backend()(project_name=project_name)
+        _, project_id = auth.default()
+        backend = service_backends.get_backend()(project_id=project_id)
 
     service = Service(service_id=service_sruid, backend=backend, run_function=run_function)
 

octue/cloud/emulators/_pub_sub.py

@@ -469,7 +469,7 @@ def __init__(self, request):
 
 def get_pub_sub_resource_name(path):
     """Get the Pub/Sub resource name of the topic or subscription (e.g. "octue.services.<uuid>") from its path (e.g.
-    "projects/<project-name>/topics/octue.services.<uuid>").
+    "projects/<project-id>/topics/octue.services.<uuid>").
 
     :param str path:
     :return str:

octue/cloud/events/answer_question.py

@@ -8,21 +8,21 @@
 logger = logging.getLogger(__name__)
 
 
-def answer_question(question, project_name, service_configuration):
+def answer_question(question, project_id, service_configuration):
     """Answer a question received by a service.
 
     :param dict question: a question event and its attributes
-    :param str project_name: the name of the project the service is running on
+    :param str project_id: the name of the project the service is running on
     :param octue.configuration.ServiceConfiguration service_configuration:
     :return dict: the result event
     """
     service_namespace, service_name, service_revision_tag = get_sruid_parts(service_configuration)
     service_sruid = create_sruid(namespace=service_namespace, name=service_name, revision_tag=service_revision_tag)
-    service = Service(service_id=service_sruid, backend=GCPPubSubBackend(project_name=project_name))
+    service = Service(service_id=service_sruid, backend=GCPPubSubBackend(project_id=project_id))
 
     runner = Runner.from_configuration(
         service_configuration=service_configuration,
-        project_name=project_name,
+        project_id=project_id,
         service_id=service_sruid,
     )
 

octue/cloud/pub_sub/service.py

@@ -107,7 +107,7 @@ def services_topic(self):
         :raise octue.exceptions.ServiceNotFound: if the topic doesn't exist in the project
         :return octue.cloud.pub_sub.topic.Topic: the Octue services topic for the project
         """
-        topic = Topic(name=OCTUE_SERVICES_TOPIC_NAME, project_name=self.backend.project_name)
+        topic = Topic(name=OCTUE_SERVICES_TOPIC_NAME, project_id=self.backend.project_id)
 
         if not topic.exists():
             raise octue.exceptions.ServiceNotFound(

octue/cloud/pub_sub/subscription.py

@@ -24,9 +24,9 @@ class Subscription:
     """A candidate subscription to use with Google Pub/Sub. The subscription represented by an instance of this class
     does not necessarily already exist on the Google Pub/Sub servers.
 
-    :param str name: the name of the subscription excluding "projects/<project_name>/subscriptions/<namespace>"
+    :param str name: the name of the subscription excluding "projects/<project_id>/subscriptions/<namespace>"
     :param octue.cloud.pub_sub.topic.Topic topic: the topic the subscription is attached to
-    :param str|None project_name: the name of the Google Cloud project that the subscription belongs to; if `None`, the project name of the topic is used
+    :param str|None project_id: the ID of the Google Cloud project that the subscription belongs to; if `None`, the project ID of the topic is used
     :param str|None filter: if provided, only receive messages matching the filter (see here for filter syntax: https://cloud.google.com/pubsub/docs/subscription-message-filter#filtering_syntax)
     :param int ack_deadline: the time in seconds after which, if the subscriber hasn't acknowledged a message, to retry sending it to the subscription
     :param int message_retention_duration: unacknowledged message retention time in seconds
@@ -42,7 +42,7 @@ def __init__(
         self,
         name,
         topic,
-        project_name=None,
+        project_id=None,
         filter=None,
         ack_deadline=600,
         message_retention_duration=600,
@@ -55,7 +55,7 @@ def __init__(
         self.name = name
         self.topic = topic
         self.filter = filter
-        self.path = self.generate_subscription_path(project_name or self.topic.project_name, self.name)
+        self.path = self.generate_subscription_path(project_id or self.topic.project_id, self.name)
         self.ack_deadline = ack_deadline
         self.message_retention_duration = Duration(seconds=message_retention_duration)
 
@@ -182,14 +182,14 @@ def exists(self, timeout=5):
             return False
 
     @staticmethod
-    def generate_subscription_path(project_name, subscription_name):
-        """Generate a full subscription path in the format `projects/<project_name>/subscriptions/<subscription_name>`.
+    def generate_subscription_path(project_id, subscription_name):
+        """Generate a full subscription path in the format `projects/<project_id>/subscriptions/<subscription_name>`.
 
-        :param str project_name:
+        :param str project_id:
         :param str subscription_name:
         :return str:
         """
-        return f"projects/{project_name}/subscriptions/{subscription_name}"
+        return f"projects/{project_id}/subscriptions/{subscription_name}"
 
     def _create_proto_message_subscription(self):
         """Create a Proto message subscription from the instance to be sent to the Pub/Sub API.

octue/cloud/pub_sub/topic.py

@@ -17,14 +17,14 @@ class Topic:
     called.
 
     :param str name: the name to give the topic
-    :param str project_name: the name of the GCP project the topic should exist in
+    :param str project_id: the name of the GCP project the topic should exist in
     :return None:
     """
 
-    def __init__(self, name, project_name):
+    def __init__(self, name, project_id):
         self.name = name
-        self.project_name = project_name
-        self.path = self.generate_topic_path(self.project_name, self.name)
+        self.project_id = project_id
+        self.path = self.generate_topic_path(self.project_id, self.name)
         self._created = False
 
     @cached_property
@@ -112,14 +112,14 @@ def exists(self, timeout=10):
         return False
 
     @staticmethod
-    def generate_topic_path(project_name, topic_name):
-        """Generate a full topic path in the format `projects/<project_name>/topics/<topic_name>`.
+    def generate_topic_path(project_id, topic_name):
+        """Generate a full topic path in the format `projects/<project_id>/topics/<topic_name>`.
 
-        :param str project_name:
+        :param str project_id:
         :param str topic_name:
         :return str:
         """
-        return f"projects/{project_name}/topics/{topic_name}"
+        return f"projects/{project_id}/topics/{topic_name}"
 
     def _log_creation(self):
         """Log the creation of the topic.

octue/cloud/storage/client.py

@@ -42,11 +42,11 @@ def __init__(self, credentials=OCTUE_MANAGED_CREDENTIALS):
         warnings.simplefilter("ignore", category=ResourceWarning)
 
         if credentials == OCTUE_MANAGED_CREDENTIALS:
-            self.credentials, self.project_name = auth.default()
+            self.credentials, self.project_id = auth.default()
         else:
             self.credentials = credentials
 
-        self.client = Client(project=self.project_name, credentials=self.credentials)
+        self.client = Client(project=self.project_id, credentials=self.credentials)
 
     def create_bucket(self, name, location=None, allow_existing=False, timeout=_DEFAULT_TIMEOUT):
         """Create a new bucket. If the bucket already exists, and `allow_existing` is `True`, do nothing; if it is

octue/resources/service_backends.py

@@ -39,20 +39,20 @@ class ServiceBackend(ABC):
 class GCPPubSubBackend(ServiceBackend):
     """A dataclass containing the details needed to use Google Cloud Pub/Sub as a Service backend.
 
-    :param str project_name: the name of the project to use for Pub/Sub
+    :param str project_id: the name of the project to use for Pub/Sub
     :return None:
     """
 
-    def __init__(self, project_name):
-        if project_name is None:
+    def __init__(self, project_id):
+        if project_id is None:
             raise exceptions.CloudLocationNotSpecified(
-                "`project_name` must be specified for a service to connect to the correct service - received None."
+                "`project_id` must be specified for a service to connect to the correct service - received None."
             )
 
-        self.project_name = project_name
+        self.project_id = project_id
 
     def __repr__(self):
-        return f"<{type(self).__name__}(project_name={self.project_name!r})>"
+        return f"<{type(self).__name__}(project_id={self.project_id!r})>"
 
 
 AVAILABLE_BACKENDS = {

octue/runner.py

@@ -46,7 +46,7 @@ class Runner:
     :param str|None output_location: the path to a cloud directory to save output datasets at
     :param bool use_signed_urls_for_output_datasets: if `True`, use signed URLs instead of cloud URIs for dataset paths in the output manifest
     :param str|None diagnostics_cloud_path: the path to a cloud directory to store diagnostics (this includes the configuration, input values and manifest, and logs for each question)
-    :param str|None project_name: name of Google Cloud project to get credentials from
+    :param str|None project_id: name of Google Cloud project to get credentials from
     :param str|None service_id: the ID of the service being run
     :param bool delete_local_files: if `True`, delete any files downloaded and registered temporary directories created during an analysis once it's finished
     :return None:
@@ -62,7 +62,7 @@ def __init__(
         output_location=None,
         use_signed_urls_for_output_datasets=False,
         diagnostics_cloud_path=None,
-        project_name=None,
+        project_id=None,
         service_id=None,
         service_registries=None,
         delete_local_files=False,
@@ -105,14 +105,14 @@ def __init__(
         self.service_id = service_id
         self.service_registries = service_registries
         self.delete_local_files = delete_local_files
-        self._project_name = project_name
+        self._project_id = project_id
 
     @classmethod
-    def from_configuration(cls, service_configuration, project_name=None, service_id=None, **overrides):
+    def from_configuration(cls, service_configuration, project_id=None, service_id=None, **overrides):
         """Instantiate a runner from a service configuration.
 
         :param octue.configuration.ServiceConfiguration service_configuration:
-        :param str|None project_name: name of Google Cloud project to get credentials from
+        :param str|None project_id: name of Google Cloud project to get credentials from
         :param str|None service_id: the ID of the service being run
         :param overrides: optional keyword arguments to override the `Runner` instantiation parameters extracted from the service configuration
         :return octue.runner.Runner: a runner configured with the given service configuration
@@ -126,7 +126,7 @@ def from_configuration(cls, service_configuration, project_name=None, service_id
             "output_location": service_configuration.output_location,
             "use_signed_urls_for_output_datasets": service_configuration.use_signed_urls_for_output_datasets,
             "diagnostics_cloud_path": service_configuration.diagnostics_cloud_path,
-            "project_name": project_name,
+            "project_id": project_id,
             "service_id": service_id,
             "service_registries": service_configuration.service_registries,
             "delete_local_files": service_configuration.delete_local_files,
@@ -287,15 +287,15 @@ def _populate_environment_with_google_cloud_secrets(self):
         if not missing_credentials:
             return
 
-        google_cloud_credentials, project_name = auth.default()
+        google_cloud_credentials, project_id = auth.default()
         secrets_client = secretmanager.SecretManagerServiceClient(credentials=google_cloud_credentials)
 
         if google_cloud_credentials is None:
-            project_name = self._project_name
+            project_id = self._project_id
 
         for credential in missing_credentials:
             secret_path = secrets_client.secret_version_path(
-                project=project_name,
+                project=project_id,
                 secret=credential["name"],
                 secret_version="latest",
             )

octue/templates/template-child-services/elevation_service/octue.yaml

@@ -4,4 +4,4 @@ services:
     configuration_values:
       backend:
         name: "GCPPubSubBackend"
-        project_name: "octue-sdk-python"
+        project_id: "octue-sdk-python"

octue/templates/template-child-services/elevation_service/twine.json

@@ -14,12 +14,12 @@
 						"type": "string",
 						"pattern": "^(GCPPubSubBackend)$"
 					},
-					"project_name": {
+					"project_id": {
 						"description": "Name of the Google Cloud Platform (GCP) project the service should exist in.",
 						"type": "string"
 					}
 				},
-				"required": ["name", "project_name"]
+				"required": ["name", "project_id"]
 			}
 		}
 	},