Seqgen use json instead of xml (#177)

* Swap xml with json for seqgen

* Add seqgen test cases

* Rename `diff_input_sequence` + Change Test Fail Format

* Add Spellcheck expect

* Make Test Independant of File Structure

.github/actions/spelling/expect.txt

@@ -89,6 +89,7 @@ cls
 CMake
 cmdhist
 cmds
+cmp
 CODEFILE
 Codemirror
 colorized
@@ -230,6 +231,7 @@ FFFF
 fieldset
 figcaption
 figsize
+filecmp
 filemode
 fileno
 filepath

src/fprime_gds/common/loaders/cmd_json_loader.py

@@ -12,7 +12,7 @@
 
 
 class CmdJsonLoader(JsonLoader):
-    """Class to load xml based command dictionaries"""
+    """Class to load json based command dictionaries"""
 
     COMMANDS_FIELD = "commands"
 

src/fprime_gds/common/loaders/event_json_loader.py

@@ -13,7 +13,7 @@
 
 
 class EventJsonLoader(JsonLoader):
-    """Class to load xml based event dictionaries"""
+    """Class to load json based event dictionaries"""
 
     EVENTS_FIELD = "events"
 

src/fprime_gds/common/tools/seqgen.py

@@ -22,7 +22,7 @@
 from fprime_gds.common.data_types import exceptions as gseExceptions
 from fprime_gds.common.data_types.cmd_data import CmdData, CommandArgumentsException
 from fprime_gds.common.encoders.seq_writer import SeqBinaryWriter
-from fprime_gds.common.loaders.cmd_xml_loader import CmdXmlLoader
+from fprime_gds.common.loaders.cmd_json_loader import CmdJsonLoader
 from fprime_gds.common.parsers.seq_file_parser import SeqFileParser
 
 __author__ = "Tim Canham"
@@ -56,9 +56,9 @@ def generateSequence(inputFile, outputFile, dictionary, timebase, cont=False):
         raise SeqGenException(msg)
 
     # Check the user environment:
-    cmd_xml_dict = CmdXmlLoader()
+    cmd_json_dict = CmdJsonLoader(dictionary)
     try:
-        (cmd_id_dict, cmd_name_dict, versions) = cmd_xml_dict.construct_dicts(
+        (cmd_id_dict, cmd_name_dict, versions) = cmd_json_dict.construct_dicts(
             dictionary
         )
     except gseExceptions.GseControllerUndefinedFileException:
@@ -153,7 +153,7 @@ def main():
         action="store",
         type=str,
         required=True,
-        help="Dictionary file name",
+        help="JSON Dictionary file name",
     )
     parser.add_argument(
         "-t",

test/fprime_gds/common/tools/input/simple_bad_sequence.seq

@@ -0,0 +1,9 @@
+;--------------------------------------------------------------------
+; Simple sequence file
+; Note: that anything after a ';' is a comment
+;--------------------------------------------------------------------
+
+
+R00:00:00 cmdDisp.CMD_NO_OP
+R00:00:00 cmdDisp.CMD_NO_OP_STRING "Awesome string!" ; And a nice comment too
+R00:00:00 cmdDisp.FRIENDLY_GREETING "Hello!"

test/fprime_gds/common/tools/input/simple_sequence.seq

@@ -0,0 +1,8 @@
+;--------------------------------------------------------------------
+; Simple sequence file
+; Note: that anything after a ';' is a comment
+;--------------------------------------------------------------------
+
+
+R00:00:00 cmdDisp.CMD_NO_OP
+R00:00:00 cmdDisp.CMD_NO_OP_STRING "Awesome string!" ; And a nice comment too

test/fprime_gds/common/tools/resources/simple_dictionary.json

@@ -0,0 +1,40 @@
+{
+    "metadata" : {
+        "deploymentName" : "test",
+        "projectVersion" : "0",
+        "frameworkVersion" : "0",
+        "libraryVersions" : [
+        ],
+        "dictionarySpecVersion" : "1.0.0"
+    },
+    "commands" : [
+        {
+            "name" : "cmdDisp.CMD_NO_OP_STRING",
+            "commandKind" : "async",
+            "opcode" : 4097,
+            "formalParams" : [
+                {
+                    "name" : "arg1",
+                    "type" : {
+                        "name" : "string",
+                        "kind" : "string",
+                        "size" : 40
+                    },
+                    "ref" : false,
+                    "annotation" : "The String command argument"
+                }
+            ],
+            "queueFullBehavior" : "assert",
+            "annotation" : "No-op string command"
+        },    
+        {
+            "name" : "cmdDisp.CMD_NO_OP",
+            "commandKind" : "async",
+            "opcode" : 4096,
+            "formalParams" : [
+            ],
+            "queueFullBehavior" : "assert",
+            "annotation" : "No-op command"
+        }
+    ]
+}

test/fprime_gds/common/tools/resources/simple_dictionary.xml

@@ -0,0 +1,12 @@
+<dictionary topology="test" framework_version="0" project_version="0">
+    <commands>
+        <command component="cmdDisp" mnemonic="CMD_NO_OP" opcode="0x1000" description="No-op command">
+            <args/>
+        </command>
+        <command component="cmdDisp" mnemonic="CMD_NO_OP_STRING" opcode="0x1001" description="No-op string command">
+            <args>
+                <arg name="arg1" description="&#10;          The String command argument&#10;          " len="40" type="string"/>
+            </args>
+        </command>
+    </commands>
+</dictionary>

test/fprime_gds/common/tools/seqgen_unit_test.py

@@ -1,7 +1,42 @@
+import filecmp
+from pathlib import Path
+import tempfile
 import unittest
 
+import fprime_gds.common.tools.seqgen as seqgen
 
 class APITestCases(unittest.TestCase):
     def test_nominal_sequence(self):
-
-        pass
+        self.assertEqual(self.check_sequence_generates_expected_binary(
+            Path(__file__).parent / "input" / "simple_sequence.seq",
+            Path(__file__).parent / "expected" / "simple_expected.bin",
+            Path(__file__).parent / "resources" / "simple_dictionary.json"
+        ), True)
+
+    def test_fail_unmatched_command_sequence(self):
+        with self.assertRaisesRegex(seqgen.SeqGenException, "does not match any command in the command dictionary."):
+            self.check_sequence_generates_expected_binary(
+                Path(__file__).parent / "input" / "simple_bad_sequence.seq",
+                Path(__file__).parent / "expected" / "simple_expected.bin",
+                Path(__file__).parent / "resources" / "simple_dictionary.json"
+            )
+
+    def check_sequence_generates_expected_binary(self, 
+                                                 input_sequence, 
+                                                 expected_binary, 
+                                                 dictionary):
+        temp_dir = tempfile.TemporaryDirectory()
+        output_bin = Path(f"{temp_dir.name}/out_binary")
+        seqgen.generateSequence(
+            input_sequence,
+            output_bin,
+            dictionary,
+            0xffff
+        )
+        is_equal = filecmp.cmp(output_bin, expected_binary)
+        temp_dir.cleanup()
+        return is_equal
+
+
+if __name__ == "__main__":
+    unittest.main()