From 15b5d001d386b1624a1835764cb2961338ccd6fe Mon Sep 17 00:00:00 2001 From: Marko Ristin Date: Mon, 18 Jan 2021 07:00:44 +0100 Subject: [PATCH] Test e2e that sing-off enforcement fires This is an end-to-end test to manually check that the sign-off enforcements fires. Please do not close this pull request. If you want to re-test the sign-off enforcement, just rebase this commit to the master branch and do a forced push. No `Signed-off-by:` line is expected in this commit body and the developer should manually check that the checks fail on this pull request. --- .github/workflows/build-and-test.yml | 36 -------------- .../test-sign-off-enforcement-fires.yml | 12 +++++ dist/index.js | 48 +++++++++++++++---- 3 files changed, 50 insertions(+), 46 deletions(-) delete mode 100644 .github/workflows/build-and-test.yml create mode 100644 .github/workflows/test-sign-off-enforcement-fires.yml diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml deleted file mode 100644 index 688d449..0000000 --- a/.github/workflows/build-and-test.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: "build-and-test" -on: - pull_request: - push: - branches: - - master - - dev - -jobs: - build: - runs-on: windows-latest - steps: - - uses: actions/checkout@v1 - - - name: Install dependencies - run: npm install - - - name: Execute all scripts - run: npm run all - - test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - uses: ./ - with: - additional-verbs: 'chrusimusi, unit-test' - path-to-additional-verbs: src/additional-verbs.txt - - test-allow-one-liners: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - uses: ./ - with: - allow-one-liners: 'true' diff --git a/.github/workflows/test-sign-off-enforcement-fires.yml b/.github/workflows/test-sign-off-enforcement-fires.yml new file mode 100644 index 0000000..2e9df5c --- /dev/null +++ b/.github/workflows/test-sign-off-enforcement-fires.yml @@ -0,0 +1,12 @@ +name: "e2e-test-sign-off-enforcement" +on: [push] + +jobs: + test-sign-off-enforcement-fires: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + + - uses: ./ + with: + enforce-sign-off: 'true' diff --git a/dist/index.js b/dist/index.js index 92427be..0e48d8f 100644 --- a/dist/index.js +++ b/dist/index.js @@ -738,6 +738,21 @@ function checkBody(subject, bodyLines) { } return errors; } +const signedOffByRe = new RegExp('^\\s*Signed-off-by:\\s*[^<]+\\s*<[^@>, ]+@[^@>, ]+>\\s*$'); +function checkSignedOff(bodyLines) { + const errors = []; + let matches = 0; + for (const line of bodyLines) { + if (signedOffByRe.test(line)) { + matches++; + } + } + if (matches === 0) { + errors.push("The body does not contain any 'Signed-off-by: ' line. " + + 'Did you sign off the commit with `git commit --signoff`?'); + } + return errors; +} const mergeMessageRe = new RegExp("^Merge branch '[^\\000-\\037\\177 ~^:?*[]+' " + 'into [^\\000-\\037\\177 ~^:?*[]+$'); function check(message, inputs) { @@ -765,6 +780,9 @@ function check(message, inputs) { const subjectBody = maybeSubjectBody.subjectBody; errors.push(...checkSubject(subjectBody.subject, inputs)); errors.push(...checkBody(subjectBody.subject, subjectBody.bodyLines)); + if (inputs.enforceSignOff) { + errors.push(...checkSignedOff(subjectBody.bodyLines)); + } } } // Post-condition @@ -2325,7 +2343,7 @@ module.exports = require("https"); /***/ 215: /***/ (function(module) { -module.exports = {"_from":"@octokit/rest@^16.15.0","_id":"@octokit/rest@16.43.1","_inBundle":false,"_integrity":"sha512-gfFKwRT/wFxq5qlNjnW2dh+qh74XgTQ2B179UX5K1HYCluioWj8Ndbgqw2PVqa1NnVJkGHp2ovMpVn/DImlmkw==","_location":"/@octokit/rest","_phantomChildren":{"deprecation":"2.3.1","once":"1.4.0","os-name":"3.1.0"},"_requested":{"type":"range","registry":true,"raw":"@octokit/rest@^16.15.0","name":"@octokit/rest","escapedName":"@octokit%2frest","scope":"@octokit","rawSpec":"^16.15.0","saveSpec":null,"fetchSpec":"^16.15.0"},"_requiredBy":["/@actions/github"],"_resolved":"https://registry.npmjs.org/@octokit/rest/-/rest-16.43.1.tgz","_shasum":"3b11e7d1b1ac2bbeeb23b08a17df0b20947eda6b","_spec":"@octokit/rest@^16.15.0","_where":"/home/marko/workspace/mristin/opinionated-commit-message/node_modules/@actions/github","author":{"name":"Gregor Martynus","url":"https://github.com/gr2m"},"bugs":{"url":"https://github.com/octokit/rest.js/issues"},"bundleDependencies":false,"bundlesize":[{"path":"./dist/octokit-rest.min.js.gz","maxSize":"33 kB"}],"contributors":[{"name":"Mike de Boer","email":"info@mikedeboer.nl"},{"name":"Fabian Jakobs","email":"fabian@c9.io"},{"name":"Joe Gallo","email":"joe@brassafrax.com"},{"name":"Gregor Martynus","url":"https://github.com/gr2m"}],"dependencies":{"@octokit/auth-token":"^2.4.0","@octokit/plugin-paginate-rest":"^1.1.1","@octokit/plugin-request-log":"^1.0.0","@octokit/plugin-rest-endpoint-methods":"2.4.0","@octokit/request":"^5.2.0","@octokit/request-error":"^1.0.2","atob-lite":"^2.0.0","before-after-hook":"^2.0.0","btoa-lite":"^1.0.0","deprecation":"^2.0.0","lodash.get":"^4.4.2","lodash.set":"^4.3.2","lodash.uniq":"^4.5.0","octokit-pagination-methods":"^1.1.0","once":"^1.4.0","universal-user-agent":"^4.0.0"},"deprecated":false,"description":"GitHub REST API client for Node.js","devDependencies":{"@gimenete/type-writer":"^0.1.3","@octokit/auth":"^1.1.1","@octokit/fixtures-server":"^5.0.6","@octokit/graphql":"^4.2.0","@types/node":"^13.1.0","bundlesize":"^0.18.0","chai":"^4.1.2","compression-webpack-plugin":"^3.1.0","cypress":"^3.0.0","glob":"^7.1.2","http-proxy-agent":"^4.0.0","lodash.camelcase":"^4.3.0","lodash.merge":"^4.6.1","lodash.upperfirst":"^4.3.1","lolex":"^5.1.2","mkdirp":"^1.0.0","mocha":"^7.0.1","mustache":"^4.0.0","nock":"^11.3.3","npm-run-all":"^4.1.2","nyc":"^15.0.0","prettier":"^1.14.2","proxy":"^1.0.0","semantic-release":"^17.0.0","sinon":"^8.0.0","sinon-chai":"^3.0.0","sort-keys":"^4.0.0","string-to-arraybuffer":"^1.0.0","string-to-jsdoc-comment":"^1.0.0","typescript":"^3.3.1","webpack":"^4.0.0","webpack-bundle-analyzer":"^3.0.0","webpack-cli":"^3.0.0"},"files":["index.js","index.d.ts","lib","plugins"],"homepage":"https://github.com/octokit/rest.js#readme","keywords":["octokit","github","rest","api-client"],"license":"MIT","name":"@octokit/rest","nyc":{"ignore":["test"]},"publishConfig":{"access":"public"},"release":{"publish":["@semantic-release/npm",{"path":"@semantic-release/github","assets":["dist/*","!dist/*.map.gz"]}]},"repository":{"type":"git","url":"git+https://github.com/octokit/rest.js.git"},"scripts":{"build":"npm-run-all build:*","build:browser":"npm-run-all build:browser:*","build:browser:development":"webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json","build:browser:production":"webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map","build:ts":"npm run -s update-endpoints:typescript","coverage":"nyc report --reporter=html && open coverage/index.html","generate-bundle-report":"webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html","lint":"prettier --check '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","lint:fix":"prettier --write '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","postvalidate:ts":"tsc --noEmit --target es6 test/typescript-validate.ts","prebuild:browser":"mkdirp dist/","pretest":"npm run -s lint","prevalidate:ts":"npm run -s build:ts","start-fixtures-server":"octokit-fixtures-server","test":"nyc mocha test/mocha-node-setup.js \"test/*/**/*-test.js\"","test:browser":"cypress run --browser chrome","update-endpoints":"npm-run-all update-endpoints:*","update-endpoints:fetch-json":"node scripts/update-endpoints/fetch-json","update-endpoints:typescript":"node scripts/update-endpoints/typescript","validate:ts":"tsc --target es6 --noImplicitAny index.d.ts"},"types":"index.d.ts","version":"16.43.1"}; +module.exports = {"_args":[["@octokit/rest@16.43.1","C:\\Users\\rist\\workspace\\mristin\\opinionated-commit-message"]],"_from":"@octokit/rest@16.43.1","_id":"@octokit/rest@16.43.1","_inBundle":false,"_integrity":"sha512-gfFKwRT/wFxq5qlNjnW2dh+qh74XgTQ2B179UX5K1HYCluioWj8Ndbgqw2PVqa1NnVJkGHp2ovMpVn/DImlmkw==","_location":"/@octokit/rest","_phantomChildren":{"@types/node":"12.12.42","deprecation":"2.3.1","once":"1.4.0","os-name":"3.1.0"},"_requested":{"type":"version","registry":true,"raw":"@octokit/rest@16.43.1","name":"@octokit/rest","escapedName":"@octokit%2frest","scope":"@octokit","rawSpec":"16.43.1","saveSpec":null,"fetchSpec":"16.43.1"},"_requiredBy":["/@actions/github"],"_resolved":"https://registry.npmjs.org/@octokit/rest/-/rest-16.43.1.tgz","_spec":"16.43.1","_where":"C:\\Users\\rist\\workspace\\mristin\\opinionated-commit-message","author":{"name":"Gregor Martynus","url":"https://github.com/gr2m"},"bugs":{"url":"https://github.com/octokit/rest.js/issues"},"bundlesize":[{"path":"./dist/octokit-rest.min.js.gz","maxSize":"33 kB"}],"contributors":[{"name":"Mike de Boer","email":"info@mikedeboer.nl"},{"name":"Fabian Jakobs","email":"fabian@c9.io"},{"name":"Joe Gallo","email":"joe@brassafrax.com"},{"name":"Gregor Martynus","url":"https://github.com/gr2m"}],"dependencies":{"@octokit/auth-token":"^2.4.0","@octokit/plugin-paginate-rest":"^1.1.1","@octokit/plugin-request-log":"^1.0.0","@octokit/plugin-rest-endpoint-methods":"2.4.0","@octokit/request":"^5.2.0","@octokit/request-error":"^1.0.2","atob-lite":"^2.0.0","before-after-hook":"^2.0.0","btoa-lite":"^1.0.0","deprecation":"^2.0.0","lodash.get":"^4.4.2","lodash.set":"^4.3.2","lodash.uniq":"^4.5.0","octokit-pagination-methods":"^1.1.0","once":"^1.4.0","universal-user-agent":"^4.0.0"},"description":"GitHub REST API client for Node.js","devDependencies":{"@gimenete/type-writer":"^0.1.3","@octokit/auth":"^1.1.1","@octokit/fixtures-server":"^5.0.6","@octokit/graphql":"^4.2.0","@types/node":"^13.1.0","bundlesize":"^0.18.0","chai":"^4.1.2","compression-webpack-plugin":"^3.1.0","cypress":"^3.0.0","glob":"^7.1.2","http-proxy-agent":"^4.0.0","lodash.camelcase":"^4.3.0","lodash.merge":"^4.6.1","lodash.upperfirst":"^4.3.1","lolex":"^5.1.2","mkdirp":"^1.0.0","mocha":"^7.0.1","mustache":"^4.0.0","nock":"^11.3.3","npm-run-all":"^4.1.2","nyc":"^15.0.0","prettier":"^1.14.2","proxy":"^1.0.0","semantic-release":"^17.0.0","sinon":"^8.0.0","sinon-chai":"^3.0.0","sort-keys":"^4.0.0","string-to-arraybuffer":"^1.0.0","string-to-jsdoc-comment":"^1.0.0","typescript":"^3.3.1","webpack":"^4.0.0","webpack-bundle-analyzer":"^3.0.0","webpack-cli":"^3.0.0"},"files":["index.js","index.d.ts","lib","plugins"],"homepage":"https://github.com/octokit/rest.js#readme","keywords":["octokit","github","rest","api-client"],"license":"MIT","name":"@octokit/rest","nyc":{"ignore":["test"]},"publishConfig":{"access":"public"},"release":{"publish":["@semantic-release/npm",{"path":"@semantic-release/github","assets":["dist/*","!dist/*.map.gz"]}]},"repository":{"type":"git","url":"git+https://github.com/octokit/rest.js.git"},"scripts":{"build":"npm-run-all build:*","build:browser":"npm-run-all build:browser:*","build:browser:development":"webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json","build:browser:production":"webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map","build:ts":"npm run -s update-endpoints:typescript","coverage":"nyc report --reporter=html && open coverage/index.html","generate-bundle-report":"webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html","lint":"prettier --check '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","lint:fix":"prettier --write '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json","postvalidate:ts":"tsc --noEmit --target es6 test/typescript-validate.ts","prebuild:browser":"mkdirp dist/","pretest":"npm run -s lint","prevalidate:ts":"npm run -s build:ts","start-fixtures-server":"octokit-fixtures-server","test":"nyc mocha test/mocha-node-setup.js \"test/*/**/*-test.js\"","test:browser":"cypress run --browser chrome","update-endpoints":"npm-run-all update-endpoints:*","update-endpoints:fetch-json":"node scripts/update-endpoints/fetch-json","update-endpoints:typescript":"node scripts/update-endpoints/typescript","validate:ts":"tsc --target es6 --noImplicitAny index.d.ts"},"types":"index.d.ts","version":"16.43.1"}; /***/ }), @@ -4578,7 +4596,7 @@ const inspection = __importStar(__webpack_require__(117)); const represent = __importStar(__webpack_require__(110)); const input = __importStar(__webpack_require__(553)); function runWithExceptions() { - var _a, _b, _c; + var _a, _b, _c, _d, _e; const messages = commitMessages.retrieve(); //// // Parse inputs @@ -4586,7 +4604,10 @@ function runWithExceptions() { const additionalVerbsInput = (_a = core.getInput('additional-verbs', { required: false })) !== null && _a !== void 0 ? _a : ''; const pathToAdditionalVerbsInput = (_b = core.getInput('path-to-additional-verbs', { required: false })) !== null && _b !== void 0 ? _b : ''; const allowOneLinersInput = (_c = core.getInput('allow-one-liners', { required: false })) !== null && _c !== void 0 ? _c : ''; - const maybeInputs = input.parseInputs(additionalVerbsInput, pathToAdditionalVerbsInput, allowOneLinersInput); + const enforceSignOffInput = (_d = core.getInput('enforce-sign-off', { required: false })) !== null && _d !== void 0 ? _d : ''; + const maybeInputs = input.parseInputs(additionalVerbsInput, pathToAdditionalVerbsInput, allowOneLinersInput, enforceSignOffInput); + // TODO: remove + core.info(`The maybeInputs.enforceSignOffInput are: ${(_e = maybeInputs.inputs) === null || _e === void 0 ? void 0 : _e.enforceSignOff}`); if (maybeInputs.error !== null) { core.error(maybeInputs.error); core.setFailed(maybeInputs.error); @@ -9372,14 +9393,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); -exports.parseAllowOneLiners = exports.parseVerbs = exports.parseInputs = exports.MaybeInputs = exports.Inputs = void 0; +exports.parseVerbs = exports.parseInputs = exports.MaybeInputs = exports.Inputs = void 0; const fs_1 = __importDefault(__webpack_require__(747)); class Inputs { - constructor(hasAdditionalVerbsInput, pathToAdditionalVerbs, allowOneLiners, additionalVerbs) { + constructor(hasAdditionalVerbsInput, pathToAdditionalVerbs, allowOneLiners, additionalVerbs, enforceSignOff) { this.hasAdditionalVerbsInput = hasAdditionalVerbsInput; this.pathToAdditionalVerbs = pathToAdditionalVerbs; this.allowOneLiners = allowOneLiners; this.additionalVerbs = additionalVerbs; + this.enforceSignOff = enforceSignOff; } } exports.Inputs = Inputs; @@ -9403,7 +9425,7 @@ class MaybeInputs { } } exports.MaybeInputs = MaybeInputs; -function parseInputs(additionalVerbsInput, pathToAdditionalVerbsInput, allowOneLinersInput) { +function parseInputs(additionalVerbsInput, pathToAdditionalVerbsInput, allowOneLinersInput, enforceSignOffInput) { const additionalVerbs = new Set(); const hasAdditionalVerbsInput = additionalVerbsInput.length > 0; if (additionalVerbsInput) { @@ -9423,12 +9445,19 @@ function parseInputs(additionalVerbsInput, pathToAdditionalVerbsInput, allowOneL } const allowOneLiners = !allowOneLinersInput ? false - : parseAllowOneLiners(allowOneLinersInput); + : parseBooleanFromString(allowOneLinersInput); if (allowOneLiners === null) { return new MaybeInputs(null, 'Unexpected value for allow-one-liners. ' + `Expected either 'true' or 'false', got: ${allowOneLinersInput}`); } - return new MaybeInputs(new Inputs(hasAdditionalVerbsInput, pathToAdditionalVerbsInput, allowOneLiners, additionalVerbs), null); + const enforceSignOff = !enforceSignOffInput + ? false + : parseBooleanFromString(enforceSignOffInput); + if (enforceSignOff === null) { + return new MaybeInputs(null, 'Unexpected value for enforce-sign-off. ' + + `Expected either 'true' or 'false', got: ${enforceSignOffInput}`); + } + return new MaybeInputs(new Inputs(hasAdditionalVerbsInput, pathToAdditionalVerbsInput, allowOneLiners, additionalVerbs, enforceSignOff), null); } exports.parseInputs = parseInputs; function parseVerbs(text) { @@ -9444,7 +9473,7 @@ function parseVerbs(text) { return verbs; } exports.parseVerbs = parseVerbs; -function parseAllowOneLiners(text) { +function parseBooleanFromString(text) { if (text === '' || text.toLowerCase() === 'false' || text === '0') { return false; } @@ -9453,7 +9482,6 @@ function parseAllowOneLiners(text) { } return null; } -exports.parseAllowOneLiners = parseAllowOneLiners; /***/ }),