| title | description | author | resourceType | personas | labels | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Allure Framework OpenShift |
Get started with docs and resources for Allure Framework, a flexible lightweight multi-language test report tool. |
esune |
Components |
|
|
Allure is a flexible, lightweight multi-language test report tool.
Allure Framework OpenShift provides a set of OpenShift configurations to set up an instance of the Allure service and Allure UI. See: docs.qameta.io/allure for additional details regarding Allure Framework.
The configurations in this repository are based on the Allure Docker Service Docker images by Frank Escobar.
The service is composed by the following components:
- allure: the Allure server where the test results will be sent to be stored and aggregated for visualization.
- allure-ui: a frontend that allows the visualization of test reports.
The templates provided in the openshift folder include everything that is necessary to create the required builds and deployments.
Since there are interdependencies between deployment configurations, please make sure to follow this order when creating them for the first time:
- build and deploy the Allure service
- build and deploy the Allure UI service
The manage script makes the process of adding a Allure instance to your project very easy. The script was build on the openshift-developer-tools scripts.
Once you've cloned the repository, open a bash shell (Git Bash for example) to the openshift directory of the working copy.
The following example assumes an OpenShift project set named ggpixq ...
./manage -n ggpixq init- to initialize the configurations to be deployed into your project../manage build- to publish the build configuration(s) into yourtoolsproject and start the build../manage -e prod deploy- to publish the deployment configuration(s) into yourprodenvironment and tag the application images to start the deployments.- Browse to the deployed application to complete the configuration.
The deployment will have created a set of secrets for you to reference while completing the initial configuration: allure-admin, containing randomly generated credentials for your main super-user account.
For full script documentation run ./manage -h.
Note: some mandatory parameters are left blank in the template as they will be different for each deployment. Make sure you set values for all of them in the parameter files BEFORE generating the deployments in order to avoid issues.
In particular, it is important to set the ALLURE_DOCKER_PUBLIC_API_URL parameter in the allure-ui deployment to the URL that exposes the allure service.
Once everything is up and running in OpenShift, please refer to the Allure Docker service instructions and the official Allure Framework docs to set-up your reports.