test: Migrate test automation scripts and pipeline for KMgeneric

Author: Avijit-Microsoft

.github/workflows/test-automation.yml

@@ -0,0 +1,106 @@
+name: Test Automation KMGeneric
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+      - 'tests/e2e-test/**'
+  schedule:
+      - cron: '0 13 * * *'  # Runs at 1 PM UTC
+  workflow_dispatch:
+
+env:
+    url: ${{ vars.KMG_WEB_URL }}
+    api_url: ${{ vars.KMG_API_URL }}
+    accelerator_name: "KMGeneric"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r tests/e2e-test/requirements.txt
+
+      - name: Ensure browsers are installed
+        run: python -m playwright install --with-deps chromium
+
+      - name: Run tests(1)
+        id: test1
+        run: |
+          xvfb-run pytest --headed --html=report/report.html --self-contained-html
+        working-directory: tests/e2e-test
+        continue-on-error: true
+
+      - name: Sleep for 30 seconds
+        if: ${{ steps.test1.outcome == 'failure' }}
+        run: sleep 30s
+        shell: bash
+
+      - name: Run tests(2)
+        if: ${{ steps.test1.outcome == 'failure' }}
+        id: test2
+        run: |
+          xvfb-run pytest --headed --html=report/report.html --self-contained-html
+        working-directory: tests/e2e-test
+        continue-on-error: true
+
+      - name: Sleep for 60 seconds
+        if: ${{ steps.test2.outcome == 'failure' }}
+        run: sleep 60s
+        shell: bash
+
+      - name: Run tests(3)
+        if: ${{ steps.test2.outcome == 'failure' }}
+        id: test3
+        run: |
+          xvfb-run pytest --headed --html=report/report.html --self-contained-html
+        working-directory: tests/e2e-test
+
+      - name: Upload test report
+        id: upload_report
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: test-report
+          path: tests/e2e-test/report/*
+
+      - name: Send Notification
+        if: always()
+        run: |
+          RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+          REPORT_URL=${{ steps.upload_report.outputs.artifact-url }}
+          IS_SUCCESS=${{ steps.test1.outcome == 'success' || steps.test2.outcome == 'success' || steps.test3.outcome == 'success' }}
+          # Construct the email body
+          if [ "$IS_SUCCESS" = "true" ]; then
+            EMAIL_BODY=$(cat <<EOF
+            {
+              "body": "<p>Dear Team,</p><p>We would like to inform you that the ${{ env.accelerator_name }} Test Automation process has completed successfully.</p><p><strong>Run URL:</strong> <a href=\"${RUN_URL}\">${RUN_URL}</a><br></p><p><strong>Test Report:</strong> <a href=\"${REPORT_URL}\">${REPORT_URL}</a></p><p>Best regards,<br>Your Automation Team</p>",
+              "subject": "${{ env.accelerator_name }} Test Automation - Success"
+            }
+          EOF
+            )
+          else
+            EMAIL_BODY=$(cat <<EOF
+            {
+              "body": "<p>Dear Team,</p><p>We would like to inform you that the ${{ env.accelerator_name }} Test Automation process  has encountered an issue and has failed to complete successfully.</p><p><strong>Run URL:</strong> <a href=\"${RUN_URL}\">${RUN_URL}</a><br> ${OUTPUT}</p><p><strong>Test Report:</strong> <a href=\"${REPORT_URL}\">${REPORT_URL}</a></p><p>Please investigate the matter at your earliest convenience.</p><p>Best regards,<br>Your Automation Team</p>",
+              "subject": "${{ env.accelerator_name }} Test Automation - Failure"
+            }
+          EOF
+            )
+          fi
+          # Send the notification
+          curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA}}" \
+            -H "Content-Type: application/json" \
+            -d "$EMAIL_BODY" || echo "Failed to send notification"

.github/workflows/test.yml

@@ -92,7 +92,7 @@ jobs:
       - name: Run Backend Tests with Coverage
         if: env.skip_backend_tests == 'false'
         run: |
-          pytest --cov=. --cov-report=term-missing --cov-report=xml
+          pytest --cov=. --cov-report=term-missing --cov-report=xml ./src/tests/api
 
       - name: Skip Backend Tests
         if: env.skip_backend_tests == 'true'

tests/e2e-test/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+microsoft/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+archive/
+report/
+screenshots/
+report.html
+

tests/e2e-test/README.md

@@ -0,0 +1,35 @@
+# Automation Proof Of Concept for Document Knowledge Mining Accelerator
+
+Write end-to-end tests for your web apps with [Playwright](https://github.com/microsoft/playwright-python) and [pytest](https://docs.pytest.org/en/stable/).
+
+- Support for **all modern browsers** including Chromium, WebKit and Firefox.
+- Support for **headless and headed** execution.
+- **Built-in fixtures** that provide browser primitives to test functions.
+
+Pre-Requisites:  
+
+- Install Visual Studio Code: Download and Install Visual Studio Code(VSCode).
+- Install NodeJS: Download and Install Node JS
+
+Create and Activate Python Virtual Environment
+
+- From your directory open and run cmd : "python -m venv microsoft"
+This will create a virtual environment directory named microsoft inside your current directory
+- To enable virtual environment, copy location for "microsoft\Scripts\activate.bat" and run from cmd
+
+Installing Playwright Pytest from Virtual Environment
+
+- To install libraries run "pip install -r requirements.txt"
+
+
+Run test cases
+
+- To run test cases from your 'tests' folder : "pytest --html=report.html --self-contained-html"
+
+Create .env file in project root level with web app url and client credentials
+
+- create a .env file in project root level and the application url. please refer 'sample_dotenv_file.txt' file.
+
+## Documentation
+
+See on [playwright.dev](https://playwright.dev/python/docs/test-runners) for examples and more detailed information.

tests/e2e-test/base/__init__.py

@@ -0,0 +1 @@
+from . import base

tests/e2e-test/base/base.py

@@ -0,0 +1,46 @@
+from config.constants import *
+import requests
+import json
+from dotenv import load_dotenv
+import os
+import uuid
+
+class BasePage:
+    def __init__(self, page):
+        self.page = page
+
+    def scroll_into_view(self,locator):
+        reference_list = locator
+        locator.nth(reference_list.count()-1).scroll_into_view_if_needed()
+
+    def is_visible(self,locator):
+        locator.is_visible()
+
+    def validate_response_status(self,questions):
+        load_dotenv()
+        WEB_URL = os.getenv("web_url")
+        
+        url = f"{API_URL}/api/chat"
+       
+
+        user_message_id = str(uuid.uuid4())
+        assistant_message_id = str(uuid.uuid4())
+        conversation_id = str(uuid.uuid4())
+
+        payload = {
+            "messages": [{"role": "user", "content": questions,
+                            "id": user_message_id}],
+            "conversation_id": conversation_id,
+        }
+        # Serialize the payload to JSON
+        payload_json = json.dumps(payload)
+        headers = {
+            "Content-Type": "application/json-lines",
+            "Accept": "*/*"
+        }
+        response = self.page.request.post(url, headers=headers, data=payload_json)
+        # Check the response status code
+        assert response.status == 200, "response code is " + str(response.status)
+
+        self.page.wait_for_timeout(10000)
+

tests/e2e-test/config/constants.py

@@ -0,0 +1,25 @@
+from dotenv import load_dotenv
+import os
+import json
+
+load_dotenv()
+URL = os.getenv('url')
+if URL.endswith('/'):
+    URL = URL[:-1]
+
+load_dotenv()
+API_URL = os.getenv('api_url')
+if API_URL.endswith('/'):
+    API_URL = API_URL[:-1]
+
+# Get the absolute path to the repository root
+repo_root = os.getenv('GITHUB_WORKSPACE', os.getcwd())
+
+# Construct the absolute path to the JSON file
+#note: may have to remove 'tests/e2e-test' from below when running locally
+json_file_path = os.path.join(repo_root, 'tests/e2e-test', 'testdata', 'prompts.json')
+
+with open(json_file_path, 'r') as file:
+    data = json.load(file)
+    questions = data['questions']
+