diff options
Diffstat (limited to 'platform/ios/test/MGLTestUtility.h')
-rw-r--r-- | platform/ios/test/MGLTestUtility.h | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/platform/ios/test/MGLTestUtility.h b/platform/ios/test/MGLTestUtility.h index 9cd5227ac5..2e02e4f9de 100644 --- a/platform/ios/test/MGLTestUtility.h +++ b/platform/ios/test/MGLTestUtility.h @@ -1,4 +1,21 @@ -#define MGL_CHECK_PENDING_TEST() \ + +/** + MGL_CHECK_IF_PENDING_TEST_SHOULD_RUN() + + Include this macro at the top of a "pending" test - one that would normally fail, + but you want to include is as a compile-time test or as a reminder. + + This will output the included warning in the test log, which `xcpretty` will detect. + This allows such pending tests to be identified in CI logs. + + If you provide `MAPBOX_RUN_PENDING_TESTS` as an environment variable ALL pending + tests will run. + + In addition, it's a good idea to append `PENDING` to the test method name, as this + will also be picked up by xcpretty. PENDING tests will be distinguished by a `⧖` + and `[PENDING]` + */ +#define MGL_CHECK_IF_PENDING_TEST_SHOULD_RUN() \ /* By default, skip pending tests. Otherwise check environment for MAPBOX_RUN_PENDING_TESTS */ \ { \ NSString *runPendingTests = [[NSProcessInfo processInfo] environment][@"MAPBOX_RUN_PENDING_TESTS"]; \ @@ -8,15 +25,3 @@ return; \ } \ } - -#define MGL_PENDING_TEST(name) \ - /* Appending `PENDING` to the method name allows xcpretty to mark the test as pending */ \ - - (void)name ## PENDING { MGL_CHECK_PENDING_TEST() - -#define MGL_ENABLED_TEST(name) \ - - (void)name { - -#define MGL_DISABLED_TEST(name) \ - - (void)DISABLED ## name { - - |