### Install and Start RabbitMQ Server on RHEL/CentOS Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm These commands install RabbitMQ server, which can be run on the same machine as Allure TestOps for low-load scenarios. It sets up the RabbitMQ Erlang repository, installs necessary dependencies, installs the RabbitMQ server package, configures it to start on boot, and starts the service. ```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 ``` -------------------------------- ### Start Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm This command initiates all Allure TestOps services, bringing the application online. ```Shell sudo systemctl start testops ``` -------------------------------- ### Start Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Command to initiate and run the Allure TestOps gateway, UAA, and report services using systemctl. ```Shell sudo systemctl start allure-gateway allure-uaa allure-report ``` -------------------------------- ### Start Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Command to initiate the Allure TestOps gateway, UAA, and report services using `systemctl`. ```Shell sudo systemctl start allure-gateway allure-uaa allure-report ``` -------------------------------- ### List All Kubernetes Resources Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-kubernetes Retrieves a comprehensive list of all Kubernetes resources (deployments, pods, services, etc.) in the current namespace, useful for checking the status of installed components. ```bash kubectl get all ``` -------------------------------- ### Install and Initialize PostgreSQL 15 Server on RHEL/CentOS Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm This sequence of commands installs PostgreSQL 15 server on a RHEL/CentOS system. It adds the PostgreSQL YUM repository, disables the default PostgreSQL module, installs the server package, initializes the database, and then enables and starts the PostgreSQL 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 ``` -------------------------------- ### Start Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-docker-compose Starts all Docker services for Allure TestOps in detached mode. This command is used for initial setup, license activation, and general service startup. ```docker docker compose up -d ``` -------------------------------- ### Install RabbitMQ on Ubuntu Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb Commands to install RabbitMQ, including adding the Erlang repository, installing dependencies, downloading the RabbitMQ DEB package, installing it, 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 ``` -------------------------------- ### Start Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb This command initiates all Allure TestOps services. Use it to bring the application online after it has been stopped or after system boot. ```shell sudo systemctl start testops ``` -------------------------------- ### Start Allure TestOps 5.x Instance with systemctl Source: https://docs.qameta.io/allure-testops/advanced/api/migrations/to-5 This command starts the Allure TestOps 5.x service using `systemctl`. This is typically used for DEB/RPM installations where Allure TestOps is configured as a system service. ```Shell sudo systemctl start testops ``` -------------------------------- ### Install and Initialize PostgreSQL 14 Server on RHEL/CentOS Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm These commands install PostgreSQL 14 server, which can be run on the same machine as Allure TestOps for low-load scenarios. It adds the PostgreSQL YUM repository, disables the default PostgreSQL module, installs the server, initializes the database, enables it to start on boot, and 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 postgresql14-server sudo /usr/pgsql-14/bin/postgresql-14-setup initdb sudo systemctl enable postgresql-14 sudo systemctl start postgresql-14 ``` -------------------------------- ### Install RabbitMQ Server on RHEL/CentOS Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm These commands install RabbitMQ server, including its Erlang dependency, on a RHEL/CentOS system. It adds the RabbitMQ Erlang repository, installs necessary utilities and Erlang, then installs the RabbitMQ server RPM, and finally enables and starts the RabbitMQ service. ```bash wget -q -O- 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.13.2/rabbitmq-server-3.13.2-1.el8.noarch.rpm sudo chkconfig rabbitmq-server on sudo /sbin/service rabbitmq-server start ``` -------------------------------- ### Get Allure TestOps Installed Components with Kubectl Source: https://docs.qameta.io/allure-testops/advanced/api/install/kubernetes This command lists all Kubernetes resources (deployments, services, pods, etc.) within the 'testops' namespace, providing an overview of all installed Allure TestOps components. It's useful for verifying the presence and status of your setup. ```bash kubectl get all --namespace testops ``` -------------------------------- ### Check Docker Compose V2 Installation Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose This command verifies if Docker Compose V2 is correctly installed on your system by displaying its version. ```bash docker compose version ``` -------------------------------- ### Example Output: Docker Compose Services List Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-docker-compose This is an example of the output generated by the `docker compose ps` command. The 'SERVICE' column is particularly important as it provides the names of individual components (e.g., allure-gateway, allure-report) that can be used to filter logs. ```Shell 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 ``` -------------------------------- ### Start Allure TestOps 5.x Instance with Docker Compose Source: https://docs.qameta.io/allure-testops/advanced/api/migrations/to-5 This command starts the Allure TestOps 5.x instance in detached mode using Docker Compose. It assumes you are in the Allure TestOps installation directory where the `docker-compose.yml` file is located. ```Shell docker compose up -d ``` -------------------------------- ### Start Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Starts all Allure TestOps services in detached mode using Docker Compose. This command launches the application and its dependencies, allowing it to run in the background. ```bash docker compose up -d ``` -------------------------------- ### Edit Allure TestOps configuration file Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Example command to open an Allure TestOps configuration file with superuser privileges using `sudo nano`. This allows modification of parameters. ```bash sudo nano /opt/allure-testops/gateway/conf/allure-gateway.conf ``` -------------------------------- ### Example Gmail Configuration for DEB/RPM (testops.conf) Source: https://docs.qameta.io/allure-testops/advanced/api/configuration/smtp An example `testops.conf` file configuration snippet illustrating how to set up mail server parameters for a Gmail account in a DEB/RPM installation. This includes SMTP host, port, authentication, and TLS/SSL settings. Note that Google requires dedicated app passwords for SMTP. ```Properties SPRING_MAIL_HOST=smtp.gmail.com SPRING_MAIL_PORT=587 ALLURE_MAIL_FROM=[email protected] SPRING_MAIL_PASSWORD=Ohku6Zo9gee5aen0 SPRING_MAIL_USERNAME=[email protected] SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=true SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_REQUIRED=true SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_ENABLE=true SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_TRUST=smtp.gmail.com ``` -------------------------------- ### Install Redis on Linux Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb Commands to install Redis on a Linux system using apt, including adding the Redis GPG key and repository, then updating package lists and installing Redis. ```bash wget -q -O- https://packages.redis.io/gpg | sudo gpg --dearmor --output /usr/share/keyrings/redis-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list sudo apt update sudo apt install -y redis ``` -------------------------------- ### Add Qameta Helm Repository Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-kubernetes Adds the Qameta Helm repository to your local Helm configuration, allowing you to fetch Allure TestOps charts. ```bash helm repo add qameta https://dl.qameta.io/artifactory/helm ``` -------------------------------- ### Allure Gateway Configuration Parameters Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Documentation for parameters available in the `allure-gateway.conf` file, located at `/opt/allure-testops/gateway/conf/allure-gateway.conf`. These parameters control common settings and connections to Redis. ```APIDOC allure-gateway.conf: Full path: /opt/allure-testops/gateway/conf/allure-gateway.conf Parameters: Common parameters: ALLURE_ENDPOINT: Description: The URL which should be used to access the Allure TestOps web interface. Note: To make Allure TestOps available via HTTPS, you need to configure a reverse proxy. See Network configuration for more details. Connection to the Redis storage server: SPRING_REDIS_HOST: Description: server hostname. SPRING_REDIS_PORT: Description: server port. SPRING_REDIS_PASSWORD: Description: password for connecting to the storage. ``` -------------------------------- ### Install Amazon Corretto 17 JDK on RHEL/CentOS Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm These commands install Amazon Corretto 17, the recommended JDK implementation for running Allure TestOps. The first command adds the Corretto YUM repository, and the second command installs the `java-17-amazon-corretto-devel` package using `yum`. ```bash curl -1sLf https://yum.corretto.aws/corretto.repo | sudo tee /etc/yum.repos.d/corretto.repo sudo yum install -y java-17-amazon-corretto-devel ``` -------------------------------- ### Navigate to Allure TestOps Installation Directory Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Changes the current working directory to the Allure TestOps installation path, typically `~/testops`. This is a prerequisite for running subsequent Docker Compose commands. ```bash cd ~/testops ``` -------------------------------- ### Example: First Administrator Email Address Source: https://docs.qameta.io/allure-testops/advanced/api/install/kubernetes An example of the email address format to be specified in the `email` parameter for the first administrator of Allure TestOps. This email is used to send an invitation. ```Plaintext admin@example.com ``` -------------------------------- ### Install Allure TestOps 'box' package Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Installs the Allure TestOps 'box' package, which automatically includes MinIO and Redis locally. Replace '4.22.1' with the desired version. It assumes PostgreSQL is also installed locally. ```bash sudo yum install -y allure-testops-box-4.22.1 ``` -------------------------------- ### Allure TestOps Manual Text Formatting Markup Examples Source: https://docs.qameta.io/allure-testops/advanced/api/briefly/test-cases/scenario Examples of markup symbols for real-time text formatting within Allure TestOps scenarios, demonstrating how to apply bold, italic, strikethrough, inline code, and combinations of these styles. ```Allure TestOps Markup **Bold** -> **Bold** *Italic* -> *Italic* ~~Strikethrough~~ -> ~~Strikethrough~~ `Code` -> `Code` ** *Bold italic* ** -> ***Bold italic*** ~~ ** *Bold italic strikethrough* ** ~~ -> ***~~Bold italic strikethrough~~*** ``` -------------------------------- ### Install PostgreSQL 15 on Ubuntu Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb Commands to add the PostgreSQL APT repository, update package lists, and install PostgreSQL 15 on Ubuntu. ```bash wget -q -O- https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo gpg --dearmor --output /usr/share/keyrings/pgdg.gpg echo "deb [signed-by=/usr/share/keyrings/pgdg.gpg] http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list sudo apt update sudo apt install -y postgresql-15 ``` -------------------------------- ### Navigate to Allure TestOps Installation Directory Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Changes the current directory to the Allure TestOps installation path, typically `~/testops`, which is a prerequisite for many Docker Compose operations. ```bash cd ~/testops ``` -------------------------------- ### Configure SAML 2.0 Authentication for Allure TestOps Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm This configuration example demonstrates how to set up SAML 2.0 authentication for Allure TestOps. It includes parameters for enabling SAML, specifying the IDP, ACS URL, entity ID, metadata URL, and mapping user attributes and roles. Adjustments are required based on your specific identity provider. ```Shell ALLURE_SECURE=true ALLURE_LOGIN_PRIMARY=saml2 ALLURE_LOGIN_SAML2_ENABLED=true ALLURE_LOGIN_SAML2_ID=google ALLURE_LOGIN_SAML2_ACS_URL=https:///api/login/saml2/sso/{registrationId} ALLURE_LOGIN_SAML2_ENTITY_ID=https:///api/login/saml2/authenticate/{registrationId} ALLURE_LOGIN_SAML2_METADATA_URL=https://path/to/metadata.xml ALLURE_LOGIN_SAML2_DEFAULTROLE=ROLE_GUEST ALLURE_LOGIN_SAML2_FIRSTNAMEATTRIBUTE=firstNameAttribute ALLURE_LOGIN_SAML2_LASTNAMEATTRIBUTE=lastNameAttribute ALLURE_LOGIN_SAML2_EMAILATTRIBUTE=emailAttribute ALLURE_LOGIN_SAML2_SYNCROLES=false/true ALLURE_LOGIN_SAML2_GROUPROLEATTRIBUTE=groupRoleAttribute ALLURE_LOGIN_SAML2_GROUPAUTHORITIES_ROLEUSERGROUPS=testops_users ALLURE_LOGIN_SAML2_GROUPAUTHORITIES_ROLEADMINGROUPS=testops_admins ``` -------------------------------- ### GitHub Workflow for Pytest with Allure TestOps using allurectl Action Source: https://docs.qameta.io/allure-testops/advanced/api/integrations/github This GitHub Actions workflow demonstrates how to run Pytest tests, generate Allure results, and upload them to Allure TestOps using the `setup-allurectl` GitHub Action. It includes steps for Python setup, dependency installation, and test execution with `allurectl watch`. ```yaml name: run-and-upload-to-testops on: workflow_dispatch: inputs: GITHUB_TESTS_ENDPOINT: description: "System under test" required: true default: https://system.under.test GITHUB_TESTS_BROWSER: description: "Browser to be used in tests" required: true default: chrome ALLURE_JOB_RUN_ID: description: "ALLURE_JOB_RUN_ID is service parameter required for triggering workflows from Allure TestOps. Leave blank." required: false ALLURE_USERNAME: description: "ALLURE_USERNAME service parameter. Leave blank" required: false env: ALLURE_RESULTS: "allure-results" ALLURE_JOB_RUN_ID: ${{ github.event.inputs.ALLURE_JOB_RUN_ID }} jobs: all-tests: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v4 with: python-version: '3.11' - name: Install dependencies for pytest and allure framework integration run: | python -m pip install --upgrade pip pip install allure-pytest pytest - name: install and configure allurectl using GH Action uses: allure-framework/setup-allurectl@v1 with: allure-endpoint: https://testops.example.com allure-token: ${{ secrets.ALLURE_TOKEN }} allure-project-id: 9999 - name: Run pytest tests run: | allurectl watch -- pytest ./test --alluredir=${ALLURE_RESULTS} --capture=no || true env: GITHUB_TESTS_ENDPOINT: ${{ github.event.inputs.GITHUB_TESTS_ENDPOINT }} GITHUB_TESTS_BROWSER: ${{ github.event.inputs.GITHUB_TESTS_BROWSER }} GITHUB_TESTS_BRANCH: ${{ github.ref_name }} ``` -------------------------------- ### Restart Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Restarts Allure TestOps services by first stopping them and then starting them again. This ensures that any updated configuration files are re-read and applied effectively. ```bash docker compose down; docker compose up -d ``` -------------------------------- ### Example Output of Allure TestOps Environment Variables Source: https://docs.qameta.io/allure-testops/advanced/api/ecosystem/allurectl This is an example output showing the environment variables that `allurectl job-run env` can set, providing details like launch ID, job run ID, launch and job run URLs, and project ID. These variables are useful for referencing the created entities. ```text ALLURE_ENDPOINT=https://testops.example.com ALLURE_LAUNCH_ID=11111 ALLURE_RESULTS=./allure-results ALLURE_JOB_RUN_ID=12345 ALLURE_LAUNCH_TAGS=master, gitlab, demo, pytest, skip-live-doc, ignore ALLURE_TOKEN=[MASKED] ALLURE_LAUNCH_NAME=allure-pytest - 1ea04f48 ALLURE_JOB_RUN_URL=https://testops.example.com/jobrun/14433 ALLURE_LAUNCH_URL=https://testops.example.com/launch/31897 ALLURE_PROJECT_ID=433 ``` -------------------------------- ### Download Allure TestOps Docker Compose Configuration Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose This command downloads the Allure TestOps Docker Compose configuration ZIP archive using `wget` and then unzips it into a directory named 'testops'. This is the first step to setting up Allure TestOps locally. ```Shell wget https://dl.qameta.io/artifactory/bin/docker-compose/testops-docker-compose.zip -O testops-compose.zip && unzip testops-compose.zip -d "testops" ``` -------------------------------- ### Install HashiCorp Consul on RHEL/CentOS Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm These commands install HashiCorp Consul, which is used for service discovery and communication between components of Allure TestOps. The first command adds the HashiCorp YUM repository, and the second command installs the `consul` package using `yum`. ```bash curl -1sLf https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo | sudo tee /etc/yum.repos.d/hashicorp.repo sudo yum install -y consul ``` -------------------------------- ### Create Allure TestOps Launch from a Test Plan Source: https://docs.qameta.io/allure-testops/advanced/api/ecosystem/allurectl This snippet illustrates how to create a launch in Allure TestOps based on a pre-defined test plan. It involves generating a `testplan.json` file using an AQL query and then executing tests with `allurectl watch` while referencing this test plan. ```bash export ALLURE_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" # create tetsplan.json based on AQL for test cases "testPlan=222" where 222 is the ID of a test plan ./allurectl test-case plan -q "testPlan=222" --output-file ${ALLURE_TESTPLAN_PATH} # execute test cases based on testplan.json ./allurectl watch -- [tests_execution_command] ``` -------------------------------- ### GitHub Workflow for Pytest with Allure TestOps using Manual allurectl Download Source: https://docs.qameta.io/allure-testops/advanced/api/integrations/github This GitHub Actions workflow illustrates how to run Pytest tests and upload results to Allure TestOps by manually downloading and configuring `allurectl`. It includes steps for Python setup, dependency installation, and test execution, suitable when direct GitHub Action usage is restricted. ```yaml name: pytest tests with allure framework on: workflow_dispatch: inputs: GITHUB_TESTS_ENDPOINT: description: "System under test" required: true default: https://system.under.test GITHUB_TESTS_BROWSER: description: "Browser to be used in tests" required: true default: chrome ALLURE_JOB_RUN_ID: description: "Inner parameter for Allure TestOps" required: false ALLURE_USERNAME: description: "ALLURE_USERNAME service parameter. Leave blank" required: false env: ALLURE_ENDPOINT: ${{ secrets.ALLURE_ENDPOINT }} ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }} ALLURE_PROJECT_ID: ${{ secrets.ALLURE_PROJECT_ID }} ALLURE_TESTPLAN_PATH: "./testplan.json" ALLURE_RESULTS: "allure-results" ALLURE_JOB_RUN_ID: ${{ github.event.inputs.ALLURE_JOB_RUN_ID }} GH_BRANCH: ${{ github.ref_name }} ALLURE_LAUNCH_TAGS: "github, demo, pytest, $GH_BRANCH" jobs: tests: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v4 with: python-version: '3.11' - uses: actions/github-script@v4 id: allure-job-uid with: result-encoding: string script: | const result = await github.actions.getWorkflowRun({ owner: context.repo.owner, repo: context.repo.repo, run_id: context.runId, }); return `${context.repo.owner}/${context.repo.repo}/actions/workflows/${result.data.workflow_id}` - name: Download and make allurectl executable run: | wget https://github.com/allure-framework/allurectl/releases/download/2.15.1/allurectl_linux_amd64 -O ./allurectl chmod +x ./allurectl - name: Install dependencies for pytest and allure framework integration run: | python -m pip install --upgrade pip pip install allure-pytest pytest - name: Test with pytest and gen allure results shell: bash working-directory: ${{ github.action_path }} env: ALLURE_JOB_UID: ${{steps.allure-job-uid.outputs.result}} GITHUB_TESTS_ENDPOINT: ${{ github.event.inputs.GITHUB_TESTS_ENDPOINT }} GITHUB_TESTS_BROWSER: ${{ github.event.inputs.GITHUB_TESTS_BROWSER }} run: | ``` -------------------------------- ### Configure Firewall for Allure TestOps Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm Configures the firewall to allow incoming TCP traffic on port 8080, which is used by Allure TestOps. Example provided for CentOS default firewall setup. ```Bash sudo firewall-cmd --permanent --add-port=8080/tcp sudo firewall-cmd --reload ``` -------------------------------- ### Add Qameta APT Repository to System Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Adds the Qameta repository sources to the system's APT sources list, allowing installation of Allure TestOps packages. This command should be pasted as a whole. ```shell cat </api/login/saml2/authenticate/{registrationId} acsUrl: https:///api/login/saml2/sso/{registrationId} identityProviderMetadataUri: https://path/to/metadata.xml syncRoles: false firstNameAttribute: firstNameAttribute lastNameAttribute: lastNameAttribute emailAttribute: emailAttribute groups: groupRoleAttribute: groupRoleAttribute roleUserGroups: testops_users roleAdminGroups: testops_admins ``` -------------------------------- ### Navigate to Allure TestOps Installation Directory Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-docker-compose Command to change the current directory to the Allure TestOps installation path, typically used before running Docker commands. ```Shell cd ~/allure-testops ``` -------------------------------- ### Allure TestOps OpenID Configuration Example Source: https://docs.qameta.io/allure-testops/advanced/api/configuration/authentication/azure-openid An example YAML configuration snippet for integrating OpenID authentication with Allure TestOps, showing placeholder values for Azure AD setup. ```yaml auth: primary: openid # ... openid: enabled: false providerName: azure clientName: testops clientId: clientSecret: redirectUri: https://testops.example.com/login/oauth2/code/azure scope: openid, email, profile authorizationGrantType: authorization_code authorizationUri: https://login.microsoftonline.com//oauth2/v2.0/authorize jwksSetUri: https://login.microsoftonline.com//discovery/v2.0/keys tokenUri: https://login.microsoftonline.com//oauth2/v2.0/token usernameAttribute: preferred_username defaultRole: ROLE_GUEST syncRoles: false groupRoleAttribute: groupRoleAttribute roleUserGroups: roleUserGroups roleAdminGroups: roleAdminGroups # userinfoUri: https://graph.microsoft.com/oidc/userinfo userinfoUri: # issuerUri: https://login.microsoftonline.com/a411f6bf-a08d-4aab-bef9-7f0991b2ec76/v2.0 issuerUri: firstNameAttribute: lastNameAttribute: ``` -------------------------------- ### Download and make allurectl executable on Linux x64 Source: https://docs.qameta.io/allure-testops/advanced/api/ecosystem/allurectl This snippet demonstrates how to download the allurectl command-line tool for Linux on an x64 CPU using wget, and then make the downloaded file executable using chmod. This prepares allurectl for use on a Linux system. ```bash wget https://github.com/allure-framework/allurectl/releases/latest/download/allurectl_linux_amd64 -O ./allurectl chmod +x ./allurectl ``` -------------------------------- ### List Running Allure TestOps Docker Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Displays a list of all services currently running as part of the Allure TestOps Docker Compose deployment, showing their names, images, status, and exposed ports. ```bash docker compose ps ``` ```text name@computer folder-name % docker compose ps NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS testops allure/testops:5.6.4 "...entrypoint.sh" testops hour ago healthy 7777->8080/tcp rabbitmq rabbitmq:3.9 "...entrypoint.sh" rabbitmq hour ago healthy 5671-5672/tcp redis redis:6.2 "...entrypoint.sh" redis hour ago healthy 6379/tcp ``` -------------------------------- ### Allure TestOps PostgreSQL Database Configuration Parameters Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Parameters for connecting Allure TestOps to a PostgreSQL database for application data. ```APIDOC TESTOPS_DB_HOST: database server hostname TESTOPS_DB_PORT: database server port TESTOPS_DB_NAME: database name TESTOPS_DB_USERNAME: username for connecting to the database TESTOPS_DB_PASS: password for connecting to the database ``` -------------------------------- ### Start Allure TestOps System Service (DEB/RPM) Source: https://docs.qameta.io/allure-testops/advanced/api/migrations/to-5113 Restarts the Allure TestOps application service using `systemctl` after configuration updates have been applied for DEB/RPM installations. ```shell sudo systemctl start testops ``` -------------------------------- ### Restart Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Command to restart the Allure TestOps gateway, UAA, and report services using `systemctl`. ```Shell sudo systemctl restart allure-gateway allure-uaa allure-report ``` -------------------------------- ### Restart Allure TestOps core services Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Restarts the essential Allure TestOps services: allure-gateway, allure-uaa, and allure-report, using systemctl. ```shell sudo systemctl restart allure-gateway allure-uaa allure-report ``` -------------------------------- ### Start Allure TestOps Docker Compose Deployment Source: https://docs.qameta.io/allure-testops/advanced/api/migrations/to-5113 Initiates the Allure TestOps deployment using the updated `docker-compose.yml` file, running services in detached mode (`-d`) in the background. ```shell docker compose up -d ``` -------------------------------- ### Log in to Qameta Docker Repository Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Authenticates Docker with the Qameta repository using provided credentials, which is necessary to pull Allure TestOps images. ```bash docker login --username USERNAME --password PASSWORD ``` -------------------------------- ### Set ALLURE_ENDPOINT in Configuration Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm Sets the URL for accessing the Allure TestOps web interface in the configuration file. This example uses HTTPS. ```Bash ALLURE_ENDPOINT=https://testops.example.com/ ``` -------------------------------- ### Configure Docker Image Registry and Repository Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Define `IMAGES_REGISTRY` and `IMAGES_REPO` parameters in the `.env` file to specify where Docker images for Allure TestOps should be pulled from. This example uses `docker.io` as the registry and `allure` as the repository, which are common defaults. ```Configuration IMAGES_REGISTRY=docker.io IMAGES_REPO=allure ``` -------------------------------- ### Check Ubuntu OS Version Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb Command to verify the Ubuntu operating system version using `lsb_release -a`. ```bash lsb_release -a ``` -------------------------------- ### Navigate to Allure TestOps Configuration Directory Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-kubernetes Changes the current directory to where the values.yaml file for Allure TestOps is located, typically ~/allure-testops. ```bash cd ~/allure-testops ``` -------------------------------- ### Pull Latest Allure TestOps Docker Images Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Downloads the latest Docker images for Allure TestOps components based on the `RELEASE_TO_DEPLOY` parameter in the `.env` file, preparing for an upgrade. ```bash docker compose pull ``` -------------------------------- ### Configure firewall to allow TCP port 8080 Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Configures the firewall (example for CentOS) to permanently allow incoming traffic on TCP port 8080, then reloads the firewall rules. ```bash sudo firewall-cmd --permanent --add-port=8080/tcp sudo firewall-cmd --reload ``` -------------------------------- ### Log into Qameta Docker Image Registry Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Authenticates with the Qameta Docker image registry. Replace `USERNAME` and `PASSWORD` with the credentials provided by the Qameta sales team. This step is necessary before pulling Allure TestOps service images. ```bash docker login --username USERNAME --password PASSWORD ``` -------------------------------- ### Open Allure TestOps Configuration File with sudo nano Source: https://docs.qameta.io/allure-testops/advanced/api/install/rpm Command to open the Allure TestOps configuration file '/opt/testops/conf/testops.conf' using the nano text editor with superuser privileges. ```Bash sudo nano /opt/testops/conf/testops.conf ``` -------------------------------- ### Configure SMTP for Allure TestOps UAA Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Example configuration for connecting Allure TestOps UAA service to an SMTP server for email notifications, including host, port, authentication, and SSL settings. Remember to replace placeholder values with actual server data. ```Configuration # please remember, this is an example, which won't work for you, # you need to update your config with real SMTP server data. ALLURE_MAIL_HOST=smtp.gmail.com ALLURE_MAIL_PORT=465 ALLURE_MAIL_USERNAME=username ALLURE_MAIL_PASSWORD=password [email protected] ALLURE_MAIL_SMTP_AUTH=true ALLURE_MAIL_SMTP_STARTTLS_ENABLE=true ALLURE_MAIL_SMTP_STARTTLS_REQUIRED=true ALLURE_MAIL_SMTP_SSL_ENABLE=true ALLURE_MAIL_SMTP_SSL_TRUST=smtp.gmail.com ``` -------------------------------- ### Deploy Allure TestOps Helm Chart Source: https://docs.qameta.io/allure-testops/advanced/api/install/kubernetes Provides shell commands to add the Qameta Helm repository, update repository data, and navigate to the directory containing the values.yaml file. These are initial steps for installing the Allure TestOps Helm chart after preparing the configuration file. ```Shell helm repo add qameta https://dl.qameta.io/artifactory/helm helm repo update cd ~/allure-testops ``` -------------------------------- ### Configure SMTP for Allure TestOps UAA Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Example configuration for connecting Allure TestOps User Authentication and Authorization (UAA) service to an SMTP server for email notifications, such as password resets. This snippet provides placeholder values that need to be updated with actual server details. ```Configuration # please remember, this is an example, which won't work for you, # you need to update your config with real SMTP server data. ALLURE_MAIL_HOST=smtp.gmail.com ALLURE_MAIL_PORT=465 ALLURE_MAIL_USERNAME=username ALLURE_MAIL_PASSWORD=password [email protected] ALLURE_MAIL_SMTP_AUTH=true ALLURE_MAIL_SMTP_STARTTLS_ENABLE=true ALLURE_MAIL_SMTP_STARTTLS_REQUIRED=true ALLURE_MAIL_SMTP_SSL_ENABLE=true ALLURE_MAIL_SMTP_SSL_TRUST=smtp.gmail.com ``` -------------------------------- ### Monitor System Processes and Resources (Linux Shell) Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose The `top` command provides a dynamic real-time view of a running system. It can display system summary information as well as a list of processes or threads currently being managed by the Linux kernel. Useful for identifying resource-intensive processes. ```shell top ``` -------------------------------- ### Configure LDAP for Allure TestOps UAA Authentication Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Example configuration for integrating Allure TestOps UAA service with an LDAP server for user authentication and role synchronization. Includes settings for LDAP URL, user and group search bases, filters, and service account credentials. ```Configuration #Example of using LDAP ALLURE_LOGIN_PRIMARY=ldap ALLURE_LOGIN_LDAP_ENABLED='true' ALLURE_LOGIN_LDAP_REFERRAL=follow ALLURE_LOGIN_LDAP_URL=ldap://ldap.url.here:port # ALLURE_LOGIN_LDAP_USERDNPATTERNS= do not use with ALLURE_LOGIN_LDAP_USERSEARCHFILTER ALLURE_LOGIN_LDAP_USERSEARCHBASE="ou=People,dc=space" ALLURE_LOGIN_LDAP_USERSEARCHFILTER="uid={0}" ALLURE_LOGIN_LDAP_DEFAULTROLE=${LDAP_DEFAULT_ROLE} ALLURE_LOGIN_LDAP_UIDATTRIBUTE=uid ALLURE_LOGIN_LDAP_SYNCROLES='true' # these are to be enabled if ALLURE_LOGIN_LDAP_SYNCROLES='true' ALLURE_LOGIN_LDAP_GROUPSEARCHBASE="ou=group,dc=space" ALLURE_LOGIN_LDAP_GROUPSEARCHFILTER="memberUid={1}" ALLURE_LOGIN_LDAP_GROUPROLEATTRIBUTE=cn ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEUSERGROUPS=group_with_ato_users,every_user_is_user ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEADMINGROUPS=group_with_ato_admins,every_user_is_admin # service account data to log-in to LDAP ALLURE_LOGIN_LDAP_USERDN="cn=admin,dc=space" ALLURE_LOGIN_LDAP_PASSWORD='ServiceAccountPasswordHere' # additional parameters, can be disabled by default #ALLURE_LOGIN_LDAP_LOWERCASEUSERNAMES=true #ALLURE_LOGIN_LDAP_PASSWORDATTRIBUTE=userPassword ``` -------------------------------- ### Pull Allure TestOps Docker Images Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Downloads all required Docker images for Allure TestOps services and third-party components based on the selected configuration template. This process may take several minutes depending on network speed. ```bash docker compose pull ``` -------------------------------- ### Configure Allure TestOps with Local Accounts and SMTP Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-kubernetes This configuration example sets the primary authentication method to 'system' (local accounts) and enables SMTP for email notifications, which is essential for user registration and login processes. It specifies SMTP host, port, authentication details, and TLS/SSL settings. ```yaml # this is just an example which won't work if applied without any changes. allure: auth: primary: system smtp: enabled: true host: smtp.gmail.com port: 465 authEnabled: true from: [email protected] username: serice-account-for-SMTP password: SMPTPasswordOrAppPasswordOrAnyOtherSecretRequiredBySMTP startTLSEnabled: true startTLSRequired: true sslEnabled: true sslTrust: smtp.gmail.com ``` -------------------------------- ### Restart Allure TestOps Services Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb This command restarts all Allure TestOps services. It is used during initial setup to apply configuration changes, for general management to apply minor updates or resolve temporary issues, and as a final step after an upgrade. Allow a few minutes for services to fully restart. ```shell sudo systemctl restart testops ``` -------------------------------- ### Allure TestOps S3-compatible Storage Configuration Parameters Source: https://docs.qameta.io/allure-testops/advanced/api/install/docker-compose Parameters for connecting Allure TestOps to an S3-compatible storage server. ```APIDOC TESTOPS_S3_URL: server URL TESTOPS_S3_BUCKET: S3 bucket name TESTOPS_S3_REGION: S3 region name TESTOPS_S3_ACCESS_KEY: access key for connecting to the bucket TESTOPS_S3_SECRET_KEY: secret key for connecting to the bucket ``` -------------------------------- ### Install Allure TestOps 'min' package Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-rpm Installs the minimal Allure TestOps package. Replace '4.22.1' with the desired version. This option only installs Allure TestOps itself. ```bash sudo yum install -y allure-testops-min-4.22.1 ``` -------------------------------- ### Allure TestOps Report Link Source: https://docs.qameta.io/allure-testops/advanced/api/ecosystem/allurectl Provides the exact URL to the newly created launch in Allure TestOps, enabling quick access to the detailed test report. ```CLI Output Report link: https://testops.example.com/launch/34 ``` -------------------------------- ### Install Allure TestOps Package Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb Install the Allure TestOps package using apt. This command will install the version specified in the preferences file or the latest available if no pin is set. ```bash sudo apt install -y testops ``` -------------------------------- ### Configure Allure TestOps with LDAP Authentication Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-kubernetes This example configures Allure TestOps to use LDAP as the primary authentication provider. It includes settings for LDAP server URL, user and group search bases, filters, and attribute mappings for user IDs and roles. It also shows how to enable or disable LDAP. ```yaml allure: auth: primary: ldap ldap: enabled: false auth: user: user pass: pass referral: follow url: ldap://ldap.example.com:389 usernamesToLowercase: true passwordAttribute: userPassword user: searchBase: dc=example,dc=com searchFilter: (&((objectClass=Person))(uid={0})) syncRoles: false uidAttribute: uid group: searchBase: ou=qa,ou=Security Groups,dc=example,dc=com searchFilter: (&(objectClass=Person)(uid={1})) roleAttribute: cn userGroupName: allure_users adminGroupName: allure_admins ``` -------------------------------- ### Configure LDAP for Allure TestOps UAA Source: https://docs.qameta.io/allure-testops/advanced/api/install/v4-deb Example configuration for integrating Allure TestOps User Authentication and Authorization (UAA) service with an LDAP directory for user authentication and role synchronization. This snippet demonstrates common LDAP parameters including URL, search bases, filters, and service account details. ```Configuration #Example of using LDAP ALLURE_LOGIN_PRIMARY=ldap ALLURE_LOGIN_LDAP_ENABLED='true' ALLURE_LOGIN_LDAP_REFERRAL=follow ALLURE_LOGIN_LDAP_URL=ldap://ldap.url.here:port # ALLURE_LOGIN_LDAP_USERDNPATTERNS= do not use with ALLURE_LOGIN_LDAP_USERSEARCHFILTER ALLURE_LOGIN_LDAP_USERSEARCHBASE="ou=People,dc=space" ALLURE_LOGIN_LDAP_USERSEARCHFILTER="uid={0}" ALLURE_LOGIN_LDAP_DEFAULTROLE=${LDAP_DEFAULT_ROLE} ALLURE_LOGIN_LDAP_UIDATTRIBUTE=uid ALLURE_LOGIN_LDAP_SYNCROLES='true' # these are to be enabled if ALLURE_LOGIN_LDAP_SYNCROLES='true' ALLURE_LOGIN_LDAP_GROUPSEARCHBASE="ou=group,dc=space" ALLURE_LOGIN_LDAP_GROUPSEARCHFILTER="memberUid={1}" ALLURE_LOGIN_LDAP_GROUPROLEATTRIBUTE=cn ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEUSERGROUPS=group_with_ato_users,every_user_is_user ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEADMINGROUPS=group_with_ato_admins,every_user_is_admin # service account data to log-in to LDAP ALLURE_LOGIN_LDAP_USERDN="cn=admin,dc=space" ALLURE_LOGIN_LDAP_PASSWORD='ServiceAccountPasswordHere' # additional parameters, can be disabled by default #ALLURE_LOGIN_LDAP_LOWERCASEUSERNAMES=true #ALLURE_LOGIN_LDAP_PASSWORDATTRIBUTE=userPassword ``` -------------------------------- ### Add Qameta APT Repository to System Source: https://docs.qameta.io/allure-testops/advanced/api/install/deb Add the Qameta repository sources to the system's apt sources list. This command must be pasted as a whole, without running its lines separately. ```bash cat <