selftests/harness: Refactor XFAIL into SKIP
authorKees Cook <keescook@chromium.org>
Mon, 22 Jun 2020 18:16:49 +0000 (11:16 -0700)
committerShuah Khan <skhan@linuxfoundation.org>
Mon, 6 Jul 2020 21:59:40 +0000 (15:59 -0600)
Plumb the old XFAIL result into a TAP SKIP.

Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
tools/testing/selftests/kselftest_harness.h
tools/testing/selftests/seccomp/seccomp_bpf.c

index f8f7e47..b519765 100644 (file)
                        __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
 
 /**
- * XFAIL(statement, fmt, ...)
+ * SKIP(statement, fmt, ...)
  *
- * @statement: statement to run after reporting XFAIL
+ * @statement: statement to run after reporting SKIP
  * @fmt: format string
  * @...: optional arguments
  *
- * This forces a "pass" after reporting a failure with an XFAIL prefix,
+ * This forces a "pass" after reporting why something is being skipped
  * and runs "statement", which is usually "return" or "goto skip".
  */
-#define XFAIL(statement, fmt, ...) do { \
+#define SKIP(statement, fmt, ...) do { \
        if (TH_LOG_ENABLED) { \
-               fprintf(TH_LOG_STREAM, "#      XFAIL     " fmt "\n", \
+               fprintf(TH_LOG_STREAM, "#      SKIP     " fmt "\n", \
                        ##__VA_ARGS__); \
        } \
-       /* TODO: find a way to pass xfail to test runner process. */ \
        _metadata->passed = 1; \
+       _metadata->skip = 1; \
        _metadata->trigger = 0; \
        statement; \
 } while (0)
@@ -777,6 +777,7 @@ struct __test_metadata {
        struct __fixture_metadata *fixture;
        int termsig;
        int passed;
+       int skip;       /* did SKIP get used? */
        int trigger; /* extra handler after the evaluation */
        int timeout;    /* seconds to wait for test timeout */
        bool timed_out; /* did this test timeout instead of exiting? */
@@ -866,17 +867,31 @@ void __wait_for_test(struct __test_metadata *t)
                fprintf(TH_LOG_STREAM,
                        "# %s: Test terminated by timeout\n", t->name);
        } else if (WIFEXITED(status)) {
-               t->passed = t->termsig == -1 ? !WEXITSTATUS(status) : 0;
                if (t->termsig != -1) {
+                       t->passed = 0;
                        fprintf(TH_LOG_STREAM,
                                "# %s: Test exited normally instead of by signal (code: %d)\n",
                                t->name,
                                WEXITSTATUS(status));
-               } else if (!t->passed) {
-                       fprintf(TH_LOG_STREAM,
-                               "# %s: Test failed at step #%d\n",
-                               t->name,
-                               WEXITSTATUS(status));
+               } else {
+                       switch (WEXITSTATUS(status)) {
+                       /* Success */
+                       case 0:
+                               t->passed = 1;
+                               break;
+                       /* SKIP */
+                       case 255:
+                               t->passed = 1;
+                               t->skip = 1;
+                               break;
+                       /* Other failure, assume step report. */
+                       default:
+                               t->passed = 0;
+                               fprintf(TH_LOG_STREAM,
+                                       "# %s: Test failed at step #%d\n",
+                                       t->name,
+                                       WEXITSTATUS(status));
+                       }
                }
        } else if (WIFSIGNALED(status)) {
                t->passed = 0;
@@ -906,6 +921,7 @@ void __run_test(struct __fixture_metadata *f,
 {
        /* reset test struct */
        t->passed = 1;
+       t->skip = 0;
        t->trigger = 0;
        t->step = 0;
        t->no_print = 0;
@@ -918,15 +934,31 @@ void __run_test(struct __fixture_metadata *f,
                t->passed = 0;
        } else if (t->pid == 0) {
                t->fn(t, variant);
-               /* return the step that failed or 0 */
-               _exit(t->passed ? 0 : t->step);
+               /* Make sure step doesn't get lost in reporting */
+               if (t->step >= 255) {
+                       ksft_print_msg("Too many test steps (%u)!?\n", t->step);
+                       t->step = 254;
+               }
+               /* Use 255 for SKIP */
+               if (t->skip)
+                       _exit(255);
+               /* Pass is exit 0 */
+               if (t->passed)
+                       _exit(0);
+               /* Something else happened, report the step. */
+               _exit(t->step);
        } else {
                __wait_for_test(t);
        }
        ksft_print_msg("         %4s  %s%s%s.%s\n", t->passed ? "OK" : "FAIL",
               f->name, variant->name[0] ? "." : "", variant->name, t->name);
-       ksft_test_result(t->passed, "%s%s%s.%s\n",
-              f->name, variant->name[0] ? "." : "", variant->name, t->name);
+
+       if (t->skip)
+               ksft_test_result_skip("%s%s%s.%s\n",
+                       f->name, variant->name[0] ? "." : "", variant->name, t->name);
+       else
+               ksft_test_result(t->passed, "%s%s%s.%s\n",
+                       f->name, variant->name[0] ? "." : "", variant->name, t->name);
 }
 
 static int test_harness_run(int __attribute__((unused)) argc,
index 252140a..8c1cc80 100644 (file)
@@ -3069,7 +3069,7 @@ TEST(get_metadata)
 
        /* Only real root can get metadata. */
        if (geteuid()) {
-               XFAIL(return, "get_metadata requires real root");
+               SKIP(return, "get_metadata requires real root");
                return;
        }
 
@@ -3112,7 +3112,7 @@ TEST(get_metadata)
        ret = ptrace(PTRACE_SECCOMP_GET_METADATA, pid, sizeof(md), &md);
        EXPECT_EQ(sizeof(md), ret) {
                if (errno == EINVAL)
-                       XFAIL(goto skip, "Kernel does not support PTRACE_SECCOMP_GET_METADATA (missing CONFIG_CHECKPOINT_RESTORE?)");
+                       SKIP(goto skip, "Kernel does not support PTRACE_SECCOMP_GET_METADATA (missing CONFIG_CHECKPOINT_RESTORE?)");
        }
 
        EXPECT_EQ(md.flags, SECCOMP_FILTER_FLAG_LOG);
@@ -3673,7 +3673,7 @@ TEST(user_notification_continue)
        resp.val = 0;
        EXPECT_EQ(ioctl(listener, SECCOMP_IOCTL_NOTIF_SEND, &resp), 0) {
                if (errno == EINVAL)
-                       XFAIL(goto skip, "Kernel does not support SECCOMP_USER_NOTIF_FLAG_CONTINUE");
+                       SKIP(goto skip, "Kernel does not support SECCOMP_USER_NOTIF_FLAG_CONTINUE");
        }
 
 skip:
@@ -3681,7 +3681,7 @@ skip:
        EXPECT_EQ(true, WIFEXITED(status));
        EXPECT_EQ(0, WEXITSTATUS(status)) {
                if (WEXITSTATUS(status) == 2) {
-                       XFAIL(return, "Kernel does not support kcmp() syscall");
+                       SKIP(return, "Kernel does not support kcmp() syscall");
                        return;
                }
        }