Allure TestOps

https://docs.qameta.io/
Admin
Allure TestOps is an actionable reporting platform and test management system built around...
Tokens:338,575
Snippets:2,953
Trust Score:9.5
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install RabbitMQ

Source: https://docs.qameta.io/allure-testops/server/install/linux-packages/deb

Commands to install RabbitMQ server on Debian-based systems. Includes downloading the Erlang setup script, installing dependencies, downloading the RabbitMQ .deb package, and enabling/starting the service.

```bash
wget -q -O- https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/setup.deb.sh | sudo bash
sudo apt install -y socat logrotate erlang
wget https://github.com/rabbitmq/rabbitmq-server/releases/download/v3.13.2/rabbitmq-server_3.13.2-1_all.deb -O rabbitmq-server.deb
sudo dpkg -i rabbitmq-server.deb
sudo systemctl enable rabbitmq-server
sudo systemctl start rabbitmq-server
```

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

### Install PostgreSQL 15

Source: https://docs.qameta.io/allure-testops/server/install/linux-packages/rpm

Installs PostgreSQL 15 server, initializes the database, and enables/starts the service.

```bash
sudo yum install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-$(rpm -E %{rhel})-$(arch)/pgdg-redhat-repo-latest.noarch.rpm
sudo dnf -y module disable postgresql
sudo yum install -y postgresql15-server
sudo /usr/pgsql-15/bin/postgresql-15-setup initdb
sudo systemctl enable postgresql-15
sudo systemctl start postgresql-15
```

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

### AQL launch function: createdDate > dayStartUtc()

Source: https://docs.qameta.io/reference/aql

Use dayStartUtc() to get today's day start as an epoch UTC time stamp. The example filters launches created after the start of today.

```aql
createdDate > dayStartUtc()
```

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

### upload example with command line parameters

Source: https://docs.qameta.io/allure-testops/reference/ecosystem/allurectl

Runs allurectl upload with all required parameters provided as command-line flags, including endpoint, token, project ID, launch name, tags, and the results directory.

```bash
./allurectl upload \
  --endpoint https://testops.example.com \
  --token 55555555-5555-5555-5555-555555555555 \
  --project-id 100 \
  --launch-name "Local verification run" \
  --launch-tags "regress, nightly" \
  /path/to/allure-results

```

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

### Start Allure TestOps services

Source: https://docs.qameta.io/allure-testops/server/install/linux-packages/deb

Use this command to start all Allure TestOps services after installation or when they are stopped.

```bash
sudo systemctl start testops

```

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

### Complete SAML2 configuration example for testops.conf

Source: https://docs.qameta.io/allure-testops/server/configure/authentication/saml/okta-saml-2-0

Example environment variables for enabling SAML2 with Okta. Set ALLURE_LOGIN_PRIMARY to 'system' initially for testing, and use ROLE_GUEST as default role when syncRoles is true.

```properties
ALLURE_LOGIN_PRIMARY=system
ALLURE_LOGIN_SAML2_ENABLED=true
ALLURE_LOGIN_SAML2_ID=okta
ALLURE_LOGIN_SAML2_ACS_URL=https://testops.xyz/api/login/saml2/sso/{registrationId}
ALLURE_LOGIN_SAML2_ENTITY_ID=https://testops.xyz/api/login/saml2/authenticate/{registrationId}
ALLURE_LOGIN_SAML2_METADATA_URL=https://trial-000000.okta.com/app/eXXXXXXXXXXXXXXXX7/sso/saml/metadata
ALLURE_LOGIN_SAML2_DEFAULTROLE=ROLE_GUEST
ALLURE_LOGIN_SAML2_FIRSTNAMEATTRIBUTE=firstName
ALLURE_LOGIN_SAML2_LASTNAMEATTRIBUTE=lastName
ALLURE_LOGIN_SAML2_EMAILATTRIBUTE=email
ALLURE_LOGIN_SAML2_SYNCROLES=true
ALLURE_LOGIN_SAML2_GROUPROLEATTRIBUTE=groups
ALLURE_LOGIN_SAML2_GROUPAUTHORITIES_ROLEUSERGROUPS=ato_users
ALLURE_LOGIN_SAML2_GROUPAUTHORITIES_ROLEADMINGROUPS=ato_admins
```

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

### watch example with command line parameters

Source: https://docs.qameta.io/allure-testops/reference/ecosystem/allurectl

Runs allurectl watch with all required parameters provided as command-line flags, including endpoint, token, project ID, launch name, tags, and results path.

```bash
./allurectl watch \
  --endpoint https://testops.example.com \
  --token 55555555-5555-5555-5555-555555555555 \
  --project-id 100 \
  --launch-name "Local verification run" \
  --launch-tags "regress,nightly" \
  --results path/to/allure-results \
  -- /path/to/tests/execution/command

```

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

### List all installed components in the testops namespace

Source: https://docs.qameta.io/allure-testops/server/install/kubernetes

Use this command to get the list of all installed components in the 'testops' namespace, which is the first step in collecting debug information.

```bash
kubectl get all -n testops

```

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

### Install the VS Code extension via command line

Source: https://docs.qameta.io/allure-testops/reference/ecosystem/vs-code-plugin

Install the qameta.allure-vscode extension from the VS Code marketplace or by using the command palette (Ctrl+P) and pasting this command.

```shell
ext install qameta.allure-vscode

```

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

### Example output of docker compose ps

Source: https://docs.qameta.io/allure-testops/server/upgrade/archive/v4-docker-compose-installation

Example output showing service names, statuses, and ports. The SERVICE column is used to get logs for specific components.

```text
name@computer folder-name % docker compose ps
NAME                 COMMAND                  SERVICE                    STATUS               PORTS
allure-gateway       "/bin/sh -c /entrypo…"   allure-gateway             running (healthy)   0.0.0.0:10777->8080/tcp
allure-report        "/bin/sh -c /entrypo…"   allure-report              running (healthy)
allure-uaa           "/bin/sh -c /entrypo…"   allure-uaa                 running (healthy)
autoheal             "/docker-entrypoint …"   autoheal                   running (healthy)
minio-local          "/opt/bitnami/script…"   minio-local                running              0.0.0.0:9000->9000/tcp
minio-provisioning   "/bin/sh -c 'mc conf…"   minio-local-provisioning   exited (0)
rabbit               "/opt/bitnami/script…"   rabbitmq                   running              25672/tcp
redis                "/opt/bitnami/script…"   redis                      running (healthy)    6379/tcp
report-db            "docker-entrypoint.s…"   report-db                  running              5432/tcp
uaa-db               "docker-entrypoint.s…"   uaa-db                     running              5432/tcp

```

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

### Configuration file example

Source: https://docs.qameta.io/allure-testops/reference/ecosystem/allurectl

Shows the content of an allurectl configuration file (default location ~/.allure/config.yaml) with the endpoint parameter.

```yaml
endpoint: https://your-testops.example.com

```

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

### DEB/RPM testops.conf HTTPS configuration

Source: https://docs.qameta.io/allure-testops/server/configure/network-and-https

Update ALLURE_ENDPOINT to use https instead of http in /opt/testops/conf/testops.conf. This example shows the required parameter for enabling HTTPS in DEB or RPM installations.

```properties
ALLURE_ENDPOINT=https://testops.example.com

```

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

### Apply the Pipeline with kubectl

Source: https://docs.qameta.io/allure-testops/reference/integrations/ci-systems/tekton

Applies the 'allure-example-pipeline.yaml' file to create the Tekton Pipeline in the cluster.

```bash
kubectl apply -f allure-example-pipeline.yaml

```

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

### Docker Compose .env HTTPS configuration

Source: https://docs.qameta.io/allure-testops/server/configure/network-and-https

Update TESTOPS_PROTO to https and TESTOPS_INSTANCE_PORT to 443. This example shows the required environment variables for enabling HTTPS in a Docker Compose installation.

```env
TESTOPS_PROTO=https
TESTOPS_INSTANCE_URL=testops.example.com
TESTOPS_INSTANCE_PORT=443
TESTOPS_CONTAINER_PORT=8080

```

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

### allurectl watch --help

Source: https://docs.qameta.io/allure-testops/reference/ecosystem/allurectl

Displays help information for the watch command.

```bash
allurectl watch --help

```

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

### AQL launch function: createdDate > weekAgo()

Source: https://docs.qameta.io/reference/aql

Use weekAgo() to get the UTC epoch time stamp back 1 week from now. The example returns everything created during the last week.

```aql
createdDate > weekAgo()
```

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

### Environment variables example for upload

Source: https://docs.qameta.io/allure-testops/reference/ecosystem/allurectl

Sets the required environment variables (ALLURE_ENDPOINT, ALLURE_TOKEN, ALLURE_PROJECT_ID, ALLURE_LAUNCH_NAME) and runs allurectl upload to upload results from a specified directory.

```bash
# defined somewhere in the pipeline
export ALLURE_ENDPOINT=https://testops.example.com
export ALLURE_TOKEN=55555555-5555-5555-5555-555555555555
export ALLURE_PROJECT_ID=100
export ALLURE_LAUNCH_NAME="Nightly API tests"

# tests executed somewhere
# results are copied from somewhere to /path/to/allure-results

# uploading results
./allurectl upload /path/to/allure-results

```

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

### AQL launch function: createdDate > sixMonthsAgo()

Source: https://docs.qameta.io/reference/aql

Use sixMonthsAgo() to get the UTC epoch time stamp back 6 months from now. The example returns everything created during the last 6 months.

```aql
createdDate > sixMonthsAgo()
```

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

### Install RabbitMQ (optional)

Source: https://docs.qameta.io/allure-testops/server/upgrade/archive/v4-rpm-installation

Installs RabbitMQ server on the same machine as Allure TestOps. Not recommended for high-load use cases.

```bash
curl -1sLf 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/setup.rpm.sh' | sudo bash
sudo yum install -y socat logrotate initscripts erlang
sudo yum install -y https://github.com/rabbitmq/rabbitmq-server/releases/download/v3.9.14/rabbitmq-server-3.9.14-1.el8.noarch.rpm
sudo chkconfig rabbitmq-server on
sudo /sbin/service rabbitmq-server start

```
Tokens:
Raw