Skip to content
Snippets Groups Projects
Unverified Commit 3010cfeb authored by Andre Angelantoni's avatar Andre Angelantoni
Browse files

Modifications to README and CHANGELOG.

parent 78a1dbaf
No related branches found
No related tags found
No related merge requests found
Automated Testing Kit 2.0.0 (2025-03-22)
Automated Testing Kit 2.0.0 (2025-05-14)
----------------------------------------
Changes since branched from 1.3.0:
Changes since being branched from 1.3.0:
- Upgrade code to be compatible with Drupal 11.
- Update Drupal requirement to be >=11.0 and <12.
- Add prerequisite test.
- Add pre-flight mechanism (to check if the site is ready for testing).
- Make Sitemap XML test more reliable (by Sitemap domain matching).
- Add an option to execute Drush commands with SSH.
- Add email verification with Mailtrap or Testmail.
- Add email verification with Mailtrap and Testmail.
- Add custom reporter with log levels.
- Add a test on build-in website feedback.
- Add a test on block caching.
- Add a test for built-in website feedback form.
- Add a test for block caching.
- Update README file.
\ No newline at end of file
# Automated Testing Kit
# Automated Testing Kit for Drupal
Automated Testing Kit (ATK) is a suite of tests and useful functions for end-to-end
testing using Cypress and Playwright such as:
- basic login/logout via the UI
- registration
- integration of the QA Accounts module
- registration/forget password
- basic tests of node, taxonomy, media, user entities, search and menus.
- executing drush commands via aliases or to Pantheon via Terminus and ssh
- much more.
- caching
- sitemap
- and much more.
ATK works in the following environments:
In addition, Automated Testing Kit also provides:
- integration of the QA Accounts module.
- executing Drush commands against target sites via aliases and SSH.
- executing Drush commands against Pantheon via Terminus.
- pre-flight tests to check if the site is ready for testing.
Automated Testing Kit works in the following environments:
- on the native OS (i.e. macOS/Linux)
- native OS against the app in a container (via DDEV/Lando/Docksal)
- within a container.
Use Docker images provided by the Cypress and Playwright teams
([Cypress documentation](https://docs.cypress.io/examples/docker), [Playwright documentation](https://playwright.dev/docs/docker)).
For a full description of the module, visit the
[project page](https://www.drupal.org/project/automated_testing_kit).
Installation/configuration instructions plus the lists of functions and tests are in
the documentation
[here](https://performantlabs.com/automated-testing-kit/automated-testing-kit).
[here](https://performantlabs.com/automated-testing-kit/introduction).
Join the Drupal [Slack workspace](https://www.drupal.org/join-slack) and
the [#automated_testing_kit](https://drupal.slack.com/archives/C05DSFVJMD1) channel to ask questions.
......@@ -31,6 +34,9 @@ the [#automated_testing_kit](https://drupal.slack.com/archives/C05DSFVJMD1) chan
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/automated_testing_kit).
Try the Kit first with the [Demo Recipe](https://performantlabs.com/automated-testing-kit/applying-automated-testing-kit-recipe).
Check out Testor, the [snapshot management tool](https://github.com/performantlabs/testor).
## Table of contents
......@@ -44,19 +50,18 @@ Submit bug reports and feature suggestions, or track changes in the
## Requirements
Install on Drupal >=11.
Install on Drupal >=11 and less than 12.
This module requires Cypress or Playwright to be installed plus the browsers you
will test on (all of which can be in containers). See those projects for installation
instructions.
will test on.
The module has several dependencies, which are listed in [the documentation](https://performantlabs.com/automated-testing-kit/requirements).
It has several dependencies, which are listed in [the documentation](https://performantlabs.com/automated-testing-kit/requirements).
## Recommended modules
Some tests require additional modules to be installed. If you don't want to use those
tests, comment them out and don't install the module(s) below.
Some tests require additional modules to be installed depending on which tests you want to run.
If you don't want to use those tests, comment them out and don't install the module dependencies.
See [the documentation](https://performantlabs.com/automated-testing-kit/installation) for the modules that the tests require.
......@@ -65,16 +70,13 @@ See [the documentation](https://performantlabs.com/automated-testing-kit/install
* Install as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/node/1897420 for further information.
* Installing the module without Composer is not recommended and is unsupported.
* Read [the ATK documentation](https://performantlabs.com/automated-testing-kit/configuration). Move the tests to your project
* Thoroughly read [the ATK documentation](https://performantlabs.com/automated-testing-kit/installation). Move the tests to your project
with the atk_setup script, set up the target URL and further customize the Kit for
your Drupal installation.
## Configuration
Refer to the [documentation](https://performantlabs.com/automated-testing-kit/automated-testing-kit);
you will need to set the target URL and a few more items.
Automated Testing Kit has a configuration page located at
/admin/config/development/automated_testing_kit/edit (stub for now).
......@@ -85,10 +87,10 @@ Automated Testing Kit has a configuration page located at
something else?**
**A:** You'll find many videos and blog posts comparing the tools
in the [Learning Resources area of the documentation](https://performantlabs.com/automated-testing-kit/learning-resources).
in the [Learning Resources](https://performantlabs.com/automated-testing-kit/learning-resources) area of the documentation.
## Maintainers
- André Angelantoni - [aangel](https://www.drupal.org/u/aangel)
- Ilia Liaukin [ilyaukin](https://www.drupal.org/u/ilyaukin)
- Ilia Liaukin - [ilyaukin](https://www.drupal.org/u/ilyaukin)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment