Skip to content

Commit 5a46b2e

Browse files
committed
[ci] Add readme that describes how our testing works
1 parent 3f24957 commit 5a46b2e

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,44 @@ Mybatis-core is now being auto formatted. Given nature of some code logic with
3131
- ```// @formatter:on``` to end the block of unformatted code
3232

3333
If comment sections need same behaviour such as javadocs, note that the entire block must be around entire comment as direct usage does not properly indicate that formatter treats it all as one comment block regardless.
34+
35+
Tests
36+
-----
37+
38+
Mybatis-3 code runs more expressive testing depending on jdk usage and platform.
39+
40+
By default, we set ```<excludedGroups>TestcontainersTests</excludedGroups>``` which will exclude a subset of tests with @Tag('TestcontainersTests'). Further, if pre jdk 16, we will further exclude record classes from executions further reducing tests.
41+
42+
When using jdk 16+, we adjust the rule to ```<excludedGroups>TestcontainersTests,RequireIllegalAccess</excludedGroups>```.
43+
44+
When we run on ci platform, we further make adjustments as needed. See [here](.github/workflows/ci.yaml) for details.
45+
46+
As of 2/20/2023, using combined system + jdk will result in given number of tests ran. This will change as tests are added or removed over time.
47+
48+
without adjusting settings (ie use as is, platform does not matter)
49+
50+
- any OS + jdk 11 = 1730 tests
51+
- any OS + jdk 17 = 1710 tests
52+
- any OS + jdk 19 = 1710 tests
53+
- any OS + jdk 20 = 1710 tests
54+
- any OS + jdk 21 = 1710 tests
55+
56+
our adjustments for GH actions where platform does matter
57+
58+
- windows + jdk 11 = 1730 tests
59+
- windows + jdk 17 = 1710 tests
60+
- windows + jdk 19 = 1710 tests
61+
- windows + jdk 20 = 1710 tests
62+
- windows + jdk 21 = 1710 tests
63+
64+
- linux + jdk 11 = 1765 tests
65+
- linux + jdk 17 = 1745 tests
66+
- linux + jdk 19 = 1745 tests
67+
- linux + jdk 20 = 1745 tests
68+
- linux + jdk 21 = 1745 tests
69+
70+
- mac + jdk 11 = 1730 tests
71+
- mac + jdk 17 = 1710 tests
72+
- mac + jdk 19 = 1710 tests
73+
- mac + jdk 20 = 1710 tests
74+
- mac + jdk 21 = 1710 tests

0 commit comments

Comments
 (0)