fprime-gds 3.5.2a1__tar.gz → 3.5.2a2__tar.gz

fprime_gds-3.5.2a2/.github/actions/spelling/expect.txt

@@ -0,0 +1,379 @@
+abeautifulsite
+AClass
+addoption
+ADEBAD
+adrianheine
+allbox
+ALLEXTERNALS
+ALOG
+amsmath
+ANamespace
+Anps
+argcomplete
+argdesc
+argname
+argtype
+autoapi
+AUTOBRIEF
+autocoded
+autogen
+autoraise
+autosectionlabel
+backface
+batchmode
+baudrate
+bcolors
+BGR
+Biberstein
+bibtex
+bitmaps
+breadcrumb
+Btns
+BUGLIST
+calibri
+callergraph
+callgraph
+cata
+CCB
+CCFF
+Cdioux
+cdn
+cdxoefg
+CFDG
+CFDP
+CFPD
+chartjs
+CHNG
+classdocs
+clearfix
+cls
+cmdhist
+CODEFILE
+COLORSTYLE
+colorwheel
+columnify
+combuffer
+commandsi
+configs
+Consolas
+creatingdocsetswithdoxygen
+csum
+curateable
+curated
+curating
+customise
+daringfireball
+dataobjects
+dblclick
+Dct
+ddl
+Ded
+deframe
+deframed
+deframer
+deframing
+DEPRECATEDLIST
+DESER
+Deserial
+deserializes
+dests
+dexc
+DGRAM
+diafile
+dimitri
+dinkel
+docbook
+docset
+dontinclude
+DOTFONTPATH
+downfiles
+downlinker
+dox
+doxyfile
+doxygenversion
+doxyindexer
+doxypypy
+doxyrules
+doxysearch
+Doxywizard
+doy
+dps
+dropleft
+dropright
+dropup
+Drv
+Dsh
+dts
+DVI
+ECLIPSEHELP
+ECONNRESET
+ect
+EEXIST
+Efg
+ENDC
+endcond
+errorhandler
+errorrs
+ev
+Evn
+evr
+evt
+extlinks
+exts
+fastentrypoints
+fbuild
+fd
+FEEDNAME
+FFCC
+FFFF
+fileurl
+Firefox
+focusring
+FONTNAME
+FONTPATH
+FONTSIZE
+fpp
+fprime
+fptable
+fsw
+gdiplus
+getbootstrap
+github
+grayscales
+gse
+gtags
+GUIS
+gz
+Haverbeke
+hh
+hhc
+hhk
+hhp
+hidecallergraph
+hidecallgraph
+hideinitializer
+hlp
+HLTH
+hookspecs
+hpaulson
+htags
+hyperlinks
+idct
+idl
+ieeetr
+ified
+ifun
+IH
+inprogress
+intersphinx
+intlimits
+ip
+ipc
+ipp
+itcl
+ixx
+janamian
+Jdk
+jpl
+JSO
+jsonable
+jsonified
+jsonify
+keepalive
+keyify
+kinda
+lestarch
+levelname
+Lezer
+libcrc
+libiconv
+Linting
+LIw
+logdata
+logdir
+logpath
+logselect
+luxon
+makeindex
+MAKEVAR
+marijnh
+matchobj
+mathjax
+mcternan
+MDFILE
+memb
+millis
+misordered
+MML
+moz
+msc
+mscfile
+mscgen
+mstarch
+mx
+mycompany
+nassert
+nbytes
+Neue
+Nify
+ninjaaron
+nitpicky
+noapp
+NOSONAR
+nosort
+nosubgrouping
+Noto
+NSPACES
+nuntil
+odl
+OKBLUE
+OKGREEN
+OMG
+OPREG
+oring
+osexc
+OSX
+outputfile
+packetized
+Paetz
+PARAMDOC
+passthrough
+pb
+pdflatex
+PERLMOD
+pkts
+plainnat
+plantuml
+PNGs
+preds
+prm
+procs
+PROGRAMLISTING
+projectbrief
+projectlogo
+projectname
+projectnumber
+propget
+propput
+px
+py
+qch
+qhelpgenerator
+QHG
+qhp
+qsf
+qthelpproject
+rackerlabs
+rackspace
+rae
+rb
+RCVHWM
+RCVTIMEO
+RDWR
+Readback
+recommonmark
+recuring
+recvd
+recvs
+reder
+removeit
+reqparse
+riverbankcomputing
+Roboto
+rollup
+rpaetz
+rst
+saba
+sdd
+searchdata
+Segoe
+seqfile
+seqgen
+serializables
+serialutil
+showinitializer
+sideeffect
+SIGALRM
+sizeb
+SMAP
+Smath
+SNDHWM
+sorttable
+squashify
+sss
+Ssymbols
+stackoverflow
+startuml
+subgrouping
+subhist
+subhistory
+superpackage
+superpkg
+tabetc
+tagfile
+tcanham
+tcp
+tcpserver
+td
+telem
+TESTLIST
+Theif
+thtcp
+thudp
+timebase
+timescales
+timespan
+timestep
+timestring
+timetype
+tinyseqgen
+TKC
+tlm
+toctree
+TODOLIST
+tooltiptext
+treeview
+tsn
+tstring
+ttl
+tts
+twbs
+typedef'ed
+typedef
+uart
+ucf
+udp
+UIs
+uk
+ul
+UNINIT
+updown
+upfiles
+uplinker
+uplinkvue
+usec
+useconds
+usepackage
+usr
+vh
+vhd
+vhdl
+viewcode
+vle
+vname
+VRuntime
+vw
+Watney
+webified
+webpage
+website
+wikipedia
+WSL
+wx
+xapian
+xhttp
+xl
+xmit
+xy
+zeromq
+zmq

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/.github/workflows/spelling.yml

@@ -21,24 +21,33 @@ jobs:
       actions: read
     outputs:
       followup: ${{ steps.spelling.outputs.followup }}
-    runs-on: ubuntu-20.04
-    if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
-    concurrency:
-      group: spelling-${{ github.event.pull_request.number || github.ref }}
-      # note: If you use only_check_changed_files, you do not want cancel-in-progress
-      cancel-in-progress: true
+    runs-on: ubuntu-24.04
+    if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}
     steps:
     - name: check-spelling
       id: spelling
-      uses: check-spelling/check-spelling@v0.0.20
+      uses: check-spelling/check-spelling@v0.0.24
       with:
         suppress_push_for_open_pull_request: 1
         checkout: true
         post_comment: 0
-        extra_dictionaries:
+        check_extra_dictionaries: ''
+        dictionary_source_prefixes: >
+          {
+          "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20241114/dictionaries/"
+          }
+        extra_dictionaries: |
           cspell:filetypes/filetypes.txt
           cspell:python/python.txt
+          cspell:python/python/python-lib.txt
+          cspell:python/python/python.txt
+          cspell:python/common/extra.txt
           cspell:django/django.txt
           cspell:html/html.txt
           cspell:fullstack/fullstack.txt
-        check_extra_dictionaries: ''
+          cspell:software-terms/softwareTerms.txt
+          cspell:cpp/stdlib-c.txt
+          cspell:cpp/stdlib-cpp.txt
+          cspell:mnemonics/mnemonics.txt
+          cspell:cpp/ecosystem.txt
+

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: fprime-gds
-Version: 3.5.2a1
+Version: 3.5.2a2
 Summary: F Prime Flight Software Ground Data System layer
 Author-email: Michael Starch <Michael.D.Starch@jpl.nasa.gov>, Thomas Boyer-Chammard <Thomas.Boyer.Chammard@jpl.nasa.gov>
 License: 

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/src/fprime_gds/common/data_types/cmd_data.py

@@ -131,9 +131,8 @@ class CmdData(sys_data.SysData):
         else:
             # The arguments are currently serializable objects which cannot be
             # used to fill in a format string. Convert them to values that can be
-            arg_val_list = [arg_obj.val for arg_obj in self.args]
-
-            arg_str = " ".join(str(arg_val_list))
+            arg_val_list = self.get_arg_vals()
+            arg_str = str(arg_val_list)
 
         if verbose and csv:
             return f"{time_str},{raw_time_str},{name},{self.id},{arg_str}"

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/src/fprime_gds/common/loaders/json_loader.py

@@ -178,7 +178,10 @@ class JsonLoader(dict_loader.DictLoader):
             SerializableType: The constructed serializable type.
 
         """
-        struct_members = []
+        # Note on struct_members: the order of the members list matter when calling construct_type() below.
+        # It should be ordered by incrementing index which corresponds to the order in the FPP declaration
+        # The JSON dictionary ordering is not guaranteed, so we use a dict() to sort by index below.
+        struct_members = {}
         for name, member_dict in qualified_type.get("members").items():
             member_type_dict = member_dict["type"]
             member_type_obj = self.parse_type(member_type_dict)
@@ -197,11 +200,17 @@ class JsonLoader(dict_loader.DictLoader):
                 member_type_obj.FORMAT if hasattr(member_type_obj, "FORMAT") else "{}"
             )
             description = member_type_dict.get("annotation", "")
-            struct_members.append((name, member_type_obj, fmt_str, description))
+            member_index = member_dict["index"]
+            if member_index in struct_members:
+                raise KeyError(
+                    f"Invalid dictionary: Duplicate index {member_index} in serializable type {type_name}"
+                )
+            struct_members[member_index] = (name, member_type_obj, fmt_str, description)
 
+        # Construct the serializable type with list of members sorted by index
         ser_type = SerializableType.construct_type(
             type_name,
-            struct_members,
+            [struct_members[i] for i in sorted(struct_members.keys())],
         )
         self.parsed_types[type_name] = ser_type
         return ser_type

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/src/fprime_gds/common/transport.py

@@ -241,7 +241,7 @@ class ThreadedTCPSocketClient(ThreadedTransportClient):
         assert self.dest is not None, "Cannot send data before connect call"
         self.sock.send(b"A5A5 %s %s" % (self.dest, data))
 
-    def recv(self, timeout=100):
+    def recv(self, timeout=0.1):
         """Receives data from the threaded tcp server
 
         Receives raw data from the threaded tcp server. This data is expected to have no headers and will be passed as

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/src/fprime_gds.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: fprime-gds
-Version: 3.5.2a1
+Version: 3.5.2a2
 Summary: F Prime Flight Software Ground Data System layer
 Author-email: Michael Starch <Michael.D.Starch@jpl.nasa.gov>, Thomas Boyer-Chammard <Thomas.Boyer.Chammard@jpl.nasa.gov>
 License: 

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/src/fprime_gds.egg-info/SOURCES.txt

@@ -261,6 +261,7 @@ src/fprime_gds/plugin/__init__.py
 src/fprime_gds/plugin/definitions.py
 src/fprime_gds/plugin/system.py
 test/fprime_gds/test_plugins.py
+test/fprime_gds/common/data_types/test_cmd_data.py
 test/fprime_gds/common/distributor/test_distributor.py
 test/fprime_gds/common/encoders/test_ch_encoder.py
 test/fprime_gds/common/encoders/test_event_encoder.py

fprime_gds-3.5.2a2/test/fprime_gds/common/data_types/test_cmd_data.py

@@ -0,0 +1,66 @@
+"""
+Tests Command Data
+
+Created on Jan 11, 2025
+@author: AlesKus
+"""
+
+import unittest
+from fprime.common.models.serialize.bool_type import BoolType
+import fprime.common.models.serialize.numerical_types as numerical_types
+from fprime.common.models.serialize.string_type import StringType
+from fprime_gds.common.templates.cmd_template import CmdTemplate
+from fprime_gds.common.data_types.cmd_data import CmdData
+
+
+class CmdDataTest(unittest.TestCase):
+    def test_str_bool_command_arg(self):
+        """
+        Tests CmdData::get_str() for a command with one bool argument
+        """
+        opcode = 42
+        mnemonic = "TEST_CMD_BOOL"
+        component = "PythonTests"
+        arguments = [("status", None, BoolType)]
+        command_template = CmdTemplate(opcode, mnemonic, component, arguments)
+        cmd_data = CmdData((True, ), command_template)
+
+        data_str = cmd_data.get_str()
+
+        self.assertIn("[True]", data_str)
+
+    def test_str_numerical_command_args(self):
+        """
+        Tests CmdData::get_str() for a command with several numerical arguments
+        """
+        opcode = 43
+        mnemonic = "TEST_CMD_NUMERICS"
+        component = "PythonTests"
+        arguments = [("just_int", None, numerical_types.U32Type),
+                     ("just_float", None, numerical_types.F64Type),
+                     ("just_byte", None, numerical_types.I8Type)]
+        command_template = CmdTemplate(opcode, mnemonic, component, arguments)
+        cmd_data = CmdData((12345, 98.765, 127), command_template)
+
+        data_str = cmd_data.get_str()
+
+        self.assertIn("[12345, 98.765, 127]", data_str)
+
+    def test_str_string_command_args(self):
+        """
+        Tests CmdData::get_str() for a command with one string argument
+        """
+        opcode = 44
+        mnemonic = "TEST_CMD_STR"
+        component = "PythonTests"
+        arguments = [("just_string", None, StringType.construct_type(f"String_{128}", 128))]
+        command_template = CmdTemplate(opcode, mnemonic, component, arguments)
+        cmd_data = CmdData(("Everything is good", ), command_template)
+
+        data_str = cmd_data.get_str()
+
+        self.assertIn("['Everything is good']", data_str)
+
+
+if __name__ == "__main__":
+    unittest.main()

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/test/fprime_gds/common/loaders/resources/RefTopologyDictionary.json

@@ -8,6 +8,38 @@
     "dictionarySpecVersion" : "1.0.0"
   },
   "typeDefinitions" : [
+    {
+      "kind" : "struct",
+      "qualifiedName" : "Ref.TestMisorderedStructIndexes",
+      "members" : {
+        "ThisIsOne" : {
+          "type" : {
+            "name" : "U32",
+            "kind" : "integer",
+            "size" : 32,
+            "signed" : false
+          },
+          "index" : 1
+        },
+        "ThisIsZero" : {
+          "type" : {
+            "name" : "U32",
+            "kind" : "integer",
+            "size" : 32,
+            "signed" : false
+          },
+          "index" : 0
+        },
+        "ThisIsTwo" : {
+          "type" : {
+            "name" : "Ref.PacketRecvStatus",
+            "kind" : "qualifiedIdentifier"
+          },
+          "index" : 2
+        }
+      },
+      "annotation" : "This type does not exist in Ref and is only used for GDS internal testing"
+    },
     {
       "kind" : "struct",
       "qualifiedName" : "Ref.PacketStat",

{fprime_gds-3.5.2a1 → fprime_gds-3.5.2a2}/test/fprime_gds/common/loaders/test_json_loader.py

@@ -100,6 +100,16 @@ def test_construct_serializable_type(loader):
     assert ref_choice_pair.MEMBER_LIST[1][2] == "{}"
 
 
+def test_struct_with_unordered_members(loader):
+    misordered_member = loader.parse_type(
+        {"name": "Ref.TestMisorderedStructIndexes", "kind": "qualifiedIdentifier"}
+    )
+    assert issubclass(misordered_member, SerializableType)
+    assert misordered_member.MEMBER_LIST[0][0] == "ThisIsZero"
+    assert misordered_member.MEMBER_LIST[1][0] == "ThisIsOne"
+    assert misordered_member.MEMBER_LIST[2][0] == "ThisIsTwo"
+
+
 def test_construct_primitive_types(loader):
     i32_type = loader.parse_type(
         {"name": "I32", "kind": "integer", "size": 32, "signed": True}