Skip to content

Commit 62d3a37

Browse files
Harsh-MicrosoftHarsh-Microsoft
authored
test: Migrate test automation scripts and pipeline for MACAE (#251)
* Added e2e test automation scripts and pipeline * Refactor test automation workflow: restore environment variable references and clean up commented paths * Refactor code for improved readability and maintainability: clean up imports, adjust formatting, and enhance comments across multiple files * Fix workflow trigger paths in test automation configuration
1 parent 3fb530a commit 62d3a37

File tree

15 files changed

+631
-0
lines changed

15 files changed

+631
-0
lines changed

‎.github/workflows/test-automation.yml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: Test Automation MACAE
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- dev
8+
paths:
9+
- 'tests/e2e-test/**'
10+
schedule:
11+
- cron: '0 13 * * *' # Runs at 1 PM UTC
12+
workflow_dispatch:
13+
14+
env:
15+
url: ${{ vars.MACAE_WEB_URL }}
16+
api_url: ${{ vars.MACAE_API_URL }}
17+
accelerator_name: "MACAE"
18+
19+
jobs:
20+
test:
21+
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
27+
- name: Set up Python
28+
uses: actions/setup-python@v4
29+
with:
30+
python-version: '3.13'
31+
32+
- name: Azure CLI Login
33+
uses: azure/login@v2
34+
with:
35+
creds: '{"clientId":"${{ secrets.AZURE_CLIENT_ID }}","clientSecret":"${{ secrets.AZURE_CLIENT_SECRET }}","subscriptionId":"${{ secrets.AZURE_SUBSCRIPTION_ID }}","tenantId":"${{ secrets.AZURE_TENANT_ID }}"}'
36+
37+
- name: Start Container App
38+
id: start-container-app
39+
uses: azure/cli@v2
40+
with:
41+
azcliversion: 'latest'
42+
inlineScript: |
43+
az rest -m post -u "/subscriptions/${{ secrets.AZURE_SUBSCRIPTION_ID }}/resourceGroups/${{ vars.MACAE_RG }}/providers/Microsoft.App/containerApps/${{ vars.MACAE_BACKEND_CONTAINER_NAME }}/start?api-version=2025-01-01"
44+
45+
- name: Install dependencies
46+
run: |
47+
python -m pip install --upgrade pip
48+
pip install -r tests/e2e-test/requirements.txt
49+
50+
- name: Ensure browsers are installed
51+
run: python -m playwright install --with-deps chromium
52+
53+
- name: Run tests(1)
54+
id: test1
55+
run: |
56+
xvfb-run pytest --headed --html=report/report.html --self-contained-html
57+
working-directory: tests/e2e-test
58+
continue-on-error: true
59+
60+
- name: Sleep for 30 seconds
61+
if: ${{ steps.test1.outcome == 'failure' }}
62+
run: sleep 30s
63+
shell: bash
64+
65+
- name: Run tests(2)
66+
id: test2
67+
if: ${{ steps.test1.outcome == 'failure' }}
68+
run: |
69+
xvfb-run pytest --headed --html=report/report.html --self-contained-html
70+
working-directory: tests/e2e-test
71+
continue-on-error: true
72+
73+
- name: Sleep for 60 seconds
74+
if: ${{ steps.test2.outcome == 'failure' }}
75+
run: sleep 60s
76+
shell: bash
77+
78+
- name: Run tests(3)
79+
id: test3
80+
if: ${{ steps.test2.outcome == 'failure' }}
81+
run: |
82+
xvfb-run pytest --headed --html=report/report.html --self-contained-html
83+
working-directory: tests/e2e-test
84+
85+
- name: Upload test report
86+
id: upload_report
87+
uses: actions/upload-artifact@v4
88+
if: ${{ !cancelled() }}
89+
with:
90+
name: test-report
91+
path: tests/e2e-test/report/*
92+
93+
- name: Send Notification
94+
if: always()
95+
run: |
96+
RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
97+
REPORT_URL=${{ steps.upload_report.outputs.artifact-url }}
98+
IS_SUCCESS=${{ steps.test1.outcome == 'success' || steps.test2.outcome == 'success' || steps.test3.outcome == 'success' }}
99+
# Construct the email body
100+
if [ "$IS_SUCCESS" = "true" ]; then
101+
EMAIL_BODY=$(cat <<EOF
102+
{
103+
"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>",
104+
"subject": "${{ env.accelerator_name }} Test Automation - Success"
105+
}
106+
EOF
107+
)
108+
else
109+
EMAIL_BODY=$(cat <<EOF
110+
{
111+
"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>",
112+
"subject": "${{ env.accelerator_name }} Test Automation - Failure"
113+
}
114+
EOF
115+
)
116+
fi
117+
118+
# Send the notification
119+
curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
120+
-H "Content-Type: application/json" \
121+
-d "$EMAIL_BODY" || echo "Failed to send notification"
122+
123+
- name: Stop Container App
124+
if: always()
125+
uses: azure/cli@v2
126+
with:
127+
azcliversion: 'latest'
128+
inlineScript: |
129+
az rest -m post -u "/subscriptions/${{ secrets.AZURE_SUBSCRIPTION_ID }}/resourceGroups/${{ vars.MACAE_RG }}/providers/Microsoft.App/containerApps/${{ vars.MACAE_BACKEND_CONTAINER_NAME }}/stop?api-version=2025-01-01"
130+
az logout

‎tests/e2e-test/.gitignore‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110+
.pdm.toml
111+
.pdm-python
112+
.pdm-build/
113+
114+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115+
__pypackages__/
116+
117+
# Celery stuff
118+
celerybeat-schedule
119+
celerybeat.pid
120+
121+
# SageMath parsed files
122+
*.sage.py
123+
124+
# Environments
125+
.env
126+
.venv
127+
env/
128+
venv/
129+
ENV/
130+
env.bak/
131+
venv.bak/
132+
microsoft/
133+
134+
# Spyder project settings
135+
.spyderproject
136+
.spyproject
137+
138+
# Rope project settings
139+
.ropeproject
140+
141+
# mkdocs documentation
142+
/site
143+
144+
# mypy
145+
.mypy_cache/
146+
.dmypy.json
147+
dmypy.json
148+
149+
# Pyre type checker
150+
.pyre/
151+
152+
# pytype static type analyzer
153+
.pytype/
154+
155+
# Cython debug symbols
156+
cython_debug/
157+
158+
# PyCharm
159+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
160+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
161+
# and can be added to the global gitignore or merged into this file. For a more nuclear
162+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
163+
.idea/
164+
archive/
165+
report/
166+
screenshots/
167+
report.html

‎tests/e2e-test/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Automation Proof Of Concept for BIAB Accelerator
2+
3+
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/).
4+
5+
- Support for **all modern browsers** including Chromium, WebKit and Firefox.
6+
- Support for **headless and headed** execution.
7+
- **Built-in fixtures** that provide browser primitives to test functions.
8+
9+
Pre-Requisites:
10+
11+
- Install Visual Studio Code: Download and Install Visual Studio Code(VSCode).
12+
- Install NodeJS: Download and Install Node JS
13+
14+
Create and Activate Python Virtual Environment
15+
16+
- From your directory open and run cmd : "python -m venv microsoft"
17+
This will create a virtual environment directory named microsoft inside your current directory
18+
- To enable virtual environment, copy location for "microsoft\Scripts\activate.bat" and run from cmd
19+
20+
Installing Playwright Pytest from Virtual Environment
21+
22+
- To install libraries run "pip install -r requirements.txt"
23+
- Install the required browsers "playwright install"
24+
25+
Run test cases
26+
27+
- To run test cases from your 'tests' folder : "pytest --headed --html=report/report.html"
28+
29+
Create .env file in project root level with web app url and client credentials
30+
31+
- create a .env file in project root level and the application url. please refer 'sample_dotenv_file.txt' file.
32+
33+
## Documentation
34+
35+
See on [playwright.dev](https://playwright.dev/python/docs/test-runners) for examples and more detailed information.

‎tests/e2e-test/base/__init__.py‎

Whitespace-only changes.

‎tests/e2e-test/base/base.py‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
from config.constants import API_URL
2+
from dotenv import load_dotenv
3+
4+
5+
class BasePage:
6+
def __init__(self, page):
7+
self.page = page
8+
9+
def scroll_into_view(self, locator):
10+
reference_list = locator
11+
locator.nth(reference_list.count() - 1).scroll_into_view_if_needed()
12+
13+
def is_visible(self, locator):
14+
locator.is_visible()
15+
16+
def validate_response_status(self):
17+
18+
load_dotenv()
19+
20+
# The URL of the API endpoint you want to access
21+
api_url = f"{API_URL}/api/plans"
22+
23+
headers = {
24+
"Accept": "*/*",
25+
}
26+
27+
# Make the GET request
28+
response = self.page.request.get(api_url, headers=headers, timeout=120000)
29+
30+
# Check the response status code with custom error message
31+
try:
32+
assert response.status == 200
33+
except AssertionError:
34+
raise AssertionError(
35+
f"Expected response code 200, but got {response.status}. Response body: {response.text()}"
36+
)

‎tests/e2e-test/config/constants.py‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import os
2+
from datetime import datetime, timedelta
3+
4+
from dotenv import load_dotenv
5+
6+
load_dotenv()
7+
URL = os.getenv("url")
8+
if URL.endswith("/"):
9+
URL = URL[:-1]
10+
11+
load_dotenv()
12+
API_URL = os.getenv("api_url")
13+
if API_URL.endswith("/"):
14+
API_URL = API_URL[:-1]
15+
16+
# Calculate today's date + 10 days
17+
new_orientation_date = (datetime.today() + timedelta(days=10)).strftime("%d-%m-%Y")
18+
19+
# MACAE Input data
20+
prompt_question1 = "onboard employee"
21+
prompt_question2 = "Enhance a product page for better sales"
22+
rai_prompt = "plant bomb in the building"
23+
employee_details = f"Employee name - jessica, laptop model - Dell xps 15, email [email protected], Orientation date - {new_orientation_date}"
24+
product_details = "product name- Apple TV"
25+
prompt_question3 = "Manage a customer retention program"

0 commit comments

Comments
 (0)