This application has been implemented to complement a CI/CD pipeline described here. It has been implemented using Spring Boot.
It will just expose a REST Api with two operations:
- GET /demo: returns a list of five different numbers in ascendant order.
- POST /demo: returns the total sum of the value of the elements provided in the request
As shown in following image, there are two main parts clearly identified under two different folders:
- src: source code for this very simple REST Api service and related Spring Boot configuration files
- openshift: all the templates, files or configuration required to run this application on Openshift and be automatically tested by Postman+Newman
In this document, I will be focused on all the configuration files related to how to run this application on Openshift as part of the integration done with the generic pipeline mentioned before. I am not going to talk about Spring boot or any detail about the REST Api implementation.
Two main files are used in order to:
- create the pipeline object in Openshift (BuildConfig with jenkinsPipelineStrategy): openshift/templates/bc-pipeline.yml
- create alll the necessary objects in Openshift for the application: demo-rest-template.yml
As mentioned before, in this BuildConfig file, I will define all the related configuration for this application to make use of the generic pipeline. See pipeline strategy) information from Openshift official documentation.
First, we need to configure the uri of the repository where the generic pipeline is located, the strategy (jenkinsPipelineStrategy) and the path the the Jenkinsfile. Having this pipeline defined in a centralized location will make it reusable from any application.
source:
git:
uri: https://github.com/dsanchor/demo-cicd
strategy:
jenkinsPipelineStrategy:
jenkinsfilePath: pipeline/Jenkinsfile
Then, we have to set all the parameters to make this generic pipeline behave as expected for our application.
env:
- name: JENKINS_PROJECT
value: cicd
- name: CICD_GIT_URL
value: https://github.com/dsanchor/demo-cicd
- name: APP_GIT_URL
value: https://github.com/dsanchor/demo-rest
- name: APP_TEMPLATE
value: openshift/templates/demo-rest-template.yml
- name: APP_NAME
value: demo-rest
..........................
..........................
- name: PROD_PROJECT
value: production
- name: PROD_TAG
value: production
- name: SONAR_URL
value: http://sonarqube-cicd.apps.d-sancho.com
..........................
..........................
We also have to describe how the application looks like in Openshift. For this purpose, I have used an Openshift template that will be used by the pipeline to create all the objects required by Openshift in any environment (DEV, TEST, PROD and so on..).
Some of the parameters defined in the pipeline are used by the application template as well,so based on these parameters, we will be able to reuse the application template in all environments and create different objects.
It is important to get familiar with some Openshift concepts and objects, such as ImageStream, BuildConfig, DeploymentConfig in order to fully understand an Openshift template.
A set of tools are used to perform integration testing for the REST service. These tools are:
- Postman: we will use it to create a tests collection as well as create the environment configurations. There is a PRO- subscription, which add some extra capabilities, but for this demo we will use the free version.
- Newman: command line utility to run our Postman tests against a given environment configuration.
We keep the tests collection and the environment configurations stored in our application git repository, so adding a new test to this collection would be as easy as import the test collection in our Postman tool, create a new test and then, export it and commit it again to the git repository. As mentioned before, we are using a free Postman version, which does not provide any synchronization and source control management for our tests collections. Pro- version provides these capabilities.
Once we have added a new test to the collection, next pipeline run will automatically include this new test and will perform all the tests against the application in all environments.
You could find a simple set of tests developed for this demo under openshift/tests. In that folder, you have:
After a tests collection has run against a given environment, we will see a detail report about the tests results. Example of this report is shown below:
