ТестОпс

https://qatools.ru/docs/
Admin
ТестОпс — это универсальный инструмент для комплексного тестирования, который позволяет управлять...
Tokens:31,831
Snippets:72
Trust Score:6.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Enable and Start Consul Service

Source: https://qatools.ru/docs/setup/install/packages-rpm

Reloads the systemd manager configuration to recognize the new Consul service file and then enables Consul to start automatically on boot and starts the service immediately.

```shell
systemctl daemon-reload
systemctl enable consul.service
systemctl start consul
```

--------------------------------

### Enable RabbitMQ Server

Source: https://qatools.ru/docs/setup/install/packages-rpm

Enables the RabbitMQ server to start automatically upon system boot. This command ensures that the RabbitMQ message broker is available after server restarts.

```shell
chkconfig rabbitmq-server on
```

--------------------------------

### Активация конфигурации Nginx

Source: https://qatools.ru/docs/setup/install/packages-rpm

Создание символической ссылки для включения конфигурационного файла Nginx в список доступных сайтов.

```bash
ln -s /etc/nginx/sites-available/allure.conf /etc/nginx/sites-enabled/allure.conf
```

--------------------------------

### Add Consul Repository and Install

Source: https://qatools.ru/docs/setup/install/packages-rpm

Configures the YUM package manager to include the HashiCorp repository and then installs the Consul binary. This prepares the system for running Consul as a service.

```shell
yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo
yum -y install consul
```

--------------------------------

### Install Essential Utilities

Source: https://qatools.ru/docs/setup/install/packages-rpm

Installs fundamental system utilities required for software management and system operations. This includes 'mlocate' for file searching and 'curl', 'epel-release', 'yum-utils' for package management and network operations.

```bash
yum install -y mlocate
```

```bash
yum install -y curl epel-release yum-utils
```

--------------------------------

### Запуск и включение автозапуска Nginx

Source: https://qatools.ru/docs/setup/install/packages-rpm

Команды для запуска службы Nginx и настройки ее автоматического запуска при старте системы.

```bash
systemctl start nginx
systemctl enable nginx
```

--------------------------------

### Установка Nginx и Certbot

Source: https://qatools.ru/docs/setup/install/packages-rpm

Команды для установки веб-сервера Nginx и утилиты Certbot для получения SSL-сертификатов в системах на базе Debian/Ubuntu.

```bash
sudo apt install nginx certbot
```

--------------------------------

### Конфигурация Nginx для ТестОпс

Source: https://qatools.ru/docs/setup/install/packages-rpm

Пример конфигурационного файла Nginx для проксирования запросов к сервису ТестОпс и настройки SSL. Файл должен быть сохранен как /etc/nginx/sites-available/allure.conf.

```bash
cat << EOF > /etc/nginx/sites-available/allure.conf
upstream allure {
     server 127.0.0.1:8083 weight=1;
}

server {
   listen 80;
   server_name %%DOMAIN%%;
   return 301 https://$host$request_uri;
}

server {
   listen 0.0.0.0:443 ssl;
   server_name %%DOMAIN%%;
   ssl_certificate /etc/letsencrypt/live/%%DOMAIN%%/fullchain.pem;
   ssl_certificate_key /etc/letsencrypt/live/%%DOMAN%%/privkey.pem;
   ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
   ssl_protocols TLSv1.1 TLSv1.2;
   ssl_prefer_server_ciphers on;
   location / {
       proxy_pass http://allure;
       proxy_set_header Host $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_redirect off;
   }
}
EOF
```

--------------------------------

### Получение SSL-сертификата с помощью Certbot

Source: https://qatools.ru/docs/setup/install/packages-rpm

Команда для получения SSL-сертификата для указанного домена с использованием Certbot. Замените %%DOMAIN%% на ваш домен.

```bash
certbot certonly -d %%DOMAIN%%
```

--------------------------------

### Install Amazon Corretto 17 JDK

Source: https://qatools.ru/docs/setup/install/packages-rpm

Installs Amazon Corretto 17 JDK, a Java runtime environment required for Java-based applications like TestOps. It involves importing the Corretto GPG key, adding the Corretto repository, and installing the development package.

```shell
rpm --import https://yum.corretto.aws/corretto.key
curl -L -o /etc/yum.repos.d/corretto.repo https://yum.corretto.aws/corretto.repo
yum install -y java-17-amazon-corretto-devel
```

--------------------------------

### Get TestOps Service Status

Source: https://qatools.ru/docs/setup/install/packages-rpm

Retrieves the current status of Allure TestOps services such as uaa, report, and gateway using the systemctl command.

```bash
systemctl status allure-uaa
systemctl status allure-report
systemctl status allure-gateway
```

--------------------------------

### System Package Update

Source: https://qatools.ru/docs/setup/install/packages-rpm

Updates the system's package manager and installed software. These commands ensure that the system has the latest available packages and security patches before proceeding with further installations.

```shell
yum check-update
yum upgrade
```

--------------------------------

### Restore Configuration and Restart Services

Source: https://qatools.ru/docs/setup/install/packages-rpm

Restores previously backed-up configuration files and restarts the Allure TestOps services to apply the saved configurations after an update.

```shell
cp ~/allure-gateway.conf /opt/allure-testops/gateway/conf/allure-gateway.conf
cp ~/allure-report.conf /opt/allure-testops/report/conf/allure-report.conf
cp ~/allure-uaa.conf /opt/allure-testops/uaa/conf/allure-uaa.conf

systemctl restart allure-uaa && systemctl restart allure-report && systemctl restart allure-gateway
```

--------------------------------

### Update TestOps Box Package

Source: https://qatools.ru/docs/setup/install/packages-rpm

Installs a specific version of the Allure TestOps Box package using the yum package manager.

```bash
yum install allure-testops-box-4.24.1-1
```

--------------------------------

### S3 Bucket Policy для ТестОпс

Source: https://qatools.ru/docs/setup/install/packages-rpm

JSON-политика доступа, необходимая для корректной работы ТестОпс с файлами в S3. Определяет разрешения на чтение, запись и удаление объектов, а также управление бакетом.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "S3assets",
            "Effect": "Allow",
            "Action": [
                "s3:PutObjectAcl",
                "s3:PutObject",
                "s3:ListMultipartUploadParts",
                "s3:ListBucketMultipartUploads",
                "s3:ListBucket",
                "s3:GetObjectAcl",
                "s3:GetObject",
                "s3:GetBucketLocation",
                "s3:GetBucketAcl",
                "s3:DeleteObject"
            ],
            "Resource": [
                "arn:aws:s3:::<allure_s3_bucket_name>/*",
                "arn:aws:s3:::<allure_s3_bucket_name>"
            ]
        }
    ]
}
```

--------------------------------

### Consul Configuration File

Source: https://qatools.ru/docs/setup/install/packages-rpm

Provides a minimal configuration for Consul to run as a server. This includes setting the data directory, client address, server mode, bind address, advertise address, and bootstrap expectation.

```shell
data_dir = "/opt/consul"
client_addr = "127.0.0.1"
server = true
bind_addr = "0.0.0.0"
advertise_addr = "127.0.0.1"
bootstrap_expect=1
```

--------------------------------

### Create Report PostgreSQL Database

Source: https://qatools.ru/docs/setup/install/packages-rpm

Creates a dedicated PostgreSQL user 'report' and a database 'report' with specific encoding and collation settings. It grants all necessary privileges to the user for the database and the public schema.

```sql
CREATE USER report WITH PASSWORD 'reportreport';
CREATE DATABASE report TEMPLATE template0 ENCODING 'utf8' LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8';
\c report
GRANT ALL PRIVILEGES ON database report to report;
GRANT ALL PRIVILEGES ON SCHEMA public TO report;
\q
exit
```

--------------------------------

### Backup TestOps Configuration Files

Source: https://qatools.ru/docs/setup/install/packages-rpm

Saves the configuration files for Allure TestOps gateway, report, and uaa services to the user's home directory before performing an update.

```shell
cp /opt/allure-testops/gateway/conf/allure-gateway.conf ~/
cp /opt/allure-testops/report/conf/allure-report.conf ~/
cp /opt/allure-testops/uaa/conf/allure-uaa.conf ~/
```

--------------------------------

### Stop TestOps Services

Source: https://qatools.ru/docs/setup/install/packages-rpm

Stops the Allure TestOps services including uaa, report, and gateway using the systemctl command.

```bash
systemctl stop allure-uaa
systemctl stop allure-report
systemctl stop allure-gateway
```

--------------------------------

### Submitting Suggestions and Feedback

Source: https://qatools.ru/docs/support

Details the process for submitting product suggestions and feedback. Access is restricted to registered users. Suggestions guide the product roadmap but implementation is not guaranteed.

```APIDOC
SubmitSuggestion:
  Access: Registered users only
  Location: https://help.qatools.ru/ideas/
  Process:
    1. Register or log in to the support portal.
    2. Navigate to the suggestions page.
    3. Add new suggestions or vote for existing ones.
  Notes:
    - Submission does not guarantee implementation or response time.
    - Suggestions serve as input for the product roadmap.
    - The team reserves the right not to implement or respond to every suggestion.
  Required Information for Evaluation:
    - Context: Describe the task or problem.
    - Proposed Solution: Detail the desired feature or change.
    - Alternatives: Mention other approaches tried or considered.
    - Additional materials (process descriptions, links) are helpful.
```

--------------------------------

### Create UAA PostgreSQL Database

Source: https://qatools.ru/docs/setup/install/packages-rpm

Creates a dedicated PostgreSQL user 'uaa' and a database 'uaa' with specific encoding and collation settings. It grants all necessary privileges to the user for the database and the public schema.

```sql
CREATE USER uaa WITH PASSWORD 'uaauaa';
CREATE DATABASE uaa TEMPLATE template0 ENCODING 'utf8' LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8';
\c uaa
GRANT ALL PRIVILEGES ON database uaa to uaa;
GRANT ALL PRIVILEGES ON SCHEMA public TO uaa;
\q
exit
```

--------------------------------

### View TestOps Service Logs

Source: https://qatools.ru/docs/setup/install/packages-rpm

Displays real-time logs for Allure TestOps services (uaa, report, gateway) using journalctl, with the -f flag to follow new entries.

```bash
journalctl -f -u allure-uaa
journalctl -f -u allure-report
journalctl -f -u allure-gateway
```

--------------------------------

### Configure S3 Blob Storage

Source: https://qatools.ru/docs/setup/install/packages-rpm

Sets environment variables to configure Allure TestOps to use S3-compatible object storage, specifying endpoint, bucket, region, and credentials.

```shell
ALLURE_BLOBSTORAGE_TYPE=S3
ALLURE_BLOBSTORAGE_S3_PATHSTYLEACCESS=true
ALLURE_BLOBSTORAGE_S3_ENDPOINT="http://localhost:9000"
ALLURE_BLOBSTORAGE_S3_BUCKET=testops
ALLURE_BLOBSTORAGE_S3_REGION=region
ALLURE_BLOBSTORAGE_S3_ACCESSKEY=M8P2RAAa73KCBNmXKcp9csX5u5SXUg7L
ALLURE_BLOBSTORAGE_S3_SECRETKEY=YPZNUd5eULXGTZN9c9dNj8M4vffCpYPE
```

--------------------------------

### Consul Systemd Service File

Source: https://qatools.ru/docs/setup/install/packages-rpm

Defines a systemd service unit for Consul, specifying its description, dependencies, execution commands, restart policy, and resource limits. This allows Consul to be managed as a background service.

```shell
[Unit]
Description=Consul
Documentation=https://www.consul.io/
Requires=network-online.target
After=network-online.target

[Service]
User=root
Group=root
ExecStart=/usr/bin/consul agent -config-dir=/etc/consul.d/
ExecReload=/bin/kill -HUP $MAINPID
KillMode=process
Restart=on-failure
LimitNOFILE=65536

[Install]
WantedBy=multi-user.target
```

--------------------------------

### TestOps Kaiten Integration Setup

Source: https://qatools.ru/docs/integrations/issue-trackers/kaiten

Instructions for adding and configuring the Kaiten integration within the TestOps platform, including specifying the Kaiten endpoint.

```APIDOC
TestOps Integration Configuration:

1. Access your TestOps instance.
2. Navigate to Administration → Integrations.
3. Click + Add integration.
4. Select Kaiten from the list of available integrations.
5. Fill in the fields:
   - Name: A descriptive name for the integration (e.g., Kaiten production).
   - Endpoint: The URL of your Kaiten instance (e.g., https://example.kaiten.ru/).
6. Click Add integration.
```

--------------------------------

### First Response Definition

Source: https://qatools.ru/docs/support

Explains what constitutes a 'First Response' from technical support, clarifying that it's an initial acknowledgment and not necessarily a final solution.

```APIDOC
FirstResponse:
  Definition: The initial message from a support specialist confirming receipt and commencement of review for a request or chat message.
  Content:
    - May not contain the final solution.
    - Confirms acknowledgment and review process initiation.
```

--------------------------------

### Remove TestOps Packages

Source: https://qatools.ru/docs/setup/install/packages-rpm

Uninstalls the Allure TestOps Box package using the yum package manager.

```bash
yum remove allure-testops-box
```

--------------------------------

### Установка ТестОпс 5.x в Docker Compose

Source: https://qatools.ru/docs/setup/install/compose-5

Руководство по установке ТестОпс версии 5.x с использованием Docker Compose. Этот метод подходит для небольших команд и нагрузок (до 3000 результатов автотестов за запуск или 30 000 в сутки). Для больших нагрузок рекомендуется Kubernetes или пакетная установка.

```markdown
# Установка ТестОпс версии 5.x в Docker Compose

Внимание

В разделе описывается, как установить и запустить **ТестОпс версии 5.х** в Docker Compose.

Инструкция для версии 4.x перенесена [в архив](/docs/setup/install/compose/). Чтобы установить и запустить ТестОпс, пожалуйста, используйте только актуальную инструкцию.

Установка с помощью [Docker Compose](https://docs.docker.com/compose/) - самый простой вариант установки ТестОпс, но подходит только для небольших команд с относительно небольшой нагрузкой (не более 3 000 результатов автотестов за запуск или не более 30 000 — в сутки). Если нагрузка возрастает, стабильность работы в Docker Compose будет ниже, чем при использовании [Kubernetes](/docs/setup/install/kubernetes-5/) или при установке [c помощью пакетов Linux](/docs/setup/install/packages-deb-5/).
```

--------------------------------

### Check Service Status in Consul

Source: https://qatools.ru/docs/setup/install/packages-rpm

Queries the Consul API using curl to check the health status of Allure TestOps services like ee-gateway, ee-uaa, and ee-report.

```bash
curl  http://127.0.0.1:8500/v1/health/service/allure-ee-gateway
curl  http://127.0.0.1:8500/v1/health/service/allure-ee-uaa
curl  http://127.0.0.1:8500/v1/health/service/allure-ee-report
```

--------------------------------

### Редактирование файла конфигурации TestOps

Source: https://qatools.ru/docs/setup/install/packages-rpm-5

Команда для открытия файла конфигурации TestOps в текстовом редакторе nano с правами суперпользователя. Требуется для внесения изменений в параметры системы.

```sh
sudo nano /opt/testops/conf/testops.conf
```

--------------------------------

### Миграция с ТестОпс версии 4.x на 5.x

Source: https://qatools.ru/docs/setup/install/compose-5

Информация о процессе миграции с ТестОпс версии 4.x на версию 5.x. Подчеркивается, что версия 5.x не может быть установлена поверх 4.x, и требуется миграция данных и конфигурации. Обновление возможно только с версии 4.26.5.

```markdown
## Миграция с ТестОпс версии 4.x

Внимание

ТестОпс версии 5.х нельзя развернуть поверх версии 4.х. Для обновления необходима миграция данных в одну базу данных, а также переход на новую конфигурацию.

Перейти на ТестОпс версии 5.х можно только с версии **4.26.5**. Обновление с более старых версий приведет к **сбоям в системе** и **потере данных**.

Чтобы обновить ТестОпс версии 4.26.5 до версии 5.x, пожалуйста, обратитесь к [руководству по миграции](/docs/setup/install/to-5/).
```

--------------------------------

### Execute Tests with a Testplan

Source: https://qatools.ru/docs/ecosystem/allurectl

This snippet demonstrates how to set up environment variables for Allure TestOps, create a testplan.json file from a specified test plan ID, and then execute tests using the allurectl watch command with the generated test plan.

```shell
export ALLURE_TOKEN=<token>
export ALLURE_ENDPOINT=https://testops.example.com
export ALLURE_PROJECT_ID=111
export ALLURE_LAUNCH_NAME="$(date \"+%Y-%m-%d %H%M%S\") executing test plan"
export ALLURE_LAUNCH_TAGS="watch, testplan"
export ALLURE_RESULTS="allure-results"
export ALLURE_TESTPLAN_PATH="testplan.json"
# Создание testplan.json на основе тест-плана с идентификатором 222
./allurectl test-case plan -q "testPlan=222" --output-file ${ALLURE_TESTPLAN_PATH}
# Запуск тестов, указанных в testplan.json
./allurectl watch -- [tests_execution_command]
```

--------------------------------

### Security-Related Requests

Source: https://qatools.ru/docs/support

Defines the procedure for reporting security vulnerabilities and threats. All other inquiries should be submitted as standard support requests.

```APIDOC
SecurityRequest:
  Purpose: Notify the TestOps team about security issues.
  Types:
    - Found vulnerabilities.
    - Security threats, including user data compromise.
  Escalation:
    - For all other requests, submit as 'Support Requests'.
  Channel:
    - Direct channel to the product team via the support portal.
```

--------------------------------

### Очистка сессий Redis с помощью FLUSHALL

Source: https://qatools.ru/docs/troubleshooting

Эта команда очищает все сессионные данные, хранящиеся в Redis, сбрасывая сессии всех пользователей и принудительно выходя их из системы. Используется для решения проблем с «застрявшими сессиями» из-за расхождений часовых поясов. Команда не влияет на постоянные данные ТестОпс.

```shell
redis-cli FLUSHALL
```
Tokens:
Raw