cuzun-net/bookmate-test-project

A test automation project for service Bookmate (Web, API and mobile tests)

Test automation project for service Bookmate

Bookmate is a subscription based e-book service providing access to books, comics, audiobooks,
related social activity - reviews, comments, ratings, private and public bookshelfs.
Consists of website and mobile applications for Android and iOS.

Table of contents

• Description
• Tools and technologies
• How to run
  • Gradle command
  • Property files
    • Default property files
  • Run in Jenkins
• Telegram Notifications
• Test results report in Allure Report
• Allure TestOps integration
  • Project in Allure TestOps
  • Start a run of custom set of tests
  • Dashboards
  • Defects
• GitHub webhooks
• Jira integration
• Video of running tests

Description

The test project consists of Web, API and mobile(android) tests.
A brief list of interesting facts about the project:

• Page Object with steps using Chain of Invocations
• Fake data generating with Faker library
• Parametrized tests
• Parametrized build
• Different configuration files for test running depending on build parameters
• Config with Owner library
• Using Lombok for models for API tests
• Objects serialization/deserialization for API requests/responses using Jackson
• Using request/response specifications for API tests
• Custom Allure listener for beautiful API requests/responses logging
• Allure TestOps integration
• Autotests as test documentation
• Github webhooks on each push to trigger Jenkins build
• Jira integration
• Parallel execution

Tools and a technologies

The autotests in this project are written in Java using Selenide framework.
Gradle - is used as a build automation tool.
JUnit5 - to execute tests.
REST Assured - for easy API testing of REST services.
Jenkins - CI/CD for running tests remotely.
Selenoid - to remote launching browsers in Docker containers.
Browserstack - to run mobile tests.
Android Studio tools, Appium - to tun mobile tests locally in a mobile device emulator.
Allure Report - for test results visualisation.
Telegram Bot - for test results notifications.
Allure TestOps - as Test Management System.

Back to the table of contents ⬆

How to run

Gradle command

To run locally and in Jenkins the following command is used:

gradle clean test -Dtag=<tag> -DrunIn=<runIn>

Additional parameters:

-Dselenoid_user_sys_prop=enter_user -Dselenoid_key_sys_prop=enter_key - credentials for selenoid
-Dbrowserstack_user_sys_prop=enter_user -Dbrowserstack_key_sys_prop=enter_key - credentials for browserstack
-Dthreads=number_of_threads can be added for parallel tests execution
-DapiBaseUrl=url can be added to set a base url for API tests

tag - tests with this tag will be executed:

• API
• Web
• Android

runIn - defines an environment for running these tests:

• <not defined>(for API tests)
• browser_selenoid
• browser_local
• android_browserstack
• android_emulator
• android_real
• android_selenoid

Additional properties are retrieved from the corresponding properties file(depending on runIn value):

./resources/config/project-${runIn}.properties

Valid combinations:

graph LR
A[tag] --> B[API]
A --> C[Web]
A --> D[Android]
C --> E[browser_selenoid]
C --> F[browser_local]
D --> G[android_browserstack]
D --> H[android_emulator]
D --> I[android_real]
D --> J[android_selenoid]

Loading

Back to the table of contents ⬆

Property files

Possible properties in a project-${runIn}.properties file:

remoteDriver=
baseUrl=
browser=
browserSize=
user=
key=
deviceName=
platformVersion=

• remoteDriver - URL for remote WebDriver
• baseUrl - base URL for Web tests
• browser - browser for Web tests
• browserSize - size of browser for Web tests
• user - login for authorization. By default, it's ${browserstack_user_sys_prop} or ${selenide_user_sys_prop}, that is it comes from system properties
• key - key/password for authorization. By default, it's ${browserstack_key_sys_prop} or ${selenide_key_sys_prop}, that is it comes from system properties
• deviceName - android device name or serial number
• platformVersion - android version

Back to the table of contents ⬆

Default property files

The section below is automatically updated from content of src/test/resources/config/ directory.

Web

• project-browser_selenoid.properties

  remoteDriver=https://selenoid.autotests.cloud/wd/hub
  baseUrl=https://bookmate.com
  browser=chrome
  browserSize=1920x1080
  user=${selenoid_user_sys_prop}
  key=${selenoid_key_sys_prop}

• project-browser_local.properties

  baseUrl=https://bookmate.com
  browser=chrome
  browserSize=1920x1080

Android

• project-android_browserstack.properties

  user=${browserstack_user_sys_prop}
  key=${browserstack_key_sys_prop}
  deviceName=Samsung Galaxy S22 Ultra
  platformVersion=12.0

• project-android_emulator.properties

  remoteDriver=http://localhost:4723/wd/hub
  deviceName=Pixel_4_API_30
  platformVersion=11.0

• project-android_real.properties

  remoteDriver=http://localhost:4723/wd/hub
  deviceName=5200aecd4956a489
  platformVersion=8.0

• project-android_selenoid.properties

  remoteDriver=https://selenoid.autotests.cloud/wd/hub
  user=${selenoid_user_sys_prop}
  key=${selenoid_key_sys_prop}
  deviceName=android
  platformVersion=8.1

Back to the table of contents ⬆

Run configurations in IDEA

For convenience of running tests, IDEA run configurations are committed to this project

Back to the table of contents ⬆

Run in Jenkins

Main page of the build:

A parametrized Jenkins job can be launched with needed tag and runIn:

project-{runIn}.properties config files are created in the build workspace on start build.

Sensitive information(login names and passwords) is stored in an encrypted form in Jenkins credential storage.
And relatively safe transferred to the build by gradle arguments(see Gradle command section, 'Additional parameters') and it's values masked in the logs.

After the build is done the test results are available in:

• Allure Report
• Allure TestOps - results are uploaded there and the automated test-cases can be automatically updated accordingly to the recent changes in the code.

Back to the table of contents ⬆

Telegram Notifications

Telegram bot sends a brief report to a specified telegram chat by results of each build.

Back to the table of contents ⬆

Test results report in Allure Report

Main page

Main page of Allure report contains the following blocks:

• ALLURE REPORT - displays date and time of the test, overall number of launched tests, а также диаграмму с указанием процента и количества успешных, упавших и сломавшихся в процессе выполнения тестов
• TREND - displays trend of running tests for all runs
• SUITES - displays distribution of tests by suites
• CATEGORIES - displays distribution of unsuccessful tests by defect types

List of tests with steps and test artefacts

On the page the list of the tests grouped by suites with status shown for each test.
Full info about each test can be shown: tags, severity, duration, detailed steps.

Also additional test artifacts are available:

• Screenshot
• Page Source
• Video
• Browserstack full info link

Back to the table of contents ⬆

Allure TestOps integration

The link can be accessed only by authorized users.

Project in Allure TestOps

Test-cases in the project are imported and constantly updated from the code, so there is no need in complex process of synchronization manual test-cases and autotests.
It is enough to create and update an autotest in the code and the test-case in TMS always will be in actual state.
Manual test-cases also can be added in TMS in case of need(via web interface or via code).

stateDiagram-v2
state "Test created/updated in the code" as A
state "Build in Jenkins is triggered on push or started manually" as B
state "Jenkins build is done" as C
state "Allure TestOps launch related to the build marked as closed" as D
state "All executed test-cases are automatically created/updated according to the code" as E
[*] --> A
A --> B
B --> C
C --> D
D --> E
E --> A

Loading

Ability to start a run of custom set of tests from Allure TestOps

Any person not related to autotest creation can select a set of tests, environment parameter(RunIn) and start a run.
Allure TestOps run will be created, Jenkins job triggered with correct parameters. And results of the job will be seamlessly integrated into Allure TestOps.

As soon as the Jenkins job is done, corresponding tests get their statuses. A tester can finish manual tests(if any) and click "Close launch".

After that all these test-cases(names, steps, tags etc.) will be updated according to the recent code changes.

Back to the table of contents ⬆

Dashboards

Automation trends charts, distribution tests by some different parameters etc.:

Back to the table of contents ⬆

Defects

Knows defects are automatically recognized by defined patterns for test fails in further launches.

Back to the table of contents ⬆

GitHub webhooks

Each push to the repository triggers 3 builds in Jenkins:

gradle clean test -Dtag=API

gradle clean test -Dtag=Web -DrunIn=browser_selenoid

gradle clean test -Dtag=Android -DrunIn=android_browserstack

This way we can find problems earlier and always have actual state of test-cases in Allure TestOps.

Back to the table of contents ⬆

Jira integration

Back to the table of contents ⬆

Video of running tests

ui_test.mp4

android-test.mp4

Back to the table of contents ⬆