chore: enhance skip function to return the skip reason

Author: baileympearson

test/tools/unified-spec-runner/runner.ts

@@ -60,14 +60,14 @@ export async function runUnifiedTest(
   ctx: Mocha.Context,
   unifiedSuite: uni.UnifiedSuite,
   test: uni.Test,
-  skipFilter?: (test: uni.Test) => boolean
+  skipFilter?: uni.TestFilter
 ): Promise<void>;
 
 export async function runUnifiedTest(
   ctx: Mocha.Context,
   unifiedSuite: uni.UnifiedSuite,
   test: uni.Test,
-  testsToSkipOrFilter?: string[] | ((test: uni.Test) => boolean)
+  testsToSkipOrFilter?: string[] | uni.TestFilter
 ): Promise<void> {
   // Some basic expectations we can catch early
   expect(test).to.exist;
@@ -77,7 +77,8 @@ export async function runUnifiedTest(
 
   if (Array.isArray(testsToSkipOrFilter)) {
     const testsToSkip = testsToSkipOrFilter;
-    testsToSkipOrFilter = (test: uni.Test) => testsToSkip.includes(test.description);
+    testsToSkipOrFilter = ({ description }) =>
+      testsToSkip.includes(description) ? 'Test was filtered without a skip reason' : null;
   }
 
   const schemaVersion = patchVersion(unifiedSuite.schemaVersion);
@@ -90,6 +91,16 @@ export async function runUnifiedTest(
     ctx.skip();
   }
 
+  const skipReason = testsToSkipOrFilter?.(test);
+
+  if (typeof skipReason === 'string') {
+    if (skipReason.length === 0) {
+      expect.fail(`Test was skipped with an empty skip reason: ${test.description}`);
+    }
+    ctx.skipReason = skipReason;
+    ctx.skip();
+  }
+
   if (testsToSkipOrFilter?.(test)) {
     ctx.skip();
   }
@@ -279,14 +290,11 @@ export function runUnifiedSuite(specTests: uni.UnifiedSuite[], testsToSkip?: str
  *
  * @param skipFilter - a function that returns true if the test should be skipped
  */
-export function runUnifiedSuite(
-  specTests: uni.UnifiedSuite[],
-  skipFilter?: (test: uni.Test) => boolean
-): void;
+export function runUnifiedSuite(specTests: uni.UnifiedSuite[], skipFilter?: uni.TestFilter): void;
 
 export function runUnifiedSuite(
   specTests: uni.UnifiedSuite[],
-  testsToSkipOrFilter?: string[] | ((test: uni.Test) => boolean)
+  testsToSkipOrFilter?: string[] | uni.TestFilter
 ): void {
   for (const unifiedSuite of specTests) {
     context(String(unifiedSuite.description), function () {

test/tools/unified-spec-runner/schema.ts

@@ -236,3 +236,8 @@ export interface ExpectedError {
   errorLabelsOmit?: string[];
   expectResult?: unknown;
 }
+
+/**
+ * A type that represents the test filter provided to the unifed runner.
+ */
+export type TestFilter = (test: Test) => null | string;