From 1cffe74a89212254b646659e7072a409b2f7a650 Mon Sep 17 00:00:00 2001
From: Eric Cornelissen <ericornelissen@gmail.com>
Date: Tue, 24 Oct 2023 20:36:29 +0200
Subject: [PATCH] Improve breakage tests (#1262)

Add tests verifying that the `Shescape` and `Stubscape` constructors by
themselves behave the same way between the development head and last
released version.

This should improve confidence as without these tests there is a chance
that the implementation is changed such that, e.g., on the development
head the constructor throws where in the last version all methods would
throw instead (which is a breaking change). By having a test dedicated
to the constructor, the described scenario would be caught.

Also some reformatting because I didn't like the way the tests were
written before.
---
 test/breakage/index.test.js   | 43 ++++++++++++++++++++++++++-------
 test/breakage/testing.test.js | 45 ++++++++++++++++++++++++++++-------
 2 files changed, 71 insertions(+), 17 deletions(-)

diff --git a/test/breakage/index.test.js b/test/breakage/index.test.js
index a9e4a1325..22847538c 100644
--- a/test/breakage/index.test.js
+++ b/test/breakage/index.test.js
@@ -11,12 +11,36 @@ import { arbitrary } from "./_.js";
 import { Shescape } from "shescape";
 import { Shescape as Previouscape } from "shescape-previous";
 
+testProp(
+  "Shescape#constructor",
+  [arbitrary.shescapeOptions()],
+  (t, options) => {
+    let shescape, previouscape;
+    let errored, previousErrored;
+
+    try {
+      shescape = new Shescape(options);
+    } catch (_) {
+      errored = true;
+    }
+
+    try {
+      previouscape = new Previouscape(options);
+    } catch (_) {
+      previousErrored = true;
+    }
+
+    t.is(errored, previousErrored);
+  },
+);
+
 testProp(
   "Shescape#escape",
   [arbitrary.shescapeOptions(), fc.anything()],
   (t, options, arg) => {
-    let result, previousResult, errored, previousErrored;
     let shescape, previouscape;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       shescape = new Shescape(options);
@@ -32,8 +56,8 @@ testProp(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -44,8 +68,9 @@ testProp(
     fc.oneof(fc.anything(), fc.array(fc.anything())),
   ],
   (t, options, args) => {
-    let result, previousResult, errored, previousErrored;
     let shescape, previouscape;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       shescape = new Shescape(options);
@@ -61,8 +86,8 @@ testProp(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -70,8 +95,9 @@ testProp(
   "Shescape#quote",
   [arbitrary.shescapeOptions(), fc.anything()],
   (t, options, arg) => {
-    let result, previousResult, errored, previousErrored;
     let shescape, previouscape;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       shescape = new Shescape(options);
@@ -87,8 +113,8 @@ testProp(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -99,8 +125,9 @@ testProp(
     fc.oneof(fc.anything(), fc.array(fc.anything())),
   ],
   (t, options, args) => {
-    let result, previousResult, errored, previousErrored;
     let shescape, previouscape;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       shescape = new Shescape(options);
@@ -116,7 +143,7 @@ testProp(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
diff --git a/test/breakage/testing.test.js b/test/breakage/testing.test.js
index 2e76c9eb3..3d377766d 100644
--- a/test/breakage/testing.test.js
+++ b/test/breakage/testing.test.js
@@ -11,12 +11,36 @@ import { arbitrary } from "./_.js";
 import { Shescape as Stubscape, Throwscape } from "shescape/testing";
 import { Shescape as Previoustub } from "shescape-previous/testing";
 
+testProp(
+  "Stubscape#constructor",
+  [arbitrary.shescapeOptions()],
+  (t, options) => {
+    let stubscape, previoustub;
+    let errored, previousErrored;
+
+    try {
+      stubscape = new Stubscape(options);
+    } catch (_) {
+      errored = true;
+    }
+
+    try {
+      previoustub = new Previoustub(options);
+    } catch (_) {
+      previousErrored = true;
+    }
+
+    t.is(errored, previousErrored);
+  },
+);
+
 testProp(
   "Stubscape#escape",
   [arbitrary.shescapeOptions(), fc.anything()],
   (t, options, arg) => {
-    let result, previousResult, errored, previousErrored;
     let stubscape, previoustub;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       stubscape = new Stubscape(options);
@@ -32,8 +56,8 @@ testProp(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -44,8 +68,9 @@ testProp(
     fc.oneof(fc.anything(), fc.array(fc.anything())),
   ],
   (t, options, args) => {
-    let result, previousResult, errored, previousErrored;
     let stubscape, previoustub;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       stubscape = new Stubscape(options);
@@ -61,8 +86,8 @@ testProp(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -72,8 +97,9 @@ testProp.skip(
   "Stubscape#quote",
   [arbitrary.shescapeOptions(), fc.anything()],
   (t, options, arg) => {
-    let result, previousResult, errored, previousErrored;
     let stubscape, previoustub;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       stubscape = new Stubscape(options);
@@ -89,8 +115,8 @@ testProp.skip(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -103,8 +129,9 @@ testProp.skip(
     fc.oneof(fc.anything(), fc.array(fc.anything())),
   ],
   (t, options, args) => {
-    let result, previousResult, errored, previousErrored;
     let stubscape, previoustub;
+    let result, previousResult;
+    let errored, previousErrored;
 
     try {
       stubscape = new Stubscape(options);
@@ -120,8 +147,8 @@ testProp.skip(
       previousErrored = true;
     }
 
-    t.is(errored, previousErrored);
     t.is(typeof result, typeof previousResult);
+    t.is(errored, previousErrored);
   },
 );
 
@@ -131,8 +158,8 @@ testProp.skip(
   "Throwscape#constructor",
   [arbitrary.shescapeOptions()],
   (t, options) => {
-    let errored, previousErrored;
     let throwscape, previousthrow;
+    let errored, previousErrored;
 
     try {
       throwscape = new Throwscape(options);