Sanity-QA Flow¶
Ordering a Sanity Build¶
Once the initial data has been set up, you have the option to order a Sanity Build.
Sanity Build¶
The Sanity Build Process is used to assess that the selected revision in the master branch of the Customer Solution repository is buildable.
During this process, the code in the master branch is built and deployed. Several criteria are checked which include Database code generation, Database code deployment and code compilation.
To order a sanity build, there must be at least one new commit made after the latest 'san-OK' tag.
Note
The 'san-OK' tag is applied to a commit after a successful completion of a sanity build for that specific commit.
To order a Sanity Build, first click on the ‘Sanity Build’ button.
 |
|---|
| Figure 1.1 - Order Sanity Build Button |
After you click on Sanity Build, the panel shown below will open.
Note
Please keep in mind that this panel only appears when there is at least one new commit after the latest 'qa-OK' tag and/or at least one new commit after the 'san-OK' tag..
 |
|---|
| Figure 1.2 - Order Sanity Build Panel |
The Target Commit dropdown provides a list of commits made after the latest 'san-OK' commit.
Then select the desired commit from the Target commit dropdown and then click on the Order button.
 |
|---|
| Figure 1.3 - Order Sanity Build Panel - Target Commit dropdown and Order button |
Note
Please note that when ordering a sanity build alone, do not check the 'Order sanity build with QA environment' checkbox...
When the Sanity Build is successfully initiated, a toast message will appear on the screen indicating that the sanity is successfully initiated.
 |
|---|
| Figure 1.4 - Success Toast Indicating that the Sanity Build is successfully initiated |
Approximately, within 1 hour time, the Sanity Build gets completed successfully and, ‘san-OK’ tag will appear next to the subsequent commit.
 |
|---|
| Figure 1.5 - "san-OK" tag is added after the sanity build has been completed successfully |
Ordering a sanity build along with a QA environment¶
Ordering a QA environment concurrently with the sanity build serves the purpose of efficiency. Given that a Quality Assurance Engineer initiates the sanity build, and considering the time it takes to complete, combining the QA environment order with the sanity build helps in saving time.
To order a sanity build along with a QA environment, ensure the following conditions are met:
- There should be at least one new commit after the latest ‘qa-ok’ tag.
- There shouldn’t be any Sanity Builds in progress.
- There should not be any currently active Quality Assurance (QA) environments..
First click on the Sanity Build button where the panel shown below will open.
Note
Please keep in mind that this panel only appears when there is at least one new commit after the latest 'san-OK' tag and/or at least one new commit after the 'qa-OK' tag....
|
|---|
| Figure 1.6 - Order a Sanity Build along with a QA environment |
Next check the Order sanity build with QA environment check box.
 |
|---|
| Figure 1.7 - Order a Sanity Build along with a QA environment |
The Target commit drop down list may consist of a list of commits after the latest ‘qa-OK’ tag.
 |
|---|
| Figure 1.8 - Order a Sanity Build along with a QA environment - Target Commits |
Then select the required commit from the Target commit drop down list and click on the Order button.
|
|---|
| Figure 1.9 - Order a Sanity Build along with a QA environment |
When you click the ‘Order’ button, both the sanity build, and the provisioning of the QA environment will be initiated simultaneously.
The QA environment is provisioned with the data you initially added. Additionally, you also have the capability to add more data to the QA environment and approve it as needed.
Ordering a Sanity build when there are no new commits¶
When attempting to order a sanity build without any new commits after the latest ‘qa-OK’, an error message will appear as shown below.
 |
|---|
| Figure 1.10 - No New Commits error message |
When the error illustrated above occurs, please follow the steps outlined below:
- Go to the "Customer Solution Repository."
- Implement a code change and perform a commit, then ensure the Pull Request is approved.
- Place an order for a "Sanity Build."
Ordering Sanity when there is no new commit after the latest ‘san-OK’ tag¶
When attempting to order a sanity build without any new commits after the latest 'san-OK' tag, the Sanity Build Panel will display an inline error message as shown below.
 |
|---|
| Figure 1.11 - Inline error Message that indicates no commits' found after the last successful sanity build |
Nevertheless, you can proceed by selecting the 'Order Sanity build with QA environment' checkbox. In this situation, only the QA environment will be provisioned.
When the error illustrated above occurs and if you want to proceed with a sanity build, please follow the steps outlined below:
- Go to the "Customer Solution Repository."
- Implement a code change and perform a commit, then ensure the Pull Request is approved.
- Place an order for a "Sanity Build."
Ordering a sanity build when there is an on-going sanity build¶
When attempting to order a sanity build while there is a sanity build in progress, you will encounter the error message depicted below.
 |
|---|
| Figure 1.12 - Unable to Order Sanity error message |
When the error mentioned above occurs, kindly wait until the sanity build finishes. You can then access the 'Customer Solution Repository' to verify if there no ‘san-Pending’ tags in the repository. Then you can proceed to order a sanity build after making another commit in customer solution repository.
Ordering a QA environment along with Sanity whilst there is an on-going QA environment¶
When attempting to order a QA environment along with the sanity build while there is a currently active QA environment, you will encounter the message depicted below.
 |
|---|
| Figure 1.13 - Unable to Order QA Environment information box |
To proceed, please delete the existing QA environment.
Ordering the sixth consecutive sanity build¶
When provisioning the development environment, it is necessary to include the most recent quality assurance (QA) approved database and merge all the sanity checked code base. In cases where more than five sanity checks are involved, this leads to a substantial volume of code changes, resulting in an extended duration for the provisioning of the development environment. Further, this may cause errors when entering the test data. Therefore, when you attempt to order sixth consecutive sanity build without QA approval for the code changes, the warning message below will appear.
 |
|---|
| Figure 1.14 - Warning message when ordering 6th consecutive sanity build |
You are able to take the actions mentioned below.
- Ignore and Proceed - Sanity build will get successful; however, you will be restricted from ordering a Dev environment.
- Cancel - Ordering a sanity build process will be terminated. So that you are able to order a QA environment and approve the changes.
24R1 and Above
Application Information on the Quality Assurance Environment Card¶
When the Quality Assurance Environment (QA) card is expanded, Application Information section will be displayed. Application information section contains the credentials to the IFS Cloud Application. Note that, these credentials can only be used to log into the IFS Cloud Application.
 |
|---|
| Figure 1.15 - Application Information |