Skip to content

Commit 48eb635

Browse files
tiffany-taylorGirgias
authored andcommitted
[skip-ci] Add README for ext/mysqli tests
Closes GH-5804
1 parent b18b2c8 commit 48eb635

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

ext/mysqli/tests/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# The mysqli extension tests
2+
3+
To run the tests, a test database must be created in the MySQL command-line:
4+
```sql
5+
CREATE DATABASE test;
6+
```
7+
8+
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.
9+
10+
```bash
11+
# Database host
12+
# Default: localhost
13+
MYSQL_TEST_HOST
14+
15+
# Database port
16+
MYSQL_TEST_PORT
17+
18+
# Database user
19+
# Default: root
20+
MYSQL_TEST_USER
21+
22+
# Database user password
23+
# The default password is empty (no password).
24+
MYSQL_TEST_PASSWD
25+
26+
# Database name
27+
# Default: test
28+
MYSQL_TEST_DB
29+
30+
# Storage engine to use
31+
MYSQL_TEST_ENGINE
32+
33+
# Database server socket
34+
MYSQL_TEST_SOCKET
35+
```
36+
37+
## MySQL User Permissions
38+
39+
The MySQL user used to run the tests must have full permissions on the test database.

0 commit comments

Comments
 (0)