TestPlans: Add documentation

Author: manuroe

.github/workflows/nightly.yml

@@ -3,9 +3,6 @@ name: Nightly checks
 on:
   schedule:
     - cron:  '0 3 * * 1-5'
-  
-  # TODO: To remov
-  pull_request:
 
   workflow_dispatch:
 

CHANGES.rst

@@ -18,7 +18,11 @@ Changes to be released in next version
  * 
 
 🧱 Build
- * 
+ * Tests: Use UnitTests suffix for unit tests classes.
+ * Tests: Cut some existing tests to seperate unit tests and integration tests.
+ * Tests: Create 4 test plans for the macOS target: AllTests, AllTestsWithSanitizers, UnitTests and UnitTestsWithSanitizers.
+ * GH Actions: Run unit tests on every PR and develop branch update.
+ * GH Actions: Run integration tests nightly on develop using last Synapse release.
 
 Others
  * 

README.rst

@@ -467,7 +467,9 @@ Then, open ``MatrixSDK.xcworkspace``.
 
 Tests
 =====
-The tests in the SDK Xcode project are both unit and integration tests.
+The tests in the SDK Xcode project are both unit and integration tests. 
+
+Unit tests class use the suffix "UnitTests" to differentiate them. A unit test is a test that does not make any HTTP requests or uses mocked HTTP requests.
 
 Out of the box, the tests use one of the homeservers (located at
 http://localhost:8080) of the "Demo Federation of Homeservers"
@@ -491,6 +493,22 @@ Every time you want to launch these test homeservers, type::
 You can now run tests from the Xcode Test navigator tab or select the
 MatrixSDKTests scheme and click on the "Test" action.
 
+Test Plans
+----------
+We have test plans in MatrixSDKTests/TestPlans for the macOS target to run tests separately or with different configurations.
+
+AllTests
+  Default test plan to run all tests.
+
+AllTestsWithSanitizers
+  Run all tests with 2 configurations "ASan + UBSan" and "TSan + UBSan". "UBSan" for Unexpected Behavior Sanitizer. "ASan" for Address Sanitizier. "Tsan" for Thread Sanitizer. This setup was adviced at WWDC2019 (https://developer.apple.com/videos/play/wwdc2019/413?time=2270). This test plan requires 2 builds that are slow to run.
+
+UnitTests
+  Test plan for all unit tests.
+
+UnitTestsWithSanitizers
+  All unit tests with 2 configurations "ASan + UBSan" and "TSan + UBSan" described above.
+
 Known issues
 ============