@stacks/rendezvous 0.7.3 → 0.8.0

package/README.md

@@ -56,6 +56,7 @@ npx rv <path-to-clarinet-project> <contract-name> <type>
 - `--path` – The path to use for the replay functionality.
 - `--runs` – The number of test iterations to use for exercising the contracts.
   (default: `100`)
+- `--bail` – Stop after the first failure.
 - `--dial` – The path to a JavaScript file containing custom pre- and
   post-execution functions (dialers).
 

package/dist/app.js

@@ -94,10 +94,12 @@ const helpMessage = `
     --seed - The seed to use for the replay functionality.
     --path - The path to use for the replay functionality.
     --runs - The runs to use for iterating over the tests. Default: 100.
+    --bail - Stop after the first failure.
     --dial – The path to a JavaScript file containing custom pre- and post-execution functions (dialers).
     --help - Show the help message.
   `;
-const parseOptionalArgument = (argName) => {
+const parseBooleanOption = (argName) => process.argv.slice(4).includes(`--${argName}`);
+const parseOption = (argName) => {
     var _a;
     return (_a = process.argv
         .find((arg, idx) => idx >= 4 && arg.toLowerCase().startsWith(`--${argName}`))) === null || _a === void 0 ? void 0 : _a.split("=")[1];
@@ -140,24 +142,28 @@ function main() {
         const manifestPath = (0, path_1.join)(manifestDir, (0, exports.getManifestFileName)(manifestDir, sutContractName));
         radio.emit("logMessage", `Using manifest path: ${manifestPath}`);
         radio.emit("logMessage", `Target contract: ${sutContractName}`);
-        const seed = parseInt(parseOptionalArgument("seed"), 10) || undefined;
+        const seed = parseInt(parseOption("seed"), 10) || undefined;
         if (seed !== undefined) {
             radio.emit("logMessage", `Using seed: ${seed}`);
         }
-        const path = parseOptionalArgument("path") || undefined;
+        const path = parseOption("path") || undefined;
         if (path !== undefined) {
             radio.emit("logMessage", `Using path: ${path}`);
         }
-        const runs = parseInt(parseOptionalArgument("runs"), 10) || undefined;
+        const runs = parseInt(parseOption("runs"), 10) || undefined;
         if (runs !== undefined) {
             radio.emit("logMessage", `Using runs: ${runs}`);
         }
+        const bail = parseBooleanOption("bail");
+        if (bail) {
+            radio.emit("logMessage", `Bailing on first failure.`);
+        }
         /**
          * The path to the dialer file. The dialer file allows the user to register
          * custom pre and post-execution JavaScript functions to be executed before
          * and after the public function calls during invariant testing.
          */
-        const dialPath = parseOptionalArgument("dial") || undefined;
+        const dialPath = parseOption("dial") || undefined;
         if (dialPath !== undefined) {
             radio.emit("logMessage", `Using dial path: ${dialPath}`);
         }
@@ -181,11 +187,11 @@ function main() {
         // If "test", call `checkProperties` for property-based testing.
         switch (type) {
             case "invariant": {
-                yield (0, invariant_1.checkInvariants)(simnet, sutContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, dialerRegistry, radio);
+                yield (0, invariant_1.checkInvariants)(simnet, sutContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, bail, dialerRegistry, radio);
                 break;
             }
             case "test": {
-                (0, property_1.checkProperties)(simnet, sutContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, radio);
+                (0, property_1.checkProperties)(simnet, sutContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, bail, radio);
                 break;
             }
         }

package/dist/invariant.js

@@ -31,11 +31,13 @@ const dialer_1 = require("./dialer");
  * @param seed The seed for reproducible invariant testing.
  * @param path The path for reproducible invariant testing.
  * @param runs The number of test runs.
+ * @param bail Stop execution after the first failure and prevent further
+ * shrinking.
  * @param dialerRegistry The custom dialer registry.
  * @param radio The custom logging event emitter.
  * @returns void
  */
-const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, dialerRegistry, radio) => __awaiter(void 0, void 0, void 0, function* () {
+const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, bail, dialerRegistry, radio) => __awaiter(void 0, void 0, void 0, function* () {
     // A map where the keys are the Rendezvous identifiers and the values are
     // arrays of their SUT (System Under Test) functions. This map will be used
     // to access the SUT functions for each Rendezvous contract afterwards.
@@ -298,11 +300,12 @@ const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousA
             simnet.mineEmptyBurnBlocks(r.burnBlocks);
         }
     })), {
-        verbose: true,
+        endOnFailure: bail,
+        numRuns: runs,
+        path: path,
         reporter: radioReporter,
         seed: seed,
-        path: path,
-        numRuns: runs,
+        verbose: true,
     });
 });
 exports.checkInvariants = checkInvariants;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stacks/rendezvous",
-    "version": "0.7.3",
+    "version": "0.8.0",
     "description": "Meet your contract's vulnerabilities head-on.",
     "main": "app.js",
     "bin": {

package/dist/property.js

@@ -21,10 +21,12 @@ const traits_1 = require("./traits");
  * @param seed The seed for reproducible property-based tests.
  * @param path The path for reproducible property-based tests.
  * @param runs The number of test runs.
+ * @param bail Stop execution after the first failure and prevent further
+ * shrinking.
  * @param radio The custom logging event emitter.
  * @returns void
  */
-const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, radio) => {
+const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousAllFunctions, seed, path, runs, bail, radio) => {
     const testContractId = rendezvousList[0];
     // A map where the keys are the test contract identifiers and the values are
     // arrays of their test functions. This map will be used to access the test
@@ -202,11 +204,12 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
             }
         }
     }), {
-        verbose: true,
+        endOnFailure: bail,
+        numRuns: runs,
+        path: path,
         reporter: radioReporter,
         seed: seed,
-        path: path,
-        numRuns: runs,
+        verbose: true,
     });
 };
 exports.checkProperties = checkProperties;

package/dist/traits.js

@@ -17,21 +17,37 @@ const enrichInterfaceWithTraitData = (ast, traitReferenceMap, functionInterfaceL
     const enriched = new Map();
     const enrichArgs = (args, functionName, traitReferenceMap, path = []) => {
         return args.map((arg) => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
             const listNested = !arg.name;
             const currentPath = listNested ? path : [...path, arg.name];
+            // Exit early if the traitReferenceMap does not have anything we are
+            // looking for. It means that the current parameter does not have an
+            // associated trait reference.
+            if (!traitReferenceMap ||
+                (!traitReferenceMap[arg.name] &&
+                    !traitReferenceMap.tuple &&
+                    !traitReferenceMap.list &&
+                    !traitReferenceMap.response &&
+                    !traitReferenceMap.optional &&
+                    !((_a = traitReferenceMap[arg.name]) === null || _a === void 0 ? void 0 : _a.tuple) &&
+                    !((_b = traitReferenceMap[arg.name]) === null || _b === void 0 ? void 0 : _b.list) &&
+                    !((_c = traitReferenceMap[arg.name]) === null || _c === void 0 ? void 0 : _c.response) &&
+                    !((_d = traitReferenceMap[arg.name]) === null || _d === void 0 ? void 0 : _d.optional) &&
+                    traitReferenceMap !== "trait_reference")) {
+                return arg;
+            }
             if (arg.type && arg.type.tuple) {
                 return Object.assign(Object.assign({}, arg), { type: {
                         tuple: enrichArgs(arg.type.tuple, functionName, listNested
                             ? traitReferenceMap.tuple
-                            : (_a = traitReferenceMap[arg.name]) === null || _a === void 0 ? void 0 : _a.tuple, currentPath),
+                            : (_e = traitReferenceMap[arg.name]) === null || _e === void 0 ? void 0 : _e.tuple, currentPath),
                     } });
             }
             else if (arg.type && arg.type.list) {
                 return Object.assign(Object.assign({}, arg), { type: {
                         list: enrichArgs([arg.type.list], functionName, listNested
                             ? traitReferenceMap.list
-                            : (_b = traitReferenceMap[arg.name]) === null || _b === void 0 ? void 0 : _b.list, arg.type.list.type.tuple
+                            : (_f = traitReferenceMap[arg.name]) === null || _f === void 0 ? void 0 : _f.list, arg.type.list.type.tuple
                             ? [...currentPath, "tuple"]
                             : arg.type.list.type.response
                                 ? [...currentPath, "response"]
@@ -45,13 +61,13 @@ const enrichInterfaceWithTraitData = (ast, traitReferenceMap, functionInterfaceL
                 const errorPath = listNested ? currentPath : [...currentPath, "error"];
                 const okTraitReference = enrichArgs([{ name: "ok", type: arg.type.response.ok }], functionName, {
                     ok: listNested
-                        ? (_c = traitReferenceMap.response) === null || _c === void 0 ? void 0 : _c.ok
-                        : (_e = (_d = traitReferenceMap[arg.name]) === null || _d === void 0 ? void 0 : _d.response) === null || _e === void 0 ? void 0 : _e.ok,
+                        ? (_g = traitReferenceMap.response) === null || _g === void 0 ? void 0 : _g.ok
+                        : (_j = (_h = traitReferenceMap[arg.name]) === null || _h === void 0 ? void 0 : _h.response) === null || _j === void 0 ? void 0 : _j.ok,
                 }, okPath)[0];
                 const errorTraitReference = enrichArgs([{ name: "error", type: arg.type.response.error }], functionName, {
                     error: listNested
-                        ? (_f = traitReferenceMap.response) === null || _f === void 0 ? void 0 : _f.error
-                        : (_h = (_g = traitReferenceMap[arg.name]) === null || _g === void 0 ? void 0 : _g.response) === null || _h === void 0 ? void 0 : _h.error,
+                        ? (_k = traitReferenceMap.response) === null || _k === void 0 ? void 0 : _k.error
+                        : (_m = (_l = traitReferenceMap[arg.name]) === null || _l === void 0 ? void 0 : _l.response) === null || _m === void 0 ? void 0 : _m.error,
                 }, errorPath)[0];
                 return Object.assign(Object.assign({}, arg), { type: {
                         response: {
@@ -65,7 +81,7 @@ const enrichInterfaceWithTraitData = (ast, traitReferenceMap, functionInterfaceL
                 const optionalTraitReference = enrichArgs([{ name: "optional", type: arg.type.optional }], functionName, {
                     optional: listNested
                         ? traitReferenceMap.optional
-                        : (_j = traitReferenceMap[arg.name]) === null || _j === void 0 ? void 0 : _j.optional,
+                        : (_o = traitReferenceMap[arg.name]) === null || _o === void 0 ? void 0 : _o.optional,
                 }, optionalPath)[0];
                 return Object.assign(Object.assign({}, arg), { type: {
                         optional: optionalTraitReference.type,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/rendezvous",
-  "version": "0.7.3",
+  "version": "0.8.0",
   "description": "Meet your contract's vulnerabilities head-on.",
   "main": "app.js",
   "bin": {