- Getting Started with Test Suite
- Studio
- Orchestrator
- Testing robots
- Test Manager
Test Suite User Guide
SAP Cloud ALM
Integrate your SAP Cloud ALM projects to Test Manager to create test projects, test cases, execute tests, and view detailed execution information. The integration helps you manage and execute automated tests in your SAP Cloud ALM instance through Test Manager.
You can integrate SAP Cloud ALM with UiPath Test Suite, and leverage the test automation and test management capabilities offered by UiPath Studio and Test Manager.
When you integrate SAP Cloud ALM with Test Manager you can perform the following testing activities:
- Test case creation:
- Create automated test cases in SAP Cloud ALM, for which you can later assign Studio automations inside Test Manager.
- Create automated test cases in Test Manager that synchronize with your target SAP Cloud ALM project.
- Test case execution:
- Execute automated test cases within Test Manager through the SAP Cloud ALM interface.
- Execute automated test cases within Test Manager independently from the SAP Cloud ALM interface.
- Test case reporting:
- Navigate from SAP Cloud ALM directly to the test execution view in Test Manager for detailed information.
Perform the following steps to integrate SAP Cloud ALM with Test Manager:
For more information about manually creating a service, visit Creating Services Manually, from the SAP Cloud ALM documentation.
- In SAP Cloud ALM, go to Administration, and then Landscape Management.
- Open the Services & Systems page.
- Select Add, and choose New Cloud Service.
- Configure the new UiPath service with the required parameters as follows:
- Name: Input
UiPath
. - Description: Input
UiPath Test Suite
. - System Number: Input the system number available in your SAP environment.
- Service Type: Select Unspecified Cloud Service (HTTP).
- Role: Select Test.
- Name: Input
- Select Save to confirm the new service.
Endpoints allow you to create an authenticated connection to the previously created service. For more information, visit Adding Endpoints from the SAP Cloud ALM documentation.
- Create an external application in the UiPath organization that you want to
connect SAP Cloud ALM to.
Note: The App ID and Secret ID (under App Secrets) are used when configuring the authentication type of the endpoint.
For more information about creating and managing external applications, visit Managing external OAuth applications.
- Assign the following Test
Manager user and application scopes to the previously created external
application.
- TM.Projects
- TM.TestSets
- TM.TestCases
- TM.TestExecutions
- TM.CustomFieldDefinitions
- TM.CustomFieldValues
For more information about Test Manager scopes, visit API Scopes.
- In the Redirect URL field, enter
https://www.uipath.com
.
- Inside the Services & Systems page, select the previously created service.
- Under Endpoints, select Add.
- In the Add Endpoint pop-up, configure the following parameters:
- Endpoint Name:
This parameter is automatically generated. Change the value to
UiPath
. - Use Case: The supported use case for the UiPath service is Test Automation.
- Root URL: Input
the Test Manager URL of the tenant where you want to create the test
cases, followed by the
api
suffix.For example:https://govcloud.uipath.us/{organizationName}/{tenantName}/testmanager_/api
. - Authentication
Type: Select OAuth2ClientCredentials.
- Client ID: Input the value of App ID from the previously created external application.
- Client Secret: Input the value of Secret ID from the previously created external application.
- Token Service
URL: Input the UiPath® Identity Server endpoint of type Token:
https://cloud.uipath.com/identity_/connect/token
.For a list of Identity server endpoints, visit UiPath Identity Server Endpoints.
- Endpoint Name:
This parameter is automatically generated. Change the value to
- Select Save to confirm the new endpoint.
These configurations ensure that the SAP Cloud ALM and Test Manager systems can communicate and synchronize.
After you integrate SAP Cloud ALM with Test Manager, you can perform testing operations, such as creating test cases, executing them, and viewing the execution results. The following sections demonstrate the end-to-end process of the integration.
The SAP Cloud ALM and Test Manager integration applies only to automated test cases.
Overview
When you create an automated test case, SAP Cloud ALM simultaneously creates a new project in your connected Test Manager instance. The name of the project is the same as the one in SAP Cloud ALM, as well as a unique ID at the end. The project also includes the new test case that you created. When you decide to create further test cases using identical configurations to your initial test case, SAP Cloud ALM creates a new test case within your previously generated project.
Test cases created in both SAP Cloud ALM and Test Manager, are created within a specific context. The SAP Cloud ALM context is stored in the following custom fields from the Test Manager project: SAP Country/Region, SAP Scope and SAP Solution Process. These parameters establish the proper mapping and context between test cases in SAP Cloud ALM and Test Manager. These custom fields can hold multiple values, depending on the number of scopes and corresponding processes that you synchronize to the Test Manager project.
If you need to create a test case in Test Manager that should be synchronized to SAP Cloud ALM, select the appropriate context for the previous mentioned custom fields.
Creating an automated test case in SAP Cloud ALM
- Go to SAP Cloud ALM and from the Project dropdown list, select an existent project or create a dedicated one, used to integrate with Test Manager.
- Go to the Test Preparation app.
- In the Test Cases section,
select Create a Test Case. Configure the test case as follows:
- Type: Select
Automated.
The integration helps with creating, managing, and executing automated test cases for your business solutions in SAP Cloud ALM.
- Automation
Provider: Select the
UiPath Test Suite
endpoint from the dropdown list. - Title: Enter a title that is unique for the desired scope.
- Scope: Select a
scope.
This value is present in Test Manager as the SAP Scope custom field.
- Solution Process:
Optionally, select a solution process.
This value is present in Test Manager as the SAP Solution Process custom field.
- Country/Region: If
you selected a solution process, then you have to select a desired
country or region.
This value is present in Test Manager as the SAP Country/Region custom field.
Figure 1. The New Test Case pop-up from SAP Cloud ALM where you configure the new test case
- Type: Select
Automated.
- Select Save to confirm the test case creation.
- Go to Test Manager from SAP Cloud
ALM, to the newly created test case.
- In the Test Manager project, go to Project settings, and select the Automation tab.
- Assign a default
Orchestrator folder to the project created through SAP Cloud ALM:
- Select the Default Folder dropdown list.
- Select your preferred Orchestrator folder.
- Select
Save to confirm your changes.
The selected folder is used to execute all your tests.
Note: This step is required just once, right after the creation of the associated Test Manager project.
For more information about creating automated test cases in SAP Cloud ALM, visit Creating Automated Test Cases.
Creating an automated test case in Test Manager
To trigger the creation of an automated test case in SAP Cloud ALM from Test Manager, perform the following steps:
- Open your Test Manager project that you created from SAP Cloud ALM in the previous steps.
- In the left navigation panel, go to Test Cases.
- Select Create Test Case.
- Configure the test case as
follows:
- Name: Enter a name for your test case.
- Version: Optionally, add a version tag to the test case.
- Description: Optionally, enter a description for the test case.
- Labels: Add custom labels.
- Select Create to confirm the new test case.
- Open the newly created test case, and go to the Details tab.
- Select the relevant values for your
SAP Cloud ALM target project in the following custom fields:
- SAP Country/Region:
Select the target country/region.
This is the equivalent country/region where you want to test your solution process.
- SAP Scope: Select the
desired scope.
This is the equivalent scope that you are testing in your SAP Cloud ALM project.
- SAP Solution Process:
Select the target solution process.
This is the equivalent solution process that you are testing in your SAP Cloud ALM project.
Note: If your Test Manager project holds multiple SAP scopes and process values, make sure the selected process corresponds to the chosen scope. Test Manager does not automatically filter the SAP Solution Processes based on the SAP Scope value.
By selecting the appropriate values for SAP Scope, SAP Solution Process, and SAP Country you ensure the test cases created in Test Manager will synchronize with SAP Cloud ALM when the same scope and process are synchronized.
Figure 2. The custom field values related to SAP in a Test Manager test case
- SAP Country/Region:
Select the target country/region.
For more information about creating test cases in Test Manager, visit Create test cases.
Synchronizing test cases from Test Manager to SAP Cloud ALM
Steps
To synchronize the test cases created in Test Manager in your connected SAP Cloud ALM project, perform the following steps:
- Open your SAP Cloud ALM project, and go to the Test Preparation app.
- In the Test Cases section,
select Synchronize Automated Test Cases.
Figure 3. The Synchronize Automated Test Cases button
- Select the scope for which you
want to synchronize automated test cases.
Note: This value must match the scope used for creating new automated test cases in Test Manager.For example, if you created an automated test case in Test Manager with
Scope 3
, ensure this sameScope 3
scope is selected in SAP Cloud ALM when you synchronize test cases. - Select the automation provider
(
UiPath Test Suite
), which is the endpoint you used to create automated tests. - Select Synchronize to finish the process.
For more information about synchronizing automated test cases from Test Manager to SAP Cloud ALM, visit Synchronizing Automated Test Cases.
Use UiPath® Studio to create a test automation or assign an automation to an existing test case in Test Manager.
Steps
- In Studio, open an existing project or create a new one.
- Connect this project to a Test Manager instance.
- From the Design ribbon, select Test Manager.
- Select Test Manager Settings.
- Enter the base URL of your synchronized Test Manager instance with SAP Cloud ALM.
- Select Connect.
- After the connection is successful, in the Default Project field, enter the name or prefix of the target Test Manager project.
- Create and design test cases for your solution process.
Visit the Introduction page of Test Suite Studio to explore the available test design capabilities.
- Go to the Project panel of your project, and right-click a test case.
- Select Link to Test Manager.
- In the Link to Test Manager pop-up, provide the following test
information:
- Project: Select the project containing the existent test case or
where a new one will be created.
If you selected a default project when you connected Studio to Test Manager, this project will appear in the Project field.
- Test: Enter the name of an existent test case from the selected
project. To create a new test case, leave the default
<new test case>
value selected. - Name: To create a new test case, leave
<new test case>
in the Test field, and provide a name for the new test case in Test Manager. - Requirement: Optionally, enter the name of an existent
requirement and assign it to the test case. If you do not want to assign
a requirement, leave the
<none>
value selected.
- Project: Select the project containing the existent test case or
where a new one will be created.
- Select OK to save the changes.
For more information on assigning automations to test cases in Test Manager, visit Assigning automations to test cases.
You can execute automated test cases directly from both SAP Cloud ALM and Test Manager. The execution results are displayed in both SAP Cloud ALM and Test Manger.
For detailed steps on how to execute automated test cases in SAP Cloud ALM, visit Executing Automated Test Cases.
You can check the execution status and data, in real time, from both SAP Cloud ALM, and Test Manager. After you execute a test case, you can see the status of the execution both in SAP Cloud ALM and Test Manager.
While you are still in the Executed Test Runs section of a test case in SAP Cloud ALM, select Open Execution Log to navigate directly to the execution log of that test case within Test Manager.
Synchronizing ongoing execution status from Test Manager to SAP
After you trigger the execution of a test case in SAP Cloud ALM, you can track the status and the progress of the test run from the test case list. You can refresh the status and the progress of the test run by selecting Refresh Test Progress from the Automation Provider.
Synchronizing finished execution status from Test Manager to SAP
Once a test case execution is completed in Test Manager, it can be synchronized with SAP Cloud ALM. To do this, navigate to your SAP Cloud ALM project and select the Test Execution app. Within the Test Cases section, select the desired test case and then select Refresh Executed Test Runs from the Automation Provider. This action updates the execution status in SAP Cloud ALM to match the one from Test Manager.