Rr 15 fix containerappclient (#17)

* container app client fix

* remove None option

* fix docstrings

* fix credential

* updated docs for containerappclient

* fix documentation

* updating start_job

* add stop_job function

* update container client and docs

* Update cfa/cloudops/_containerappclient.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* readme and changelog updates

* fixed docs

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: ryanraaschCDC

README.md

@@ -1,4 +1,5 @@
-![Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCDCgov%2Fcfa-cloudops%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.tool.poetry.version&style=plastic&label=version&color=lightgray)
+![Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCDCgov%2Fcfa-cloudops%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&query=project.version&style=plastic&logoColor=lightGray&label=version)
+
 ![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&style=plastic&link=https://raw.githubusercontent.com/CDCgov/cfa_azure/refs/heads/master/.pre-commit-config.yaml)
 ![pre-commit](https://github.com/CDCgov/cfa_azure/workflows/pre-commit/badge.svg?style=plastic&link=https://github.com/CDCgov/cfa-cloudops/actions/workflows/pre-commit.yaml)
 ![CI](https://github.com/CDCgov/cfa_azure/workflows/Python%20Unit%20Tests%20with%20Coverage/badge.svg?style=plastic&link=https://github.com/CDCgov/cfa-cloudops/actions/workflows/pre-commit.yaml&link=https://github.com/CDCgov/cfa-cloudops/actions/workflows/ci.yaml)

cfa/cloudops/_containerappclient.py

@@ -1,12 +1,14 @@
 import logging
 import os
 
+import dotenv
 from azure.identity import ManagedIdentityCredential
 from azure.mgmt.appcontainers import ContainerAppsAPIClient
 from azure.mgmt.appcontainers.models import (
     JobExecutionContainer,
     JobExecutionTemplate,
 )
+from azure.mgmt.resource import SubscriptionClient
 
 logger = logging.getLogger(__name__)
 
@@ -22,6 +24,7 @@ class ContainerAppClient:
 
     def __init__(
         self,
+        dotenv_path=None,
         resource_group=None,
         subscription_id=None,
         job_name=None,
@@ -30,13 +33,22 @@ def __init__(
         Initialize a ContainerAppClient for Azure Container Apps jobs.
 
         Args:
+            dotenv_path (str, optional): Path to a .env file to load environment variables.
             resource_group (str, optional): Azure resource group name. If None, uses env var AZURE_RESOURCE_GROUP_NAME.
             subscription_id (str, optional): Azure subscription ID. If None, uses env var AZURE_SUBSCRIPTION_ID.
-            job_name (str, optional): Default job name for operations.
+            job_name (str, optional): Job name for Container App Job.
 
         Raises:
             ValueError: If required parameters are missing and not set in environment variables.
         """
+        self.credential = ManagedIdentityCredential()
+        dotenv.load_dotenv(dotenv_path)
+        sub_c = SubscriptionClient(self.credential)
+        # pull in account info and save to environment vars
+        account_info = list(sub_c.subscriptions.list())[0]
+        os.environ["AZURE_SUBSCRIPTION_ID"] = account_info.subscription_id
+        os.environ["AZURE_TENANT_ID"] = account_info.tenant_id
+        os.environ["AZURE_RESOURCE_GROUP_NAME"] = account_info.display_name
         if resource_group is None:
             resource_group = os.getenv("AZURE_RESOURCE_GROUP_NAME")
             if resource_group is None:
@@ -52,14 +64,13 @@ def __init__(
                 )
         self.subscription_id = subscription_id
         self.job_name = job_name
-        self.credential = ManagedIdentityCredential()
 
         self.client = ContainerAppsAPIClient(
             credential=self.credential, subscription_id=subscription_id
         )
         logger.debug("client initialized.")
 
-    def get_job_info(self, job_name):
+    def get_job_info(self, job_name: str | None = None):
         """
         Retrieve detailed information about a specific Container App job.
 
@@ -69,12 +80,18 @@ def get_job_info(self, job_name):
         Returns:
             dict: Dictionary containing job details.
         """
+        if job_name is None:
+            if self.job_name is None:
+                raise ValueError("Please specify a job name.")
+            else:
+                job_name = self.job_name
+
         for i in self.client.jobs.list_by_resource_group(self.resource_group):
             if i.name == job_name:
                 job_info = i
         return job_info.as_dict()
 
-    def get_command_info(self, job_name):
+    def get_command_info(self, job_name: str | None = None):
         """
         Get command, image, and environment details for containers in a job.
 
@@ -84,6 +101,12 @@ def get_command_info(self, job_name):
         Returns:
             list[dict]: List of container info dicts (name, image, command, args, env).
         """
+        if job_name is None:
+            if self.job_name is None:
+                raise ValueError("Please specify a job name.")
+            else:
+                job_name = self.job_name
+
         for i in self.client.jobs.list_by_resource_group(self.resource_group):
             if i.name == job_name:
                 job_info = i
@@ -115,7 +138,7 @@ def list_jobs(self):
         ]
         return job_list
 
-    def check_job_exists(self, job_name):
+    def check_job_exists(self, job_name: str):
         """
         Check if a Container App job exists in the resource group.
 
@@ -133,10 +156,10 @@ def check_job_exists(self, job_name):
 
     def start_job(
         self,
-        job_name: str = None,
-        command: list[str] = None,
-        args: list[str] = None,
-        env: list[str] = None,
+        job_name: str | None = None,
+        command: list[str] | None = None,
+        args: list[str] | None = None,
+        env: list[str] | None = None,
     ):
         """
         Start a Container App job, optionally overriding command, args, or environment.
@@ -189,8 +212,41 @@ def start_job(
                 new_containers.append(container)
             t = JobExecutionTemplate(containers=new_containers)
             logger.debug("submitting job start request.")
-            self.client.jobs.begin_start(
+            try:
+                self.client.jobs.begin_start(
+                    resource_group_name=self.resource_group,
+                    job_name=job_name,
+                    template=t,
+                )
+                print(f"Started job {job_name}.")
+            except Exception as e:
+                logger.error(f"Failed to start job {job_name}: {e}")
+                raise
+
+    def stop_job(self, job_name: str, job_execution_name: str):
+        """
+        Stop a specific execution of an Azure Container App Job.
+
+        Args:
+            job_name (str): Name of the Container App Job.
+            job_execution_name (str): Name of the job execution to stop.
+
+        Returns:
+            Any: Response object from the Azure SDK if successful, or None if an error occurs.
+
+        Raises:
+            Exception: If the stop operation fails.
+        """
+        try:
+            response = self.client.jobs.begin_stop_execution(
                 resource_group_name=self.resource_group,
                 job_name=job_name,
-                template=t,
+                job_execution_name=job_execution_name,
+            ).result()
+            logger.info(
+                f"Job execution '{job_execution_name}' for job '{job_name}' stopped successfully."
             )
+            return response
+        except Exception as e:
+            logger.error(f"Error stopping job execution: {e}")
+            return None

changelog.md

@@ -8,6 +8,11 @@ The versioning pattern is `major.minor.patch`.
 
 ---
 
+## v0.0.2
+
+- Updated ContainerAppClient
+- New documentation for ContainerAppClient
+
 ## v0.0.1
 
 - Added CloudClient, ContainerAppClient, and other modules

docs/ContainerAppClient/index.md

@@ -0,0 +1,93 @@
+# ContainerAppClient Overview
+
+The `ContainerAppClient` class provides a Python interface for managing Azure Container Apps jobs using the Azure SDK. It supports inspection, listing, existence checks, and starting jobs with custom commands and environment variables.
+
+## Features
+- Authenticate using Azure Managed Identity and environment variables
+- List all jobs in a resource group
+- Retrieve detailed job information
+- Inspect container commands, images, and environment variables
+- Check if a job exists
+- Start jobs with custom commands, arguments, and environment variables
+- Stop a running container app job
+
+## Setup
+
+1. **Install dependencies**
+   - The ContainerAppClient is available in the `cfa-cloudops` package. Install the package by executing the following code in your terminal.
+
+   ```bash
+   pip install git+https://github.com/CDCgov/cfa-cloudops.git
+   ```
+
+2. **Environment variables**
+   - The client uses Managed Identity credentialing by default, which can then pull in the subscription ID, resource group name, and tenant Id.
+   - It's possible to pass in specific variables or use environment variables for Azure authentication:
+     - `AZURE_SUBSCRIPTION_ID`
+     - `AZURE_RESOURCE_GROUP_NAME`
+     - `AZURE_TENANT_ID`
+   - You can use a `.env` file and pass its path to the client, or set these variables manually.
+
+## Usage Example
+
+```python
+from cfa.cloudops import ContainerAppClient
+
+# Simplest instantiation using Managed Identity
+client = ContainerAppClient()
+
+# Initialize the client (dotenv_path is optional)
+client = ContainerAppClient(dotenv_path=".env", resource_group="my-rg", subscription_id="xxxx-xxxx", job_name="my-job")
+
+# List all jobs in the resource group
+jobs = client.list_jobs()
+print("Jobs:", jobs)
+
+# Check if a job exists
+exists = client.check_job_exists("my-job")
+print("Job exists:", exists)
+
+# Get job information
+info = client.get_job_info("my-job")
+print("Job info:", info)
+
+# Get command and environment info for containers in a job
+cmd_info = client.get_command_info("my-job")
+print("Command info:", cmd_info)
+
+# Start a job (optionally override command, args, env)
+client.start_job(
+    job_name="my-job",
+    command=["python", "main.py"],
+    args=["--input", "data.csv"],
+    env=[{"name": "ENV_VAR", "value": "value"}]
+)
+
+# Stop a job
+client.stop_job(
+    job_name="my-job",
+    job_execution_name="my-job-xxxxxxx"
+)
+```
+
+## Method Reference
+
+- `__init__(dotenv_path, resource_group, subscription_id, job_name)`
+  - Initializes the client and loads environment variables.
+- `list_jobs()`
+  - Returns a list of job names in the resource group.
+- `check_job_exists(job_name)`
+  - Returns `True` if the job exists, `False` otherwise.
+- `get_job_info(job_name)`
+  - Returns a dictionary of job details.
+- `get_command_info(job_name)`
+  - Returns a list of container info dicts (name, image, command, args, env).
+- `start_job(job_name, command, args, env)`
+  - Starts a job, optionally overriding command, args, and environment variables.
+- `stop_job(job_name, job_execution_name)`
+  - Stops the specified job execution.
+
+## Notes
+- The client uses Azure Managed Identity for authentication. Ensure your environment supports this (e.g., Azure VM, App Service, or configure credentials).
+- If you do not provide `resource_group`, `subscription_id`, or `job_name`, the client will attempt to use environment variables or values from the `.env` file.
+- All operations are logged using Python's `logging` module for easier debugging.

docs/index.md

@@ -2,6 +2,7 @@
 
 - [Overview](./overview.md)
 - [CloudClient](./CloudClient/index.md)
+- [ContainerAppClient](./ContainerAppClient/index.md)
 - [Automation](./automation.md)
 - [Local Execution](./local.md)
 - [Modules](./modules.md)

mkdocs.yml

@@ -5,6 +5,7 @@ nav:
   - Overview: overview.md
   - Automation: automation.md
   - CloudClient: CloudClient/index.md
+  - ContainerAppClient: ContainerAppClient/index.md
   - Local Execution: local.md
   - Modules: modules.md
   - Sample Files: files/index.md

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cfa.cloudops"
-version = "0.0.1"
+version = "0.0.2"
 description = "Cloud storage, batch, functions, MLOps assistance"
 authors = [
     {name = "Ryan Raasch", email = "xng3@cdc.gov"}