28:null 29:["$","title",null,{"children":"Tests on Observable | Jerry Jäppinen | Observable"}] 2e:T19e5,status = { const buttonFullscreen = document.createElement("button"); buttonFullscreen.classList.add("__status-fullscreen-button"); buttonFullscreen.textContent = "⛶"; buttonFullscreen.title = "Fullscreen"; buttonFullscreen.classList; buttonFullscreen.onclick = (e) => { e.stopPropagation(); if (document.fullscreenElement != null) { document.exitFullscreen(); } else { const parentCell = e.currentTarget.parentElement.parentElement.parentElement; console.log(parentCell); parentCell.requestFullscreen ? parentCell.requestFullscreen() : parentCell.webkitRequestFullscreen(); } buttonFullscreen.blur(); }; const container = htl.html`

60 ? "mid" : "low" }-count ${run ? "__status-running" : "__status-waiting"} ${ results.failCount ? "__status-fail" : "__status-success" }"> ${buttonFullscreen} ${ !run ? htl.html`Waiting to run tests` : _.orderBy(results.all, "index").map((t) => { const textContent = `${ t.fail && results.all.length * 16 < width ? "⛔️" : "" }`; const el = htl.html`

${textContent}

`; el.addEventListener("click", async (e) => { e.preventDefault(); await navigator.clipboard.writeText( t.parentIsArray ? t.parents[t.parents.length - 1] : t.key ); el.setAttribute("title", "Copied to clipboard"); setTimeout(() => { el.setAttribute("title", t.id); }, 1000); }); return el; }) }

`; const rootCount = Math.pow(results.all.length, 0.5); let cols = Math.ceil(rootCount); if (width <= 640 && cols > 2) { cols = Math.ceil(cols / 2); } const rows = Math.ceil(results.all.length / cols); const styles = htl.html``; return htl.html`${container}${styles}`; }2f:T41f,results = { const testsToRun = testFilter ? _.filter(normalizedTests, testFilter) : normalizedTests; const all = run ? _.orderBy( await Promise.all( testsToRun.map(async (test, i) => { return await runTest(test, i); }) ), "fail", "desc" ) : []; const __resultsByIsFail = _.groupBy(all, "fail"); const fails = __resultsByIsFail.true || []; const successes = __resultsByIsFail.false || []; const testCount = testsToRun.length; const failCount = fails.length; const successCount = successes.length; const sum = _.sum(all.map((t) => t.sum)); const duration = _.sum(all.map((t) => t.duration)); const iterationCount = _.sum(all.map((t) => t.iterationCount)); return { all, byId: _.keyBy(all, "id"), fails, successes, testCount, failCount, successCount, failRatio: testCount ? failCount / testCount : 0, successRatio: testCount ? successCount / testCount : 0, sum, duration, iterationCount }; }30:T6ce,tests = ({ successWithEnsure() { return ensure(Math.PI > 3, Math.PI < 4); }, // To fix this test, remove all errors and falsy values failWithEnsure() { ensure("foo", Math.PI < 3, true, false, undefined, new Error()); }, // Tests written with expect.js, see below helloWorld() { expect(typeof "hello").to.be("string"); }, // To fix this test, do basic math "Fail with expect"() { expect(1 + 1).to.be(3); }, math: { subtraction: [ () => { expect(1 - 0).to.be(1); }, () => { expect(1 - 2).to.be(-1); } ], add: { twoNumbers() { expect(3 + 4).to.be(7); } } }, more: [ () => { expect(1 - 0).to.be(1); }, () => { expect(1 - 2).to.be(-1); } ], // async async fetchSuccess(i, id) { console.log("Logging...", i, id); // For demo purposes, this only runs on first iteration (i === 0) when tests are repeated // Otherwise, changing `repeat` in the slider below would trigger a lot of requests if (!i) { await fetch("https://jsonplaceholder.typicode.com/posts/1"); } }, async fetch404(i) { if (!i) { const res = await fetch("https://jsonplaceholder.typicode.com/posts/999"); ensure(!res.ok, res.status === 404); } }, // This test will fail (due to browser restrictions) async fetchError(i) { if (!i) { await fetch("http://url.that.fails"); } }, // This is testing an expected error async fetchErrorPass(i) { if (!i) { const failure = await fails(async () => { await fetch("http://url.that.fails"); }); ensure(_.isError(failure.error), failure.errorName === "TypeError"); } } })31:T99b,function ensure(...conditions) { const cases = []; for (let i = 0; i < conditions.length; ++i) { try { // Success case: truthy value if (conditions[i] && !(conditions[i] instanceof Error)) { cases.push({ fail: false, i, caseString: conditions[i] && conditions[i].toString && _.isFunction(conditions[i].toString) ? conditions[i].toString() : "" + conditions[i], case: conditions[i], errorName: undefined, errorMessage: undefined, errorCause: undefined, error: undefined }); // Non-truthy value, but no error } else { let error; if (conditions[i] instanceof Error) { error = conditions[i]; } cases.push({ fail: true, i, caseString: conditions[i] && conditions[i].toString && _.isFunction(conditions[i].toString) ? conditions[i].toString() : "" + conditions[i], case: conditions[i], errorName: error ? error.name : error, errorMessage: error ? error.message : error, errorCause: error ? error.cause : error, error }); } // Fail execution } catch (error) { cases.push({ fail: true, i, caseString: conditions[i] && conditions[i].toString && _.isFunction(conditions[i].toString) ? conditions[i].toString() : "" + conditions[i], case: conditions[i], errorName: error.name, errorMessage: error.message, errorCause: error.cause, error }); } } const caseCount = cases.length; const fails = _.filter(cases, "fail"); const failCount = fails.length; const errors = _.filter(cases, "error").map((c) => c.error); const results = { fail: !!failCount, fails, failCount, status: failCount ? "Fail" : "Pass", errors, caseCount, successCount: caseCount - failCount, cases, casesString: cases.map((c) => c.caseString).join(", ") // casesString: // conditions && conditions.toString && _.isFunction(conditions.toString) // ? conditions.toString() // : "" + conditions }; if (results.fail) { throw new ValidationError(results); } return results; }32:T42f,async function fails(callback) { if (!callback || !_.isFunction(callback)) { throw Error("You must pass a callback function to fails()"); } try { await callback(); } catch (error) { const obj = {}; for (const key of Object.getOwnPropertyNames(error)) { obj[key] = error[key]; } return { // TODO: accept multiple callbacks here errors: [error], casesString: callback.toString(), cases: [ { ...obj, fail: false, i: 0, caseString: callback.toString(), case: undefined, errorName: error.name, errorMessage: error.message, errorCause: error.cause, error } ], // Duplicate first error on top level, for convenience errorName: error.name, errorMessage: error.message, errorCause: error.cause, error }; } // fail( // "fails: this should have thrown an error, but it didn't:" + // "\n" + // callback // ); throw new FailsError(callback); }33:T5e2,reportOptions = ({ required: false, rows: reportRows, width: { Tests: 300, Duration: 80, Runs: 34 }, align: { Duration: "right", Runs: "right" }, format: { Tests([i, fail, s]) { const color = i < 0 ? "inherit" : fail ? "#e7040f" : "#00b800"; return html`${s}`; }, Details([i, fail, callbackString, stack]) { const color = i < 0 ? "inherit" : fail ? "#e7040f" : "#inherit"; const bg = i >= 0 && fail ? "rgba(255, 0, 0, 0.075)" : "transparent"; return html`

${callbackString}
${fail && stack ? `${stack}` : ""}

`; }, Duration([i, fail, duration]) { let d = `${Math.round(duration * 1000) / 1000}`; // let lm = 5; // for (let l = 0; l < lm; ++l) { // if (d.substring(".") > -1 && d.length < lm) { // d += "0"; // } else { // break; // } // } return html`${duration ? `${d}` : "0"} ms`; }, Runs([i, fail, iterationCount]) { return html`${iterationCount}`; } } })34:T753,async function runTest(test, index) { const iterations = []; let slowest = null; let fastest = null; let returned; for (let i = 0; i < repeat; ++i) { const startTime = performance.now(); try { returned = await test.callback(i, test.id); // Fail } catch (err) { const endTime = performance.now(); const duration = endTime - startTime; iterations.push({ ...test, i, index, returned, startTime, endTime, duration, fail: true, status: "Fail", error: err, errorName: err.name, errorMessage: err.message, stack: err.stack }); break; } // Success const endTime = performance.now(); const duration = endTime - startTime; if (_.isNull(slowest) || duration > slowest) { slowest = duration; } if (_.isNull(fastest) || duration < fastest) { fastest = duration; } iterations.push({ ...test, i, index, returned, startTime, endTime, duration, fail: false, status: "Pass" }); } const sum = _.sum(iterations.map((t) => t.duration)); const iterationCount = iterations.length; const mean = iterationCount ? sum / iterationCount : 0; const fail = _.find(iterations, (t) => t.fail); return { ...test, index, iterations, iterationCount, iterationsSkipped: repeat - iterationCount, fail: !!fail, status: fail ? "Fail" : "Pass", error: fail ? fail.error : undefined, errorName: fail ? fail.errorName : undefined, errorMessage: fail ? fail.errorMessage : undefined, stack: fail ? fail.stack : undefined, durationTotal: iterations[iterationCount - 1].endTime - iterations[0].startTime, slowest, fastest, sum, duration: mean }; }35:[{"id":"ef55957f3e916e5bae037566b6aee3ab0e9494b8d9f55b6df361b903ef098836705f0552d5824d32ad64b3bc8d4b8d0b016954635f5e88c2ea688fe59c3e437d","href":"https://static.observableusercontent.com/files/ef55957f3e916e5bae037566b6aee3ab0e9494b8d9f55b6df361b903ef098836705f0552d5824d32ad64b3bc8d4b8d0b016954635f5e88c2ea688fe59c3e437d","name":"image.png","type":"image/png","lastModified":1722516493011.821,"size":215935}] 2c:{"id":"75d697122c8f14d2","slug":"tests","title":"Tests on Observable","thumbnail":"892f54260ef769001c77c4edb004920093ec52feb2fa510beb909fa430b12f59","access_level":"public","create_time":"$D2024-07-31T13:35:35.460Z","update_time":"$D2025-12-20T11:14:48.983Z","view_time":null,"first_public_time":"$D2024-07-31T19:12:23.228Z","has_unpublished_edits":null,"fork":false,"stars":14,"starred":false,"owner":{"type":"team","id":"78ae8536857bb3ab","login":"jerryjappinen","name":"Jerry Jäppinen","avatar_url":"https://avatars-next.observableusercontent.com/da68ef84738ce83ecc0aca0bac01d671eeaa7b46c1b3e4333452f0dc24a48f2f","tier":"starter_2024"},"version":4857,"publish_version":null,"role":null,"authored":false,"authors":[{"type":"individual","id":"5e1c1d34cf3c138c","login":"jerryjappinen","name":"Jerry Jäppinen","avatar_url":"https://avatars-next.observableusercontent.com/da68ef84738ce83ecc0aca0bac01d671eeaa7b46c1b3e4333452f0dc24a48f2f","tier":null}],"members":[{"type":"individual","id":"5e1c1d34cf3c138c","login":"jerryjappinen","name":"Jerry Jäppinen","avatar_url":"https://avatars-next.observableusercontent.com/da68ef84738ce83ecc0aca0bac01d671eeaa7b46c1b3e4333452f0dc24a48f2f","tier":null,"role":"editor"},{"type":"team","id":"78ae8536857bb3ab","login":"jerryjappinen","name":"Jerry Jäppinen","avatar_url":"https://avatars-next.observableusercontent.com/da68ef84738ce83ecc0aca0bac01d671eeaa7b46c1b3e4333452f0dc24a48f2f","tier":"starter_2024","role":"editor"}],"comments":[],"custom_thumbnail":true,"trashed":false,"lapsed":null,"subscribed":null,"forks":2,"collection":{"id":"472c088ec1a9671b","slug":"libraries","title":"Libraries","owner":{"id":"78ae8536857bb3ab","login":"jerryjappinen","name":"Jerry Jäppinen"}},"type":"notebook","body":{"title":"Tests on Observable","cells":[{"id":0,"value":"# Tests on Observable","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":226,"value":"Test automation suite for your notebooks:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":2614,"value":"$2e","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":2306,"value":"This notebook intentionally has failing test cases for demo purposes. See successful test status in the demo notebook.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4513,"value":"toc({\n closed: true,\n select: \"h2, h3\"\n // select: \".observablehq > h2:not(#source)\"\n})","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4740,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3757,"value":"## Usage","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3759,"value":"Write `tests` with `ensure` and show `status` in your notebook:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":237,"value":"```js\nimport { ensure, status } with { tests } from \"@jerryjappinen/tests\"\n\nfunction tests () {\n ensure(Math.PI > 3, Math.PI < 4)\n}\n\nstatus\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4437,"value":"You can use `expect.js` for more complex tests (see docs below).","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":2319,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3011,"value":"`report` has a breakdown of each test:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3039,"value":"```js\nimport { report } with { tests } from \"@jerryjappinen/tests\"\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":346,"value":"report = Inputs.table([reportSummary, ...reportData], reportOptions)","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":466,"value":"viewof reportSearch = Inputs.search(results.all)","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":2090,"value":"viewof reportRows = Inputs.range([1, 100], {\n label: html`reportRows =`,\n step: 1,\n value: 24\n})","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":694,"value":"You can embed or download this report using cell options, or show it in fullscreen with custom CSS. You could even run tests as scheduled jobs.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1419,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":655,"value":"To access all result data, import `results`:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":684,"value":"```js\nimport { results } with { tests } from \"@jerryjappinen/tests\"\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":260,"value":"$2f","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":2846,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":2847,"value":"You can use graphs to visualize `results.all`:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":2821,"value":"Plot.plot({\n x: { grid: true, label: \"Duration (ms)\" },\n y: { grid: true, label: \"Test\" },\n color: { legend: false, scheme: \"RdYlGn\", reverse: true },\n insetLeft: 0,\n marginLeft: 160,\n height: 280,\n marks: [\n Plot.barX(results.all, {\n x: \"duration\",\n y: \"id\",\n fill: \"fail\",\n tip: true\n }),\n Plot.ruleX([0])\n ]\n})","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1052,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":216,"value":"## Writing tests","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":728,"value":"- You can provide a single function, an array of functions or an object with keys (to name each test).\n- You can nest arrays or objects if you have a lot of tests.\n- Each test function will be passed the current iteration and its own ID as an argument.\n- Return values are optional, but might help with debugging.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":34,"value":"$30","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":640,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1341,"value":"## Configuration","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":669,"value":"To _not_ run tests automatically, set `run` to `false`:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":675,"value":"```js\nimport { ... } with { run, tests } from \"@jerryjappinen/tests\"\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":150,"value":"viewof run = Inputs.toggle({ label: html`run =`, value: true })","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":668,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":954,"value":"To run multiple iterations of each test, maybe for benchmarking, set `repeat` to a number higher than `1`:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1028,"value":"```js\nimport { ... } with { repeat, tests } from \"@jerryjappinen/tests\"\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":903,"value":"viewof repeat = Inputs.range([1, 200], {\n label: html`repeat =`,\n step: 1,\n value: 1\n})","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1007,"value":"Each iteration of each test will be recorded under `results`. Only successful runs will be repeated.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":950,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1059,"value":"To limit which tests to run, set a `testFilter`:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1064,"value":"```js\nimport { ... } with { testFilter, tests } from \"@jerryjappinen/tests\"\n\nfunction testFilter ({ ${_.keys(normalizedTests[0]).join(\", \")} }) {\n return path[0] === \"math\"\n}\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3790,"value":"You can use a function or any of the shorthands that `_.filter` accepts.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3615,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4527,"value":"## External CIs","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4530,"value":"You can show test results run on a server if you can fetch them over an API:\n\n```js\nimport { ... } with { tests } from \"@jerryjappinen/tests\"\n\n// Load results from API (CORS headers required)\nciResults = fetch(\"https://api.someci.com/mytests\")\n\n// Generate a test function for each test result\ntests = ciResults.map((ciResult) => {\n return () => {\n ensure(ciResult.wasSuccess)\n }\n})\n\n// Status will now show your CI test results\nstatus\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4533,"value":"As `status` can be opened in fullscreen, you can create a radiator dashboard if you set a timer to refresh the results periodically.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":117,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":763,"value":"## Testing with `ensure()`","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1545,"value":"$31","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1753,"value":"`ensure` asserts that your conditions are _truthy_. If not, you fail:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3242,"value":"ensure(2 < 1)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1779,"value":"You get a full report when passing:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3240,"value":"ensure(1 < 2)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":3236,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3237,"value":"Lodash is imported in every Observable notebook. This makes testing convenient:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1758,"value":"ensure(\n Math.PI,\n Math.PI > 3,\n Math.PI < 4,\n _.isPlainObject({}),\n _.isArray([]),\n _.isNumber(Date.now()),\n _.isDate(new Date()),\n _.isEqual({ foo: \"bar\" }, { foo: \"bar\" })\n)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1588,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1625,"value":"Upon failure, each test case is separated in the error message:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1549,"value":"ensure(\n 1 < 2,\n 2 < 1,\n Math.PI < 3,\n true,\n false,\n undefined,\n _.isNumber(\"Hello\"),\n new Error()\n)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":3574,"value":"`report` will show you this message, so finding the failing cases is easy.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3409,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3410,"value":"### Standalone `ensure()`","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3412,"value":"`ensure` is useful even without the fancy reporting shown above. The simplest set of test cases for a notebook might look like this:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3474,"value":"```js\nimport { ensure } from \"@jerryjappinen/tests\"\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3414,"value":"ensure(\n results,\n _.isPlainObject(results),\n _.isArray(results.all),\n _.isBoolean(run),\n\n // If you set run to false with the toggle above, this will fail\n run,\n\n _.isFunction(inspect),\n _.isFunction(ensure),\n _.isFunction(expect),\n\n // Being clever: use map to avoid repeating the same test function\n ...[\n repeat,\n results.testCount,\n results.failCount,\n results.successCount\n ].map(\n _.isNumber\n )\n)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":3419,"value":"There's no error, so you know your code is passing the tests. If you don't need fancy reporting from `status` and `report`, this is enough.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1998,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3928,"value":"### Errors and failing","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3616,"value":"There is a convenient helper to manually `fail` a test:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3604,"value":"function fail(...args) {\n throw Error(...args);\n}","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":3729,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3679,"value":"If your code is supposed to throw an error, use `fails` to test it:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3670,"value":"$32","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4487,"value":"await fetch(\"http://url.that.fails\")","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4838,"value":"`fails` will return a result object with details about what happened:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3672,"value":"// This will NOT throw an error, so your test will pass\nfails(async () => {\n await fetch(\"http://url.that.fails\");\n})","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4841,"value":"If your code does _not_ throw an error even though it should, `fails` will expectedly fail your test (by throwing an error):","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3677,"value":"// This WILL throw an error and fail your test\nfails(() => {\n console.log(\"Foo\")\n})","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":3879,"value":"Note that you must pass a function to `fails`.","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3836,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3739,"value":"You can `ensure` details about the error (remember to use `await`):","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3814,"value":"{\n const { error } = await fails(async () => {\n await fetch(\"http://url.that.fails\");\n });\n\n return ensure(\n _.isError(error),\n error.name === \"TypeError\",\n error.message === \"Failed to fetch\"\n );\n}","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":59,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3507,"value":"### Debugging with `inspect()`","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1991,"value":"function inspect(...args) {\n try {\n ensure(...args)\n } catch (error) {\n return error.cause\n }\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1623,"value":"To debug a failing test case, use `inspect` instead of `ensure`. You’ll get a full report instead of an error:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":2274,"value":"```js\nimport { ensure, inspect } from \"@jerryjappinen/tests\"\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3505,"value":"ensure(Math.PI < 3)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1976,"value":"inspect(Math.PI < 3)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1524,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1740,"value":"## Testing with `expect.js`","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":71,"value":"expect = require('expect.js@0.3.1/index.js').catch(() => window[\"expect\"])","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":218,"value":"If you don't like `ensure`, you can use expect.js:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":2277,"value":"```js\nimport { expect } with { tests } from \"@jerryjappinen/tests\"\n\nfunction tests () {\n expect(Math.PI).to.be.above(3)\n}\n```","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1743,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":3799,"value":"`expect` is a popular choice for writing tests, but it is more complex than `ensure`. Here is a quick reference from its readme:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":641,"value":"$${__expectjsMeta.readme.substring(\n __expectjsMeta.readme.indexOf(\"## API\") + \"## API\".length,\n __expectjsMeta.readme.indexOf(\"## Using with a test framework\")\n)}","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4524,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":608,"value":"## Source","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":1051,"value":"testFilter = null","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":2069,"value":"reportData = reportSearch.map(\n (\n {\n id,\n fail,\n path,\n duration,\n callback,\n callbackString,\n stack,\n iterationCount\n },\n i\n ) => {\n const columns = {\n Tests: [i, fail, (fail ? \"⛔️\" : \"✅\") + \" \" + id],\n Details: [i, fail, callbackString, stack],\n Duration: [i, fail, duration]\n };\n\n if (repeat > 1) {\n columns.Runs = [i, fail, iterationCount];\n }\n\n return columns;\n }\n)","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":2113,"value":"reportSummary = {\n const row = {\n Tests: [\n -1,\n !!results.failCount,\n !run\n ? \"Waiting to run tests\"\n : results.failCount\n ? `${reportRows <= 1 ? \"⛔️ \" : \"\"}${results.failCount}/${\n results.testCount\n } tests failing`\n : `${reportRows <= 1 ? \"✅ \" : \"\"}All ${\n results.testCount\n } tests passing`\n ],\n Details: [\n -1,\n !!results.failCount,\n !run ? \"\" : `All tests run in ${Math.round(results.sum * 1000) / 1000} ms`\n ],\n Duration: [-1, !!results.failCount, results.duration]\n };\n\n if (repeat > 1) {\n row.Runs = [-1, !!results.failCount, results.iterationCount];\n }\n\n return row;\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":2072,"value":"$33","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":81,"value":"$34","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":111,"value":"function normalizeTest (value, key, parents) {\n if (_.isPlainObject(value)) {\n return normalizeTest()\n }\n return { key, parents, value }\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":140,"value":"function normalizeTests(tests, parents = [], parentIsArray) {\n let normalized = [];\n\n _.each(tests, (value, key) => {\n // Format arrays\n if (_.isArray(value)) {\n // console.log(\"isArray\");\n normalized = [\n ...normalized,\n ...normalizeTests(\n _.keyBy(value, (val) => {\n return `${key}-${value.indexOf(val)}`;\n }),\n [...parents, key],\n true\n )\n ];\n\n // Nested tests\n } else if (_.isPlainObject(value)) {\n normalized = [...normalized, ...normalizeTests(value, [...parents, key])];\n\n // Callback\n } else {\n const path = [...parents, key];\n normalized.push({\n callback: value,\n parents,\n parentIsArray: !!parentIsArray,\n key,\n path,\n id: path.join(\".\"),\n callbackString: value.toString()\n });\n }\n });\n\n return normalized;\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":134,"value":"normalizedTests = normalizeTests(\n _.isFunction(tests) || _.isArray(tests) ? { tests } : tests,\n [],\n _.isArray(tests)\n)","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1893,"value":"class ValidationError extends Error {\n constructor(results) {\n const message = `${\n results.caseCount > 1\n ? `${results.failCount} test cases failing:`\n : \"Test case failing:\"\n }`;\n const detail = `${results.cases\n .map((c) => `${c.fail ? \"⛔️\" : \"✅\"} ${c.i}: ${c.caseString}`)\n .join(\"\\n\")}`;\n\n super(message + \"\\n\" + detail);\n\n this.name = \"ensure()\";\n this.results = results;\n // Error.captureStackTrace(this, ValidationError);\n this.stack = `${detail}`;\n this.cause = results;\n }\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":3917,"value":"class FailsError extends Error {\n constructor(callback) {\n const message = `This should have thrown an error, but it didn't:\n${callback}`;\n\n super(message);\n\n this.name = \"fails()\";\n // Error.captureStackTrace(this, ValidationError);\n this.stack = `${callback}`;\n this.cause = callback;\n }\n}","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1046,"value":"__repeat = Math.max(1, Math.min(repeat, 10000))","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":1855,"value":"__expectjsMeta = (await fetch(\"https://registry.npmjs.org/expect.js\")).json()","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4806,"value":"---","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":4512,"value":"import { baseStyles } from \"@jerryjappinen/ui\"","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4850,"value":"import { toc } from \"@jerryjappinen/snippets\"","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4796,"value":"baseStyles","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"}],"files":"$W35","stdlib":"1","titling":"auto"}} 2d:"$2c:body"