Add command execution functionality to Bitbucket app and update configuration settings

This commit is contained in:
mrT23
2024-03-06 07:53:13 +02:00
parent 3016d5d1ed
commit 2f6f1d5879
3 changed files with 43 additions and 27 deletions

View File

@ -265,21 +265,16 @@ inline_code_comments = true
Each time you invoke a `/review` tool, it will use inline code comments. Each time you invoke a `/review` tool, it will use inline code comments.
#### BitBucket Self-Hosted App automatic tools #### BitBucket Self-Hosted App automatic tools
You can configure in your local `.pr_agent.toml` file which tools will **run automatically** when a new PR is opened. to control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file:
```
Specifically, set the following values:
```yaml
[bitbucket_app] [bitbucket_app]
auto_review = true # set as config var in .pr_agent.toml pr_commands = [
auto_describe = true # set as config var in .pr_agent.toml "/review --pr_reviewer.num_code_suggestions=0",
auto_improve = true # set as config var in .pr_agent.toml "/improve --pr_code_suggestions.summarize=false",
]
``` ```
`bitbucket_app.auto_review`, `bitbucket_app.auto_describe` and `bitbucket_app.auto_improve` are used to enable/disable automatic tools. Note that due to limitations of the bitbucket platform, not all tools or sub-options, are supported. See [here](./README.md#Overview) for an overview of the supported tools for bitbucket.
If not set, the default option is that only the `review` tool will run automatically when a new PR is opened.
Note that due to limitations of the bitbucket platform, the `auto_describe` tool will be able to publish a PR description only as a comment.
In addition, some subsections like `PR changes walkthrough` will not appear, since they require the usage of collapsible sections, which are not supported by bitbucket.
### Azure DevOps provider ### Azure DevOps provider

View File

@ -16,6 +16,7 @@ from starlette_context import context
from starlette_context.middleware import RawContextMiddleware from starlette_context.middleware import RawContextMiddleware
from pr_agent.agent.pr_agent import PRAgent from pr_agent.agent.pr_agent import PRAgent
from pr_agent.algo.utils import update_settings_from_args
from pr_agent.config_loader import get_settings, global_settings from pr_agent.config_loader import get_settings, global_settings
from pr_agent.git_providers.utils import apply_repo_settings from pr_agent.git_providers.utils import apply_repo_settings
from pr_agent.identity_providers import get_identity_provider from pr_agent.identity_providers import get_identity_provider
@ -72,6 +73,24 @@ async def handle_manifest(request: Request, response: Response):
manifest_obj = json.loads(manifest) manifest_obj = json.loads(manifest)
return JSONResponse(manifest_obj) return JSONResponse(manifest_obj)
async def _perform_commands_bitbucket(commands_conf: str, agent: PRAgent, api_url: str, log_context: dict):
apply_repo_settings(api_url)
commands = get_settings().get(f"bitbucket_app.{commands_conf}", {})
for command in commands:
try:
split_command = command.split(" ")
command = split_command[0]
args = split_command[1:]
other_args = update_settings_from_args(args)
new_command = ' '.join([command] + other_args)
get_logger().info(f"Performing command: {new_command}")
with get_logger().contextualize(**log_context):
await agent.handle_request(api_url, new_command)
except Exception as e:
get_logger().error(f"Failed to perform command {command}: {e}")
@router.post("/webhook") @router.post("/webhook")
async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Request): async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Request):
log_context = {"server_type": "bitbucket_app"} log_context = {"server_type": "bitbucket_app"}
@ -118,18 +137,19 @@ async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Req
with get_logger().contextualize(**log_context): with get_logger().contextualize(**log_context):
apply_repo_settings(pr_url) apply_repo_settings(pr_url)
if get_identity_provider().verify_eligibility("bitbucket", if get_identity_provider().verify_eligibility("bitbucket",
sender_id, pr_url) is not Eligibility.NOT_ELIGIBLE: sender_id, pr_url) is not Eligibility.NOT_ELIGIBLE:
auto_review = get_setting_or_env("BITBUCKET_APP.AUTO_REVIEW", None) if get_settings().get("bitbucket_app.pr_commands"):
if auto_review is None or is_true(auto_review): # by default, auto review is enabled await _perform_commands_bitbucket("pr_commands", PRAgent(), pr_url, log_context)
await PRReviewer(pr_url).run() else: # backwards compatibility
auto_improve = get_setting_or_env("BITBUCKET_APP.AUTO_IMPROVE", None) auto_review = get_setting_or_env("BITBUCKET_APP.AUTO_REVIEW", None)
if is_true(auto_improve): # by default, auto improve is disabled if is_true(auto_review): # by default, auto review is disabled
await PRCodeSuggestions(pr_url).run() await PRReviewer(pr_url).run()
auto_describe = get_setting_or_env("BITBUCKET_APP.AUTO_DESCRIBE", None) auto_improve = get_setting_or_env("BITBUCKET_APP.AUTO_IMPROVE", None)
if is_true(auto_describe): # by default, auto describe is disabled if is_true(auto_improve): # by default, auto improve is disabled
await PRDescription(pr_url).run() await PRCodeSuggestions(pr_url).run()
# with get_logger().contextualize(**log_context): auto_describe = get_setting_or_env("BITBUCKET_APP.AUTO_DESCRIBE", None)
# await agent.handle_request(pr_url, "review") if is_true(auto_describe): # by default, auto describe is disabled
await PRDescription(pr_url).run()
elif event == "pullrequest:comment_created": elif event == "pullrequest:comment_created":
pr_url = data["data"]["pullrequest"]["links"]["html"]["href"] pr_url = data["data"]["pullrequest"]["links"]["html"]["href"]
log_context["api_url"] = pr_url log_context["api_url"] = pr_url

View File

@ -165,9 +165,10 @@ pr_commands = [
] ]
[bitbucket_app] [bitbucket_app]
#auto_review = true # set as config var in .pr_agent.toml pr_commands = [
#auto_describe = true # set as config var in .pr_agent.toml "/review --pr_reviewer.num_code_suggestions=0",
#auto_improve = true # set as config var in .pr_agent.toml "/improve --pr_code_suggestions.summarize=false",
]
[local] [local]