Merge pull request #42 from lbarcziova/introduce-dry-run

Introduce dry-run mode for skipping pushing and creating MRs

Author: lbarcziova

beeai/Makefile

@@ -1,5 +1,6 @@
 IMAGE_NAME ?= beeai-agent
 COMPOSE_FILE ?= compose.yaml
+DRY_RUN ?= false
 
 COMPOSE ?= $(shell command -v podman >/dev/null 2>&1 && echo "podman compose" || echo "docker-compose")
 
@@ -28,6 +29,7 @@ run-rebase-agent-standalone:
 		-e VERSION=$(VERSION) \
 		-e JIRA_ISSUE=$(JIRA_ISSUE) \
 		-e BRANCH=$(BRANCH) \
+		-e DRY_RUN=$(DRY_RUN) \
 		rebase-agent
 
 
@@ -41,6 +43,7 @@ run-backport-agent-standalone:
 		-e UPSTREAM_FIX=$(UPSTREAM_FIX) \
 		-e JIRA_ISSUE=$(JIRA_ISSUE) \
 		-e BRANCH=$(BRANCH) \
+		-e DRY_RUN=$(DRY_RUN) \
 		backport-agent
 
 
@@ -51,11 +54,11 @@ run-backport-agent-standalone:
 
 .PHONY: start
 start:
-	$(COMPOSE) -f $(COMPOSE_FILE) up
+	DRY_RUN=$(DRY_RUN) $(COMPOSE) -f $(COMPOSE_FILE) up
 
 .PHONY: start-detached
 start-detached:
-	$(COMPOSE) -f $(COMPOSE_FILE) up -d
+	DRY_RUN=$(DRY_RUN) $(COMPOSE) -f $(COMPOSE_FILE) up -d
 
 .PHONY: stop
 stop:

beeai/README.md

@@ -41,6 +41,12 @@ make PACKAGE=httpd VERSION=2.4.62 JIRA_ISSUE=RHEL-12345 BRANCH=c10s run-rebase-a
 make PACKAGE=httpd UPSTREAM_FIX=https://github.com/... JIRA_ISSUE=RHEL-12345 BRANCH=c10s run-backport-agent-standalone
 ```
 
+## Dry-Run mode
+
+Both backport and rebase agents support **dry-run mode** for testing workflows without actually pushing changes or creating merge requests. By default, agents run in **production mode** and will create actual commits, pushes, and merge requests.
+
+To enable dry-run mode for testing, set the `DRY_RUN=true` environment variable.
+
 ## Observability
 
 You can connect to http://localhost:6006/ to access Phoenix web interface and trace agents

beeai/agents/backport_agent.py

@@ -13,15 +13,17 @@
 from beeai_framework.errors import FrameworkError
 from beeai_framework.memory import UnconstrainedMemory
 from beeai_framework.middleware.trajectory import GlobalTrajectoryMiddleware
+from beeai_framework.template import PromptTemplate, PromptTemplateInput
 from beeai_framework.tools import Tool
 from beeai_framework.tools.search.duckduckgo import DuckDuckGoSearchTool
 from beeai_framework.tools.think import ThinkTool
 
 from base_agent import BaseAgent, TInputSchema, TOutputSchema
+from constants import COMMIT_PREFIX, BRANCH_PREFIX
 from observability import setup_observability
 from tools import ShellCommandTool
 from triage_agent import BackportData, ErrorData
-from utils import redis_client
+from utils import redis_client, get_git_finalization_steps
 
 
 class InputSchema(BaseModel):
@@ -70,6 +72,33 @@ def input_schema(self) -> type[TInputSchema]:
     def output_schema(self) -> type[TOutputSchema]:
         return OutputSchema
 
+    def _render_prompt(self, input: TInputSchema) -> str:
+        # Define template function that can be called from the template
+        def backport_git_steps(data: dict) -> str:
+            input_data = self.input_schema.model_validate(data)
+            return get_git_finalization_steps(
+                package=input_data.package,
+                jira_issue=input_data.jira_issue,
+                commit_title=f"{COMMIT_PREFIX} backport {input_data.jira_issue}",
+                files_to_commit=f"*.spec and {input_data.jira_issue}.patch",
+                branch_name=f"{BRANCH_PREFIX}-{input_data.jira_issue}",
+                git_user=input_data.git_user,
+                git_email=input_data.git_email,
+                git_url=input_data.git_url,
+                dist_git_branch=input_data.dist_git_branch,
+            )
+
+        template = PromptTemplate(
+            PromptTemplateInput(
+                schema=self.input_schema,
+                template=self.prompt,
+                functions={
+                    "backport_git_steps": backport_git_steps
+                }
+            )
+        )
+        return template.render(input)
+
     @property
     def prompt(self) -> str:
         return """
@@ -106,16 +135,7 @@ def prompt(self) -> str:
               to the build environment as required by the command).
             * Verify the newly added patch applies cleanly using the command `centpkg prep`.
 
-          6. Commit the changes:
-            * The title of the Git commit should be in the format "[DO NOT MERGE: AI EXPERIMENTS] backport {{ jira_issue }}"
-            * Include the reference to Jira as "Resolves: <jira_issue>" for the issue {{ jira_issue }}.
-            * Commit the RPM spec file change and the newly added patch file.
-            * Push the commit to the fork.
-
-           7. Open a merge request:
-             * Authenticate using `glab`
-             * Open a merge request against the upstream repository of the {{ package }} in {{ git_url }}
-               with previously created commit.
+          6. {{ backport_git_steps }}
         """
 
 

beeai/agents/constants.py

@@ -0,0 +1,4 @@
+
+COMMIT_PREFIX = "[DO NOT MERGE: AI EXPERIMENTS]"
+
+BRANCH_PREFIX = "automated-package-update"

beeai/agents/rebase_agent.py

@@ -13,15 +13,17 @@
 from beeai_framework.errors import FrameworkError
 from beeai_framework.memory import UnconstrainedMemory
 from beeai_framework.middleware.trajectory import GlobalTrajectoryMiddleware
+from beeai_framework.template import PromptTemplate, PromptTemplateInput
 from beeai_framework.tools import Tool
 from beeai_framework.tools.search.duckduckgo import DuckDuckGoSearchTool
 from beeai_framework.tools.think import ThinkTool
 
 from base_agent import BaseAgent, TInputSchema, TOutputSchema
+from constants import COMMIT_PREFIX, BRANCH_PREFIX
 from observability import setup_observability
 from tools import ShellCommandTool
 from triage_agent import RebaseData, ErrorData
-from utils import redis_client
+from utils import redis_client, get_git_finalization_steps
 
 
 class InputSchema(BaseModel):
@@ -70,6 +72,33 @@ def input_schema(self) -> type[TInputSchema]:
     def output_schema(self) -> type[TOutputSchema]:
         return OutputSchema
 
+    def _render_prompt(self, input: TInputSchema) -> str:
+        # Define template function that can be called from the template
+        def rebase_git_steps(data: dict) -> str:
+            input_data = self.input_schema.model_validate(data)
+            return get_git_finalization_steps(
+                package=input_data.package,
+                jira_issue=input_data.jira_issue,
+                commit_title=f"{COMMIT_PREFIX} Update to version {input_data.version}",
+                files_to_commit="*.spec",
+                branch_name=f"{BRANCH_PREFIX}-{input_data.version}",
+                git_user=input_data.git_user,
+                git_email=input_data.git_email,
+                git_url=input_data.git_url,
+                dist_git_branch=input_data.dist_git_branch,
+            )
+
+        template = PromptTemplate(
+            PromptTemplateInput(
+                schema=self.input_schema,
+                template=self.prompt,
+                functions={
+                    "rebase_git_steps": rebase_git_steps
+                }
+            )
+        )
+        return template.render(input)
+
     @property
     def prompt(self) -> str:
         return """
@@ -131,16 +160,7 @@ def prompt(self) -> str:
               * Generate the SRPM using `rpmbuild -bs` (ensure your .spec file and source files are correctly
                 copied to the build environment as required by the command).
 
-          6. Commit the changes:
-              * The title of the Git commit should be in the format "[DO NOT MERGE: AI EXPERIMENTS] Update to version {{ version }}"
-              * Include the reference to Jira as "Resolves: <jira_issue>" for each issue in {{ jira_issues }}.
-              * Commit just the specfile change.
-
-          7. Open a merge request:
-            * Authenticate using `glab`
-            * Push the commit to the fork.
-            * Open a merge request against the upstream repository of the {{ package }} in {{ git_url }}
-              with previously created commit.
+          6. {{ rebase_git_steps }}
 
           Report the status of the rebase operation including:
           - Whether the package was already up to date
@@ -161,7 +181,10 @@ async def main() -> None:
         and (branch := os.getenv("BRANCH", None))
     ):
         input = InputSchema(
-            package=package, version=version, jira_issue=jira_issue, dist_git_branch=branch
+            package=package,
+            version=version,
+            jira_issue=jira_issue,
+            dist_git_branch=branch,
         )
         output = await agent.run_with_schema(input)
         print(output.model_dump_json(indent=4))

beeai/agents/utils.py

@@ -1,3 +1,5 @@
+import os
+
 from contextlib import asynccontextmanager
 from typing import AsyncGenerator, Callable
 
@@ -28,3 +30,49 @@ async def mcp_tools(
         if filter:
             tools = [t for t in tools if filter(t.name)]
         yield tools
+
+
+def get_git_finalization_steps(
+    package: str,
+    jira_issue: str,
+    commit_title: str,
+    files_to_commit: str,
+    branch_name: str,
+    git_user: str = "RHEL Packaging Agent",
+    git_email: str = "[email protected]",
+    git_url: str = "https://gitlab.com/redhat/centos-stream/rpms",
+    dist_git_branch: str = "c9s",
+) -> str:
+    """Generate Git finalization steps with dry-run support"""
+    dry_run = os.getenv("DRY_RUN", "False").lower() == "true"
+
+    # Common commit steps
+    git_config_steps = f"""* Configure git user: `git config user.name "{git_user}"`
+            * Configure git email: `git config user.email "{git_email}"`"""
+
+    commit_steps = f"""* Add files to commit: {files_to_commit}
+            * Create commit with title: "{commit_title}"
+            * Include JIRA reference: "Resolves: {jira_issue}" in commit body"""
+
+    if dry_run:
+        return f"""
+        **DRY RUN MODE**: Commit changes locally only
+
+        Commit the changes:
+            {git_config_steps}
+            {commit_steps}
+
+        **Important**: In dry-run mode, only commit locally. Do not push or create merge requests.
+        """
+    else:
+        return f"""
+        Commit and push the changes:
+            {git_config_steps}
+            {commit_steps}
+            * Push the branch `{branch_name}` to the fork
+
+        Open a merge request:
+            * Authenticate using `glab`
+            * Open a merge request against {git_url}/{package}
+            * Target branch: {dist_git_branch}
+        """

beeai/compose.yaml

@@ -13,6 +13,7 @@ x-beeai-agent: &beeai-agent
     - REDIS_URL=redis://valkey:6379/0
     - COLLECTOR_ENDPOINT=http://phoenix:6006/v1/traces
     - MAX_RETRIES=3
+    - DRY_RUN=${DRY_RUN:-false}
   env_file:
     - .secrets/beeai-agent.env
   volumes: