New operation improvements

package.json

@@ -116,6 +116,7 @@
     "flat": "^5.0.2",
     "geodesy": "1.1.3",
     "highlight.js": "^11.5.1",
+    "iniparser": "^1.0.5",
     "jimp": "^0.16.1",
     "jquery": "3.6.0",
     "js-crc": "^0.2.0",

src/core/config/scripts/generateOpsIndex.mjs

@@ -58,3 +58,64 @@ fs.writeFileSync(
     code
 );
 console.log("Written operation index.");
+
+// find all test files
+const testsDir = path.join(process.cwd() + "/tests/operations/tests/");
+const testObjs = [];
+fs.readdirSync(testsDir).forEach(file => {
+    if (!file.endsWith(".mjs")) return;
+    testObjs.push(file.split(".mjs")[0]);
+});
+
+// Construct test index file
+code = `/**
+* THIS FILE IS AUTOMATICALLY GENERATED BY src/core/config/scripts/generateOpsIndex.mjs
+*
+* @author john [[email protected]]
+* @author tlwr [[email protected]]
+* @author n1474335 [[email protected]]
+* @copyright Crown Copyright ${new Date().getUTCFullYear()}
+* @license Apache-2.0
+*/
+
+import {
+    setLongTestFailure,
+    logTestReport,
+} from "../lib/utils.mjs";
+
+import TestRegister from "../lib/TestRegister.mjs";
+`;
+
+testObjs.forEach(obj => {
+    code += `import "./tests/${obj}.mjs";\n`;
+});
+
+code += `
+// Cannot test operations that use the File type yet
+// import "./tests/SplitColourChannels.mjs";
+
+const testStatus = {
+    allTestsPassing: true,
+    counts: {
+        total: 0,
+    }
+};
+
+setLongTestFailure();
+
+const logOpsTestReport = logTestReport.bind(null, testStatus);
+
+(async function() {
+    const results = await TestRegister.runTests();
+    logOpsTestReport(results);
+})();
+`;
+
+// Write tests file
+fs.writeFileSync(
+    path.join(testsDir, "../index.mjs"),
+    code
+);
+console.log("Written operation tests index.");
+
+

src/core/config/scripts/newOperation.mjs

@@ -14,6 +14,7 @@ import process from "process";
 import fs from "fs";
 import path from "path";
 import EscapeString from "../../operations/EscapeString.mjs";
+import iniparser from "iniparser";
 
 
 const dir = path.join(process.cwd() + "/src/core/operations/");
@@ -23,6 +24,23 @@ if (!fs.existsSync(dir)) {
     console.log("Example> node --experimental-modules src/core/config/scripts/newOperation.mjs");
     process.exit(1);
 }
+const testDir = path.join(process.cwd() + "/tests/operations/tests/");
+
+const configFile = "/.gitconfig";
+let gitUserEmail, gitUserName;
+// gitconfig in root is better than global one
+let gitConfig = process.cwd() + configFile;
+if (!fs.existsSync()) {
+    gitConfig = process.env.HOME +  configFile;
+}
+// get user settings from git
+if (fs.existsSync(gitConfig)) {
+    const config = iniparser.parseSync(gitConfig);
+    if ("user" in config) {
+        if ("email" in config.user) gitUserEmail = config.user.email;
+        if ("name" in config.user) gitUserName = config.user.name; 
+    }
+}
 
 const ioTypes = ["string", "byteArray", "number", "html", "ArrayBuffer", "BigNumber", "JSON", "File", "List<File>"];
 
@@ -88,12 +106,14 @@ If your operation does not rely on a library, just leave this blank and it will
         authorName: {
             description: "Your name or username will be added to the @author tag for this operation.",
             example: "n1474335",
+            default: gitUserName,
             prompt: "Username",
             type: "string"
         },
         authorEmail: {
             description: "Your email address will also be added to the @author tag for this operation.",
             example: "[email protected]",
+            default: gitUserEmail,
             prompt: "Email",
             type: "string"
         }
@@ -123,6 +143,30 @@ prompt.get(schema, (err, result) => {
         return txt.charAt(0).toUpperCase() + txt.substr(1);
     }).replace(/[\s-()./]/g, "");
 
+    const testTemplate = `/**
+* ${moduleName} tests
+*    
+* @author ${result.authorName} [${result.authorEmail}]
+* @copyright Crown Copyright ${(new Date()).getFullYear()}
+* @license Apache-2.0
+*/
+
+import TestRegister from "../../lib/TestRegister.mjs";
+
+TestRegister.addTests([
+    {
+        name: " ${moduleName}: test",
+        input: "Example input",
+        expectedOutput: "Expected output",
+        recipeConfig: [
+            {
+                op: " ${moduleName}",
+                args: [],
+            },
+        ],
+    },
+]);
+`;
 
     const template = `/**
  * @author ${result.authorName} [${result.authorEmail}]
@@ -218,13 +262,18 @@ export default ${moduleName};
     }
     fs.writeFileSync(filename, template);
 
+    const testFilename = path.join(testDir, `./${moduleName}.mjs`);
+    fs.writeFileSync(testFilename, testTemplate);
+
     console.log(`\nOperation template written to ${colors.green(filename)}`);
+    console.log(`\nOperation test template written to ${colors.green(testFilename)}`);
     console.log(`\nNext steps:
 1. Add your operation to ${colors.green("src/core/config/Categories.json")}
-2. Write your operation code.
-3. Write tests in ${colors.green("tests/operations/tests/")}
-4. Run ${colors.cyan("npm run lint")} and ${colors.cyan("npm run test")}
-5. Submit a Pull Request to get your operation added to the official CyberChef repository.`);
+2. Write your operation code in ${colors.green(filename)}
+3. Add your operation to ${colors.green("tests/operations/index.mjs")}
+4. Write your operation test code in ${colors.green(testFilename)}
+5. Write tests in ${colors.green("tests/operations/tests/")}
+6. Run ${colors.cyan("npm run lint")} and ${colors.cyan("npm run test")}
+7. Submit a Pull Request to get your operation aldded to the official CyberChef repository.`);
 
 });
-

tests/operations/index.mjs

@@ -1,127 +1,126 @@
-/* eslint no-console: 0 */
-
 /**
- * Test Runner
- *
- * For running the tests in the test register.
- *
- * @author tlwr [[email protected]]
- * @author n1474335 [[email protected]]
- * @copyright Crown Copyright 2017
- * @license Apache-2.0
- */
+* THIS FILE IS AUTOMATICALLY GENERATED BY src/core/config/scripts/generateOpsIndex.mjs
+*
+* @author john [[email protected]]
+* @author tlwr [[email protected]]
+* @author n1474335 [[email protected]]
+* @copyright Crown Copyright 2022
+* @license Apache-2.0
+*/
 
 import {
     setLongTestFailure,
     logTestReport,
 } from "../lib/utils.mjs";
 
 import TestRegister from "../lib/TestRegister.mjs";
+import "./tests/AvroToJSON.mjs";
 import "./tests/BCD.mjs";
+import "./tests/BLAKE2b.mjs";
+import "./tests/BLAKE2s.mjs";
 import "./tests/BSON.mjs";
 import "./tests/BaconCipher.mjs";
 import "./tests/Base45.mjs";
 import "./tests/Base58.mjs";
-import "./tests/Base64.mjs";
 import "./tests/Base62.mjs";
+import "./tests/Base64.mjs";
 import "./tests/Base85.mjs";
 import "./tests/BitwiseOp.mjs";
+import "./tests/Bombe.mjs";
 import "./tests/ByteRepr.mjs";
+import "./tests/CBORDecode.mjs";
+import "./tests/CBOREncode.mjs";
+import "./tests/CSV.mjs";
+import "./tests/CaesarBoxCipher.mjs";
 import "./tests/CartesianProduct.mjs";
-import "./tests/CetaceanCipherEncode.mjs";
 import "./tests/CetaceanCipherDecode.mjs";
-import "./tests/CharEnc.mjs";
+import "./tests/CetaceanCipherEncode.mjs";
 import "./tests/ChangeIPFormat.mjs";
+import "./tests/CharEnc.mjs";
 import "./tests/Charts.mjs";
 import "./tests/Checksum.mjs";
+import "./tests/CipherSaber2.mjs";
 import "./tests/Ciphers.mjs";
 import "./tests/Code.mjs";
+import "./tests/Colossus.mjs";
 import "./tests/Comment.mjs";
 import "./tests/Compress.mjs";
 import "./tests/ConditionalJump.mjs";
+import "./tests/ConvertCoordinateFormat.mjs";
+import "./tests/ConvertToNATOAlphabet.mjs";
 import "./tests/Crypt.mjs";
-import "./tests/CSV.mjs";
 import "./tests/DateTime.mjs";
+import "./tests/DefangIP.mjs";
+import "./tests/ELFInfo.mjs";
+import "./tests/Enigma.mjs";
 import "./tests/ExtractEmailAddresses.mjs";
 import "./tests/Fork.mjs";
 import "./tests/FromDecimal.mjs";
-import "./tests/Gzip.mjs";
+import "./tests/FromGeohash.mjs";
+import "./tests/GetAllCasings.mjs";
 import "./tests/Gunzip.mjs";
+import "./tests/Gzip.mjs";
+import "./tests/HASSH.mjs";
 import "./tests/Hash.mjs";
 import "./tests/HaversineDistance.mjs";
 import "./tests/Hex.mjs";
 import "./tests/Hexdump.mjs";
 import "./tests/Image.mjs";
 import "./tests/IndexOfCoincidence.mjs";
-import "./tests/Jump.mjs";
+import "./tests/JA3Fingerprint.mjs";
+import "./tests/JA3SFingerprint.mjs";
 import "./tests/JSONBeautify.mjs";
 import "./tests/JSONMinify.mjs";
 import "./tests/JSONtoCSV.mjs";
 import "./tests/JWTDecode.mjs";
 import "./tests/JWTSign.mjs";
 import "./tests/JWTVerify.mjs";
+import "./tests/Jump.mjs";
+import "./tests/LS47.mjs";
+import "./tests/LZString.mjs";
+import "./tests/Lorenz.mjs";
+import "./tests/LuhnChecksum.mjs";
 import "./tests/MS.mjs";
 import "./tests/Magic.mjs";
+import "./tests/Media.mjs";
 import "./tests/MorseCode.mjs";
+import "./tests/MultipleBombe.mjs";
 import "./tests/NetBIOS.mjs";
 import "./tests/NormaliseUnicode.mjs";
 import "./tests/OTP.mjs";
+import "./tests/PEMtoHex.mjs";
 import "./tests/PGP.mjs";
 import "./tests/PHP.mjs";
 import "./tests/ParseIPRange.mjs";
+import "./tests/ParseObjectIDTimestamp.mjs";
 import "./tests/ParseQRCode.mjs";
-import "./tests/PEMtoHex.mjs";
+import "./tests/ParseSSHHostKey.mjs";
+import "./tests/ParseTCP.mjs";
+import "./tests/ParseTLV.mjs";
+import "./tests/ParseUDP.mjs";
 import "./tests/PowerSet.mjs";
+import "./tests/Protobuf.mjs";
+import "./tests/RSA.mjs";
 import "./tests/Regex.mjs";
 import "./tests/Register.mjs";
 import "./tests/Rotate.mjs";
+import "./tests/SIGABA.mjs";
+import "./tests/SM4.mjs";
 import "./tests/SeqUtils.mjs";
 import "./tests/SetDifference.mjs";
 import "./tests/SetIntersection.mjs";
 import "./tests/SetUnion.mjs";
-import "./tests/SM4.mjs";
+import "./tests/SplitColourChannels.mjs";
 import "./tests/StrUtils.mjs";
+import "./tests/Subsection.mjs";
 import "./tests/SymmetricDifference.mjs";
 import "./tests/TextEncodingBruteForce.mjs";
-import "./tests/TranslateDateTimeFormat.mjs";
-import "./tests/Magic.mjs";
-import "./tests/ParseTLV.mjs";
-import "./tests/Media.mjs";
 import "./tests/ToFromInsensitiveRegex.mjs";
-import "./tests/YARA.mjs";
-import "./tests/ConvertCoordinateFormat.mjs";
-import "./tests/Enigma.mjs";
-import "./tests/Bombe.mjs";
-import "./tests/MultipleBombe.mjs";
+import "./tests/ToGeohash.mjs";
+import "./tests/TranslateDateTimeFormat.mjs";
 import "./tests/Typex.mjs";
-import "./tests/BLAKE2b.mjs";
-import "./tests/BLAKE2s.mjs";
-import "./tests/Protobuf.mjs";
-import "./tests/ParseSSHHostKey.mjs";
-import "./tests/DefangIP.mjs";
-import "./tests/ParseUDP.mjs";
-import "./tests/ParseTCP.mjs";
-import "./tests/AvroToJSON.mjs";
-import "./tests/Lorenz.mjs";
-import "./tests/LuhnChecksum.mjs";
-import "./tests/CipherSaber2.mjs";
-import "./tests/Colossus.mjs";
-import "./tests/ParseObjectIDTimestamp.mjs";
 import "./tests/Unicode.mjs";
-import "./tests/RSA.mjs";
-import "./tests/CBOREncode.mjs";
-import "./tests/CBORDecode.mjs";
-import "./tests/JA3Fingerprint.mjs";
-import "./tests/JA3SFingerprint.mjs";
-import "./tests/HASSH.mjs";
-import "./tests/GetAllCasings.mjs";
-import "./tests/SIGABA.mjs";
-import "./tests/ELFInfo.mjs";
-import "./tests/Subsection.mjs";
-import "./tests/CaesarBoxCipher.mjs";
-import "./tests/LS47.mjs";
-import "./tests/LZString.mjs";
-
+import "./tests/YARA.mjs";
 
 // Cannot test operations that use the File type yet
 // import "./tests/SplitColourChannels.mjs";