Skip to content

Commit 4d3c287

Browse files
committed
Update DEVELOP and README files
Include detailed command to copy the source files and simplify the steps to run MTR tests as the test had been updated to start easier. Indicate that Windows OS is not supported. Contributing on behalf of my employer Amazon Web Services, Inc.
1 parent 059ce00 commit 4d3c287

File tree

2 files changed

+20
-23
lines changed

2 files changed

+20
-23
lines changed

DEVELOP.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,9 @@ the tests accordingly.
3838
MySQL 8.0 to test audit plugin functionality with a single thread.
3939

4040
## Running test suite with mysql-test-run
41-
42-
### Register test
43-
44-
To register the audit plugin MTR test, add the following line to `/mysql-test/include/plugin.defs`:
45-
46-
server_audit plugin_output_directory no SERVER_AUDIT server_audit
47-
48-
### Load plugin
49-
50-
To test the plugin, either install the plugin when executing the MTR test
51-
or [pre-load the
52-
plugin](https://dev.mysql.com/doc/refman/8.0/en/plugin-loading.html#server-plugin-installing-command-line)
53-
before the MTR starts.
54-
55-
Server audit plugin test requires `test_plugin_server` to test the proxy
56-
use case. The test plugin `test_plugin_server` must be installed during the server start
57-
up, otherwise the proxy test case will fail.
58-
59-
The [test case
60-
options](https://dev.mysql.com/doc/dev/mysql-server/latest/PAGE_TESTCASE_SPECIFIC_SERVER_OPTIONS.html)
61-
file `server_audit-master.opt` exists to facilitate this.
41+
```
42+
./mysql-test-run --suite=server_audit
43+
```
6244

6345
## Updating tests
6446

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,25 @@ possible, but adapts the plugin to use the MySQL 8.0 plugin API.
3030
To view the MySQL 5.7 compatible version, see the branch `mysql-5.7` in this
3131
repository.
3232

33+
## Compatibility
34+
35+
This plugin has been tested and verified on *Amazon Linux OS*
36+
https://aws.amazon.com/amazon-linux-2. It has not been tested on other operating
37+
systems and does not support Windows OS.
38+
3339
## Compilation
3440

35-
Copy the contents of this repository on top of the sources or MySQL so it
36-
compiles as part of the MySQL build.
41+
Copy the plugin source code on top of the sources of MySQL using the following
42+
command so it compiles as part of the MySQL build:
43+
44+
```
45+
rsync -av plugin/ <mysqlSourceFolder>/plugin/
46+
```
47+
48+
mysql-test is optional unless you want to run MTR tests:
49+
```
50+
rsync -av mysql-test/ <mysqlSourceFolder>/mysql-test/
51+
```
3752

3853
## Installation
3954

0 commit comments

Comments
 (0)