opsmith-cli 0.1.2a0__py3-none-any.whl

opsmith/agent.py

@@ -0,0 +1,243 @@
+import json
+import os
+import shutil
+import subprocess
+import tempfile
+import uuid  # Added for unique naming
+from dataclasses import dataclass
+from pathlib import Path
+from typing import List, Literal
+
+from pydantic import BaseModel
+from pydantic_ai import Agent, ModelRetry, RunContext
+
+
+class ModelConfig(BaseModel):
+    provider: Literal["openai", "anthropic", "google-gla"]
+    model: str
+    api_key_prefix: str
+
+    @property
+    def model_name_abs(self):
+        return f"{self.provider}:{self.model}"
+
+    @property
+    def api_key_env_var(self):
+        return f"{self.api_key_prefix}_API_KEY"
+
+    def ensure_auth(self, api_key: str):
+        os.environ[self.api_key_env_var] = api_key.strip()
+
+
+AVAILABLE_MODELS = [
+    ModelConfig(provider="openai", model="gpt-4.1", api_key_prefix="OPENAI"),
+    ModelConfig(
+        provider="anthropic", model="claude-3-7-sonnet-20250219", api_key_prefix="ANTHROPIC"
+    ),
+    ModelConfig(provider="anthropic", model="claude-sonnet-4-20250514", api_key_prefix="ANTHROPIC"),
+    ModelConfig(
+        provider="google-gla", model="gemini-2.5-pro-preview-05-06", api_key_prefix="GEMINI"
+    ),
+    ModelConfig(
+        provider="google-gla", model="gemini-2.5-pro-preview-06-05", api_key_prefix="GEMINI"
+    ),
+]
+
+AVAILABLE_MODELS_XREF = {model.model_name_abs: model for model in AVAILABLE_MODELS}
+
+
+@dataclass
+class AgentDeps:
+    src_dir: Path
+
+
+def is_duplicate_tool_call(ctx: RunContext[AgentDeps], tool_name: str) -> bool:
+    """"""
+    tool_calls = set()
+    message_parts = [item for message in ctx.messages for item in message.parts]
+    for part in message_parts:
+        if part.part_kind == "tool-call" and part.tool_name == tool_name:
+            if isinstance(part.args, dict):
+                tool_args = json.dumps(part.args, sort_keys=True)
+            else:
+                tool_args = part.args
+            if tool_args in tool_calls:
+                return True
+            else:
+                # logger.debug(f"Tool {tool_def.name} called with arguments: {tool_args}")
+                tool_calls.add(tool_args)
+
+    return False
+
+
+def build_agent(model_config: ModelConfig, instrument: bool = False) -> Agent:
+    agent = Agent(
+        model=model_config.model_name_abs,
+        # instructions=SYSTEM_PROMPT,
+        instrument=instrument,
+        deps_type=AgentDeps,
+    )
+
+    @agent.tool(retries=5)
+    def read_file_content(ctx: RunContext[AgentDeps], filenames: List[str]) -> List[str]:
+        """
+        Reads and returns the content of specified files from the repository.
+        Use this to understand file structures, dependencies, or specific configurations.
+        Provide the relative file paths from the repository root.
+
+        Args:
+            ctx: The run context object containing the dependencies of the agent.
+            filenames: A list of relative paths to the files from the repository root.
+
+        Returns:
+            A list of strings, where each string is the content of the corresponding file.
+            The order of contents in the list matches the order of filenames in the input.
+        """
+        if is_duplicate_tool_call(ctx, "read_file_content"):
+            raise ModelRetry(
+                "The tool 'read_file_content' has already been called with the exact same list of "
+                "files in this conversation."
+            )
+
+        contents = []
+        for filename in filenames:
+            if Path(filename).is_absolute():
+                raise ModelRetry(
+                    f"Absolute file paths are not allowed for '{filename}'. Please provide a"
+                    " relative path."
+                )
+
+            absolute_file_path = ctx.deps.src_dir.joinpath(filename).resolve()
+
+            if not str(absolute_file_path).startswith(str(ctx.deps.src_dir)):
+                raise ModelRetry(
+                    f"Access denied. File '{filename}' is outside the repository root."
+                )
+
+            if not absolute_file_path.is_file():
+                raise ModelRetry(f"File '{filename}' not found or is not a regular file.")
+
+            with open(absolute_file_path, "r", encoding="utf-8", errors="ignore") as f:
+                content = f.read()
+            contents.append(content)
+        return contents
+
+    @agent.tool(retries=3)
+    def build_dockerfile(
+        ctx: RunContext[AgentDeps],
+        dockerfile_content: str,
+    ) -> str:
+        """
+        Writes the provided Dockerfile content to a temporary file, then attempts to build a Docker image
+        using that Dockerfile and the repository root as the build context.
+        If the build is successful, it attempts to run the built image with a short timeout.
+        Returns the combined output (stdout and stderr) of the 'docker build' and 'docker run' commands.
+
+        Use this tool to validate a generated Dockerfile.
+        - If the build fails, analyze the build output, revise the Dockerfile content, and call this tool again.
+        - If the build succeeds but the image run fails due to issues like missing packages or invalid commands
+          (ignoring errors related to missing environment variables or connection issues),
+          analyze the run output, revise the Dockerfile, and call this tool again.
+
+        Args:
+            ctx: The run context object.
+            dockerfile_content: The string content of the Dockerfile to be built and run.
+
+        Returns:
+            A string containing the combined stdout and stderr from the 'docker build'
+            and 'docker run' commands. If 'docker' command is not found, an error message is returned.
+        """
+        repo_root = ctx.deps.src_dir.resolve()
+        image_tag = f"opsmith-build-test-{uuid.uuid4()}"
+        build_output_str = ""
+
+        # Check if docker command is available
+        if not shutil.which("docker"):
+            raise ModelRetry(
+                "Error: Docker command not found. Please ensure Docker is installed and in your"
+                " PATH."
+            )
+
+        try:
+            # Create temporary directory for Dockerfile
+            with tempfile.TemporaryDirectory() as temp_dir:
+                temp_dockerfile = Path(temp_dir) / "Dockerfile"
+                # Write Dockerfile content
+                with open(temp_dockerfile, "w", encoding="utf-8") as f:
+                    f.write(dockerfile_content)
+
+                # Execute docker build command
+                build_process = subprocess.run(
+                    [
+                        "docker",
+                        "build",
+                        "-f",
+                        str(temp_dockerfile),
+                        "-t",
+                        image_tag,
+                        str(repo_root),
+                    ],
+                    capture_output=True,
+                    text=True,
+                )
+                build_output_str = (
+                    f"Build Output (stdout):\n{build_process.stdout}\nBuild Output"
+                    f" (stderr):\n{build_process.stderr}"
+                )
+
+                if build_process.returncode != 0:
+                    # Build failed, instruct LLM to retry with build output
+                    raise ModelRetry(
+                        "Dockerfile build failed. Analyze the following output and revise the"
+                        f" Dockerfile:\n{build_output_str}"
+                    )
+
+            # Build successful, now try to run the image
+            # Using --rm to automatically remove the container when it exits.
+            run_process = subprocess.run(
+                [
+                    "docker",
+                    "run",
+                    "--rm",
+                    image_tag,
+                ],  # Removed explicit container name as --rm handles it
+                capture_output=True,
+                text=True,
+                timeout=30,  # Timeout for the run command to prevent indefinite hangs
+            )
+            run_output_str = (
+                f"Run Output (stdout):\n{run_process.stdout}\nRun Output"
+                f" (stderr):\n{run_process.stderr}"
+            )
+
+            if run_process.returncode != 0:
+                # Run failed. Raise ModelRetry with the run output for the LLM to analyze.
+                # The LLM will decide if the error is due to the Dockerfile or an ignorable runtime issue.
+                raise ModelRetry(
+                    "Dockerfile built successfully, but running the image failed. Analyze the"
+                    " following run output to determine if the Dockerfile needs revision (e.g.,"
+                    " for missing packages, command errors) or if the error is ignorable (e.g.,"
+                    " missing environment variables, connection issues).\n\nRun"
+                    f" Output:\n{run_output_str}\n\nOriginal Build Output was:\n{build_output_str}"
+                )
+        finally:
+            # Clean up image
+            if image_tag:  # ensure image_tag was set before trying to remove
+                cleanup_image_process = subprocess.run(
+                    ["docker", "rmi", "-f", image_tag], capture_output=True, text=True
+                )
+                if (
+                    cleanup_image_process.returncode != 0
+                    and "no such image" not in cleanup_image_process.stderr.lower()
+                ):
+                    # Log or handle image removal failure if necessary, but don't fail the tool for this
+                    # This could happen if the build failed before the image was tagged,
+                    # or if another process removed it.
+                    print(
+                        f"Warning: Failed to remove Docker image {image_tag}:"
+                        f" {cleanup_image_process.stderr.strip()}"
+                    )
+
+        return f"{build_output_str}\n\n{run_output_str}".strip()
+
+    return agent

opsmith/cloud_providers/__init__.py

@@ -0,0 +1,10 @@
+from typing import Dict, Type
+
+from .aws import AWSProvider
+from .base import BaseCloudProvider, CloudProviderEnum
+from .gcp import GCPProvider
+
+CLOUD_PROVIDER_REGISTRY: Dict[CloudProviderEnum, Type[BaseCloudProvider]] = {
+    CloudProviderEnum.AWS: AWSProvider,
+    CloudProviderEnum.GCP: GCPProvider,
+}

opsmith/cloud_providers/aws.py

@@ -0,0 +1,46 @@
+import boto3
+from botocore.exceptions import ClientError, NoCredentialsError
+
+from opsmith.cloud_providers.base import (
+    AWSCloudDetail,
+    BaseCloudProvider,
+    CloudCredentialsError,
+    CloudProviderEnum,
+)
+
+
+class AWSProvider(BaseCloudProvider):
+    """AWS cloud provider implementation."""
+
+    def get_account_details(self) -> AWSCloudDetail:
+        """
+        Retrieves structured AWS account details.
+        """
+        try:
+            sts_client = boto3.client("sts")
+            identity = sts_client.get_caller_identity()
+            account_id = identity.get("Account")
+            if not account_id:
+                raise CloudCredentialsError(
+                    message=(
+                        "AWS account ID could not be determined. This might indicate an issue with"
+                        " the credentials or permissions."
+                    ),
+                    help_url="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html",
+                )
+            return AWSCloudDetail(name=CloudProviderEnum.AWS.name, account_id=account_id)
+        except (NoCredentialsError, ClientError) as e:
+            raise CloudCredentialsError(
+                message=f"AWS credentials error: {e}",
+                help_url=(
+                    "https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html"
+                ),
+            )
+        except Exception as e:
+            # Catching other unexpected exceptions during AWS interaction
+            raise CloudCredentialsError(
+                message=f"An unexpected error occurred while fetching AWS account details: {e}",
+                help_url=(
+                    "https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html"
+                ),
+            )

opsmith/cloud_providers/base.py

@@ -0,0 +1,57 @@
+import abc
+import enum
+from typing import Literal, Union
+
+from pydantic import BaseModel, Field
+
+
+class CloudProviderEnum(enum.Enum):
+    AWS = "AWS"
+    GCP = "GCP"
+
+
+class AWSCloudDetail(BaseModel):
+    name: Literal[CloudProviderEnum.AWS.name] = Field(
+        default=CloudProviderEnum.AWS.name, description="Provider name, 'aws'"
+    )
+    account_id: str = Field(..., description="AWS Account ID.")
+
+
+class GCPCloudDetail(BaseModel):
+    name: Literal[CloudProviderEnum.GCP.name] = Field(
+        default=CloudProviderEnum.GCP.name, description="Provider name, 'gcp'"
+    )
+    project_id: str = Field(..., description="GCP Project ID.")
+
+
+CloudProviderDetail = Union[AWSCloudDetail, GCPCloudDetail]
+
+
+class CloudCredentialsError(Exception):
+    """Custom exception for cloud credential errors."""
+
+    def __init__(self, message: str, help_url: str):
+        self.message = message
+        self.help_url = help_url
+        super().__init__(
+            f"{self.message}\nPlease ensure your credentials are set up correctly. For more"
+            f" information, visit: {self.help_url}"
+        )
+
+
+class BaseCloudProvider(abc.ABC):
+    """Abstract base class for cloud providers."""
+
+    def __init__(self, *args, **kwargs):
+        """
+        Initializes the cloud provider.
+        Subclasses should implement specific authentication and setup.
+        """
+        pass
+
+    @abc.abstractmethod
+    def get_account_details(self) -> CloudProviderDetail:
+        """
+        Retrieves structured account details for the cloud provider.
+        """
+        raise NotImplementedError

opsmith/cloud_providers/gcp.py

@@ -0,0 +1,67 @@
+import google.auth
+import inquirer
+from google.auth.credentials import Credentials
+from google.auth.exceptions import DefaultCredentialsError
+
+from opsmith.cloud_providers import CloudProviderEnum
+from opsmith.cloud_providers.base import (
+    BaseCloudProvider,
+    CloudCredentialsError,
+    GCPCloudDetail,
+)
+
+
+class GCPProvider(BaseCloudProvider):
+    """GCP cloud provider implementation."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._credentials = None
+
+    def get_credentials(self) -> Credentials:
+        """
+        Provides the functionality to retrieve cached credentials or obtain default
+        Google credentials if none are available.
+
+        :raises google.auth.exceptions.GoogleAuthError: If authentication fails or
+           valid credentials could not be obtained.
+        :rtype: google.auth.credentials.Credentials
+        :return: Returns the cached credentials if available, otherwise retrieves
+           and returns the default credentials via Google's authentication library.
+        """
+        if not self._credentials:
+            self._credentials, _ = google.auth.default()
+        return self._credentials
+
+    def get_account_details(self) -> GCPCloudDetail:
+        """
+        Retrieves structured GCP account details by listing available projects
+        and prompting the user for selection.
+        """
+        try:
+            self.get_credentials()
+
+            questions = [
+                inquirer.Text(
+                    name="project_id",
+                    message="Enter the GCP project you want to use",
+                ),
+            ]
+
+            answers = inquirer.prompt(questions)
+            if not answers or not answers.get("project_id"):
+                raise ValueError("GCP project selection is required. Aborting.")
+
+            selected_project_id = answers["project_id"]
+            return GCPCloudDetail(name=CloudProviderEnum.GCP.name, project_id=selected_project_id)
+
+        except DefaultCredentialsError as e:
+            raise CloudCredentialsError(
+                message=f"GCP Application Default Credentials error: {e}",
+                help_url="https://cloud.google.com/docs/authentication/provide-credentials-adc",
+            )
+        except Exception as e:
+            raise CloudCredentialsError(
+                message=f"An unexpected error occurred while fetching GCP project list: {e}",
+                help_url="https://cloud.google.com/docs/authentication/provide-credentials-adc",
+            )

opsmith/constants.py

@@ -0,0 +1,175 @@
+ROOT_IMPORTANT_FILES = [
+    # Version Control
+    ".gitignore",
+    ".gitattributes",
+    # Documentation
+    "README",
+    "README.md",
+    "README.txt",
+    "README.rst",
+    "CONTRIBUTING",
+    "CONTRIBUTING.md",
+    "CONTRIBUTING.txt",
+    "CONTRIBUTING.rst",
+    "LICENSE",
+    "LICENSE.md",
+    "LICENSE.txt",
+    "CHANGELOG",
+    "CHANGELOG.md",
+    "CHANGELOG.txt",
+    "CHANGELOG.rst",
+    "SECURITY",
+    "SECURITY.md",
+    "SECURITY.txt",
+    "CODEOWNERS",
+    # Package Management and Dependencies
+    "requirements.txt",
+    "Pipfile",
+    "Pipfile.lock",
+    "pyproject.toml",
+    "setup.py",
+    "setup.cfg",
+    "package.json",
+    "package-lock.json",
+    "yarn.lock",
+    "npm-shrinkwrap.json",
+    "Gemfile",
+    "Gemfile.lock",
+    "composer.json",
+    "composer.lock",
+    "pom.xml",
+    "build.gradle",
+    "build.gradle.kts",
+    "build.sbt",
+    "go.mod",
+    "go.sum",
+    "Cargo.toml",
+    "Cargo.lock",
+    "mix.exs",
+    "rebar.config",
+    "project.clj",
+    "Podfile",
+    "Cartfile",
+    "dub.json",
+    "dub.sdl",
+    # Configuration and Settings
+    ".env",
+    ".env.example",
+    ".editorconfig",
+    "tsconfig.json",
+    "jsconfig.json",
+    ".babelrc",
+    "babel.config.js",
+    ".eslintrc",
+    ".eslintignore",
+    ".prettierrc",
+    ".stylelintrc",
+    "tslint.json",
+    ".pylintrc",
+    ".flake8",
+    ".rubocop.yml",
+    ".scalafmt.conf",
+    ".dockerignore",
+    ".gitpod.yml",
+    "sonar-project.properties",
+    "renovate.json",
+    "dependabot.yml",
+    ".pre-commit-config.yaml",
+    "mypy.ini",
+    "tox.ini",
+    ".yamllint",
+    "pyrightconfig.json",
+    # Build and Compilation
+    "webpack.config.js",
+    "rollup.config.js",
+    "parcel.config.js",
+    "gulpfile.js",
+    "Gruntfile.js",
+    "build.xml",
+    "build.boot",
+    "project.json",
+    "build.cake",
+    "MANIFEST.in",
+    # Testing
+    "pytest.ini",
+    "phpunit.xml",
+    "karma.conf.js",
+    "jest.config.js",
+    "cypress.json",
+    ".nycrc",
+    ".nycrc.json",
+    # CI/CD
+    ".travis.yml",
+    ".gitlab-ci.yml",
+    "Jenkinsfile",
+    "azure-pipelines.yml",
+    "bitbucket-pipelines.yml",
+    "appveyor.yml",
+    "circle.yml",
+    ".circleci/config.yml",
+    ".github/dependabot.yml",
+    "codecov.yml",
+    ".coveragerc",
+    # Docker and Containers
+    "Dockerfile",
+    "docker-compose.yml",
+    "docker-compose.override.yml",
+    # Cloud and Serverless
+    "serverless.yml",
+    "firebase.json",
+    "now.json",
+    "netlify.toml",
+    "vercel.json",
+    "app.yaml",
+    "terraform.tf",
+    "main.tf",
+    "cloudformation.yaml",
+    "cloudformation.json",
+    "ansible.cfg",
+    "kubernetes.yaml",
+    "k8s.yaml",
+    # Database
+    "schema.sql",
+    "liquibase.properties",
+    "flyway.conf",
+    # Framework-specific
+    "next.config.js",
+    "nuxt.config.js",
+    "vue.config.js",
+    "angular.json",
+    "gatsby-config.js",
+    "gridsome.config.js",
+    # API Documentation
+    "swagger.yaml",
+    "swagger.json",
+    "openapi.yaml",
+    "openapi.json",
+    # Development environment
+    ".nvmrc",
+    ".ruby-version",
+    ".python-version",
+    "Vagrantfile",
+    # Quality and metrics
+    ".codeclimate.yml",
+    "codecov.yml",
+    # Documentation
+    "mkdocs.yml",
+    "_config.yml",
+    "book.toml",
+    "readthedocs.yml",
+    ".readthedocs.yaml",
+    # Package registries
+    ".npmrc",
+    ".yarnrc",
+    # Linting and formatting
+    ".isort.cfg",
+    ".markdownlint.json",
+    ".markdownlint.yaml",
+    # Security
+    ".bandit",
+    ".secrets.baseline",
+    # Misc
+    ".pypirc",
+    ".gitkeep",
+    ".npmignore",
+]