Skip to content

Commit

Permalink
[skip-ci] Add README for ext/mysqli tests
Browse files Browse the repository at this point in the history
Closes GH-5804
  • Loading branch information
tiffany-taylor authored and Girgias committed Jul 6, 2020
1 parent b18b2c8 commit 48eb635
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions ext/mysqli/tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# The mysqli extension tests

To run the tests, a test database must be created in the MySQL command-line:
```sql
CREATE DATABASE test;
```

The test suite will create the necessary tables for testing, and then delete them when testing is complete. Creating a dedicated table prior to running the tests is unnecessary. There are default values for `MYSQL_TEST_HOST`, `MYSQL_TEST_USER`, `MYSQL_TEST_DB` and `MYSQL_TEST_PASSWD`. If your values differ from the defaults, then environment variables must be set.

```bash
# Database host
# Default: localhost
MYSQL_TEST_HOST

# Database port
MYSQL_TEST_PORT

# Database user
# Default: root
MYSQL_TEST_USER

# Database user password
# The default password is empty (no password).
MYSQL_TEST_PASSWD

# Database name
# Default: test
MYSQL_TEST_DB

# Storage engine to use
MYSQL_TEST_ENGINE

# Database server socket
MYSQL_TEST_SOCKET
```

## MySQL User Permissions

The MySQL user used to run the tests must have full permissions on the test database.

0 comments on commit 48eb635

Please sign in to comment.