feat(tests): setup qase integration

.github/workflows/build.yaml

@@ -3,14 +3,34 @@ name: Build and test
 on:
   workflow_call:
     inputs:
+      qase_api_base_url:
+        description: 'Qase API URL'
+        required: true
+      qase_report:
+        description: 'Enabled/disabled reporting to Qase'
+        required: true
+      qase_project_code:
+        description: 'Qase project code'
+        required: true
+      qase_run_id:
+        description: 'Qase Run ID'
+        required: true
+      qase_run_complete:
+        description: 'Qase Run autocomplete'
+        required: true
       oarepo:
-        description: OARepo version (11, 12, ...)
+        description: 'OARepo version (11, 12, ...)'
         required: true
         default: "12"
         type: string
 
 env:
   OAREPO_VERSION: ${{ inputs.oarepo }}
+  QASE_API_BASE_URL: ${{ inputs.qase_api_base_url }}
+  QASE_TESTOPS_PROJECT: ${{ inputs.qase_project_code }}
+  QASE_TESTOPS_RUN_ID: ${{ inputs.qase_run_id }}
+  QASE_TESTOPS_RUN_COMPLETE: ${{ inputs.qase_run_complete }}
+  QASE_TESTOPS_API_TOKEN: ${{ secrets.QASE_TESTOPS_API_TOKEN }}
 
 jobs:
   build:
@@ -26,65 +46,90 @@ jobs:
           --health-timeout 5s
           --health-retries 5
         ports:
-          - 5432:5432
+          - "5432:5432"
 
     steps:
-      - name: Show oarepo version
-        run: |
+     # Checkout code
+     - uses: actions/checkout@v4
+
+     # Set up Node.js
+     - uses: actions/setup-node@v4
+
+     # Link with Qase
+     - uses: cskmnrpt/qase-link-run@v2
+       env:
+        QASE_API_TOKEN: ${{ env.QASE_API_TOKEN }}
+
+     # Install npm dependencies and run tests
+     - run: npm install
+     - run: npm test      
+
+     # Ensure environment variables and initial setup
+     - name: Set up environment and initial configuration
+       run: |
+          echo "Setting up environment..."
           echo "OAREPO_VERSION: >>>$OAREPO_VERSION<<< >>>${{ inputs.oarepo }}<<<"
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v3
+
+      # Set up Python
+      - uses: actions/setup-python@v3
         with:
           python-version: "3.10"
+
+      # Cache pip dependencies
       - name: Cache pip
         uses: actions/cache@v3
         with:
-          # This path is specific to Ubuntu
           path: ~/.cache/pip
-          # Look to see if there is a cache hit for the corresponding requirements file
           key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
             ${{ runner.os }}-
 
+      # Configure sysctl limits
       - name: Configure sysctl limits
         run: |
           sudo swapoff -a
           sudo sysctl -w vm.swappiness=1
           sudo sysctl -w fs.file-max=262144
           sudo sysctl -w vm.max_map_count=262144
 
-      - name: Runs Opensearch
+      # Run Opensearch
+      - name: Run Opensearch
         uses: ankane/setup-opensearch@v1
         with:
           plugins: analysis-icu
 
+      # Start Redis
       - name: Start Redis
         uses: supercharge/[email protected]
         with:
           redis-version: ${{ matrix.redis-version }}
-
       - name: Run tests
+        env:
+          QASE_TESTOPS_API_TOKEN: ${{ secrets.QASE_TESTOPS_API_TOKEN }}
+          QASE_TESTOPS_PROJECT: ${{ secrets.QASE_TESTOPS_PROJECT }}
+          QASE_ENVIRONMENT: gh-ci
         run: |
           ./run-tests.sh
 
-
+      # Build Python package
       - name: Build package to publish
         run: |
           .venv/bin/python setup.py sdist bdist_wheel
 
+      # Freeze Python packages
       - name: Freeze packages
         run: |
           .venv/bin/pip freeze > requirements.txt
 
-      - name: Archive production artifacts
+      # Archive production artifacts
+      - name: Archive production artifacts (dist)
         uses: actions/upload-artifact@v3
         with:
           name: dist
           path: dist
 
-      - name: Archive production artifacts
+      - name: Archive production artifacts (requirements)
         uses: actions/upload-artifact@v3
         with:
           name: requirements.txt

.github/workflows/manual-qase.yaml

@@ -0,0 +1,49 @@
+name: Build and test from Qase
+on:
+  workflow_dispatch:
+    inputs:
+      qase_api_base_url:
+        description: 'Qase API URL'
+        required: true
+      qase_report:
+        description: 'Enabled/disabled reporting to Qase'
+        required: true
+      qase_project_code:
+        description: 'Qase project code'
+        required: true
+      qase_run_id:
+        description: 'Qase Run ID'
+        required: true
+      qase_run_complete:
+        description: 'Qase Run autocomplete'
+        required: true
+      oarepo:
+        description: OARepo version (11, 12, ...)
+        required: true
+        default: "12"
+        type: string
+env:
+  QASE_API_BASE_URL: ${{ inputs.qase_api_base_url }}
+  QASE_TESTOPS_PROJECT: ${{ inputs.qase_project_code }}
+  QASE_TESTOPS_RUN_ID: ${{ inputs.qase_run_id }}
+  QASE_TESTOPS_RUN_COMPLETE: true
+  QASE_TESTOPS_API_TOKEN: ${{ secrets.QASE_TESTOPS_API_TOKEN }}
+  QASE_ENVIRONMENT: gh-ci
+
+jobs:
+  link:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: cskmnrpt/qase-link-run@v2
+        name: Link workflow run with Qase
+        env:
+          QASE_TESTOPS_API_TOKEN: ${{ secrets.QASE_TESTOPS_API_TOKEN }}
+          QASE_API_TOKEN: ${{ secrets.QASE_TESTOPS_API_TOKEN }}
+          QASE_TESTOPS_PROJECT: ${{ secrets.QASE_TESTOPS_PROJECT }}
+          QASE_ENVIRONMENT: gh-ci
+  build:
+    uses: ./.github/workflows/build.yaml
+    secrets: inherit
+    with:
+      oarepo: ${{ github.event.inputs.oarepo }}

.github/workflows/manual.yaml

@@ -11,5 +11,6 @@ on:
 jobs:
   build:
     uses: ./.github/workflows/build.yaml
+    secrets: inherit
     with:
       oarepo: ${{ github.event.inputs.oarepo }}

.github/workflows/push.yaml

@@ -9,6 +9,7 @@ permissions:
 jobs:
   build12:
     uses: ./.github/workflows/build.yaml
+    secrets: inherit
     with:
       oarepo: "12"
 

qase.config.json

@@ -0,0 +1,32 @@
+{
+	"mode": "testops",
+	"fallback": "report",
+	"report": {
+		"driver": "local",
+		"connection": {
+			"local": {
+				"path": "./build/qase-report",
+				"format": "json"
+			}
+		}
+	},
+	"testops": {
+		"project": "NRPP",
+		"run": {
+			"title": "Automated PyTest run",
+			"complete": true
+		},
+		"defect": true,
+		"bulk": true,
+		"chunk": 200
+	},
+	"framework": {
+		"pytest": {
+			"capture": {
+				"logs": true,
+				"http": true
+			}
+		}
+	},
+	"environment": "local"
+}

setup.cfg

@@ -34,6 +34,7 @@ dev =
     autoflake
     oarepo-tools
 tests =
+    qase-pytest
     pytest>=7.1.2
     psutil
 

tests/test_quase_integration.py

@@ -0,0 +1,135 @@
+from qase.pytest import qase
+import requests
+
+
+@qase.step("Step 01")
+def step01():
+    step02()
+    pass
+
+
+@qase.step("Step 02")
+def step02():
+    pass
+
+
+def test_with_steps_success():
+    step01()
+    with qase.step("Step 03"):
+        pass
+    assert 1 == 1
+
+
+def test_with_steps_failed():
+    step01()
+    with qase.step("Step 03"):
+        pass
+    assert 1 == 2
+
+def test_with_qase_id_success():
+    assert 1 == 1
+
+
+def test_with_qase_id_failed():
+    assert 1 == 2
+
+
+@qase.title("Simple test success")
+def test_with_title_success():
+    assert 1 == 1
+
+
+@qase.title("Simple test failed")
+def test_with_title_failed():
+    assert 1 == 2
+
+
+@qase.description("Try to login to Qase TestOps using login and password 1")
+def test_with_description_success():
+    assert 1 == 1
+
+
+@qase.description("Try to login to Qase TestOps using login and password")
+def test_with_description_failed():
+    assert 1 == 2
+
+
+@qase.preconditions("*Precondition 1*. Markdown is supported.")
+def test_with_preconditions_success():
+    assert 1 == 1
+
+
+@qase.preconditions("*Precondition 1*. Markdown is supported.")
+def test_with_preconditions_failed():
+    assert 1 == 2
+
+
+@qase.postconditions("*Postcondition 1*. Markdown is supported.")
+def test_with_postconditions_success():
+    assert 1 == 1
+
+
+@qase.postconditions("*Postcondition 1*. Markdown is supported.1")
+def test_with_postconditions_failed():
+    assert 1 == 2
+
+
+@qase.severity("normal")
+def test_with_severity_success():
+    assert 1 == 1
+
+
+@qase.severity("normal")
+def test_with_severity_failed():
+    assert 1 == 2
+
+
+@qase.priority("high")
+def test_with_priority_success():
+    assert 1 == 1
+
+
+@qase.priority("high")
+def test_with_priority_failed():
+    assert 1 == 2
+
+
+@qase.layer("unit")
+def test_with_layer_success():
+    assert 1 == 1
+
+
+@qase.layer("unit")
+def test_with_layer_failed():
+    assert 1 == 2
+
+@qase.layer("unit")
+def test_request_with_failed():
+    url = f"http://localhost/api/health"
+    response = requests.get(url)
+    assert response.status_code == 200
+
+
+@qase.fields(
+    ("severity", "normal"),
+    ("custom_field", "value"),
+    ("priority", "high"),
+    ("layer", "unit"),
+    ("description", "Try to login to Qase TestOps using login and password"),
+    ("preconditions", "*Precondition 1*. Markdown is supported."),
+    ("postconditions", "*Postcondition 1*. Markdown is supported."),
+)
+def test_with_fields_success():
+    assert 1 == 1
+
+
+@qase.fields(
+    ("severity", "normal"),
+    ("priority", "high"),
+    ("layer", "unit"),
+    ("description", "Try to login to Qase TestOps using login and password"),
+    ("preconditions", "*Precondition 1*. Markdown is supported."),
+    ("postconditions", "*Postcondition 1*. Markdown is supported."),
+)
+def test_with_fields_failed():
+    assert 1 == 2