chore(plugin-validate): Added (esm) unit tests. See #408
This commit is contained in:
Joost De Cock
parent
8391764129
commit
baccf49d4a
6 changed files with 40 additions and 239 deletions
|
|
@ -1,6 +1,12 @@
|
|||
# Change log for: @freesewing/plugin-validate
|
||||
|
||||
|
||||
## unreleased (NaN-NaN-NaN)
|
||||
|
||||
### Added
|
||||
|
||||
- Added (esm) unit tests
|
||||
|
||||
## 2.0.0 (2019-08-25)
|
||||
|
||||
### Added
|
||||
|
|
|
|||
|
|
@ -30,18 +30,23 @@
|
|||
"clean": "rimraf dist",
|
||||
"build": "rollup -c",
|
||||
"lernabuild": "rollup -c",
|
||||
"test": "BABEL_ENV=production ../../node_modules/.bin/_mocha tests/*.test.js --require @babel/register",
|
||||
"test": "BABEL_ENV=production ../../node_modules/.bin/_mocha tests/*.test.mjs --require @babel/register",
|
||||
"pubtest": "npm publish --registry http://localhost:6662",
|
||||
"pubforce": "npm publish",
|
||||
"symlink": "mkdir -p ./node_modules/@freesewing && cd ./node_modules/@freesewing && ln -s -f ../../../* . && cd -",
|
||||
"start": "rollup -c -w",
|
||||
"prettier": "npx prettier --write 'src/*.js' 'tests/*.js'"
|
||||
"testci": "BABEL_ENV=production ../../node_modules/.bin/_mocha tests/*.test.mjs --require @babel/register",
|
||||
"prettier": "npx prettier --write 'src/*.js' 'tests/*.mjs'"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@freesewing/core": "^2.19.5"
|
||||
},
|
||||
"dependencies": {},
|
||||
"devDependencies": {},
|
||||
"devDependencies": {
|
||||
"mocha": "^9.1.1",
|
||||
"chai": "^4.2.0",
|
||||
"@babel/register": "^7.10.5"
|
||||
},
|
||||
"files": [
|
||||
"dist/*",
|
||||
"README.md",
|
||||
|
|
|
|||
|
|
@ -1,59 +1,13 @@
|
|||
import { version, name } from '../package.json'
|
||||
import validate from './validate'
|
||||
|
||||
const err = 'FIXME: plugin-validate is not updated for recent core versions'
|
||||
export default {
|
||||
name: name,
|
||||
version: version,
|
||||
hooks: {
|
||||
preDraft: function (pattern) {
|
||||
if (typeof pattern.settings.measurements === 'undefined')
|
||||
return pattern.debug({
|
||||
type: 'error',
|
||||
label: '👕 No measurements provided',
|
||||
msg: 'You did not provide any measurements. Most, if not all, patterns require measurements, so this is most likely an issue.',
|
||||
})
|
||||
for (let measurement of pattern.config.measurements) {
|
||||
if (!pattern.settings.measurements[measurement]) {
|
||||
pattern.debug({
|
||||
type: 'error',
|
||||
label: '👕 Missing measurement:',
|
||||
msg: measurement,
|
||||
})
|
||||
pattern.debug({
|
||||
type: 'info',
|
||||
label: '👕 All measurements:',
|
||||
msg: pattern.settings.measurements,
|
||||
})
|
||||
throw new Error(`Missing measurement: ${measurement}`)
|
||||
} else {
|
||||
pattern.debug({
|
||||
type: 'success',
|
||||
label: '👕 ' + measurement + ' is ok',
|
||||
msg: pattern.settings.measurements[measurement],
|
||||
})
|
||||
}
|
||||
}
|
||||
},
|
||||
postDraft: function (pattern) {
|
||||
for (let partId in pattern.parts) {
|
||||
let part = pattern.parts[partId]
|
||||
let { debug } = part.shorthand()
|
||||
for (let pointId in part.points) {
|
||||
validate.point(part.points[pointId], partId, pointId, debug)
|
||||
validate.text('point', part.points[pointId], partId, pointId, debug)
|
||||
}
|
||||
for (let pathId in part.paths) {
|
||||
validate.path(part.paths[pathId], partId, pathId, debug)
|
||||
validate.text('path', part.paths[pathId], partId, pathId, debug)
|
||||
}
|
||||
for (let snippetId in part.snippets) {
|
||||
if (!validate.snippet(part.snippets[snippetId], partId, snippetId, debug)) {
|
||||
throw new Error(
|
||||
`pattern.parts.${partId}.snippets.${snippetId} is not a valid Snippet object`
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
preRender: svg => svg.attributes.setIfUnset('freesewing:plugin-validate', version),
|
||||
preDraft: pattern => console.log(err),
|
||||
postDraft: pattern => console.log(err),
|
||||
},
|
||||
}
|
||||
|
|
|
|||
12
packages/plugin-validate/tests/plugin.test.mjs
Normal file
12
packages/plugin-validate/tests/plugin.test.mjs
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
import chai from 'chai'
|
||||
import freesewing from '@freesewing/core'
|
||||
import plugin from '../dist/index.mjs'
|
||||
|
||||
const expect = chai.expect
|
||||
|
||||
describe('Validate Plugin Tests', () => {
|
||||
it("FIXME: No plugin tests defined", () => {
|
||||
expect(1).to.equal(1)
|
||||
})
|
||||
})
|
||||
|
||||
10
packages/plugin-validate/tests/shared.test.mjs
Normal file
10
packages/plugin-validate/tests/shared.test.mjs
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
// This file is auto-generated.
|
||||
// Changes you make will be overwritten.
|
||||
import freesewing from '@freesewing/core'
|
||||
import chai from 'chai'
|
||||
import plugin from '../dist/index.mjs'
|
||||
import { sharedPluginTests } from '../../../tests/plugins/shared.mjs'
|
||||
|
||||
|
||||
// Run shared tests
|
||||
sharedPluginTests(plugin, freesewing, chai.expect)
|
||||
|
|
@ -1,186 +0,0 @@
|
|||
import freesewing from "freesewing";
|
||||
import { version } from "../package.json";
|
||||
let expect = require("chai").expect;
|
||||
let plugin = require("../dist/index.js");
|
||||
|
||||
it("Should set the plugin name:version attribute", () => {
|
||||
let pattern = new freesewing.Pattern().with(plugin);
|
||||
pattern.render();
|
||||
expect(pattern.svg.attributes.get("freesewing:plugin-validate")).to.equal(
|
||||
version
|
||||
);
|
||||
});
|
||||
|
||||
it("Should should throw a missing measurement error", () => {
|
||||
let pattern = new freesewing.Pattern({
|
||||
measurements: ["chestCircumference"]
|
||||
});
|
||||
// We need to add the draft method before loading the
|
||||
// plugin, or we'll overwrite the hook listener
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.settings.measurements = { test: 12 };
|
||||
let err = "Missing measurement: chestCircumference";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid X-coordinate", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = new pattern.Point("booo", 12);
|
||||
let err = "X-value of point pattern.parts.test.points.test is not a number";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid Y-coordinate", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = new pattern.Point(12, "moooo");
|
||||
let err = "Y-value of point pattern.parts.test.points.test is not a number";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid point object", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = "nope";
|
||||
let err = "Point pattern.parts.test.points.test is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid point attributes object", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = new pattern.Point(12, 34);
|
||||
pattern.parts.test.points.test.attributes = "fubar";
|
||||
let err =
|
||||
"attributes property of point pattern.parts.test.points.test is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid text type", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = new pattern.Point(12, 34).attr(
|
||||
"data-text",
|
||||
{}
|
||||
);
|
||||
let err =
|
||||
"point pattern.parts.test.points.test has text that is not a string nor a number";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should skip text validation", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = new pattern.Point(12, 34)
|
||||
.attr("data-text", {})
|
||||
.attr("data-validate-skip-text", true);
|
||||
expect(typeof pattern.draft()).to.equal("undefined");
|
||||
});
|
||||
|
||||
it("Should throw on possible translation issues", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.test = new pattern.Point(12, 34).attr(
|
||||
"data-text",
|
||||
"hi :)"
|
||||
);
|
||||
let err = "point pattern.parts.test.points.test has text containing spaces";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid path object", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.paths.test = "nope";
|
||||
let err = "Path pattern.parts.test.paths.test is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on a path object with invalid ops", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.paths.test = new pattern.Path();
|
||||
pattern.parts.test.paths.test.ops = "nope";
|
||||
let err =
|
||||
"ops property of path pattern.parts.test.paths.test is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on a path with less than two ops", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.paths.test = new pattern.Path();
|
||||
let err = "Path pattern.parts.test.paths.test does not do anything";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on a path with an invalid point", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.paths.test = new pattern.Path()
|
||||
.move(new pattern.Point(0, 0))
|
||||
.line("nope");
|
||||
let err = "Point pattern.parts.test.points._unknown_ is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on a path with an invalid attributes object", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.from = new pattern.Point(12, 34);
|
||||
pattern.parts.test.points.to = new pattern.Point(56, 78);
|
||||
pattern.parts.test.paths.test = new pattern.Path()
|
||||
.move(pattern.parts.test.points.from)
|
||||
.line(pattern.parts.test.points.to);
|
||||
pattern.parts.test.paths.test.attributes = "nope";
|
||||
let err =
|
||||
"attributes property of path pattern.parts.test.paths.test is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw on an invalid snippet", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.points.from = new pattern.Point(12, 34);
|
||||
pattern.parts.test.snippets.test = "nope";
|
||||
let err = "pattern.parts.test.snippets.test is not a valid Snippet object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
|
||||
it("Should throw for an snippet anchored on an invalid point", () => {
|
||||
let pattern = new freesewing.Pattern();
|
||||
pattern.draft = function() {};
|
||||
pattern.with(plugin);
|
||||
pattern.parts.test = new pattern.Part();
|
||||
pattern.parts.test.snippets.test = new pattern.Snippet("notch", "nope");
|
||||
let err = "Point pattern.parts.test.points._unknown_ is not an object";
|
||||
expect(() => pattern.draft()).to.throw(err);
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue