PMM-7 docs #800
Open
PMM-7 docs #800
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…on v3 - Revised README.md to enhance clarity on test architecture and repository structure. - Updated GitHub Actions workflows to default to branch 'v3' for various testing scenarios. - Added comprehensive documentation for E2E tests, integration & CLI tests, package tests, infrastructure tests, and upgrade tests. - Introduced troubleshooting guide and test parameters reference for better user support. - Enhanced directory structure in documentation for easier navigation and understanding of testing processes.
- Changed default branches for PMM UI and QA tests to 'v3' in multiple workflow files. - Updated environment variable setup in documentation for PMM Client configuration. - Revised version matrix format in documentation for clarity. - Adjusted PMM server version references in upgrade tests documentation.
BupycHuk
requested review from
saikumar-vs,
peterSirotnak,
yurkovychv and
Copilot
and removed request for
saikumar-vs
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
- Renumbered the test execution steps in the E2E CodeceptJS documentation from Step 2 to Step 6. - Renumbered the test execution steps in the Feature Build tests documentation from Step 6 to Step 8.
…introduce new testing frameworks - Added important notices in README.md and various documentation files regarding the deprecation of the `pmm-tests/` directory containing BATS tests. - Created a new DEPRECATED.md file to outline the status and migration guidance for legacy tests. - Updated multiple documentation files to clarify the current testing frameworks (TypeScript/Playwright) and their usage. - Enhanced the infrastructure tests documentation to differentiate between maintained Helm tests and deprecated BATS tests.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive AI-generated documentation for the PMM-QA testing framework. The documentation provides detailed guides for running various test types locally, writing new tests, and troubleshooting common issues.
- AI-generated documentation covering all major test types (Integration/CLI, E2E, Package, Infrastructure, Upgrade, Feature Build tests)
- Comprehensive troubleshooting guide with common issues and solutions
- Complete test parameters reference with detailed configuration options
- Framework extension guide for adding new database environments
- Deprecation notice for legacy BATS tests with migration guidance
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/README.md | Main documentation index with test architecture overview and quick start guide |
| docs/integration-cli-tests.md | Guide for running CLI/Integration tests using TypeScript/Playwright framework |
| docs/e2e-tests.md | Guide for running End-to-End CodeceptJS tests with comprehensive test suite listings |
| docs/package-tests.md | Guide for running package installation tests using Vagrant/Ansible |
| docs/infrastructure-tests.md | Guide for running Kubernetes/Helm and Easy Install tests |
| docs/upgrade-tests.md | Guide for running PMM upgrade tests with incomplete implementation details |
| docs/feature-build-tests.md | Guide for running Feature Build tests to validate new features |
| docs/troubleshooting.md | Comprehensive troubleshooting guide with solutions for common issues |
| docs/test-parameters.md | Complete reference for all test parameters and configuration options |
| docs/adding-new-environments.md | Guide for extending the PMM framework with new database environments |
| pmm-tests/DEPRECATED.md | Deprecation notice for legacy BATS tests with migration guidance |
| README.md | Updated main README with improved test architecture overview |
| .github/workflows/*.yml | Updated workflow files to use 'v3' branch as default instead of 'main'/'master' |
- Added new entries to .gitignore for pmm-ui-tests, qa-integration, and package-testing directories. - Updated various documentation files to replace `python` with `python3` for executing the pmm-framework.py script and included the installation of setuptools in the setup steps for E2E and feature build tests.
# Conflicts: # docs/e2e-codeceptjs-tests.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
it's fully AI generated doc, please review it