RageCage64
/
js-test
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

First draft with cli that runs all *.test.js files

Browse Source
main
BraydonKains 3 years ago
parent 6ef8b5e6ad
commit ab01ce3b44
18 changed files with 2409 additions and 169 deletions
Show Stats Download Patch File Download Diff File

1
.eslintignore
Unescape Escape View File

@ -0,0 +1 @@
.eslintrc.cjs

22
.eslintrc.cjs
Unescape Escape View File

@ -0,0 +1,22 @@
const OFF = 0;
const WARN = 1;
const ERR = 2;
module.exports = {
"env": {
"es2021": true,
"node": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": 12,
"sourceType": "module"
},
"rules": {
"indent": [ERR, 4],
"linebreak-style": [ERR, "unix"],
"quotes": [ERR, "double"],
"semi": [ERR, "never"],
"comma-dangle": [ERR, "always-multiline"],
},
}

40
SumTestSuite.js
Unescape Escape View File

@ -1,40 +0,0 @@
'use strict';
const assert = require('assert');
const { sum } = require('./sum');
class SumTestSuite {
testSumCorrectness() {
const a = 1;
const b = 2;
const result = sum(a, b);
assert(result === a + b, 'the result should be the sum of its arguments');
}
testSumNoArgs() {
try {
sum();
} catch {
return;
}
assert.fail('should fail if not provided any arguments');
}
testSumMissingArg() {
const a = 1;
try {
sum(a);
} catch {
return;
}
assert.fail('should fail if not provided all arguments');
}
testWillFail() {
assert.fail('I have failed!');
}
}
module.exports = {
SumTestSuite,
}

21
cli.js
Unescape Escape View File

@ -0,0 +1,21 @@
#!/usr/bin/env node
import { discoverTestFiles } from "./src/discover.js"
import { runTests } from "./src/suites.js"
async function main() {
const testFilePaths = await discoverTestFiles()
for (const filePath of testFilePaths) {
const filePathParts = filePath.split("/")
const fileName = filePathParts[filePathParts.length - 1]
const suite = await import(`./${filePath}`)
console.log(`Running suite ${fileName}`)
console.log("-------------------------")
runTests(suite)
console.log("-------------------------")
}
}
main()

12
examples/commonjs/sum.cjs
Unescape Escape View File

@ -0,0 +1,12 @@
"use strict"
function sum(a, b) {
if (!a || !b)
throw Error("gimme a number")
return a + b
}
module.exports = {
sum,
}

41
examples/commonjs/sum.test.cjs
Unescape Escape View File

@ -0,0 +1,41 @@
"use strict"
const assert = require("assert")
const { sum } = require("./sum.cjs")
function testSumResult() {
const a = 1
const b = 2
const result = sum(a, b)
assert(result === a + b, "the result should be the sum of its arguments")
}
function testSumNoArgs() {
try {
sum()
} catch (_) {
return
}
assert.fail("should fail if not provided any arguments")
}
function testSumMissingArg() {
const a = 1
try {
sum(a)
} catch (_) {
return
}
assert.fail("should fail if not provided all arguments")
}
function testWillFail() {
assert.fail("I have failed!")
}
module.exports = {
testSumResult,
testSumNoArgs,
testSumMissingArg,
testWillFail,
}

6
examples/modules/sum.js
Unescape Escape View File

@ -0,0 +1,6 @@
export function sum(a, b) {
if (!a || !b)
throw Error("gimme a number")
return a + b
}

33
examples/modules/sum.test.js
Unescape Escape View File

@ -0,0 +1,33 @@
import { strict as assert } from "assert"
import { sum } from "./sum.js"
export function testSumResult() {
const a = 1
const b = 2
const result = sum(a, b)
assert(result === a + b, "the result should be the sum of its arguments")
}
export function testSumNoArgs() {
try {
sum()
} catch (_) {
return
}
assert.fail("should fail if not provided any arguments")
}
export function testSumMissingArg() {
const a = 1
try {
sum(a)
} catch (_) {
return
}
assert.fail("should fail if not provided all arguments")
}
export function testWillFail() {
assert.fail("I have failed!")
}

6
examples/programmatic/sum.js
Unescape Escape View File

@ -0,0 +1,6 @@
export function sum(a, b) {
if (!a || !b)
throw Error("gimme a number")
return a + b
}

7
index.js
Unescape Escape View File

@ -0,0 +1,7 @@
import { runTests } from "./src/suites.js"
import { discoverTestFiles } from "./src/discover.js"
export {
runTests,
discoverTestFiles,
}

2200
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

20
package.json
Unescape Escape View File

@ -2,9 +2,23 @@
"name": "js-test",
"version": "0.0.1",
"main": "index.js",
"type": "module",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"lint": "eslint .",
"lint:fix": "eslint --fix ."
},
"author": "BraydonKains",
"license": "MIT"
"bin": {
"js-test": "./cli.js"
},
"author": {
"name": "BraydonKains",
"github": "https://github.com/BraydonKains"
},
"license": "MIT",
"devDependencies": {
"eslint": "^7.29.0"
},
"dependencies": {
"tiny-glob": "^0.2.9"
}
}

53
runner.js
Unescape Escape View File

@ -1,53 +0,0 @@
'use strict';
const tests = require('./sum.test');
const { SumTestSuite } = require('./SumTestSuite');
function runTestFile() {
const results = {};
Object.entries(tests).forEach(
([_, testData]) => {
console.log(testData.description);
try {
testData.test();
console.log('SUCCESS');
// FIXME no
results[testData.description] = null;
} catch (err) {
console.log('FAILED');
console.log(err.message);
results[testData.description] = err;
}
}
);
return results;
}
function runTestSuite() {
const suite = new SumTestSuite();
const suiteProto = Object.getPrototypeOf(suite)
const testMethodNames =
Object.getOwnPropertyNames(suiteProto).filter(
prop =>
typeof suite[prop] === 'function' &&
prop.startsWith('test')
);
testMethodNames.forEach(
testMethodName => {
console.log(testMethodName);
try {
suite[testMethodName]();
console.log('SUCCESS');
} catch (err) {
console.log('FAILED');
console.log(err.message);
}
}
);
}
runTestSuite();

12
src/discover.js
Unescape Escape View File

@ -0,0 +1,12 @@
import { default as glob } from "tiny-glob"
export async function discoverTestFiles(options) {
const pattern = options?.pattern || "**/*.test.{js,cjs,mjs}"
const directory = options?.directory || "."
const files = await glob(pattern, {
cwd: directory,
})
const importUrls = files.map(f => f.replace("\\", "/")) // Silly Windows!
return importUrls
}

18
src/suites.js
Unescape Escape View File

@ -0,0 +1,18 @@
import { getMethodNames } from "./util.js"
export function runTests(suite) {
const testMethodNames = getMethodNames(suite)
testMethodNames.forEach(
testMethodName => {
console.log(testMethodName)
try {
suite[testMethodName]()
console.log("SUCCESS")
} catch (err) {
console.log("FAILED")
console.log(err.message)
}
},
)
}

6
src/util.js
Unescape Escape View File

@ -0,0 +1,6 @@
export const getMethodNames = (obj) =>
Object.getOwnPropertyNames(obj).filter(
prop =>
prop.startsWith("test") &&
typeof obj[prop] === "function",
)

8
sum.js
Unescape Escape View File

@ -1,8 +0,0 @@
'use strict';
module.exports.sum = (a, b) => {
if (!a || !b)
throw Error('gimme a number');
return a + b;
}

58
sum.test.js
Unescape Escape View File

@ -1,58 +0,0 @@
'use strict';
const assert = require('assert');
const { sum } = require('./sum');
const test = (description, testProcedure) => ({
description,
test: testProcedure,
});
const testSumCorrectness = test(
'#sum should return the sum of its arguments',
() => {
const a = 1;
const b = 2;
const result = sum(a, b);
assert(result === a + b, 'the result should be the sum of its arguments');
}
);
const testSumNoArgs = test(
'#sum should throw an error if no arguments are passed',
() => {
try {
sum();
} catch {
return;
}
assert.fail('should fail if not provided any arguments');
}
);
const testSumMissingArg = test(
'#sum should throw an error if no arguments are passed',
() => {
const a = 1;
try {
sum(a);
} catch {
return;
}
assert.fail('should fail if not provided all arguments');
}
);
const testWillFail = test(
'#sum will fail against its will',
() => {
assert.fail('I have failed!');
}
);
module.exports = {
testSumCorrectness,
testSumNoArgs,
testSumMissingArg,
testWillFail,
};
Write Preview
Loading…
Cancel
Save