diff --git a/cspell.config.yaml b/cspell.config.yaml index cd17fbd..7a847dc 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -46,6 +46,7 @@ words: - Langchain - bitnami - litellm + - reportportal - berriai - Ollama # Cloud/Infrastructure diff --git a/docs/user-guide/tools_integrations/tools/images/reportportal-api-keys.png b/docs/user-guide/tools_integrations/tools/images/reportportal-api-keys.png new file mode 100644 index 0000000..af046d0 Binary files /dev/null and b/docs/user-guide/tools_integrations/tools/images/reportportal-api-keys.png differ diff --git a/docs/user-guide/tools_integrations/tools/images/reportportal-assistant-setup.png b/docs/user-guide/tools_integrations/tools/images/reportportal-assistant-setup.png new file mode 100644 index 0000000..14937a4 Binary files /dev/null and b/docs/user-guide/tools_integrations/tools/images/reportportal-assistant-setup.png differ diff --git a/docs/user-guide/tools_integrations/tools/images/reportportal-chat-example.png b/docs/user-guide/tools_integrations/tools/images/reportportal-chat-example.png new file mode 100644 index 0000000..cfc3c8b Binary files /dev/null and b/docs/user-guide/tools_integrations/tools/images/reportportal-chat-example.png differ diff --git a/docs/user-guide/tools_integrations/tools/images/reportportal-codemie-integration.png b/docs/user-guide/tools_integrations/tools/images/reportportal-codemie-integration.png new file mode 100644 index 0000000..48df647 Binary files /dev/null and b/docs/user-guide/tools_integrations/tools/images/reportportal-codemie-integration.png differ diff --git a/docs/user-guide/tools_integrations/tools/images/reportportal-copy-key.png b/docs/user-guide/tools_integrations/tools/images/reportportal-copy-key.png new file mode 100644 index 0000000..1bf5fc8 Binary files /dev/null and b/docs/user-guide/tools_integrations/tools/images/reportportal-copy-key.png differ diff --git a/docs/user-guide/tools_integrations/tools/images/reportportal-generate-key.png b/docs/user-guide/tools_integrations/tools/images/reportportal-generate-key.png new file mode 100644 index 0000000..f5e4bf5 Binary files /dev/null and b/docs/user-guide/tools_integrations/tools/images/reportportal-generate-key.png differ diff --git a/docs/user-guide/tools_integrations/tools/overview.md b/docs/user-guide/tools_integrations/tools/overview.md index d7bccf7..750f4dd 100644 --- a/docs/user-guide/tools_integrations/tools/overview.md +++ b/docs/user-guide/tools_integrations/tools/overview.md @@ -32,6 +32,7 @@ Assistant's tools are powerful enhancements that bring completely new capabiliti | **[OpenAPI](./openapi-tool)** | Integrate with any third-party tools supporting the OpenAPI standard | | **[Jira](./jira)** | Issue tracking and project management integration for Jira Cloud and Jira Old UI | | **[LiteLLM](./litellm)** | LLM proxy integration for connecting to various AI model providers through a unified API | +| **[ReportPortal](./reportportal)** | AI-powered test execution analysis, launch data retrieval, and failure recommendations | | **[Quality Assurance](./quality-assurance-with-jira-zephyr-scale-addon)** | Test management with Zephyr Scale (formerly TM4J) and Zephyr Squad for Jira environments | | **[Xray](./xray)** | Test management with Xray for Jira - retrieve and interact with test cases using JQL-like syntax | | **[ServiceNow](./servicenow)** | ITSM operations including incident management, change requests, and CMDB operations | @@ -128,6 +129,7 @@ The table below shows which tools require integration setup and the integration | **FileSystem => Generate Image** | ❌ No | --- | ❌ No | | **Notification => Email** | ✅ Yes | Email | ❌ No | | **LiteLLM** | ✅ Yes | LiteLLM | ❌ No | +| **Report Portal** | ✅ Yes | ReportPortal | ❌ No | | **Codebase Tools => Sonar** | ✅ Yes | Sonar | ❌ No | | **Codebase Tools => Get Repo Tree** (Experimental) | ❌ No | --- \* | ❌ No | | **Codebase Tools => Search Code** (Experimental) | ❌ No | --- \* | ❌ No | diff --git a/docs/user-guide/tools_integrations/tools/reportportal.md b/docs/user-guide/tools_integrations/tools/reportportal.md new file mode 100644 index 0000000..efef545 --- /dev/null +++ b/docs/user-guide/tools_integrations/tools/reportportal.md @@ -0,0 +1,87 @@ +--- +id: reportportal +title: ReportPortal +sidebar_label: ReportPortal +pagination_prev: user-guide/tools_integrations/tools/overview +pagination_next: null +sidebar_position: 15 +--- + +# ReportPortal + +AI/Run CodeMie integrates with [ReportPortal](https://reportportal.io/) to provide AI-powered analysis of test execution results. This integration allows assistants to retrieve launch data, analyze test failures, and provide actionable recommendations for improving test quality. + +## 1. Generate ReportPortal API Key + +1.1. Log in to your ReportPortal instance. Click your user icon in the bottom-left corner and select **Profile**: + +![ReportPortal User Profile — API Keys tab](./images/reportportal-api-keys.png) + +1.2. Navigate to the **API Keys** tab and click **Generate API Key**. Specify a key name (e.g., "codemie-demo") and click **Generate**: + +![Generate API Key dialog](./images/reportportal-generate-key.png) + +1.3. Click **Copy to Clipboard** to copy the generated API Key and store it securely: + +:::warning +You won't be able to see your Key once you click the "Close" button. Make sure to copy and save it before closing the dialog. +::: + +![API Key Generated dialog](./images/reportportal-copy-key.png) + +## 2. Configure Integration in AI/Run CodeMie + +2.1. In the AI/Run CodeMie main menu, click **Integrations**, select **User** or **Project** tab, and click **+ Create**. + +2.2. Specify the integration parameters and click **+ Save**: + +- **Project**: Select your AI/Run CodeMie project name. +- **Global Integration**: Toggle on to use across multiple projects. If disabled, the integration will only be available within the selected project, and assistants and workflows attached to other projects will not be able to use it. +- **Credential Type**: ReportPortal +- **Alias**: Enter integration name (e.g., "reportportal-demo"). +- **Report Portal URL**: Enter the URL of your ReportPortal instance (e.g., `https://report-portal.example.com`). +- **Project name**: Enter the ReportPortal project name you want your assistant to analyze (e.g., "codemie"). +- **API Key**: Paste the API Key copied in step 1.3. + +![CodeMie ReportPortal integration form](./images/reportportal-codemie-integration.png) + +:::tip +You can click the **Test** button to verify the connection before saving. You should see an "Integration test successful" notification if the parameters are correct. +::: + +:::info +If you create this integration under the **Project** tab, the key will be available to the entire project by default, meaning all project members can use it. +::: + +## 3. Create Assistant with ReportPortal Tool + +3.1. Click **Explore Assistant**, then click **Create Assistant** or edit an existing one. + +3.2. In the assistant settings, expand the **Report Portal** section under available tools and select your ReportPortal integration alias from the dropdown. The following operations will be available: + +- **Get All Launches** — retrieve all test launches +- **Get Extended Launch Data** — get detailed launch information +- **Get Extended Launch Data as Raw** — get raw launch data +- **Get Launch Details** — retrieve specific launch details +- **Find Test Items by ID** — search for test items +- **Get Test Items for Launch** — list test items within a launch +- **Get Logs Per Test Item** — retrieve logs for specific tests +- **Get Test Attributes** — get test attributes +- **Get Dashboard Data** — retrieve dashboard information +- **Update Test Item** — update test item details + +![Assistant setup with ReportPortal tool](./images/reportportal-assistant-setup.png) + +3.3. Click **Create** or **Save** to finalize your assistant. + +## 4. Use Your Assistant + +4.1. Select your assistant and start a conversation. You can interact with your ReportPortal data using natural language, for example: + +- "Get me last report" — retrieve the most recent test launch summary +- "Show all failed tests from the latest launch" +- "What are the main issues in the last test run?" + +The assistant will analyze the test results and provide a summary including execution statistics, failure details, and recommendations: + +![ReportPortal chat example](./images/reportportal-chat-example.png) diff --git a/sidebars.ts b/sidebars.ts index 66b249c..cef774a 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -147,6 +147,7 @@ const sidebars: SidebarsConfig = { 'user-guide/tools_integrations/tools/openapi-tool', 'user-guide/tools_integrations/tools/jira', 'user-guide/tools_integrations/tools/litellm', + 'user-guide/tools_integrations/tools/reportportal', 'user-guide/tools_integrations/tools/quality-assurance-with-jira-zephyr-scale-addon', 'user-guide/tools_integrations/tools/servicenow', 'user-guide/tools_integrations/tools/scheduler',