Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce "breakage testing" #1233

Merged
merged 4 commits into from
Oct 21, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Introduce "breakage testing"
Add a new type of testing including a new test suite that's aimed solely
at preventing the introduction of breaking changes. To this end the
suite runs both the current version of the library and the latest
released version and compares their behaviour.
  • Loading branch information
ericcornelissen committed Oct 14, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit b7763e065f7e166f363f3e69beab0489403b23f7
8 changes: 8 additions & 0 deletions .c8/breakage.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"all": true,
"include": ["src/", "index.js"],
"exclude": [],
"check-coverage": false,
"reports-dir": "_reports/coverage/breakage",
"reporter": ["lcov", "text"]
}
31 changes: 31 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -218,6 +218,37 @@ jobs:
if: ${{ failure() || success() }}
with:
sarif_file: njsscan-results.sarif
test-breakage:
name: Breakage
runs-on: ubuntu-22.04
needs:
- test-integration
steps:
- name: Harden runner
uses: step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09 # v2.5.1
with:
disable-sudo: true
egress-policy: block
allowed-endpoints: >
actions-results-receiver-production.githubapp.com:443
api.github.com:443
artifactcache.actions.githubusercontent.com:443
github.com:443
gitlab.com:443
nodejs.org:443
objects.githubusercontent.com:443
registry.npmjs.org:443
- name: Checkout repository
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
- name: Install Node.js
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
with:
cache: npm
node-version-file: .nvmrc
- name: Install dependencies
run: npm clean-install
- name: Run breakage tests
run: npm run coverage:breakage
test-compatibility:
name: Compatibility
runs-on: ubuntu-22.04
3 changes: 2 additions & 1 deletion .licensee.json
Original file line number Diff line number Diff line change
@@ -19,7 +19,8 @@
"@andrewbranch/untar.js": "1.0.2",
"deep-freeze": "0.0.1",
"filter-iterator": "0.0.1",
"identity-function": "1.0.0"
"identity-function": "1.0.0",
"shescape": "*"
},
"corrections": true
}
14 changes: 14 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -79,6 +79,7 @@
"prettier": "3.0.3",
"publint": "0.2.3",
"rollup": "4.0.2",
"shescape-previous": "npm:[email protected]",
"sinon": "16.1.0"
},
"scripts": {
@@ -98,7 +99,8 @@
"audit:runtime": "better-npm-audit audit --production",
"benchmark": "node bench/bench.js",
"clean": "node script/clean.js",
"coverage": "npm run coverage:unit && npm run coverage:integration && npm run coverage:e2e && npm run coverage:compat",
"coverage": "npm run coverage:unit && npm run coverage:integration && npm run coverage:e2e && npm run coverage:compat && npm run coverage:breakage",
"coverage:breakage": "c8 --config .c8/breakage.json npm run test:breakage",
"coverage:compat": "c8 --config .c8/compat.json npm run test:compat",
"coverage:e2e": "node script/run-platform-coverage.js e2e",
"coverage:e2e:unix": "c8 --config .c8/e2e-unix.json npm run test:e2e",
@@ -121,7 +123,8 @@
"mutation": "npm run mutation:unit && npm run mutation:integration",
"mutation:integration": "stryker run stryker.integration.config.js",
"mutation:unit": "stryker run stryker.unit.config.js",
"test": "npm run test:unit && npm run test:integration && npm run test:e2e && npm run test:compat",
"test": "npm run test:unit && npm run test:integration && npm run test:e2e && npm run test:compat && npm run test:breakage",
"test:breakage": "ava test/breakage/**/*.test.js",
"test:compat": "ava test/compat/**/*.test.js",
"test:compat-all": "nve 14.18.0,16.13.0,18.0.0,19.0.0,20.0.0 npm run test:compat --ignore-scripts",
"test:e2e": "ava test/e2e/**/*.test.js --timeout 1m",
8 changes: 8 additions & 0 deletions test/breakage/_.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/**
* @overview Provides testing utilities.
* @license MIT
*/

import * as arbitrary from "../_arbitraries.js";

export { arbitrary };
122 changes: 122 additions & 0 deletions test/breakage/index.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
/**
* @overview Contains breakage tests for the `Shescape` class.
* @license MIT
*/

import { testProp } from "@fast-check/ava";
import * as fc from "fast-check";

import { arbitrary } from "./_.js";

import { Shescape } from "shescape";
import { Shescape as Previouscape } from "shescape-previous";

testProp(
"Shescape#escape",
[arbitrary.shescapeOptions(), fc.anything()],
(t, options, arg) => {
let result, previousResult, errored, previousErrored;
let shescape, previouscape;

try {
shescape = new Shescape(options);
result = shescape.escape(arg);
} catch (_) {
errored = true;
}

try {
previouscape = new Previouscape(options);
previousResult = previouscape.escape(arg);
} catch (_) {
previousErrored = true;
}

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

testProp(
"Shescape#escapeAll",
[
arbitrary.shescapeOptions(),
fc.oneof(fc.anything(), fc.array(fc.anything())),
],
(t, options, args) => {
let result, previousResult, errored, previousErrored;
let shescape, previouscape;

try {
shescape = new Shescape(options);
result = shescape.escapeAll(args);
} catch (_) {
errored = true;
}

try {
previouscape = new Previouscape(options);
previousResult = previouscape.escapeAll(args);
} catch (_) {
previousErrored = true;
}

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

testProp(
"Shescape#quote",
[arbitrary.shescapeOptions(), fc.anything()],
(t, options, arg) => {
let result, previousResult, errored, previousErrored;
let shescape, previouscape;

try {
shescape = new Shescape(options);
result = shescape.quote(arg);
} catch (_) {
errored = true;
}

try {
previouscape = new Previouscape(options);
previousResult = previouscape.quote(arg);
} catch (_) {
previousErrored = true;
}

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

testProp(
"Shescape#quoteAll",
[
arbitrary.shescapeOptions(),
fc.oneof(fc.anything(), fc.array(fc.anything())),
],
(t, options, args) => {
let result, previousResult, errored, previousErrored;
let shescape, previouscape;

try {
shescape = new Shescape(options);
result = shescape.quoteAll(args);
} catch (_) {
errored = true;
}

try {
previouscape = new Previouscape(options);
previousResult = previouscape.quoteAll(args);
} catch (_) {
previousErrored = true;
}

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