The startup script looks the same as above:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
services:\n runner-guitrigger-01:\n restart: unless-stopped\n image: gitlab\/gitlab-runner:alpine\n container_name: runner-guitrigger-01\n volumes:\n - \/opt\/docker_conf\/runner-guitrigger-01:\/etc\/gitlab-runner\n - \/opt\/docker_data\/runner-guitrigger-01-cache:\/opt\/docker_data\/runner-guitrigger-01-cache\n - \/var\/run\/docker.sock:\/var\/run\/docker.sock<\/pre>\n[\/et_pb_text][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”intro” _builder_version=”4.4.6″ custom_padding=”|||0px||” locked=”off”][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: set up the pipeline<\/h2>\n
Each project lives in its own git repository. In the project root folder, there is a file named .gitlab-ci.yml that configures the pipeline for each project. The file defines variables, cache settings, before and after scripts to be executed and the stages of the pipeline. The stages are basically the steps to be executed during the pipeline, and the conditions for the execution to be triggered. The last step of our pipeline is the end to end test stage.[\/et_pb_text][et_pb_image src=”\/\/cdn.berg-software.com\/wp-content\/uploads\/Berg-Software-End-to-end-tests-an-GitLab-integration-05-How-to-set-up-the-pipeline.jpg” alt=”Berg Software – End-to-end tests an GitLab integration – 05 How to set up the pipeline” title_text=”Berg Software – End-to-end tests an GitLab integration – 05 How to set up the pipeline” _builder_version=”4.4.6″ max_width=”60vw” custom_padding=”2vh||2vh|2vw|false|false”][\/et_pb_image][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]We have five environments, each of them with its specific protected branch. When a certain commit is performed there, the application is built and deployed on that specific environment. For the production environment, we have to create a certain tag with a specific naming convention for deployment.<\/p>\n
You can define variables that can be used in the same file, or in all pipeline scripts:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
variables:\nGRADLE_OPTS: \"-Dorg.gradle.daemon=false\"\nDOCKER_DRIVER: overlay2<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The stages are defined as follows: [\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
stages:\n - opssetupchmodfix\n - test<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Here we have two stages. Not all stages are executed in one single run. We will detail each stage definition later on.<\/p>\n
To speed up the jobs execution time, we need to cache the dependencies of each build so they are not downloaded every time. The cache has a key that is picked from the predefined git environment variable CI_COMMIT_REF_SLUG, that contains the git tag or branch name for which the project is built:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
<pre class=\"text\" style=\"font-family:monospace;\">cache:\n key: ${CI_COMMIT_REF_SLUG}\n paths:\n - .gradle\/wrapper\n - .gradle\/caches<\/pre><\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]We use per branch cache. All dependencies are cached inside the project folder, and the cache can be reused on every job execution within the specific project. At the end of the job, the specified folders are zipped into an archive cache.zip and stored under the specified key on the machine where the GitLab runner is executed.<\/p>\n
We can define a script to be executed before starting the execution of the stages:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
before_script:\n - export GRADLE_USER_HOME=`pwd`\/.gradle<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The test stage labeled \u2018guitest\u2019 starts the execution of the end to end tests:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
guitest:\n image: registry1.projekt.de\/prj-dind-chrome\n stage: test \n script:\n - .\/ci\/bin\/guitest.sh \"$EXECUTE_TEST_FOR_ENVIRONMENT\" \"$SRC_TRGR_BRANCH\"\n tags:\n - guirunner<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The test stage is associated with certain runners, based on tag label. Only those runners that have the same tag \u2018guirunner\u2019 can pick up the execution of this stage.<\/p>\n
The image registry1.projekt.de\/prj-dind-chrome is a custom docker image based on selenium\/standalone-chrome:latest enhanced with bash, curl, openssl, git, x11 server, jdk and other tools, in order to be able to execute the end to end test in a browser environment.<\/p>\n
Excerpt from the Dockerfile used to build the image:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
RUN sudo apt-get -y install bash curl git openssl openssh-client openjdk-8-jdk libxpm4 libxrender1 libgtk2.0-0 libnss3 libgconf-2-4 xvfb gtk2-engines-pixbuf xfonts-cyrillic xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable x11-xserver-utils x11-xkb-utils<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The runner executing this stage will start the given container from the defined image; will check out the code of the end to end project; and will launch (inside the container) the script defined in the script section:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
script:\n .\/ci\/bin\/guitest.sh \"$EXECUTE_TEST_FOR_ENVIRONMENT\" \"$SRC_TRGR_BRANCH\"<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The script is obtained from the checked-out source code. There are two environment variables given to the script that are provided to the container by the caller. They are computed based on the current branch or tag variable provided by GitLab CI_COMMIT_REF_NAME. I will explain the script later on.<\/p>\n
The process that triggers the execution can be another pipeline that calls the command in a stage[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
trigger -a ${GITLABTRIGGER_APITOKEN} -p ${ GITLABTRIGGER_GUITESTTOKEN} -t ${branch} ${GITLABTRIGGER_GUITESTID} \n-e SRC_TRGR_BRANCH=${CI_COMMIT_REF_NAME} \n-e EXECUTE_TEST_FOR_ENVIRONMENT=${GUITEST_ENVIRONMENT^^} \n-e EXECUTE_TEST_FOR_PIPELINE=${CI_PIPELINE_URL}<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The command is available in the docker image registry.gitlab.com\/finestructure\/pipeline-trigger.<\/p>\n
The artifacts section labeled \u2018artifacts:\u2019 defines what files should be made available for download after the job finishes, what is the source of those files, and for how long they should be preserved.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
artifacts:\n when: always\n paths:\n - target\/*\n - \/opt\/selenium\/config.json\n expire_in: 1 week\n<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The stage is executed only for certain branches defined in the \u2018only:\u2019 section. Additionally, the stage is not executed when the commit message given by the developer contains the text \u2018opssetup\u2019 expressed as a regular expression. There is a logical \u2018and\u2019 condition between the two.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
only:\n - branch_dev1\n - branch_dev2\n - branch_preview\n - master\n - \/^story-\/\n except:\n variables:\n - $CI_COMMIT_MESSAGE =~ \/^opssetup-*\/\n<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The script guitest.sh can launch the end to end test inside the runner container or on another dedicated remote machine. We started with the first approach but ended with running the tests on a dedicated machine.<\/p>\n
The first approach used the commands:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
Xvfb -ac :99 -screen 0 1280x1024x16 &\nexport DISPLAY=:99\n\n.\/gradlew -i clean runAParallelSuite aggregate -P webdriver.base.url=$TARGET_BASE_URL\n<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The first step was to set up the in-memory display server and resolution. In the second step, we are launching a custom Gradle task. More details will follow.<\/p>\n
This approach doesn\u2019t scale very well. We got frequent memory issues so we decided to start the tests on a dedicated machine using the commands:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
openssl enc -aes-XXalgo -d -pass env:GRP_SSL_ENCSECRET -in ci\/secrets-enc\/id_rsa-usr-dockerexec.dat >| ci\/secrets\/id_rsa-usr-dockerexec\n\nssh -i ci\/secrets\/id_rsa-usr-dockerex usr-dockerex@10.6.xx.xx -o StrictHostKeyChecking=no \"\/opt\/docker_exec\/launch-tests.sh ${CI_JOB_ID} ${TARGET_LABEL} ${TARGET_BRANCH} ${TARGET_ENV}\"\n<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]With the help of Ansible, we have set up the machine with the right user accounts and permissions to be able to launch the GUI tests from a remote machine. The user secret key is provided after it is decrypted using a protected environment variable GRP_SSL_ENCSECRET defined in the GitLab user interface. The script variables were computed based on the branch name and default GitLab variables.
\nEach job gets assigned a unique id exposed as CI_JOB_ID. The TARGET_LABEL is used to indicate the docker image labels to be used when running the test. The other two variables are indicating the branch from which to check out the test code and the environment to consider when downloading the images. In a further section, we will explain the launch script.<\/p>\n
Another stage called \u2018opssetupchmodfix\u2019 is executed only when the provided commit message contains the text \u2018opssetup-chmod-fix\u2019, and only on the runner labeled with \u2018otcprj\u2019. The stage changes the permissions of the executable bash files checked out from git into the current project workspace folder and pushes the changes back to git. The default permissions are denying the execution.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
opssetup-chmod-fix:\n stage: opssetupchmodfix\n image: registry1.projekt.de\/prj-dind-base\n script:\n - chmod oga+x .\/ci\/bin\/*.sh\n - .\/ci\/bin\/fixexecuteflag.sh\n tags:\n - otcprj\n only:\n variables:\n - $CI_COMMIT_MESSAGE =~ \/^opssetup-chmod-fix*\/\n<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The stage is needed to be executed once when coming from windows environment because there is no easy way to set the execution permission for the bash files.[\/et_pb_text][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”intro” _builder_version=”4.4.6″ custom_padding=”|||0px||” locked=”off”][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: isolate the tests<\/h2>\n
You might think that isolating the tests is a bad thing because you don\u2019t get feedback from the real system, data, and users. But actually, most of the time, the purpose of the end to end tests is to verify that the existing business-critical functionality still works as expected after performing any changes. Verifying the system consistency or performance must not be done using the end to end tests.[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: prepare the environment for running the tests<\/h2>\n
We have created a cloud machine for running the end to end tests using terraform scripts. If multiple machines are needed, they can be created dynamically. The machine is configured using Ansible. The user \u2018usr-dockerex\u2019 is created and allowed (A) to connect via its ssh key, and (B) to execute the end to end tests launch script. The script launch-tests.sh is copied during the machine setup.<\/p>\n
We need to be able to run in parallel multiple end-to-end tests for different branches and environments. Therefore, we are using the job id to prepend all services started by one run. We are using Docker Compose to start the containers.<\/p>\n
To each container name we append the job ID like in the following:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
container_name: ui-client${JOB_ID}<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]We create a docker image in the pipeline of each microservice, and push it to our docker repository. From there, the end to end tests are pulling and starting the images. Different branches produce different docker images, with well-defined labels.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
image: \"registry1.projekt.de\/ui-client:${ CLIENT_IMAGE_TAG}\"<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The tag is computed using GIT API based on the source branch, target environment, and the project that triggered the build. When working on a feature, multiple microservices and UI clients might be affected.<\/p>\n
The microservices that are not changed have to be started as well for the end to end test. For this, we need to specify a target environment where to get the latest images for that environment. Each environment is bound to a protected branch.<\/p>\n
Let\u2019s suppose we have 3 microservices and only 2 are changed. Each one resides in its own git repository. The changes for the same story\/feature are performed in a branch with the same name, let\u2019s say feature1. The first environment where the feature is deployed should be the dev environment. So, the unchanged microservice3 has to use the latest image built for the dev environment. The used images are in this case the following:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
\u2022\timage: \"registry1.projekt.de\/microservice1:feature1\" \n\u2022\timage: \"registry1.projekt.de\/ microservice2:feature1\" \n\u2022\timage: \"registry1.projekt.de\/ microservice3:dev1_latest\"<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]If feature1 branch would exist for the microservice3, it would also be used for the end to end tests. We check the existence of a branch with the following script:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
function check_branch_existence(){\n local result=$1\n local project=$2\n local branch=$3\n local exists=$(curl -I -so \/dev\/null -w \"%{http_code}\" \"https:\/\/gitlab.com\/api\/v4\/projects\/${project}\/repository\/branches\/${branch}?private_token=${GRP_GITUSER_ACCESSTOKEN}\")\n eval $result=\"'$exists'\"\n}\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]If the branch exists, the output result variable should contain the 204 HTTP response code.<\/p>\n
We have to check the existence of a docker image tag to launch the right container or fall back to a default image which is actually the dev image. We use the following function:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
function check_image_tag_existence(){\n local result=$1\n local project=$2\n local image_tag=$3\n local repo=$4\n echo \"docker inspect --type=image ${repo}\/${project}:${image_tag}\"\n local exists=$(docker inspect --type=image \"${repo}\/${project}:${image_tag}\" --format \"{{.Id}}\" > \/dev\/null 2>&1 && echo $? || echo $?) \n echo \"Exists image? ${exists}\"\n if [ $exists -eq 1 ]; then\n\techo \"try to pull image\"\n\tlocal pullresult=$(docker pull \"${repo}\/${project}:${image_tag}\";echo $?)\n\techo \"pull result ${pullresult}\"\n\techo \"tried to pull image ${repo}\/${project}:${image_tag}\"\n fi\n exists=$(docker inspect --type=image \"${repo}\/${project}:${image_tag}\" --format \"{{.Id}}\" > \/dev\/null 2>&1 && echo $? || echo $?) \n echo \"after second inspect $exists\"\n eval $result=\"'$exists'\"\n}<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]If the image is not downloaded locally the docker inspect command won\u2019t find it. Therefore, a pull is performed before the second inspect command. The result of the second inspect is returned.<\/p>\n
We are iterating through all our GitLab microservices projects to compute the right environment variables with the container images and tags.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
projects=(\"1233xxx\" \"1224xxxx\"\u2026 )\nproject_names=(..)\nproject_vars=(..)\nfor i in ${!projects[@]};\n\tdo\ncheckImageTag ${projects[$i]} ${project_names[$i]} ${project_vars[$i]} $imageTag \"dockerregistry1.server\" \"dev1-latest\"\n\tdone\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The function checkImageTag exports the right environment variables for each microservice, or default them.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
function checkImageTag(){\n\t local curProjId=$1\n\t\tlocal curProjName=$2\n\t\tlocal curProjVar=$3\n\t\tlocal curProjTag=$4\n\t\tlocal curRegistry=$5\n\t\tlocal envBranch=$6\n\t\tcheck_image_tag_existence imageexistresult $curProjName $curProjTag $curRegistry\n\t\tif [ $imageexistresult -eq 0 ]; then \n\t\t\teval \"export $(echo ${curProjVar}_IMAGE_TAG | tr [a-z] [A-Z])=$imageTag\"\n\t\telse\n\t\t\t#fallback to the default tag\n\t\t\tcheck_image_tag_existence imageexistresult $curProjName $envBranch $curRegistry\n \n\t\t\tif [ $imageexistresult -eq 0 ]; then \n\t\t\t\teval \"export $(echo ${curProjVar}_IMAGE_TAG | tr [a-z] [A-Z])=dev1-latest\"\n\t\t\telse\n\t\t\t\techo \"image ${curProjTag} for project ${curProjName} does not exist!\"\n\t\t\t\texit 1\n\t\t\tfi\n\t\tfi\n}<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]We will have exported for each microservice one variable, in the form of SERVICE_VAR_NAME_IMAGE_TAG. The var name by convention is the upper case of service name with the minus character replaced by an underscore.<\/p>\n
So far, we have computed (A) the container names to be unique for different jobs, and (B) the right docker image tags based on the branch name and target environment. We still miss the proper cleanup before launching the new containers for the tests.<\/p>\n
The execution of the end to end tests are taking less than one hour so we can stop all containers started more than one hour ago, that are still running. The containers have the prefix ad. We filter those containers and count them. If there are such containers, we use docker stop giving the list of filtered containers IDs.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
if [ `docker ps --filter \"status=running\" --filter \"name=ad\" | grep 'hour.* ago' | awk '{print $1}' | wc -l ` -gt 0 ] ; then\ndocker stop $(docker ps --filter \"status=running\" --filter \"name=ad\" | grep 'hour.* ago' | awk '{print $1}')\nfi<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]We will delete the containers afterward.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
if [ `docker ps --filter \"status=exited\" | grep 'hour.* ago' | awk '{print $1}' | wc -l ` -gt 0 ] ; then\ndocker rm $(docker ps --filter \"status=exited\" | grep 'hour.* ago' | awk '{print $1}')\nfi<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Depending on the resources of test machine(s), we can limit the amount of tests to run in parallel on one machine. It does not matter which service is counted, it can be any.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
if [ `docker inspect --format='{{.Name}} ' $(docker ps -aq --filter \"status=running\" --filter \"name=admicroservice1*\" ) | cut -d r -f 3 | wc -l` -lt 5 ] ; then\n echo 'allowing not more than 5 running gui tests'\nelse\n echo 'there are running in parallel already 5 gui test, please retry later '\n exit 1\nfi<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]A new network is created for every job ID.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
export NETWORK_BRIDGE=nwkbguitest${JOB_ID}\n[ ! \"$(docker network ls | grep $NETWORK_BRIDGE)\" ] && docker network create -d bridge $NETWORK_BRIDGE || echo \"Network present!\"\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]If the containers are already running for the same job id, we stop and remove them via the following commands:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
vardockers=`docker ps -a --filter \"name=*${JOB_ID}\"| wc -l`\nif [ $vardockers -eq 1 ]\nthen\n echo \"no containers\"\nelse\n echo \"stop and remove all containers\"\n docker stop $(docker ps -a -q --filter \"name=*${JOB_ID}\")\n docker rm $(docker ps -a -q --filter \"name=*${JOB_ID}\")\nfi<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]After the initial cleanup is performed, we are starting all containers with Docker Compose in the background.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
docker-compose -f \/opt\/docker_compose\/docker-compose-apps.yml up -d<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Afterwards, containers\u2019 IPs are logged to console and the log output of the end to end test container is redirected to the console.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
docker inspect --format='{{.Name}} {{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $(docker ps -q)\ndocker logs -f endtoend-tests${JOB_ID}<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]When the tests are finished, the final cleanup will be performed and the result code will be evaluated and returned.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
result=`docker inspect $(docker ps -aq --filter \"name=endtoend-tests${JOB_ID}\") --format='{{.State.ExitCode}}'`\ndocker-compose -f \/opt\/docker_compose\/docker-compose-apps.yml down\ndocker network rm $NETWORK_BRIDGE\ndocker network prune -f\ndocker image prune -f\ndocker volume prune -f\nexit $result<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The Docker Compose .yml file will be explained in a further section.[\/et_pb_text][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”intro” _builder_version=”4.4.6″ custom_padding=”|||0px||” locked=”off”][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: prepare the data for the tests<\/h2>\n
We use the Spock framework for system testing of our rest API. Spock is a testing and a specification platform for Java and Groovy applications that can be easily integrated with IDEs and CI pipelines via the Junit runner. Spock allows us to write specifications that describe expected features from a system under test. The tests can produce documentation for a wider audience than developers, by using the labeled blocks \u201cgiven\u201d, \u201cwhen\u201d and \u201cthen\u201d (like in the following):[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb” locked=”off”]<\/p>\n
given: \"an admin user\"\n\/\/ ...code\nwhen: \"his company settings are changed\"\n\/\/ ...code\nthen: \"the user is notified\"\n\/\/...code<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″ locked=”off”]The produced reports are looking like this:[\/et_pb_text][et_pb_image src=”\/\/cdn.berg-software.com\/wp-content\/uploads\/Berg-Software-End-to-end-tests-an-GitLab-integration-06-Reports.jpg” alt=”Berg Software – End-to-end tests an GitLab integration – 06 Reports” title_text=”Berg Software – End-to-end tests an GitLab integration – 06 Reports” _builder_version=”4.4.6″ max_width=”60vw” custom_padding=”2vh||2vh|2vw|false|false” locked=”off”][\/et_pb_image][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″ locked=”off”]The tests are organized in test suites and specs. Each spec deals with a particular domain of our APIs.[\/et_pb_text][et_pb_image src=”\/\/cdn.berg-software.com\/wp-content\/uploads\/Berg-Software-End-to-end-tests-an-GitLab-integration-07-Reports-scaled.jpg” alt=”Berg Software – End-to-end tests an GitLab integration – 07 Reports” title_text=”Berg Software – End-to-end tests an GitLab integration – 07 Reports” _builder_version=”4.4.6″ max_width=”60vw” custom_padding=”2vh||2vh|2vw|false|false” locked=”off”][\/et_pb_image][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″ locked=”off”]Basically, we are using the system tests to populate an empty database on which to run the end to end tests. A small number of system tests are written specifically for the end to end testing. This is a necessity where some data is needed, or some workflows must be prepared in advance because the same cannot be created just from the end to end tests. The tests created to facilitate the end to end tests execution should be clearly distinguished.<\/p>\n
Specific users are used for testing, in order to isolate (as much as possible) the interferences with the existing users active on the system.<\/p>\n
At the beginning of the execution, the test data is prepared. In the end, the cleanup is performed.<\/p>\n
The Docker Compose file from above contains the MySQL service that executes an SQL script on startup, to create the empty databases.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
db-mysql:\n container_name: prj-mysql${JOB_ID}\n image: mysql:5.8\n volumes:\n - \".\/setmode.cnf:\/etc\/mysql\/conf.d\/setmode.cnf\"\n ports:\n - \"3306\"\n entrypoint:\n sh -c \"\n echo 'CREATE DATABASE IF NOT EXISTS at_projects \/*!40100 DEFAULT CHARACTER SET utf8 *\/; CREATE DATABASE IF NOT EXISTS at_server; \u2026' > \/docker-entrypoint-initdb.d\/init.sql;\n \/usr\/local\/bin\/docker-entrypoint.sh --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci\n \"<\/pre>\n[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: run the tests with docker compose<\/h2>\n
All microservices and required runtime dependencies are declared in the Docker Compose file. The container names are unique, while the image tags are computed from the launching script and provided as environment variables.<\/p>\n
All services for one job are started in the same network including the database server.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
networks:\n default:\n external:\n name: ${NETWORK_BRIDGE}<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Each container must have some resource limits specified (like memory and CPU).<\/p>\n
A typical back end service looks like this:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
services: \n prj-server:\n image: \"registry1\/prj-server:${PRJ_SERVER_IMAGE_TAG}\"\n container_name: prj-server${JOB_ID}\n environment:\n - \"SPRING_PROFILES_ACTIVE=otcdev,swagger\"\n - \"SQL_SERVER_IP=db-mysql${ JOB_ID}\"\n\u2026\n ports:\n - 8080\n restart: always\n mem_limit: 2500m\n depends_on:\n - db-mysql<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]A typical front end service looks like this:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
ui-client:\n image: \"registry1 \/ui-client:${UI_CLIENT_IMAGE_TAG}\"\n container_name: ui-client${JOB_ID}\n environment:\n - \"BACKEND_SERVER_URL=http:\/\/prj-server${ JOB_ID}:8080\"\n - \"BACKEND_CHECKLIST_URL=http:\/\/prj-checklists${JOB_ID}:8084\"\n ports:\n - 8085\n restart: always\n command: \/bin\/bash -c \"envsubst < \/opt\/enviroment-endpoints.template > \/opt\/enviroment-endpoints.json && cp \/opt\/enviroment-endpoints.json \/usr\/share\/nginx\/html\/assets\/enviroment-endpoints.json && exec nginx -g 'daemon off;'\"<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]One interesting thing is the substitutions of the backend URLs environment variables into a file provided to the nginx web server. This file is then included in the UI image, to point the UI of the end-to-end tests to the right backend. At this point, we only need an instance for each service.<\/p>\n
Running the test is actually performed in a special container started from a chrome image. The image with all dependencies set is prepared to run the end-to-end test.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
services:\n endtoend-tests:\n image: registry1.projekt-adis.de\/adis-dind-chrome\n container_name: endtoend-tests${JOB_ID}\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The section maps a host folder to a container folder. The host folder will be persistent even after the container finishes the work. This is where we will store the end to end test reports.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
volumes:\n - \/opt\/docker_data\/guitest:\/repo\/tests<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The entry point defines the command to run when starting the container. There are multiple Linux commands separated by ;[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
entrypoint: >\t\t\t\t\t \n \/bin\/sh -c \"<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]First, the git user is configured to appear when committing.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
git config --global user.name \\\"${GRP_GITUSER_NAME}\\\";\t\ngit config --global user.email \\\"${GRP_GITUSER_EMAIL}\\\";\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Unique folders for each job id are created, and access rights are granted.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
sudo mkdir repo;\nsudo chmod a+rwx repo;\ncd repo;\nsudo mkdir tests\/${JOB_ID};\nsudo chmod a+rwx tests\/${JOB_ID};\nsudo rm -rf adis-systemtest;<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The code for the system test is checked out and executed on the fresh environment, in order to populate the end to end test data.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
git -C . clone --branch ${PRJ_SYSTEMTEST_BRANCH} https:\/\/${GRP_GITUSER_LOGON}:${GRP_GITUSER_ACCESSTOKEN}@gitlab.com\/company\/projects\/cust\/prj\/prj-systemtest.git;\n chmod oga+x .\/prj-systemtest\/ci\/bin\/systemtest.sh;\n cd prj-systemtest;<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The tests for populating the data are launched, giving them the right back end URLs.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
.\/ci\/bin\/systemtest.sh ISOLATED http:\/\/prj-server${JOB_ID}:8080 http:\/\/prj-projects${ JOB_ID}:8081 http:\/\/prj-checklists${ JOB_ID }:8084;<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The test results are parsed, and the job is failed if there are failures.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
cp -R build\/test-results\/test \/repo\/tests\/${ JOB_ID}\/test-results-system;\ncat \/repo\/tests\/${ JOB_ID}\/test-results-system\/TEST-specs.TestSuite.xml;\ncat \/repo\/tests\/${JOB_ID}\/test-results-system\/*.xml >> \/repo\/tests\/${ JOB_ID}\/test-results-system\/systestresult.log;\n[ `cat \/repo\/tests\/${JOB_ID}\/test-results-system\/systestresult.log | grep '\\failures=.[^0].' | wc -l` -eq 0 ] && echo 'system test success' || exit 1;<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The end to end tests are checked out from git (i.e. from the computed branch).[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
cd ..;\nsudo rm -rf prj-guitest;\ngit -C . clone --branch ${PRJ_GUITEST_BRANCH} https:\/\/${GRP_GITUSER_LOGON}:${GRP_GITUSER_ACCESSTOKEN}@gitlab.com\/company\/projects\/client\/prj\/prj-guitest.git;\nchmod oga+x .\/prj-guitest\/ci\/bin\/*.sh;\ncd prj-guitest;\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The end to end test is launched, also providing the URLs of the user interface clients.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
.\/ci\/bin\/guitest.sh ISOLATED http:\/\/prj-client${ JOB_ID} http:\/\/prj-admin-client${ JOB_ID};<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]The results are evaluated, parsed, and copied to a location where the nginx server can serve them to the outside.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
cp -R target\/site \/repo\/tests\/${ JOB_ID}\/test-site;\n cp -R build\/test-results\/runAParallelSuite \/repo\/tests\/${ JOB_ID }\/test-results;\n cp -R build\/reports\/tests\/runAParallelSuite \/repo\/tests\/${ JOB_ID }\/test-reports;\n cat \/repo\/tests\/${ JOB_ID }\/test-site\/serenity\/results.csv;\n [ `tail -n +2 \/repo\/tests\/${ JOB_ID }\/test-site\/serenity\/results.csv | grep -v SUCCESS | wc -l` -eq 0 ] && echo 'gui test successful' || exit 1;\n \"\n mem_limit: 7500m<\/pre>\n[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)” locked=”off”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: clean up after the tests<\/h2>\n
After running the test suites, we execute the cleanup step. The cleanup can fail because of various reasons, such as abrupt program termination due to the lack of resources, corrupted data or network failure, bad cleanup procedure, or redeployment in progress. One way to deal with the situation is to also do the cleanup at the beginning of the test. If the cleanup does not succeed, then fail the test. Sometimes you cannot delete any created resources if the delete API is not available or the cleanup is too expensive.<\/p>\n
Our solution is to always use a clean database for each end-to-end test execution and to populate it with the system tests. In order to do that, we needed an isolated environment.[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)” locked=”off”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: make the tests as fast as possible<\/h2>\n
The end-to-end tests are executed in parallel, to minimize execution time. In order to do that, the tests are split into independent test suites. This means that the data consumed or produced by one suite does not alter the data of other suites running in parallel. Pay attention when certain users\u2019 actions impact all other users\u2019 running sessions. For instance: the user language is changed, the user preference to not display the menu is changed, the privileges are changed.<\/p>\n
As seen above, there is a Gradle task that extends the standard test task to which we provide the application URLs where to point the browser:<\/p>\n
For the standard test task (i.e. the one where the browser should point to, based on the application\u2019s URLs), there is a Gradle task that extends it.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
task runAParallelSuite(type: Test) {\n systemProperty \"webdriver.base.url\", findProperty(\"webdriver.base.url\")\n maxParallelForks = 3\n forkEvery = 1\n include '**\/**TestSuite.class'\n testLogging.showStandardStreams = true\n}\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]There are 3 test suites to be executed in parallel, on three threads.<\/p>\n
Other factors to influence the performance are the logging, and the capturing of screenshots. We have reduced the logging to an acceptable level, and have set up the screenshots to only be captured in case of failure. The serenity.properties file, located in the root of the end to end project, contains the configurations:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
serenity.take.screenshots=FOR_FAILURES\nserenity.logging=NORMAL<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]In order to not interfere with the browser windows, running in headless mode is also a requirement. On Linux a virtual terminal has to be set up with a certain resolution, as shown above.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
chrome.switches=--headless --disable-extensions --disable-gpu --disable-dev-shm-usage --no-sandbox<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]At some point, we got a lot of invalid session errors and headless mode, that were fixed by adding the two flags –disable-gpu –disable-dev-shm-usage.<\/p>\n
Inside the end-to-end tests xpaths based on ids have to be used for maximum performance.[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)” locked=”off”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n
How to: maintain the test suite<\/h2>\n
User journeys are written for business-important scenarios. Here, the user performs different actions, to achieve a certain goal. The tasks are performed in the user interface by interacting with it. The test asks questions or makes assumptions about the result of the visible task.<\/p>\n
Group the code into reusable tasks or actions performed by the user:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
public abstract class BaseLoginTask implements Task\npublic class OpenMyProfilePage implements Task\npublic class EnterValueIntoField implements Task\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Write reusable user interface questions or queries:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
public class ConfirmationMessageAppears implements Question<String>\npublic class ValueInColumnOfTable implements Question<List<String>>\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]In order to have a maintainable test suite, one important thing is to use xpaths based on ids and not on parent\/child relations within the HTML. The changes to the layout are performed very often and should not influence the end to end tests. Use constructs like this:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
public static Target ADD_TASK = Target.the(\"AddTask button\").located(By.id(\"btn-add-tasks\"))<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]instead of:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
Target.the(\"The second selected interaction\").locatedBy(\"\/\/div\/span\/app-link-or-text\/a\");<\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Another thing is to not introduce hard-coded wait times (like \u201cwait for 20 seconds\u201d). Instead, use constructs that wait for certain conditions to happen and provide a timeout: [\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
WaitUntil.the(ChecklistTemplates.ADD_CHECKLIST_TEMPLATE_BUTTON, WebElementStateMatchers.isEnabled()) \n.forNoMoreThan(TimeConstants.SECONDS_10). seconds().performAs(actor);\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]Several levels of time outs should be established as constants, to be used everywhere. Also, a factor to adjust the timeouts at once should be established and given as system properties when running in a slower environment.[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
public static final int SECONDS_1 = 1 * factor;\n public static final int SECONDS_3 = 3 * factor;\n public static final int SECONDS_10 = 10 * factor; \n public static final int LOADER = 5 * factor; \n public static final int LONG_LIST = 10 * factor;\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]In serenity.properties we have:[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
#How long webdriver waits for elements to appear by default, in milliseconds.\nwebdriver.wait.for.timeout=5000\n#How long webdriver waits by default when you use a fluent waiting method, in milliseconds.\nwebdriver.timeouts.implicitlywait=5000\n#How long should the driver wait for elements not immediately visible, in milliseconds.\nserenity.timeout=5000\n <\/pre>\n[\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]For slow pages, if possible, we advise introducing a progress bar or a loader indicator in the user interface, that can be checked at the beginning and end of long-running operations. [\/et_pb_text][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1em” text_line_height=”1.3em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”1em” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” background_color=”#f8f8f8″ custom_margin=”|5vw||5vw|false|false” custom_padding=”||||false|false” border_width_left=”1px” border_color_left=”#bbbbbb”]<\/p>\n
WaitUntil.the(MainUIUtilities.LOADER, WebElementStateMatchers.isVisible());\nWaitUntil.the(MainUIUtilities.LOADER, WebElementStateMatchers.isNotPresent()).\nforNoMoreThan(TimeConstants.SECONDS_10).seconds().performAs(actor);\n <\/pre>\n[\/et_pb_text][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ admin_label=”intro” _builder_version=”4.4.6″ custom_padding=”|||0px||” locked=”off”][et_pb_row use_custom_gutter=”on” _builder_version=”4.4.6″ custom_margin=”||||false|false” custom_padding=”6vh||||false|false” border_color_left=”rgba(0,0,0,0)”][et_pb_column type=”4_4″ _builder_version=”4.4.1″][et_pb_text _builder_version=”4.4.6″ text_font=”|300|||||||” text_font_size=”1.1em” text_line_height=”1.6em” quote_font=”|700|||||||” quote_text_align=”left” quote_font_size=”16px” header_2_text_color=”#ff6317″ header_2_font_size=”1.5em” header_2_line_height=”0.9em” header_3_font_size=”23px” header_4_font=”||||||||” header_4_font_size=”16px” header_4_line_height=”1.5em” header_5_font_size=”14px” custom_margin=”||||false|false” custom_padding=”||||false|false” border_color_left=”#ff6317″]<\/p>\n