# Akismet Unit Tests

This collection of tests is designed to verify the basic functionality of the Akismet plugin.

## Installation

To install the test suite as a separate WordPress plugin, please follow these steps:

1. Download the `tests` directory and its contents to your local machine.

2. Using a SFTP client or your hosting file manager, upload the `tests` directory to the `wp-content/plugins/` directory of your WordPress installation. Rename it to `akismet-unit-tests`.

3. Log in to your WordPress admin panel. Go to `Plugins` > `Installed Plugins`. You should see 'Akismet Unit Tests' listed among your plugins. Click `Activate` to enable the test suite.

## Usage

Go to `Plugins` > `Installed Plugins` > `Akismet Unit Tests` in your WordPress admin panel.

Important note: do not run this on a production site! There is a risk of data loss or unintentional damage.  The unit tests should return everything to its original state, but the nature of testing means things will sometimes go wrong.

There are several prerequisites to set up before the tests will run, including:

* Setting up constants (e.g. AKISMET_UNIT_TESTS_API_KEY)
* Installing the REST API Basic Auth plugin from https://github.com/WP-API/Basic-Auth
* Disabling the WP Cron job with DISABLE_WP_CRON

The plugin will list the required steps. Once all the requirements are complete, the tests will run.