Merge pull request #2540 from OpenC3/restricted

Author: jmthomas

openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt

@@ -63,6 +63,7 @@ COMMAND <%= target_name %> ARYCMD BIG_ENDIAN "Command with array parameter"
   PARAMETER    CRC            -8   8  UINT MIN MAX 0 "CRC"
 
 COMMAND <%= target_name %> SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panels"
+  RESTRICTED
   VALIDATOR inst_cmd_validator.rb
   <%= render "_ccsds_cmd.txt", locals: {id: 8} %>
   RELATED_ITEM <%= target_name %> MECH SLRPNL1
@@ -72,6 +73,7 @@ COMMAND <%= target_name %> SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panels"
   RELATED_ITEM <%= target_name %> MECH SLRPNL5
 
 COMMAND <%= target_name %> SLRPNLRESET BIG_ENDIAN "Reset solar array panels"
+  RESTRICTED
   VALIDATOR inst_cmd_validator.rb
   <%= render "_ccsds_cmd.txt", locals: {id: 9} %>
   RELATED_ITEM <%= target_name %> MECH SLRPNL1

openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt

@@ -63,6 +63,7 @@ COMMAND <%= target_name %> ARYCMD BIG_ENDIAN "Command with array parameter"
   PARAMETER    CRC            -8   8  UINT MIN MAX 0 "CRC"
 
 COMMAND <%= target_name %> SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panels"
+  RESTRICTED
   VALIDATOR inst2_cmd_validator.py
   <%= render "_ccsds_cmd.txt", locals: {id: 8} %>
   RELATED_ITEM <%= target_name %> MECH SLRPNL1
@@ -72,6 +73,7 @@ COMMAND <%= target_name %> SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panels"
   RELATED_ITEM <%= target_name %> MECH SLRPNL5
 
 COMMAND <%= target_name %> SLRPNLRESET BIG_ENDIAN "Reset solar array panels"
+  RESTRICTED
   VALIDATOR inst2_cmd_validator.py
   <%= render "_ccsds_cmd.txt", locals: {id: 9} %>
   RELATED_ITEM <%= target_name %> MECH SLRPNL1

openc3/python/openc3/packets/packet_config.py

@@ -206,6 +206,7 @@ def process_file(self, filename, process_target_name):
                         | "APPEND_ARRAY_PARAMETER"
                         | "ALLOW_SHORT"
                         | "HAZARDOUS"
+                        | "RESTRICTED"
                         | "PROCESSOR"
                         | "META"
                         | "DISABLE_MESSAGES"
@@ -456,6 +457,8 @@ def process_current_packet(self, parser, keyword, params):
             # Allow this packet to be received with less data than the defined length
             # without generating a warning.
             case "ALLOW_SHORT":
+                usage = keyword
+                parser.verify_num_parameters(0, 0, usage)
                 self.current_packet.short_buffer_allowed = True
 
             # Mark the current command as hazardous
@@ -725,15 +728,14 @@ def process_current_item(self, parser, keyword, params):
                 parser.verify_num_parameters(2, 2, usage)
                 self.current_item.units_full = params[0]
                 self.current_item.units = params[1]
-            
+
             # Obfuscate the parameter in logs
             case "OBFUSCATE":
                 usage = "OBFUSCATE"
                 parser.verify_num_parameters(0, 0, usage)
                 self.current_item.obfuscate = True
                 self.current_packet.update_obfuscated_items_cache(self.current_item)
 
-
             # Update the description for the current telemetry item
             case "DESCRIPTION":
                 usage = "DESCRIPTION <DESCRIPTION>"

openc3/python/test/packets/test_packet_config.py

@@ -84,25 +84,56 @@ def test_creates_unknown_cmd_tlm_packets(self):
 
     # context "with all telemetry keywords" do
     #   before(:all) do
-    # top level keywords
+    # Top level keywords (don't require current packet or item)
     top_keywords = [
         "SELECT_COMMAND",
         "SELECT_TELEMETRY",
         "LIMITS_GROUP",
         "LIMITS_GROUP_ITEM",
     ]
-    # Keywords that require a current packet from TELEMETRY keyword
+    # Keywords that require a current TELEMETRY packet (telemetry-specific ITEM keywords)
     tlm_keywords = [
         "SELECT_ITEM",
+        "DELETE_ITEM",
         "ITEM",
         "ID_ITEM",
         "ARRAY_ITEM",
         "APPEND_ITEM",
         "APPEND_ID_ITEM",
         "APPEND_ARRAY_ITEM",
+        "ALLOW_SHORT",
         "PROCESSOR",
         "META",
     ]
+    # Keywords that require a current COMMAND packet (command-specific PARAMETER keywords)
+    cmd_keywords = [
+        "SELECT_PARAMETER",
+        "DELETE_PARAMETER",
+        "PARAMETER",
+        "ID_PARAMETER",
+        "ARRAY_PARAMETER",
+        "APPEND_PARAMETER",
+        "APPEND_ID_PARAMETER",
+        "APPEND_ARRAY_PARAMETER",
+    ]
+    # Keywords that apply to both COMMAND and TELEMETRY packets
+    packet_keywords = [
+        "HAZARDOUS",
+        "RESTRICTED",
+        "DISABLE_MESSAGES",
+        "HIDDEN",
+        "DISABLED",
+        "VIRTUAL",
+        "ACCESSOR",
+        "VALIDATOR",
+        "TEMPLATE",
+        "TEMPLATE_FILE",
+        "RESPONSE",
+        "ERROR_RESPONSE",
+        "SCREEN",
+        "RELATED_ITEM",
+        "IGNORE_OVERLAP",
+    ]
     # Keywords that require both a current packet and current item
     item_keywords = [
         "STATE",
@@ -161,6 +192,11 @@ def test_complains_if_there_are_not_enough_parameters(self):
             tf.close()
 
         for keyword in TestPacketConfig.tlm_keywords:
+            # Skip keywords that don't require parameters or are tested elsewhere
+            ignore_tlm = ["PROCESSOR", "META", "ALLOW_SHORT"]
+            if keyword in ignore_tlm:
+                continue
+
             tf = tempfile.NamedTemporaryFile(mode="w")
             tf.write('TELEMETRY tgt1 pkt1 LITTLE_ENDIAN "Packet"\n')
             tf.write(keyword)
@@ -188,28 +224,24 @@ def test_complains_if_there_are_not_enough_parameters(self):
             tf.close()
 
     def test_builds_the_id_value_hash(self):
-        for keyword in TestPacketConfig.tlm_keywords:
-            if keyword == "PROCESSOR" or keyword == "META":
-                continue
-
-            tf = tempfile.NamedTemporaryFile(mode="w")
-            tf.write('TELEMETRY tgt1 pkt1 BIG_ENDIAN "Packet"\n')
-            tf.write('ID_ITEM myitem 0 8 UINT 13 "Test Item id=1"\n')
-            tf.write('APPEND_ID_ITEM myitem 8 UINT 114 "Test Item id=1"\n')
-            tf.write('COMMAND tgt1 pkt1 BIG_ENDIAN "Packet"\n')
-            tf.write('ID_PARAMETER myitem 0 8 UINT 12 12 12 "Test Item id=1"\n')
-            tf.write('APPEND_ID_PARAMETER myitem 8 UINT 115 115 115 "Test Item id=1"\n')
-            tf.seek(0)
-            self.pc.process_file(tf.name, "TGT1")
-            expected_tlm_hash = {}
-            expected_tlm_hash["TGT1"] = {}
-            expected_tlm_hash["TGT1"]["[13, 114]"] = self.pc.telemetry["TGT1"]["PKT1"]
-            expected_cmd_hash = {}
-            expected_cmd_hash["TGT1"] = {}
-            expected_cmd_hash["TGT1"]["[12, 115]"] = self.pc.commands["TGT1"]["PKT1"]
-            self.assertEqual(self.pc.tlm_id_value_hash, expected_tlm_hash)
-            self.assertEqual(self.pc.cmd_id_value_hash, expected_cmd_hash)
-            tf.close()
+        tf = tempfile.NamedTemporaryFile(mode="w")
+        tf.write('TELEMETRY tgt1 pkt1 BIG_ENDIAN "Packet"\n')
+        tf.write('ID_ITEM myitem 0 8 UINT 13 "Test Item id=1"\n')
+        tf.write('APPEND_ID_ITEM myitem 8 UINT 114 "Test Item id=1"\n')
+        tf.write('COMMAND tgt1 pkt1 BIG_ENDIAN "Packet"\n')
+        tf.write('ID_PARAMETER myitem 0 8 UINT 12 12 12 "Test Item id=1"\n')
+        tf.write('APPEND_ID_PARAMETER myitem 8 UINT 115 115 115 "Test Item id=1"\n')
+        tf.seek(0)
+        self.pc.process_file(tf.name, "TGT1")
+        expected_tlm_hash = {}
+        expected_tlm_hash["TGT1"] = {}
+        expected_tlm_hash["TGT1"]["[13, 114]"] = self.pc.telemetry["TGT1"]["PKT1"]
+        expected_cmd_hash = {}
+        expected_cmd_hash["TGT1"] = {}
+        expected_cmd_hash["TGT1"]["[12, 115]"] = self.pc.commands["TGT1"]["PKT1"]
+        self.assertEqual(self.pc.tlm_id_value_hash, expected_tlm_hash)
+        self.assertEqual(self.pc.cmd_id_value_hash, expected_cmd_hash)
+        tf.close()
 
     def test_complains_if_there_are_too_many_parameters(self):
         for keyword in TestPacketConfig.top_keywords:
@@ -250,6 +282,10 @@ def test_complains_if_there_are_too_many_parameters(self):
                 case "SELECT_ITEM":
                     tf.write("ITEM myitem 0 8 UINT\n")
                     tf.write("SELECT_ITEM myitem extra\n")
+                case "DELETE_ITEM":
+                    tf.write("DELETE_ITEM myitem extra\n")
+                case "ALLOW_SHORT":
+                    tf.write("ALLOW_SHORT extra\n")
             tf.seek(0)
             with self.assertRaisesRegex(ConfigParser.Error, f"Too many parameters for {keyword}"):
                 self.pc.process_file(tf.name, "TGT1")
@@ -863,6 +899,17 @@ def test_hazardous_takes_a_description(self):
         )
         tf.close()
 
+    def test_marks_the_packet_as_restricted(self):
+        tf = tempfile.NamedTemporaryFile(mode="w")
+        tf.write('COMMAND tgt2 pkt1 LITTLE_ENDIAN "Description"\n')
+        tf.write("RESTRICTED\n")
+        tf.write('COMMAND tgt2 pkt2 LITTLE_ENDIAN "Description"\n')
+        tf.seek(0)
+        self.pc.process_file(tf.name, "SYSTEM")
+        self.assertTrue(self.pc.commands["TGT2"]["PKT1"].restricted)
+        self.assertFalse(self.pc.commands["TGT2"]["PKT2"].restricted)
+        tf.close()
+
     def test_complains_about_missing_conversion_file(self):
         self.pc = PacketConfig()