Skip to content

Commit

Permalink
Signed-off-by: Himanshu Chauhan <[email protected]>
Browse files Browse the repository at this point in the history
  • Loading branch information
hchauhan19 committed May 27, 2024
1 parent 6ba07bc commit 4bfa9fb
Show file tree
Hide file tree
Showing 976 changed files with 40,226 additions and 258 deletions.
2 changes: 1 addition & 1 deletion Ginger by Amdocs Help/.rh/.HCHAUHAN.db.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@
     Environment Configuration
Go to Resources Tab, click on the Environments and expand it to see the Environment details.


Parameter can be added to the environment application by clicking on the add button (see the button highlighted in the below screenshot). The Parameter type can be selected from the provided selection list. Enter the Parameter Name(required), Description(optional) and Initial Value(optional).
There is an additional option provided to Publish the parameter to the same application (ones with the same name) in different environments (see the highlighted button in red in the below screenshot)







Expand All @@ -29,9 +36,6 @@





User details can be entered in the Login Users tab.




Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,8 @@


      d. Configure the 'Reports - Centralized Execution Logger Settings’. Enter Reports's 'End Point URL' of your respective project

           (Go to Configuration --> Reports --> Execution Logger Configuration --> Expand Centralized Execution Logger Settings --> Select option Yes and configure End Point URL )




Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@
Ginger Azure DevOps ALM Integration

Introduction
Ginger comes with seamless integration with ALM Azure DevOps, and this document comes to explain how to use the integration functionalities.
Ginger comes with seamless integration with ALM Azure DevOps, and this document comes to explain how to use the integration functionalities.

Current supported functionalities are:

Export Ginger Business Flow to Azure DevOps - each one of the Business Flow & Activities Group will be export to Azure DevOps as Test Plan (Test Suite) item and a Test Case item respectively.
Mapping of entities of Ginger with respect to Azure DevOps are as follows :
Business Flow => Test Plan/Suite
Activities Group => Test Case
Activities => Test Steps
Publish execution result of Ginger Activities Groups to Azure DevOps as Pass/Fail.
Export Ginger Business Flow to Azure DevOps
Import Test plans from Azure DevOps to Ginger
Publish execution result to Azure DevOps
Open Automatic Defect on Azure DevOps



Pre-requisite

Expand All @@ -22,7 +20,7 @@




 


Connect Ginger to Azure DevOps
Expand All @@ -33,25 +31,25 @@



Select ALM Connection Settings”
Select ALM type – Azure DevOps using the radio buttons
Select "ALM Connection Settings”
Select ALM type – Azure DevOps using the radio buttons



Populate the ALM server URL and your ALM user name and Personal Access Token and click on “Get Projects Details”
Populate the ALM server URL and your ALM user name and Personal Access Token and click on “Get Projects Details”
ALM Server URL – It will be your Azure’s organization url.
ALM Username – It will be the username of the user
Personal Access Token - You can use a personal access token (PAT) as an alternate password to authenticate into Azure DevOps. You can click here to know more about it and how to create your personal access token.
If connection details are correct, projects details will be received, select project and click “Save Project Mapping”
Note: All Ginger – ALM interaction will try to use saved ALM configuration in Ginger, If in any case the saved configurations are incorrect or Ginger could not establish a connection to ALM, the “ALM Connection Settings” page will be shown and the user will need to enter/re-enter ALM configurations and test them before continuing.
Note: All Ginger – ALM interaction will try to use saved ALM configuration in Ginger, If in any case the saved configurations are incorrect or Ginger could not establish a connection to ALM, the "ALM Connection Settings” page will be shown and the user will need to enter/re-enter ALM configurations and test them before continuing.


Configure ALM Items Fields
Configure ALM Items Fields

Ginger allows configuring the ALM Test Case and Test Set items fields’ value to be updated when doing export from Ginger to ALM.
       For configuring the items fields values:

Click on the “ALM Items Fields Configuration” button from the “Share Options” menu.
Click on the "ALM Items Fields Configuration” button from the “Share Options” menu.



Expand All @@ -69,9 +67,17 @@
Click on the “Save” button to save the configurations.


Export Business Flow to ALM
Mapping of Ginger entities with Azure DevOps
Mapping of entities of Ginger with respect to Azure DevOps are as follows:

Business Flow => Test Plan/Suite

Activities Group => Test Case

Activities => Test Steps
Export Business Flow to ALM

Ginger allows exporting a Ginger Business Flow to ALM
Ginger allows exporting a Ginger Business Flow to ALM 

Export Activities Groups to ALM Test Cases- each one of the exported Business Flow Activities Groups will be exported to an ALM Test Case item in ALM Test Plan

Expand All @@ -81,13 +87,13 @@


All of the created ALM Test Cases from step 1 will be added to the Business Flow to represent the execution flow
Right-click the Business Flows to export and select the “Export to ALM option. It will export the selected Business Flow to the Azure.  
Right-click the Business Flows to export and select the “Export to ALM" option. It will export the selected Business Flow to the Azure  





Right-click the Business Flows to export and select the “Export All to ALM” option. It will export all the Business Flows of the solution to the ALM.
Right-click the Business Flows to export and select the “Export All to ALM" option. It will export all the Business Flows of the solution to the ALM.



Expand All @@ -102,10 +108,10 @@
Refresh the ALM. Users will able to the exported item in the ALM


Export Execution Results to ALM
Export Execution Results to ALM

       In case the executed Ginger Business Flow was originally imported from ALM Test Set or it was exported to ALM Test Set then the user can export the execution results to ALM.
     Exporting execution results to ALM from Automate tab
     Exporting execution results to ALM from Automate tab

Load the relevant Ginger Business Flow into Automate tab
Run the Ginger Test Set in “Run Flow” mode.
Expand All @@ -115,22 +121,103 @@



   Exporting execution results to ALM from Runset tab
   Exporting execution results to ALM from Runset tab

Open Run Set tab
Add Ginger Set and drag & drop Ginger Business Flows to it
Click on the Run Set Configurations button
Add new “Add Publish Execution Result to ALM Operation” Run set Action
Add new “Add Publish Execution Result to ALM Operation” Run set Action
Click on the Run button
Execution details will be exported to ALM according to Run Set configurations
Execution details will be exported to ALM according to Run Set configurations



You can now see the result on Azure DevOps as passed or failed.


Open Automatic Defect on Azure DevOps
Setting the ALM Defect’s Profiles

        To have an automated defect’s opening or to make a “manual” opening via ginger much faster, defects field’s values (from ALM) should be pre-selected.
        For this purpose, a screen, "ALM Defect’s Profiles” is available under the ALM drop-down of Solution tab.








At the top part of a screen will be presented a list of existed Defect’s Profiles – in a grid form. At the grid’s toolbox will be presented next buttons/controls:

Create/Edit a Profile
Delete a Profile
Search Profile by Name/Description




The grid will show the list of profiles and contain below columns

Name
Description
ALM Type
Is Default – a column that will be single-selectable per all values in the rows


Once Profile created/selected – Profile’s Fields grid became enabled and populated by fields and their values. Those fields/values will be retrieved from the ALM by the new REST API.Profile’s Fields grid will have below columns:

Filed Name
Mandatory – can be sorted by clicking on it
Selected Values – dropdown with current field’s values list. The value that presented will be the selected one for this profile


Deselecting (selecting other) of a Profile will be not available till all mandatory field values will not be selected (value deferent than “N/A”).
‎Closing of a current window also will be not available till all mandatory field values will not be selected. A warning message will be popped in case that is not expected.
Closing of a current window will be not available till at least one Profile will be created/exist. A warning message will be popped in case that is not expected.


How to automate the opening of Defects?

In the Run tab, click on “RunSet” and open the desired run set. Operations and click the button to add the operation “Automated ALM Defect’s Opening"
This operation can be added only when at least one “Defect’s Profiles” exists. A warning message will be popped in case that is no “Defect’s Profiles” are existing yet.
To use the operation’s functionality, the operation should be added to the “RunSet Operations” list (as usual operation’s behavior).




How to view opened automated defects?


Go to the Runset tab and click on the “ALM Defect’s Opening” tab.
This tab presents all the failures that happened during the execution - with all relevant data and screenshots.
Till the execution’s end, this tab is disabled. Once execution finished the tab became enabled.





In case of operation “Automated ALM Defect’s Opening” was in use during the last execution (or it’s not the first iteration of defect’s “manual”opening) column “ALM’s defect ID” will be populated per concerted issue. ALM Defect ID will be saved per action at the “RunSet” object
In the above grid at the right corner, click on the “Open Selected as Defects at ALM” button.
This button is enabled only if at least one issue in a grid has no defect for itself.
Once clicked – this will open for selected issues defects in ALM.
If ALM connectivity is not working correctly – a warning message will be popped and action will be aborted. Otherwise, defects will be opened in ALM with values per field as at currently selected “Defect’s Profile”.
The defect will be opened in a below-described way (the same way is relevant for the opening of defects with operation “Automated ALM Defect’s Opening”):

Naming convention: <<BusinessFlow>>_<<Activity>>_<<Action>>_”Failed”
Defect description - should copy the steps of the test that was run. Example:
BusinessFlow Name (failed)
Activity Group Name
Activity Group Name (failed)
Activity
Activity (failed)
Action
Action (failed)
Variables of failed entities (of all levels) also will be added to the description
Defect’s Attachment - screenshot will be attached to the defect, showing the error.






Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@



g.       Set Environment Details used in Runset” - This oprion shows the used Environment in the Run Set and Runner Level. This option also provides facility to users:
1. To create Virtual Environment or Dynamic Environment for execution at run time (via CLI)
          2.  To update current values of Environment Parameters and DB
          3.  To add new virtual or dynamice parameter and DB
          For more Details please check Section - "How to create Virtual Environment or Dynamic Environment via CLI"



Execution Configuration Tab
This tab has 3 options.

Expand Down
62 changes: 36 additions & 26 deletions Ginger by Amdocs Help/.rh/.HCHAUHAN.preference.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
{
"recent-files::internal:document": [{
"title": "How_to_create_Virtual_Environment_or_Dynamic_Environment_via_CLI",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Run_Sets/How_to_create_Virtual_Environment_or_Dynamic_Environment_via_CLI.htm",
"pinned": false,
"time": "May 27, 3:13 PM"
}, {
"title": "How_to_Execute_Run_set_Via_CLI",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Run_Sets/How_to_Execute_Run_set_Via_CLI.htm",
"pinned": false,
"time": "May 27, 2:57 PM"
}, {
"title": "How_to_Execute_a_Run_set",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Run_Sets/How_to_Execute_a_Run_set.htm",
"pinned": false,
"time": "May 27, 2:57 PM"
}, {
"title": "Ginger_Azure_DevOps_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_Azure_DevOps_ALM_Integration.htm",
"pinned": false,
"time": "May 27, 11:56 AM"
}, {
"title": "What_is_Environment",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Configurations/Environments/What_is_Environment.htm",
"pinned": false,
"time": "May 27, 11:45 AM"
}, {
"title": "Ginger_-_OTOMA_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Ginger_Enterprise_Features/Ginger_-_OTOMA_Integration.htm",
"pinned": false,
Expand Down Expand Up @@ -69,11 +94,6 @@
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Business_Flows/Actions/Platform_Action_Types/Browser_Action.htm",
"pinned": false,
"time": "Mar 20, 10:28 AM"
}, {
"title": "Ginger_Azure_DevOps_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_Azure_DevOps_ALM_Integration.htm",
"pinned": false,
"time": "Mar 13, 7:06 PM"
}, {
"title": "Accessibility_Testing_Action",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Business_Flows/Actions/Platform_Action_Types/Accessibility_Testing_Action.htm",
Expand Down Expand Up @@ -104,26 +124,6 @@
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/UI/Ginger_Configurations_Tab_Overview.htm",
"pinned": false,
"time": "Jan 19, 10:13 AM"
}, {
"title": "Ginger_Zephyr_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_Zephyr_ALM_Integration.htm",
"pinned": false,
"time": "Jan 19, 10:00 AM"
}, {
"title": "Ginger_qTest_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_qTest_ALM_Integration.htm",
"pinned": false,
"time": "Jan 19, 9:59 AM"
}, {
"title": "Ginger_QC_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_QC_ALM_Integration.htm",
"pinned": false,
"time": "Jan 19, 9:59 AM"
}, {
"title": "Ginger_Octane_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_Octane_ALM_Integration.htm",
"pinned": false,
"time": "Jan 19, 9:59 AM"
}],
"generate.outputs": {
"C:/Robo_Help_Lib/Ginger-Web-Help/Ginger by Amdocs Help/publish/presets/Frameless.preset": {
Expand All @@ -147,7 +147,7 @@
"C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/publish/presets/Frameless.preset": {
"exists": true,
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/docs/index.html",
"time": "2024-05-08T20:13:39+05:30",
"time": "2024-05-27T15:52:51+05:30",
"logFile": "C:/Users/hchauhan/AppData/Local/Temp/RHTMP/Frameless.ehtml"
},
"C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/publish/presets/Word Document.preset": {
Expand All @@ -164,6 +164,16 @@
}
},
"recent-files::internal:hyperlink": [{
"title": "How_to_create_Virtual_Environment_or_Dynamic_Environment_via_CLI",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Run_Sets/How_to_create_Virtual_Environment_or_Dynamic_Environment_via_CLI.htm",
"pinned": false,
"time": "May 27, 3:43 PM"
}, {
"title": "Environment_CLI_Configurations_(How_to_create_Dynamic_Environment_via_CLI)",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Run_Sets/Environment_CLI_Configurations_(How_to_create_Dynamic_Environment_via_CLI).htm",
"pinned": false,
"time": "May 27, 2:48 PM"
}, {
"title": "Ginger_Azure_DevOps_ALM_Integration",
"path": "C:/My Drive/Ginger Help Library/Ginger-Web-Help.git/Ginger by Amdocs Help/contents/assets/Ginger_By_Amdocs/Integrations/ALM_Integrations/Ginger_Azure_DevOps_ALM_Integration.htm",
"pinned": false,
Expand Down
Loading

0 comments on commit 4bfa9fb

Please sign in to comment.