Skip to content

feat: add extra_vars #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
callmesi wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add extra_vars #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 26 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,31 +85,32 @@ flowchart TD

### Deploy parameters

| Parameter | Type | Mandatory | Default value | Description |
|-------------------------------------|---------|-----------|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| ENVIRONMENT_NAME | string | **yes** | `"default"` | Environment name (e.g., dev, test, prod). |
| ENV_CONFIGURATION_TEMPLATE_FILENAME | string | no | `environment-configuration-template.json` | Environment configuration template filename used during runtime configuration rendering. |
| ATP_TESTS_GIT_REPO_URL | string | **yes** | `""` | Git repository URL for cloning test sources. Git-URL-to-project-tests.git |
| ATP_TESTS_GIT_REPO_BRANCH | string | no | `main` | Git branch to checkout. |
| TEST_PARAMS | JSON | **yes** | `{}` | Specify what test or scope should be run, for example: `'{"execution_list":[{"type": "scope","name": "regression"}]}'` |
| ATP_ENVGENE_CONFIGURATION | JSON | no | `{}` | Additional test parameters (Systems) to pass to test runner from EnvGene. |
| ATP_TESTS_GIT_REPO_BRANCH | string | no | `main` | Git branch to checkout. |
| ATP_STORAGE_PROVIDER | string | no | `"minio"` | Type of S3 storage (e.g., minio, aws). |
| ATP_TESTS_GIT_TOKEN | string | **yes** | `""` | Access token for private Git repositories with tests. |
| ATP_STORAGE_BUCKET | string | **yes** | `""` | S3 bucket name for uploading results. |
| ATP_STORAGE_USERNAME | string | **yes** | `""` | Access key for S3 bucket. |
| ATP_STORAGE_PASSWORD | string | **yes** | `""` | Secret key for S3 bucket. |
| ATP_STORAGE_SERVER_URL | string | **yes** | `""` | API endpoint for accessing S3 storage. |
| ATP_STORAGE_SERVER_UI_URL | string | **yes** | `""` | Web UI endpoint for viewing files in the S3 bucket. |
| ATP_REPORT_VIEW_UI_URL | string | **yes** | `""` | URL for viewing generated test reports. |
| CURRENT_DATE | string | no | `""` | Date to use in report naming (format: YYYY-MM-DD). |
| CURRENT_TIME | string | no | `""` | Time to use in report naming (format: HH:MM:SS). |
| ATP_RUNNER_JOB_TTL | integer | no | `43200` | Time-to-live for the test job in seconds. |
| ATP_RUNNER_JOB_EXIT_STRATEGY | integer | no | `0` | Delay in seconds before job termination (for debugging). |
| ENABLE_JIRA_INTEGRATION | boolean | no | `false` | Enable Jira integration for tests. |
| DEBUG_MODE | boolean | no | `false` | Enable additional debug behavior and logs in runner scripts. |
| ATP_MONITORING_ENABLED | boolean | no | `false` | Enable creation monitoring objects for runners. |
| SECURITY_CONTEXT_ENABLED | boolean | no | `false` | Flag to enable or disable the security context for the Playwright Runner service . |
| Parameter | Type | Mandatory | Default value | Description |
|-------------------------------------|---------|-----------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ENVIRONMENT_NAME | string | **yes** | `"default"` | Environment name (e.g., dev, test, prod). |
| ENV_CONFIGURATION_TEMPLATE_FILENAME | string | no | `environment-configuration-template.json` | Environment configuration template filename used during runtime configuration rendering. |
| ATP_TESTS_GIT_REPO_URL | string | **yes** | `""` | Git repository URL for cloning test sources. Git-URL-to-project-tests.git |
| ATP_TESTS_GIT_REPO_BRANCH | string | no | `main` | Git branch to checkout. |
| TEST_PARAMS | JSON | **yes** | `{}` | Specify what test or scope should be run, for example: `'{"execution_list":[{"type": "scope","name": "regression"}]}'` |
| ATP_ENVGENE_CONFIGURATION | JSON | no | `{}` | Additional test parameters (Systems) to pass to test runner from EnvGene. |
| ATP_TESTS_GIT_REPO_BRANCH | string | no | `main` | Git branch to checkout. |
| ATP_STORAGE_PROVIDER | string | no | `"minio"` | Type of S3 storage (e.g., minio, aws). |
| ATP_TESTS_GIT_TOKEN | string | **yes** | `""` | Access token for private Git repositories with tests. |
| ATP_STORAGE_BUCKET | string | **yes** | `""` | S3 bucket name for uploading results. |
| ATP_STORAGE_USERNAME | string | **yes** | `""` | Access key for S3 bucket. |
| ATP_STORAGE_PASSWORD | string | **yes** | `""` | Secret key for S3 bucket. |
| ATP_STORAGE_SERVER_URL | string | **yes** | `""` | API endpoint for accessing S3 storage. |
| ATP_STORAGE_SERVER_UI_URL | string | **yes** | `""` | Web UI endpoint for viewing files in the S3 bucket. |
| ATP_REPORT_VIEW_UI_URL | string | **yes** | `""` | URL for viewing generated test reports. |
| CURRENT_DATE | string | no | `""` | Date to use in report naming (format: YYYY-MM-DD). |
| CURRENT_TIME | string | no | `""` | Time to use in report naming (format: HH:MM:SS). |
| ATP_RUNNER_JOB_TTL | integer | no | `43200` | Time-to-live for the test job in seconds. |
| ATP_RUNNER_JOB_EXIT_STRATEGY | integer | no | `0` | Delay in seconds before job termination (for debugging). |
| ENABLE_JIRA_INTEGRATION | boolean | no | `false` | Enable Jira integration for tests. |
| DEBUG_MODE | boolean | no | `false` | Enable additional debug behavior and logs in runner scripts. |
| ATP_MONITORING_ENABLED | boolean | no | `false` | Enable creation monitoring objects for runners. |
| SECURITY_CONTEXT_ENABLED | boolean | no | `false` | Flag to enable or disable the security context for the Playwright Runner service . |
| EXTRA_VARS | string | no | `` | Passes additional environment variables to the test runner in the form of key-value pairs (e.g., `A=1;B=2`, `A=1,B=2`, or using newlines). Supports semicolon, comma delimiters. |


## Hardware / Resource Requirements (HWE)
Expand Down
2 changes: 2 additions & 0 deletions deployments/charts/atp3-python-runner/templates/job.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ spec:
value: "{{ .Values.DEBUG_MODE }}"
- name: TEST_PARAMS
value: {{ toJson .Values.TEST_PARAMS | quote }}
- name: EXTRA_VARS
value: "{{ .Values.EXTRA_VARS }}"
- name: ATP_ENVGENE_CONFIGURATION
valueFrom:
secretKeyRef:
Expand Down
1 change: 1 addition & 0 deletions deployments/charts/atp3-python-runner/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ ATP_MONITORING_ENABLED: true
# Security Context properties
# enabled is a flag to enable Security Context
SECURITY_CONTEXT_ENABLED: false
EXTRA_VARS: ""
# runAsUser is the user ID used to run the container
podSecurityContext:
runAsUser: 1000
Expand Down
3 changes: 3 additions & 0 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ source /scripts/native-report.sh
source /scripts/envgene.sh
# shellcheck disable=SC1091
source /scripts/render-environment-configuration.sh
# shellcheck disable=SC1091
source /scripts/parse-extra-vars.sh

# Execute main workflow
echo "🚀 Starting test execution workflow..."
Expand All @@ -54,6 +56,7 @@ echo "🚀 Starting test execution workflow..."
trap 'finalize_once' EXIT

init_environment || fail "Environment initialization failed"
parse_extra_vars || fail "EXTRA_VARS parsing failed"
clone_repository || fail "Repository clone failed"
render_environment_configuration || fail "Render Environment Configuration Failed"
load_envgene || fail "Load Envgen Failed"
Expand Down
2 changes: 1 addition & 1 deletion scripts
Open in desktop
Submodule scripts updated 4 files
+7 −2 error-handler.sh
+59 −0 parse-extra-vars.sh
+71 −0 push-metrics-start.sh
+328 −0 push-metrics.sh
Loading