diff --git a/src/core/config/Categories.json b/src/core/config/Categories.json index b87d0ddb..faedaed0 100755 --- a/src/core/config/Categories.json +++ b/src/core/config/Categories.json @@ -54,7 +54,7 @@ "From MessagePack", "To Braille", "From Braille", - "From Length Value" + "LV Decode" ] }, { diff --git a/src/core/operations/LengthValueDecoder.mjs b/src/core/operations/LVDecode.mjs similarity index 58% rename from src/core/operations/LengthValueDecoder.mjs rename to src/core/operations/LVDecode.mjs index a46333f7..63af65f6 100644 --- a/src/core/operations/LengthValueDecoder.mjs +++ b/src/core/operations/LVDecode.mjs @@ -8,61 +8,40 @@ import Operation from "../Operation"; import LengthValue from "../lib/LengthValue"; /** - * From Length Value operation + * From LV Decode operation */ -class FromLengthValue extends Operation { +class LVDecode extends Operation { /** - * FromLengthValue constructor + * LVDecode constructor */ constructor() { super(); - this.name = "From Length Value"; + this.name = "LV Decode"; this.module = "Default"; this.description = "Converts a Length-Value (LV) encoded string into a JSON object. Can optionally include a Key / Type entry."; - this.infoURL = ""; + this.infoURL = "https://wikipedia.org/wiki/KLV"; this.inputType = "byteArray"; this.outputType = "JSON"; this.args = [ { name: "Bytes in Key Value", - type: "populateOption", + type: "option", value: [ - { - name: "0 Bytes (No Key)", - value: "0" - }, - { - name: "1 Byte", - value: "1" - }, - { - name: "2 Bytes", - value: "2" - }, - { - name: "4 Bytes", - value: "4" - } + "0 Bytes (No Key)", + "1 Byte", + "2 Bytes", + "4 Bytes" ] }, { name: "Bytes in Length Value", - type: "populateOption", + type: "option", value: [ - { - name: "1 Byte", - value: "1" - }, - { - name: "2 Bytes", - value: "2" - }, - { - name: "4 Bytes", - value: "4" - } + "1 Byte", + "2 Bytes", + "4 Bytes" ] }, { @@ -99,4 +78,4 @@ class FromLengthValue extends Operation { } -export default FromLengthValue; +export default LVDecode; diff --git a/test/index.mjs b/test/index.mjs index ee0aa3b2..06b2b181 100644 --- a/test/index.mjs +++ b/test/index.mjs @@ -64,7 +64,7 @@ import "./tests/operations/SetUnion"; import "./tests/operations/SymmetricDifference"; import "./tests/operations/TranslateDateTimeFormat"; import "./tests/operations/Magic"; -import "./tests/operations/LengthValueDecoder"; +import "./tests/operations/LVDecode"; let allTestsPassing = true; const testStatusCounts = { diff --git a/test/tests/operations/LVDecode.mjs b/test/tests/operations/LVDecode.mjs new file mode 100644 index 00000000..4fd7fc83 --- /dev/null +++ b/test/tests/operations/LVDecode.mjs @@ -0,0 +1,56 @@ +/** + * LV Decoder tests. + * + * @author gchq77703 [] + * @copyright Crown Copyright 2018 + * @license Apache-2.0 + */ + +import TestRegister from "../../TestRegister"; + +TestRegister.addTests([ + { + name: "LVDecode: LengthValue", + input: "\x05\x48\x6f\x75\x73\x65\x04\x72\x6f\x6f\x6d\x04\x64\x6f\x6f\x72", + expectedOutput: JSON.stringify([{"length": 5, "value": [72, 111, 117, 115, 101]}, {"length": 4, "value": [114, 111, 111, 109]}, {"length": 4, "value": [100, 111, 111, 114]}]), + recipeConfig: [ + { + "op": "LV Decode", + "args": ["0 Bytes (No Key)", "1 Byte", false] + } + ] + }, + { + name: "LVDecode: LengthValue with BER", + input: "\x05\x48\x6f\x75\x73\x65\x04\x72\x6f\x6f\x6d\x04\x64\x6f\x6f\x72", + expectedOutput: JSON.stringify([{"length": 5, "value": [72, 111, 117, 115, 101]}, {"length": 4, "value": [114, 111, 111, 109]}, {"length": 4, "value": [100, 111, 111, 114]}]), + recipeConfig: [ + { + "op": "LV Decode", + "args": ["0 Bytes (No Key)", "4 Bytes", false] // length value is patently wrong, should be ignored by BER. + } + ] + }, + { + name: "LVDecode: KeyLengthValue", + input: "\x04\x05\x48\x6f\x75\x73\x65\x05\x04\x72\x6f\x6f\x6d\x42\x04\x64\x6f\x6f\x72", + expectedOutput: JSON.stringify([{"key":[4],"length":5,"value":[72,111,117,115,101]},{"key":[5],"length":4,"value":[114,111,111,109]},{"key":[66],"length":4,"value":[100,111,111,114]}]), + recipeConfig: [ + { + "op": "LV Decode", + "args": ["1 Byte", "1 Byte", false] + } + ] + }, + { + name: "LVDecode: KeyLengthValue with BER", + input: "\x04\x05\x48\x6f\x75\x73\x65\x05\x04\x72\x6f\x6f\x6d\x42\x04\x64\x6f\x6f\x72", + expectedOutput: JSON.stringify([{"key":[4],"length":5,"value":[72,111,117,115,101]},{"key":[5],"length":4,"value":[114,111,111,109]},{"key":[66],"length":4,"value":[100,111,111,114]}]), + recipeConfig: [ + { + "op": "LV Decode", + "args": ["1 Byte", "4 Byte", true] // length value is patently wrong, should be ignored by BER. + } + ] + } +]); diff --git a/test/tests/operations/LengthValueDecoder.mjs b/test/tests/operations/LengthValueDecoder.mjs deleted file mode 100644 index 90923c23..00000000 --- a/test/tests/operations/LengthValueDecoder.mjs +++ /dev/null @@ -1,23 +0,0 @@ -/** - * Length Value Decoder tests. - * - * @author gchq77703 [] - * @copyright Crown Copyright 2018 - * @license Apache-2.0 - */ - -import TestRegister from "../../TestRegister"; - -TestRegister.addTests([ - { - name: "KeyValue", - input: [5, 72, 111, 117, 115, 101, 4, 114, 111, 111, 109, 4, 100, 111, 111, 114], - expectedOutput: [{"key": [25], "length": 5, "value": [72, 111, 117, 115, 101]}, {"key": [73], "length": 4, "value": [114, 111, 111, 109]}, {"key": [41], "length": 4, "value": [100, 111, 111, 114]}], - recipeConfig: [ - { - "op": "Length Value Decoder", - "args": ["0 Bytes (No Key)", "1 Byte", false] - } - ] - }, -]);