Skip to content

Commit

Permalink
Improve breakage tests (#1262)
Browse files Browse the repository at this point in the history 
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.
  • Loading branch information
@ericcornelissen
ericcornelissen authored Oct 24, 2023
1 parent c171070 commit 1cffe74
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 17 deletions.
43 changes: 35 additions & 8 deletions test/breakage/index.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -32,8 +56,8 @@ testProp(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

Expand All @@ -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);
Expand All @@ -61,17 +86,18 @@ testProp(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

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);
Expand All @@ -87,8 +113,8 @@ testProp(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

Expand All @@ -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);
Expand All @@ -116,7 +143,7 @@ testProp(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);
45 changes: 36 additions & 9 deletions test/breakage/testing.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -32,8 +56,8 @@ testProp(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

Expand All @@ -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);
Expand All @@ -61,8 +86,8 @@ testProp(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

Expand All @@ -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);
Expand All @@ -89,8 +115,8 @@ testProp.skip(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

Expand All @@ -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);
Expand All @@ -120,8 +147,8 @@ testProp.skip(
previousErrored = true;
}

t.is(errored, previousErrored);
t.is(typeof result, typeof previousResult);
t.is(errored, previousErrored);
},
);

Expand All @@ -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);
Expand Down

0 comments on commit 1cffe74

Please sign in to comment.