Admin Guide

Logging into the system after installation

During installation, a temporary user with the role of "admin" (password Qwerty123) is created in the system with installation permission. The "Remember me" flag allows you to save data entered when logging in in a browser or on a device after entering your login and password.

We recommend changing the user's password before the system is put into use.

Log into the system as a user with the role of "admin."

Trial period

After Test IT is installed, it can be used by 25 users for 30 days. If you purchase a license, all data in the system during that period will be saved. When a user logs in as an administrator, they will see a notification about how much time is left until the end of the trial period.

Admin panel

To go to the Admin section, click on the avatar or the three dots in the upper right corner, then select "Admin" from the pop-up menu.

Users

In the "Users" tab you have access to a list of all users from AD and local users, as well as an "Add" button for adding a local user:

To the left of the search field is a "gear" symbol that allows you to configure the columns that are displayed. Settings are saved for the current browser.

Clicking on a line with a local user opens a window for editing the user.

The left column with "checkbox" controls allows you to select multiply local users, which will remove them from the system.

The validity of the values that have been entered is checked in the modal window for adding and editing users.

Groups

In the "Groups" tab you can create and edit names and descriptions for local groups, add users to groups and delete them, filter users, and configure columns:

To add users to the current group (the one highlighted in the left-hand column), check the boxes next to the desired users in the right-hand column, then press the button :

To delete users from the current group, select the users you want to delete from the user list in the middle of the screen and press "Delete."

Import of test documentation from TestRail

In the "Import" tab, you can import xml files exported from TestRail. Test documentation can be uploaded to a new project as well as to an existing one.

You can upload several files at once and track their progress. When the file processing is complete, the imported project will be displayed in the Test IT project list. Test IT supports standard types of xml uploads from TestRail, you can download tests with checks and expected results, as well as separated by steps.

JIRA integration

For Jira integration to work correctly, you need to set the FRONTEND_URL variable in the .env file

Before integration, you need to install the "Test IT" plugin. Installation instructions are here.

On the "Integration with Jira" tab, you can create / edit / delete connections to Jira and use a button to sync all projects using this connection to Jira.

Click on the "Create" button to open a pop-up with connection settings.

In the "Name" field, enter the name of the connection which will be reflected in the Test IT UI.

In the "URL" field, enter the full JIRA address including the protocol and port (if necessary). The fields "Login" and "Password" must be filled with the credentials of the JIRA administrator account

After entering information in the fields, click "Test". If the information has been entered correctly, you will be able to click "Save". In case of an error in the fields, an error message will appear next to the test button.

Integration with JIRA can then be used to connect the TestIT project to JIRA

JIRA Cloud integration

For Jira integration to work correctly, you need to set the FRONTEND_URL variable in the .env file

You need to configure the Jira cloud in advance:

1) Create hiddenSteps and testResultId fields (once for the whole system)

a) Go to Jira project settings / "Fields"

b) Create fields with names hiddenSteps and testResultId

Field type - a multi-line text field:

c) Apply the field to all screens that are used in projects that will be integrated with Test IT.

d) Repeat the steps above with the attribute testResultId.

2) Create task type (one time for the whole system)

a) Go to "System Settings / Issues".

b) Create a new task type by clicking the button "Add issue type". The name of the task type is TestCase.

Result:

3) Add Issue type to the project (for each project)

a) Switch to settings of the project to be integrated with TestIT.

b) Select "Issue types".

c) Add the created issue type to the scheme.

It is important that the new Issue type is present in all necessary schemes, otherwise duplication will not work.

d) Click on the TestCase issue type and add the hiddenSteps field to it.

4) Get Jira token

a) Open the Administration panel in the "Account Settings" section.

b) Open the "Security" section.

3) Create token.

Attention! Token cannot be received after closing the window.

5) Features of creating integration with cloud Jira in the administrative section of TestIT

a) The user login must be specified in full (with @mail.mail).

b) Password = Jira token.

Role editor

In the "Role editor" tab, you can add roles to users and groups:

  • they can be added and displayed in the table using the input field in which user logins or group names are entered.

  • roles can be assigned to users and groups by checking their boxes.

  • the admin role makes it possible to gain access to all functionality; the user role is required to log into the system in the absence of the admin role, the project manager role gain access to creating new projects without access to the administrative part of TestIT; a user cannot log in without a role.

  • when a role is unassigned from a user (by double-clicking on their checkbox), their session is automatically terminated, i.e. they will be returned to the system login page.

  • a user cannot assign a role to themselves (clicking on the checkbox will lead to an error).

  • if a user is added via AD/LDAP to a group that has permissions in our system, synchronization may take up to 20 minutes.

Project roles

On this page you can view access rights for pre-defined roles, create new roles and edit role rights.

Predefined roles: ProjectAdmin - full access to all project functionality, including its configuration.

TestManager - all project functionality is available, except its settings.

TestDesigner - role for users who work with the test library, access to other functionality is closed (except for Requests). Note, the role has no rights to delete test cases, only changes.

TestEngineer - with this role, the expert will have access to all sections, but without the right to delete entities.

TestExecutor - a role for starting, passing manual and autotests. Responsibility area - tab "Test plans / Execution".

Observer - minimum access to the project, only viewing of elements.

Sections of Test Management System with access restriction:

  • Project editing – section of project setting and configuration, where modifications and change of project description are available; addition of user and project team attributes ; setting of an external server project integration (JIRA).

  • Test library – an archive section of the project’s test documentation (test-cases, check-lists, shared steps).

  • Configurations – section for creating and setting of configurations within the project (Within which tests will be carried out)

  • Test planning – section of archiving project test-plans, for creation, filling and task-allocation between users.

  • Test execution – section for performing test plans which enables to record test case results as well as launch auto tests.

  • Test plan report – section of categorised reports on test plan results.

  • Autotests – section of automated tests

  • Queries – section for creating filtered queries to search amongst different test cases of the project.

  • Reports - section of consolidated reporting for the project

Levels of Access:

  • Access forbidden – the user will not have access to the section, the UI will not allow to redirect to the section; when using a direct link, access will also be forbidden. UI elements related to it will be hidden.

  • View – the user will have access to the section, the interface will also include an option to redirect to the section; when using a direct link, access will be granted. UI elements that allow to alter the content will be hidden. Errors will occur, when trying to edit the data through API.

  • Editing – allows to preview, create and edit sections and work items. The user is granted with access to the section, the interface has an option to redirect to it. Direct link transition is allowed. UI elements that enable creation and editing of the section contents are also enabled. Deleting is not allowed. UI elements that allow to delete section contents will be hidden. Errors will occur, when trying to delete the data through API.

  • Full access – includes the right to preview, create, edit and delete sections as well as work items. UI elements that allow creation, editing and deleting section contents are enabled .

To create a new role, click the "Create Role" button and enter a role name. A role will be created with minimal rights, which can be changed by clicking on a pencil near the role name.

Some rights to elements cannot be changed, for example, you may not deny access to the Test Library or restrict access to "Requests".

AD/LDAP

In the "AD/LDAP" tab you can edit the active directory (or LDAP) connection. The tab also contains a button that can be used to force synchronization. Reading and synchronization occurs every 5 minutes.

In the AD/LDAP settings, you can specify a user/group scheme to support most services.

Implemented the ability to add users from only one group to AD.

User Schema: An example filter for users from one group:

(&(objectCategory=Person)(sAMAccountName=*)(memberOf=CN=Group-Sonya,OU=Sonya-test,OU=podrazdelenie2,OU=Podrazdelenie1,DC=mtest,DC=ru))

An example of a filter that adds users from nested groups:

(&(objectCategory=Person)(sAMAccountName=*)(memberOf:1.2.840.113556.1.4.1941:=CN=Group-Sonya,OU=Sonya-test,OU=podrazdelenie2,OU=Podrazdelenie1,DC=meistertest,DC=ru))

Group Schema: Фильтр для одной группы (имя начинается с ..) :

(&(objectCategory=group)(name=Group-Sonya*))

On the AD/LDAP connection screen, you can create multiple connections or select a default connection.

The selected default connection will be displayed on the login page as the primary connection.

Loggin in via Open ID Connect

Test IT allows you to sign in using an external provider that supports the Open ID Connect protocol.

To create this kind of connection, set the necessary fields, the base domain of the service we are using to sign in, and an endpoint for receiving the Open ID Connect configuration.

In addition to this, you also need to enter the application ID and secret key you got from the provider. The scopes necessary to obtain information about users from the external system are also required.

Specify the Callback URL on the external system, replacing the domain with yours in this example: https://{test_it_domain}/api/auth/signin-oidc.

Once the provider's Open ID Connect has been added, the option to log in using it will appear on the login page:

A user who signs in using the provider's Open ID Connect will be registered in the system and assigned the role of user as long as free licenses are available.

Licenses

You can add a license key in the "Licenses" tab:

  • To get a key, contact order@testit.software from the mailbox linked to your account on the testit.software website. Enter the server ID in the body or header of the email

  • Copy the server ID by, for example, pressing the button to the right of it

  • Once you have copied the key, paste it into the window that appears when you press the "Add" button

  • To activate the key you have added, press the "Activate" button

Projects

When you click on the logo in the upper left corner, a project list will appear in which you can create a new project and edit an existing one, as well as configure access permissions to it.

There is a "Project manager" role in the role editor. A user with this role has full access to creating, editing, and configuring the project, but cannot access the admin panel.