chore(api)!: rename jobsRunAs to jobRunAsUser (#41)

Signed-off-by: Morgan Epp <[email protected]>
Signed-off-by: Graeme McHale <[email protected]>
Signed-off-by: Gahyun Suh <[email protected]>

src/deadline_worker_agent/api_models.py

@@ -240,7 +240,7 @@ class PosixUser(TypedDict):
     """The posix group name associated with session file ownership"""
 
 
-class JobsRunAs(TypedDict):
+class JobRunAsUser(TypedDict):
     posix: PosixUser
     # TODO: windows support
 
@@ -249,7 +249,11 @@ class JobDetailsData(JobDetailsIdentifierFields):
     jobAttachmentSettings: NotRequired[JobAttachmentQueueSettings]
     """The queue's job attachment settings"""
 
-    jobsRunAs: NotRequired[JobsRunAs | None]
+    # TODO: remove once service no longer sends this
+    jobsRunAs: NotRequired[JobRunAsUser | None]
+    """Deprecated: The queue's info on how to run the job processes (ie. posix user/group)"""
+
+    jobRunAsUser: NotRequired[JobRunAsUser | None]
     """The queue's info on how to run the job processes (ie. posix user/group)"""
 
     logGroupName: str

src/deadline_worker_agent/boto/shim.py

@@ -254,7 +254,14 @@ def batch_get_job_entity(
                                 "rootPrefix": "my-queue",
                             },
                             "logGroupName": "/aws/deadline/queue-abc",
+                            # TODO: remove once service no longer sends this
                             "jobsRunAs": {
+                                "posix": {
+                                    "user": "",
+                                    "group": "",
+                                }
+                            },
+                            "jobRunAsUser": {
                                 "posix": {
                                     "user": "job-user",
                                     "group": "job-group",

src/deadline_worker_agent/scheduler/scheduler.py

@@ -704,11 +704,11 @@ def _create_new_sessions(
             logger.debug(f"[{new_session_id}] Assigned actions")
 
             os_user: Optional[SessionUser] = None
-            if job_details.jobs_run_as and not self._impersonation.inactive:
+            if job_details.job_run_as_user and not self._impersonation.inactive:
                 if os.name != "posix":
                     # TODO: windows support
                     raise NotImplementedError(f"{os.name} is not supported")
-                os_user = job_details.jobs_run_as.posix
+                os_user = job_details.job_run_as_user.posix
 
             if self._impersonation.posix_job_user is not None:
                 os_user = self._impersonation.posix_job_user

src/deadline_worker_agent/sessions/job_entities/job_details.py

@@ -20,7 +20,7 @@
     IntParameter,
     JobDetailsData,
     JobAttachmentQueueSettings as JobAttachmentSettingsBoto,
-    JobsRunAs as JobsRunAsModel,
+    JobRunAsUser as JobRunAsUserModel,
     PathMappingRule,
     PathParameter,
     StringParameter,
@@ -84,31 +84,31 @@ def path_mapping_api_model_to_openjd(
     return rules
 
 
-def jobs_runs_as_api_model_to_worker_agent(
-    jobs_run_as_data: JobsRunAsModel | None,
-) -> JobsRunAs | None:
-    """Converts the 'JobsRunAs' api model to the 'JobsRunAs' dataclass
+def job_run_as_user_api_model_to_worker_agent(
+    job_run_as_user_data: JobRunAsUserModel | None,
+) -> JobRunAsUser | None:
+    """Converts the 'JobRunAsUser' api model to the 'JobRunAsUser' dataclass
     expected by the Worker Agent.
     """
-    jobs_run_as: JobsRunAs | None = None
-    if not jobs_run_as_data:
+    job_run_as_user: JobRunAsUser | None = None
+    if not job_run_as_user_data:
         return None
 
     if os.name == "posix":
-        jobs_run_as_posix = jobs_run_as_data.get("posix", {})
-        user = jobs_run_as_posix.get("user", "")
-        group = jobs_run_as_posix.get("group", "")
+        job_run_as_user_posix = job_run_as_user_data.get("posix", {})
+        user = job_run_as_user_posix.get("user", "")
+        group = job_run_as_user_posix.get("group", "")
         if not (user and group):
             return None
 
-        jobs_run_as = JobsRunAs(
+        job_run_as_user = JobRunAsUser(
             posix=PosixSessionUser(user=user, group=group),
         )
     else:
         # TODO: windows support
         raise NotImplementedError(f"{os.name} is not supported")
 
-    return jobs_run_as
+    return job_run_as_user
 
 
 @dataclass(frozen=True)
@@ -130,7 +130,7 @@ def from_boto(cls, data: JobAttachmentSettingsBoto) -> JobAttachmentSettings:
 
 
 @dataclass(frozen=True)
-class JobsRunAs:
+class JobRunAsUser:
     posix: PosixSessionUser
     # TODO: windows support
 
@@ -154,7 +154,7 @@ class JobDetails:
     parameters: list[Parameter] = field(default_factory=list)
     """The job's parameters"""
 
-    jobs_run_as: JobsRunAs | None = None
+    job_run_as_user: JobRunAsUser | None = None
     """The user associated with the job's Amazon Deadline Cloud queue"""
 
     path_mapping_rules: list[OPENJDPathMappingRule] = field(default_factory=list)
@@ -189,8 +189,13 @@ def from_boto(cls, job_details_data: JobDetailsData) -> JobDetails:
         if job_attachment_settings_boto := job_details_data.get("jobAttachmentSettings", None):
             job_attachment_settings = JobAttachmentSettings.from_boto(job_attachment_settings_boto)
 
-        jobs_run_as_data = job_details_data.get("jobsRunAs", None)
-        jobs_run_as: JobsRunAs | None = jobs_runs_as_api_model_to_worker_agent(jobs_run_as_data)
+        # Use jobRunAsUser if it exists, otherwise jobsRunAs if it exists, otherwise None.
+        job_run_as_user_data = job_details_data.get(
+            "jobRunAsUser", job_details_data.get("jobsRunAs", None)
+        )
+        job_run_as_user: JobRunAsUser | None = job_run_as_user_api_model_to_worker_agent(
+            job_run_as_user_data
+        )
 
         # Note: Record the empty string as a None as well.
         queue_role_arn: str | None = (
@@ -208,7 +213,7 @@ def from_boto(cls, job_details_data: JobDetailsData) -> JobDetails:
             parameters=job_parameters,
             schema_version=schema_version,
             log_group_name=job_details_data["logGroupName"],
-            jobs_run_as=jobs_run_as,
+            job_run_as_user=job_run_as_user,
             path_mapping_rules=path_mapping_rules,
             job_attachment_settings=job_attachment_settings,
             queue_role_arn=queue_role_arn,
@@ -252,6 +257,7 @@ def validate_entity_data(cls, entity_data: dict[str, Any]) -> JobDetailsData:
                     expected_type=list,
                     required=False,
                 ),
+                # TODO: remove jobsRunAs once service no longer responds with jobsRunAs
                 Field(
                     key="jobsRunAs",
                     expected_type=dict,
@@ -268,6 +274,22 @@ def validate_entity_data(cls, entity_data: dict[str, Any]) -> JobDetailsData:
                         ),
                     ),
                 ),
+                Field(
+                    key="jobRunAsUser",
+                    expected_type=dict,
+                    required=False,
+                    fields=(
+                        Field(
+                            key="posix",
+                            expected_type=dict,
+                            required=False,
+                            fields=(
+                                Field(key="user", expected_type=str, required=True),
+                                Field(key="group", expected_type=str, required=True),
+                            ),
+                        ),
+                    ),
+                ),
                 Field(
                     key="jobAttachmentSettings",
                     expected_type=dict,

test/unit/conftest.py

@@ -27,7 +27,7 @@
 from deadline_worker_agent.sessions.job_entities.job_details import (
     JobAttachmentSettings,
     JobDetails,
-    JobsRunAs,
+    JobRunAsUser,
 )
 from deadline_worker_agent.sessions.job_entities.job_attachment_details import (
     JobAttachmentDetails,
@@ -238,12 +238,12 @@ def job_parameters() -> list[Parameter]:
 
 
 @pytest.fixture
-def jobs_run_as() -> JobsRunAs | None:
+def job_run_as_user() -> JobRunAsUser | None:
     """The OS user/group associated with the job's queue"""
     # TODO: windows support
     if os.name != "posix":
         raise NotImplementedError(f"{os.name} is not supported")
-    return JobsRunAs(posix=PosixSessionUser(user="job-user", group="job-user"))
+    return JobRunAsUser(posix=PosixSessionUser(user="job-user", group="job-user"))
 
 
 @pytest.fixture
@@ -257,14 +257,14 @@ def job_details(
     queue_job_attachment_settings: JobAttachmentSettings,
     job_parameters: list[Parameter],
     log_group_name: str,
-    jobs_run_as: JobsRunAs | None,
+    job_run_as_user: JobRunAsUser | None,
     path_mapping_rules: list[PathMappingRule],
     schema_version: SchemaVersion,
 ) -> JobDetails:
     return JobDetails(
         job_attachment_settings=queue_job_attachment_settings,
         parameters=job_parameters,
-        jobs_run_as=jobs_run_as,
+        job_run_as_user=job_run_as_user,
         path_mapping_rules=path_mapping_rules,
         log_group_name=log_group_name,
         schema_version=schema_version,