Skip to main content
Version: 3.13-dev

Add Autotest

KubeRocketCI portal allows you to clone an existing repository with the autotest to your Version Control System (VCS), or use an external repository and import an autotest to the environment for running in stages or using as quality gates for applications. When an autotest is cloned or imported, the system automatically generates a corresponding repository within the integrated Version Control System.

Before following these guidelines, be sure to add Git Server to the platform.

The Create Autotest wizard contains four steps:

  • Initial Setup
  • Git & Project Info
  • Build Config
  • Review

To add an autotest, navigate to the Projects section on the navigation bar and click + Create Project.

Initial Setup​

Once clicked, the Create new project wizard will appear. In this dialog, you can make a choice:

  • Select Ready Template – this option allows you to select a preconfigured, ready-to-go autotest template.
  • Custom Configuration – this option allows you to create any of the supported Project types. In this case, you should select Autotest.

Choose one of the strategies and click Continue:

  • Import – allows using an existing VCS repository to integrate with KubeRocketCI. While importing the existing repository, select the Git server from the drop-down list and define the relative path to the repository, such as epmd-edp/examples/basic/edp-auto-tests-simple-example.

  • Clone – clones the indicated repository into KubeRocketCI. While cloning the existing repository, it is required to fill in the Repository URL field and specify the credentials if needed.

note

Autotest does not support the Create strategy. Use Import or Clone to add an autotest.

Git & Project Info​

In our example, we will use the Import strategy:

Select all the settings that define how the autotest will be added to the Git server:

  • Git server – the pre-configured server where the component will be hosted. Select one from the drop-down list. Please refer to the Manage Git Servers page to learn how to create one.
  • Owner - the relative path to the Git repository where Project will be created (e.g., MyGithubUsername123 or my-github-username).
  • Repository name - the name of the repository that will store code for this project. Must be at least two characters using the lower-case letters, numbers and inner dashes.
  • Default branch – the default branch the Project will be created with. The default branch cannot be deleted.
  • Project name – the name of the autotest. Must be at least two characters using lower-case letters, numbers, and inner dashes.
  • Description – brief and concise description that explains the purpose of the autotest.
  • Private – by default, all created Projects have private visibility settings in your Git account. Uncheck this option to create a public Git repository.

Build Config​

Specify the autotest language and versioning properties:

  • Code Language – defines the code language with its supported frameworks. For autotests, Other is often used to extend the default code languages when using the Clone/Import strategy.

  • Language version/framework – defines the specific framework or language version of the autotest. The field depends on the selected code language. Specify Java 17, Java 21, or Java 25 to be used.

  • Build Tool – allows you to choose the build tool to use. For autotests, Gradle and Maven are available.

  • Autotest report framework – all autotest reports are created in the Allure framework by default.

  • Codebase versioning type – defines how the autotest tag will be changed once the new image version is built. There are two versioning types:

    • default: Using the default versioning type, to specify the version of the current artifacts, images, and tags in the Version Control System, a developer should navigate to the corresponding file and change the version manually.
    • semver: Using the semver versioning type, a developer indicates the version number from which all artifacts will be versioned and, as a result, automatically registered in the corresponding file (e.g. pom.xml). When selecting the semver versioning type, extra fields will appear; type the version number from which you want the artifacts to be versioned. This versioning type is recommended and selected by default.
    note

    The Start Version From field should be filled out in compliance with the semantic versioning rules, e.g. 1.2.3 or 10.10.10 (0.1.0 by default). The Suffix field is also mandatory and has the SNAPSHOT value by default. Please refer to the Semantic Versioning page for details.

  • Specify the pattern to validate a commit message – the regular expression used to indicate the pattern that is followed on the project to validate a commit message in the code review pipeline. An example of the pattern: ^[PROJECT_NAME-d{4}]:.*$.

  • Integrate with Jira server – this check box is used in case it is required to connect Jira tickets with the commits and have a respective label in the Fix Version field.

    note

    To adjust the Jira integration functionality, first apply the necessary changes described on the Adjust Jira Integration page.

  • Jira Server – the integrated Jira server with related Jira tasks.

  • Specify the pattern to find a Jira ticket number in a commit message – based on this pattern, the value from KubeRocketCI will be displayed in Jira.

  • Mapping field name – the section where the additional Jira fields are specified, i.e. the names of the Jira fields that should be filled in with attributes from KubeRocketCI:

    • Select the name of the field in a Jira ticket. The available fields are: Fix Version/s, Component/s, and Labels.

    • Click the Add button to add the mapping field name.

    • Enter the Jira pattern for the field name:

      • For the Fix Version/s field, select the EDP_VERSION variable that represents a KubeRocketCI upgrade version, as in 2.7.0-SNAPSHOT. Combine variables to make the value more informative. For example, the pattern EDP_VERSION-EDP_COMPONENT will be displayed as 2.7.0-SNAPSHOT-nexus-operator in Jira.
      • For the Component/s field, select the EDP_COMPONENT variable that defines the name of the existing repository. For example, nexus-operator.
      • For the Labels field, select the EDP_GITTAG variable that defines a tag assigned to the commit in GitHub. For example, build/2.7.0-SNAPSHOT.59.

    • Click the bin icon to remove the Jira field name.

Review and Create​

The Review and Create window allows you to ensure the autotest configuration suits your needs and verify you entered the specifications correctly.

note

After the complete adding of the autotest, inspect the Manage Autotests page to learn how you can operate autotests.

Edit this page
Last updated on by Oleksandr_Stepanov@epam.com
Visit Main Site