Add JestExtensions toFailRequire() without message + update relevant tests

rkalis · rkalis · commit a714dc45fc89 · 2024-09-05T16:30:18.000+02:00
diff --git a/packages/cashscript/src/test/JestExtensions.ts b/packages/cashscript/src/test/JestExtensions.ts
@@ -10,6 +10,7 @@ declare global {
     interface Matchers<R> {
       toLog(value?: RegExp | string): Promise<void>;
       toFailRequireWith(value: RegExp | string): Promise<void>;
+      toFailRequire(): Promise<void>;
     }
   }
 }
@@ -57,7 +58,7 @@ expect.extend({
       await transaction.debug();
 
       const matcherHint = this.utils.matcherHint('.toFailRequireWith', undefined, match.toString(), { isNot: this.isNot });
-      const message = (): string => `${matcherHint}\n\nContract function did not fail a require statement`;
+      const message = (): string => `${matcherHint}\n\nContract function did not fail a require statement.`;
       return { message, pass: false };
     } catch (transactionError: any) {
       const matcherHint = this.utils.matcherHint('toFailRequireWith', 'received', 'expected', { isNot: this.isNot });
@@ -73,4 +74,18 @@ expect.extend({
       }
     }
   },
+  async toFailRequire(
+    this: MatcherContext,
+    transaction: Transaction,
+  ): Promise<SyncExpectationResult> {
+    try {
+      await transaction.debug();
+      const message = (): string => 'Contract function did not fail a require statement.';
+      return { message, pass: false };
+    } catch (transactionError: any) {
+      const receivedText = `Received string: ${this.utils.printReceived(transactionError?.message ?? '')}`;
+      const message = (): string => `Contract function failed a require statement.\n${receivedText}`;
+      return { message, pass: true };
+    }
+  },
 });
diff --git a/packages/cashscript/test/debugging.test.ts b/packages/cashscript/test/debugging.test.ts
@@ -450,7 +450,7 @@ describe('Debugging tests', () => {
       provider.addUtxo(contract.address, randomUtxo());
 
       const transaction = contract.functions.test_require_no_failure().to(contract.address, 1000n);
-      await expect(transaction).not.toFailRequireWith(/.*/);
+      await expect(transaction).not.toFailRequire();
     });
 
     // test_multiple_require_statements_no_message_final
@@ -721,7 +721,7 @@ describe('Debugging tests', () => {
       provider.addUtxo(contract.address, randomUtxo());
 
       const transaction = contract.functions.test_zero_handling(0n).to(contract.address, 1000n);
-      await expect(transaction).not.toFailRequireWith(/.*/);
+      await expect(transaction).not.toFailRequire();
     });
   });
 
@@ -807,8 +807,8 @@ describe('Debugging tests', () => {
       ).rejects.toThrow(/Expected pattern: not .*1 should equal 2.*\nReceived string: (.|\n)*?1 should equal 2/);
 
       await expect(
-        expect(transaction).not.toFailRequireWith(/.*/),
-      ).rejects.toThrow(/Expected pattern: not .*\nReceived string: (.|\n)*?1 should equal 2/);
+        expect(transaction).not.toFailRequire(),
+      ).rejects.toThrow(/Contract function failed a require statement\.*\nReceived string: (.|\n)*?1 should equal 2/);
     });
   });
 });
