CyberChef/Gruntfile.js

438 lines
17 KiB
JavaScript
Raw Normal View History

"use strict";
2017-04-13 20:00:55 +02:00
const webpack = require("webpack");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const BundleAnalyzerPlugin = require("webpack-bundle-analyzer").BundleAnalyzerPlugin;
2018-03-27 00:14:23 +02:00
const glob = require("glob");
const path = require("path");
2016-12-14 17:39:17 +01:00
2022-01-31 11:31:19 +01:00
const nodeFlags = "--experimental-modules --experimental-json-modules --experimental-specifier-resolution=node --no-warnings --no-deprecation";
2017-07-04 00:15:57 +02:00
/**
* Grunt configuration for building the app in various formats.
*
* @author n1474335 [n1474335@gmail.com]
* @copyright Crown Copyright 2017
* @license Apache-2.0
*/
module.exports = function (grunt) {
2016-11-28 11:42:58 +01:00
grunt.file.defaultEncoding = "utf8";
grunt.file.preserveBOM = false;
2016-12-14 17:39:17 +01:00
2016-11-28 11:42:58 +01:00
// Tasks
grunt.registerTask("dev",
"A persistent task which creates a development build whenever source files are modified.",
["clean:dev", "clean:config", "exec:generateConfig", "concurrent:dev"]);
2019-07-09 15:31:18 +02:00
grunt.registerTask("prod",
"Creates a production-ready build. Use the --msg flag to add a compile message.",
[
"eslint", "clean:prod", "clean:config", "exec:generateConfig", "findModules", "webpack:web",
2023-03-21 16:39:31 +01:00
"copy:standalone", "zip:standalone", "clean:standalone", "exec:calcDownloadHash", "chmod"
2019-07-09 15:31:18 +02:00
]);
grunt.registerTask("node",
"Compiles CyberChef into a single NodeJS module.",
2019-07-09 15:31:18 +02:00
[
"clean:node", "clean:config", "clean:nodeConfig", "exec:generateConfig", "exec:generateNodeIndex"
2019-07-09 15:31:18 +02:00
]);
2016-12-14 17:39:17 +01:00
grunt.registerTask("configTests",
2020-03-17 09:40:15 +01:00
"A task which configures config files in preparation for tests to be run. Use `npm test` to run tests.",
2019-07-09 15:31:18 +02:00
[
"clean:config", "clean:nodeConfig", "exec:generateConfig", "exec:generateNodeIndex"
2019-07-09 15:31:18 +02:00
]);
grunt.registerTask("testui",
2018-12-30 01:26:28 +01:00
"A task which runs all the UI tests in the tests directory. The prod task must already have been run.",
["connect:prod", "exec:browserTests"]);
2016-12-14 17:39:17 +01:00
2019-08-02 12:10:15 +02:00
grunt.registerTask("testnodeconsumer",
"A task which checks whether consuming CJS and ESM apps work with the CyberChef build",
["exec:setupNodeConsumers", "exec:testCJSNodeConsumer", "exec:testESMNodeConsumer", "exec:teardownNodeConsumers"]);
2019-08-02 12:10:15 +02:00
2016-11-28 11:42:58 +01:00
grunt.registerTask("default",
"Lints the code base",
["eslint", "exec:repoSize"]);
2016-12-14 17:39:17 +01:00
grunt.registerTask("lint", "eslint");
grunt.registerTask("findModules",
"Finds all generated modules and updates the entry point list for Webpack",
function(arg1, arg2) {
const moduleEntryPoints = listEntryModules();
grunt.log.writeln(`Found ${Object.keys(moduleEntryPoints).length} modules.`);
grunt.config.set("webpack.web.entry",
Object.assign({
main: "./src/web/index.js"
}, moduleEntryPoints));
});
2016-12-14 17:39:17 +01:00
2016-11-28 11:42:58 +01:00
// Load tasks provided by each plugin
2016-12-14 17:39:17 +01:00
grunt.loadNpmTasks("grunt-eslint");
2017-03-27 17:08:36 +02:00
grunt.loadNpmTasks("grunt-webpack");
2016-11-28 11:42:58 +01:00
grunt.loadNpmTasks("grunt-contrib-clean");
grunt.loadNpmTasks("grunt-contrib-copy");
grunt.loadNpmTasks("grunt-contrib-watch");
2016-11-28 11:42:58 +01:00
grunt.loadNpmTasks("grunt-chmod");
grunt.loadNpmTasks("grunt-exec");
grunt.loadNpmTasks("grunt-concurrent");
grunt.loadNpmTasks("grunt-contrib-connect");
grunt.loadNpmTasks("grunt-zip");
2016-12-14 17:39:17 +01:00
2017-03-27 17:08:36 +02:00
// Project configuration
const compileYear = grunt.template.today("UTC:yyyy"),
compileTime = grunt.template.today("UTC:dd/mm/yyyy HH:MM:ss") + " UTC",
2017-07-04 00:15:57 +02:00
pkg = grunt.file.readJSON("package.json"),
webpackConfig = require("./webpack.config.js"),
BUILD_CONSTANTS = {
COMPILE_YEAR: JSON.stringify(compileYear),
2017-07-04 00:15:57 +02:00
COMPILE_TIME: JSON.stringify(compileTime),
COMPILE_MSG: JSON.stringify(grunt.option("compile-msg") || grunt.option("msg") || ""),
PKG_VERSION: JSON.stringify(pkg.version),
2017-08-09 21:09:23 +02:00
},
2019-08-02 12:10:15 +02:00
moduleEntryPoints = listEntryModules(),
nodeConsumerTestPath = "~/tmp-cyberchef",
/**
* Configuration for Webpack production build. Defined as a function so that it
* can be recalculated when new modules are generated.
*/
webpackProdConf = () => {
return {
mode: "production",
target: "web",
entry: Object.assign({
main: "./src/web/index.js"
}, moduleEntryPoints),
output: {
path: __dirname + "/build/prod",
filename: chunkData => {
return chunkData.chunk.name === "main" ? "assets/[name].js": "[name].js";
},
globalObject: "this"
},
resolve: {
alias: {
"./config/modules/OpModules.mjs": "./config/modules/Default.mjs"
}
},
plugins: [
new webpack.DefinePlugin(BUILD_CONSTANTS),
new HtmlWebpackPlugin({
filename: "index.html",
template: "./src/web/html/index.html",
chunks: ["main"],
compileYear: compileYear,
compileTime: compileTime,
version: pkg.version,
minify: {
removeComments: true,
collapseWhitespace: true,
minifyJS: true,
minifyCSS: true
}
}),
new BundleAnalyzerPlugin({
analyzerMode: "static",
reportFilename: "BundleAnalyzerReport.html",
openAnalyzer: false
}),
]
};
};
2016-11-28 11:42:58 +01:00
2016-12-14 17:39:17 +01:00
2017-08-09 21:09:23 +02:00
/**
* Generates an entry list for all the modules.
*/
function listEntryModules() {
const entryModules = {};
2017-08-09 21:09:23 +02:00
2018-03-27 00:14:23 +02:00
glob.sync("./src/core/config/modules/*.mjs").forEach(file => {
const basename = path.basename(file);
if (basename !== "Default.mjs" && basename !== "OpModules.mjs")
entryModules["modules/" + basename.split(".mjs")[0]] = path.resolve(file);
2017-08-09 21:09:23 +02:00
});
return entryModules;
}
/**
* Detects the correct delimiter to use to chain shell commands together
* based on the current OS.
*
* @param {string[]} cmds
* @returns {string}
*/
function chainCommands(cmds) {
const win = process.platform === "win32";
if (!win) {
return cmds.join(";");
}
return cmds
// && means that subsequent commands will not be executed if the
// previous one fails. & would coninue on a fail
.join("&&")
// Windows does not support \n properly
.replace(/\n/g, "\\n");
}
2016-11-28 11:42:58 +01:00
grunt.initConfig({
2017-03-27 17:08:36 +02:00
clean: {
dev: ["build/dev/*"],
2018-03-27 00:14:23 +02:00
prod: ["build/prod/*"],
node: ["build/node/*"],
2019-07-09 15:31:18 +02:00
config: ["src/core/config/OperationConfig.json", "src/core/config/modules/*", "src/code/operations/index.mjs"],
nodeConfig: ["src/node/index.mjs", "src/node/config/OperationConfig.json"],
standalone: ["build/prod/CyberChef*.html"]
2017-03-27 17:08:36 +02:00
},
2016-12-14 17:39:17 +01:00
eslint: {
configs: ["*.{js,mjs}"],
2018-04-11 19:29:02 +02:00
core: ["src/core/**/*.{js,mjs}", "!src/core/vendor/**/*", "!src/core/operations/legacy/**/*"],
2019-03-28 00:02:10 +01:00
web: ["src/web/**/*.{js,mjs}", "!src/web/static/**/*"],
2018-03-27 00:14:23 +02:00
node: ["src/node/**/*.{js,mjs}"],
2018-12-28 22:49:40 +01:00
tests: ["tests/**/*.{js,mjs}"],
2016-11-28 11:42:58 +01:00
},
webpack: {
2023-07-14 19:53:56 +02:00
options: webpackConfig,
2023-07-14 19:37:02 +02:00
myConfig: webpackConfig,
web: webpackProdConf(),
},
2017-07-04 00:15:57 +02:00
"webpack-dev-server": {
2022-03-28 16:42:11 +02:00
options: webpackConfig,
2017-07-04 00:15:57 +02:00
start: {
2022-03-28 16:42:11 +02:00
mode: "development",
target: "web",
entry: Object.assign({
main: "./src/web/index.js"
}, moduleEntryPoints),
resolve: {
alias: {
"./config/modules/OpModules.mjs": "./config/modules/Default.mjs"
}
},
devServer: {
port: grunt.option("port") || 8080,
client: {
logging: "error",
overlay: true
2022-05-30 19:06:15 +02:00
},
hot: "only"
2022-03-28 16:42:11 +02:00
},
plugins: [
new webpack.DefinePlugin(BUILD_CONSTANTS),
new HtmlWebpackPlugin({
filename: "index.html",
template: "./src/web/html/index.html",
chunks: ["main"],
compileYear: compileYear,
2022-03-28 16:42:11 +02:00
compileTime: compileTime,
version: pkg.version,
})
]
2017-07-04 00:15:57 +02:00
}
},
zip: {
standalone: {
cwd: "build/prod/",
src: [
"build/prod/**/*",
"!build/prod/index.html",
"!build/prod/BundleAnalyzerReport.html",
],
dest: `build/prod/CyberChef_v${pkg.version}.zip`
}
},
connect: {
prod: {
options: {
2020-01-27 19:55:50 +01:00
port: grunt.option("port") || 8000,
base: "build/prod/"
}
}
},
2016-11-28 11:42:58 +01:00
copy: {
ghPages: {
options: {
2017-09-13 17:21:31 +02:00
process: function (content, srcpath) {
if (srcpath.indexOf("index.html") >= 0) {
// Add Google Analytics code to index.html
2017-09-13 17:21:31 +02:00
content = content.replace("</body></html>",
grunt.file.read("src/web/static/ga.html") + "</body></html>");
// Add Structured Data for SEO
content = content.replace("</head>",
"<script type='application/ld+json'>" +
2019-04-14 22:55:52 +02:00
JSON.stringify(JSON.parse(grunt.file.read("src/web/static/structuredData.json"))) +
"</script></head>");
2017-09-13 17:21:31 +02:00
return grunt.template.process(content, srcpath);
} else {
return content;
}
},
noProcess: ["**", "!**/*.html"]
},
2017-09-13 17:21:31 +02:00
files: [
{
2020-12-11 17:24:39 +01:00
src: ["build/prod/index.html"],
2017-09-13 17:21:31 +02:00
dest: "build/prod/index.html"
2019-08-28 19:48:31 +02:00
}
2017-09-13 17:21:31 +02:00
]
},
standalone: {
options: {
process: function (content, srcpath) {
if (srcpath.indexOf("index.html") >= 0) {
// Replace download link with version number
content = content.replace(/<a [^>]+>Download CyberChef.+?<\/a>/,
`<span>Version ${pkg.version}</span>`);
return grunt.template.process(content, srcpath);
} else {
return content;
}
},
noProcess: ["**", "!**/*.html"]
},
files: [
{
2020-12-11 17:24:39 +01:00
src: ["build/prod/index.html"],
dest: `build/prod/CyberChef_v${pkg.version}.html`
}
]
2016-11-28 11:42:58 +01:00
}
},
chmod: {
build: {
options: {
mode: "755",
},
2017-03-27 17:08:36 +02:00
src: ["build/**/*", "build/"]
2016-11-28 11:42:58 +01:00
}
},
watch: {
config: {
files: ["src/core/operations/**/*", "!src/core/operations/index.mjs"],
tasks: ["exec:generateNodeIndex", "exec:generateConfig"]
}
},
concurrent: {
dev: ["watch:config", "webpack-dev-server:start"],
options: {
logConcurrentOutput: true
}
},
2016-11-28 11:42:58 +01:00
exec: {
2023-03-21 16:39:31 +01:00
calcDownloadHash: {
command: function () {
switch (process.platform) {
case "darwin":
return chainCommands([
`shasum -a 256 build/prod/CyberChef_v${pkg.version}.zip | awk '{print $1;}' > build/prod/sha256digest.txt`,
`sed -i '' -e "s/DOWNLOAD_HASH_PLACEHOLDER/$(cat build/prod/sha256digest.txt)/" build/prod/index.html`
]);
default:
return chainCommands([
`sha256sum build/prod/CyberChef_v${pkg.version}.zip | awk '{print $1;}' > build/prod/sha256digest.txt`,
`sed -i -e "s/DOWNLOAD_HASH_PLACEHOLDER/$(cat build/prod/sha256digest.txt)/" build/prod/index.html`
]);
}
},
},
repoSize: {
command: chainCommands([
2016-12-14 17:39:17 +01:00
"git ls-files | wc -l | xargs printf '\n%b\ttracked files\n'",
"du -hs | egrep -o '^[^\t]*' | xargs printf '%b\trepository size\n'"
]),
2016-11-28 11:42:58 +01:00
stderr: false
},
cleanGit: {
2016-11-28 11:42:58 +01:00
command: "git gc --prune=now --aggressive"
},
sitemap: {
2022-01-31 12:39:17 +01:00
command: `node ${nodeFlags} src/web/static/sitemap.mjs > build/prod/sitemap.xml`,
sync: true
2018-03-27 00:14:23 +02:00
},
generateConfig: {
command: chainCommands([
"echo '\n--- Regenerating config files. ---'",
"echo [] > src/core/config/OperationConfig.json",
2022-01-31 12:39:17 +01:00
`node ${nodeFlags} src/core/config/scripts/generateOpsIndex.mjs`,
`node ${nodeFlags} src/core/config/scripts/generateConfig.mjs`,
"echo '--- Config scripts finished. ---\n'"
]),
sync: true
},
generateNodeIndex: {
command: chainCommands([
"echo '\n--- Regenerating node index ---'",
2022-01-31 12:39:17 +01:00
`node ${nodeFlags} src/node/config/scripts/generateNodeIndex.mjs`,
2018-06-19 09:53:29 +02:00
"echo '--- Node index generated. ---\n'"
]),
sync: true
},
browserTests: {
command: "./node_modules/.bin/nightwatch --env prod"
},
2019-08-02 12:10:15 +02:00
setupNodeConsumers: {
command: chainCommands([
2019-10-16 16:38:20 +02:00
"echo '\n--- Testing node consumers ---'",
2019-08-02 12:10:15 +02:00
"npm link",
`mkdir ${nodeConsumerTestPath}`,
`cp tests/node/consumers/* ${nodeConsumerTestPath}`,
`cd ${nodeConsumerTestPath}`,
"npm link cyberchef"
]),
sync: true
2019-08-02 12:10:15 +02:00
},
teardownNodeConsumers: {
command: chainCommands([
2019-08-02 12:10:15 +02:00
`rm -rf ${nodeConsumerTestPath}`,
"echo '\n--- Node consumer tests complete ---'"
]),
2019-08-02 12:10:15 +02:00
},
testCJSNodeConsumer: {
command: chainCommands([
2019-08-02 12:10:15 +02:00
`cd ${nodeConsumerTestPath}`,
2022-01-31 12:39:17 +01:00
`node ${nodeFlags} cjs-consumer.js`,
]),
2019-08-02 12:10:15 +02:00
stdout: false,
},
testESMNodeConsumer: {
command: chainCommands([
2019-08-02 12:10:15 +02:00
`cd ${nodeConsumerTestPath}`,
2022-01-31 12:39:17 +01:00
`node ${nodeFlags} esm-consumer.mjs`,
]),
2019-08-02 12:10:15 +02:00
stdout: false,
},
fixCryptoApiImports: {
command: function () {
switch (process.platform) {
case "darwin":
return `find ./node_modules/crypto-api/src/ \\( -type d -name .git -prune \\) -o -type f -print0 | xargs -0 sed -i '' -e '/\\.mjs/!s/\\(from "\\.[^"]*\\)";/\\1.mjs";/g'`;
default:
return `find ./node_modules/crypto-api/src/ \\( -type d -name .git -prune \\) -o -type f -print0 | xargs -0 sed -i -e '/\\.mjs/!s/\\(from "\\.[^"]*\\)";/\\1.mjs";/g'`;
}
},
stdout: false
2022-12-09 21:46:01 +01:00
},
fixSnackbarMarkup: {
command: function () {
switch (process.platform) {
case "darwin":
return `sed -i '' 's/<div id=snackbar-container\\/>/<div id=snackbar-container>/g' ./node_modules/snackbarjs/src/snackbar.js`;
default:
return `sed -i 's/<div id=snackbar-container\\/>/<div id=snackbar-container>/g' ./node_modules/snackbarjs/src/snackbar.js`;
}
},
2022-12-09 21:46:01 +01:00
stdout: false
}
},
2016-11-28 11:42:58 +01:00
});
};