openc3-cosmos-cfdp 1.0.0

data/microservices/CFDP/spec/models/cfdp_pdu_metadata_spec.rb

@@ -0,0 +1,346 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+
+require 'rails_helper'
+require 'cfdp_pdu'
+require 'openc3/models/microservice_model'
+require 'openc3/utilities/store_autoload'
+
+RSpec.describe CfdpPdu, type: :model do
+  before(:each) do
+    mock_redis()
+    @source_entity_id = 1
+    @destination_entity_id = 2
+    ENV['OPENC3_MICROSERVICE_NAME'] = 'DEFAULT__API__CFDP'
+    # Create the model that is consumed by CfdpMib.setup
+    model = OpenC3::MicroserviceModel.new(name: ENV['OPENC3_MICROSERVICE_NAME'], scope: "DEFAULT",
+      options: [
+        ["source_entity_id", @source_entity_id],
+        ["destination_entity_id", @destination_entity_id],
+        ["root_path", SPEC_DIR],
+      ],
+    )
+    model.create
+    CfdpMib.setup
+  end
+
+  # Validate Table 5-9: Metadata PDU Contents
+  describe "build_metadata_pdu" do
+    it "builds a Metadata PDU with no options" do
+      buffer = CfdpPdu.build_metadata_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        source_file_name: "filename",
+        destination_file_name: "test",
+        closure_requested: 1,
+        options: [])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 29
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 7 # Metadata per Table 5-4
+      # Closure requested
+      expect(buffer[8].unpack('C')[0] >> 6).to eql 1
+      # Checksum type
+      expect(buffer[8].unpack('C')[0] & 0xF).to eql 0 # legacy modular checksum
+      # File Size
+      expect(buffer[9..12].unpack('N')[0]).to eql 0xDEADBEEF
+      # Source File Name
+      expect(buffer[13].unpack('C')[0]).to eql 8
+      expect(buffer[14..21].unpack('A*')[0]).to eql 'filename'
+      # Destination File Name
+      expect(buffer[22].unpack('C')[0]).to eql 4
+      expect(buffer[23..26].unpack('A*')[0]).to eql 'test'
+
+      hash = {}
+      # decom takes just the Metadata specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_metadata_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['CLOSURE_REQUESTED']).to eql 'CLOSURE_REQUESTED'
+      expect(hash['CHECKSUM_TYPE']).to eql 0
+      expect(hash['FILE_SIZE']).to eql 0xDEADBEEF
+      expect(hash['SOURCE_FILE_NAME']).to eql 'filename'
+      expect(hash['DESTINATION_FILE_NAME']).to eql 'test'
+    end
+
+    it "builds a Metadata PDU with option: filestore request" do
+      buffer = CfdpPdu.build_metadata_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        source_file_name: "filename",
+        destination_file_name: "test",
+        closure_requested: 0,
+        options: [{
+          "TYPE" => "FILESTORE_REQUEST",
+          "ACTION_CODE" => "DELETE_FILE", # 1
+          "FIRST_FILE_NAME" => "first",
+        },
+        {
+          "TYPE" => "FILESTORE_REQUEST",
+          "ACTION_CODE" => "RENAME_FILE", # 2
+          "FIRST_FILE_NAME" => "begin",
+          "SECOND_FILE_NAME" => "end",
+        }])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 51
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 7 # Metadata per Table 5-4
+      # Closure requested
+      expect(buffer[8].unpack('C')[0] >> 6).to eql 0
+      # Checksum type
+      expect(buffer[8].unpack('C')[0] & 0xF).to eql 0 # legacy modular checksum
+      # File Size
+      expect(buffer[9..12].unpack('N')[0]).to eql 0xDEADBEEF
+      # Source File Name
+      expect(buffer[13].unpack('C')[0]).to eql 8
+      expect(buffer[14..21].unpack('A*')[0]).to eql 'filename'
+      # Destination File Name
+      expect(buffer[22].unpack('C')[0]).to eql 4
+      expect(buffer[23..26].unpack('A*')[0]).to eql 'test'
+      # Option TLV Type
+      expect(buffer[27].unpack('C')[0]).to eql 0 # 5.4.1.1 Filestore Request
+      # Option TLV Length
+      expect(buffer[28].unpack('C')[0]).to eql 7 # Action code + length field + length
+      # Option TLV Value
+      # Action Code
+      expect(buffer[29].unpack('C')[0] >> 4).to eql 1
+      # First filename length
+      expect(buffer[30].unpack('C')[0]).to eql 5
+      # First filename
+      expect(buffer[31..35].unpack('A*')[0]).to eql 'first'
+      # Option TLV Type
+      expect(buffer[36].unpack('C')[0]).to eql 0 # 5.4.1.1 Filestore Request
+      # Option TLV Length
+      expect(buffer[37].unpack('C')[0]).to eql 11
+      # Option TLV Value
+      # Action Code
+      expect(buffer[38].unpack('C')[0] >> 4).to eql 2
+      # First filename length
+      expect(buffer[39].unpack('C')[0]).to eql 5
+      # First filename
+      expect(buffer[40..44].unpack('A*')[0]).to eql 'begin'
+      # Second filename length
+      expect(buffer[45].unpack('C')[0]).to eql 3
+      # Second filename
+      expect(buffer[46..48].unpack('A*')[0]).to eql 'end'
+
+      hash = {}
+      # decom takes just the Metadata specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_metadata_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['CLOSURE_REQUESTED']).to eql 'CLOSURE_NOT_REQUESTED'
+      expect(hash['CHECKSUM_TYPE']).to eql 0
+      expect(hash['FILE_SIZE']).to eql 0xDEADBEEF
+      expect(hash['SOURCE_FILE_NAME']).to eql 'filename'
+      expect(hash['DESTINATION_FILE_NAME']).to eql 'test'
+      tlv = hash['TLVS'][0]
+      expect(tlv['TYPE']).to eql 'FILESTORE_REQUEST'
+      expect(tlv['ACTION_CODE']).to eql 'DELETE_FILE'
+      expect(tlv['FIRST_FILE_NAME']).to eql 'first'
+      tlv = hash['TLVS'][1]
+      expect(tlv['TYPE']).to eql 'FILESTORE_REQUEST'
+      expect(tlv['ACTION_CODE']).to eql 'RENAME_FILE'
+      expect(tlv['FIRST_FILE_NAME']).to eql 'begin'
+      expect(tlv['SECOND_FILE_NAME']).to eql 'end'
+    end
+
+    it "builds a Metadata PDU with option: message to user" do
+      buffer = CfdpPdu.build_metadata_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        source_file_name: "filename",
+        destination_file_name: "test",
+        closure_requested: 0,
+        options: [{
+          "TYPE" => "MESSAGE_TO_USER",
+          "MESSAGE_TO_USER" => "Hello"
+        }])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 36
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 7 # Metadata per Table 5-4
+      # Closure requested
+      expect(buffer[8].unpack('C')[0] >> 6).to eql 0
+      # Checksum type
+      expect(buffer[8].unpack('C')[0] & 0xF).to eql 0 # legacy modular checksum
+      # File Size
+      expect(buffer[9..12].unpack('N')[0]).to eql 0xDEADBEEF
+      # Source File Name
+      expect(buffer[13].unpack('C')[0]).to eql 8
+      expect(buffer[14..21].unpack('A*')[0]).to eql 'filename'
+      # Destination File Name
+      expect(buffer[22].unpack('C')[0]).to eql 4
+      expect(buffer[23..26].unpack('A*')[0]).to eql 'test'
+      # Option TLV Type
+      expect(buffer[27].unpack('C')[0]).to eql 2 # 5.4.3 Message to User
+      # Option TLV Length
+      expect(buffer[28].unpack('C')[0]).to eql 5
+      # Option TLV Value
+      expect(buffer[29..33].unpack('A*')[0]).to eql 'Hello'
+
+      hash = {}
+      # decom takes just the Metadata specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_metadata_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['CLOSURE_REQUESTED']).to eql 'CLOSURE_NOT_REQUESTED'
+      expect(hash['CHECKSUM_TYPE']).to eql 0
+      expect(hash['FILE_SIZE']).to eql 0xDEADBEEF
+      expect(hash['SOURCE_FILE_NAME']).to eql 'filename'
+      expect(hash['DESTINATION_FILE_NAME']).to eql 'test'
+      tlv = hash['TLVS'][0]
+      expect(tlv['TYPE']).to eql 'MESSAGE_TO_USER'
+      expect(tlv['MESSAGE_TO_USER']).to eql 'Hello'
+    end
+
+    it "builds a Metadata PDU with option: fault handler override" do
+      buffer = CfdpPdu.build_metadata_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        source_file_name: "filename",
+        destination_file_name: "test",
+        closure_requested: 0,
+        options: [{
+          "TYPE" => "FAULT_HANDLER_OVERRIDE",
+          "CONDITION_CODE" => "INVALID_TRANSMISSION_MODE", # 3
+          "HANDLER_CODE" => "ABONDON_TRANSACTION", # 4
+        }])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 32
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 7 # Metadata per Table 5-4
+      # Closure requested
+      expect(buffer[8].unpack('C')[0] >> 6).to eql 0
+      # Checksum type
+      expect(buffer[8].unpack('C')[0] & 0xF).to eql 0 # legacy modular checksum
+      # File Size
+      expect(buffer[9..12].unpack('N')[0]).to eql 0xDEADBEEF
+      # Source File Name
+      expect(buffer[13].unpack('C')[0]).to eql 8
+      expect(buffer[14..21].unpack('A*')[0]).to eql 'filename'
+      # Destination File Name
+      expect(buffer[22].unpack('C')[0]).to eql 4
+      expect(buffer[23..26].unpack('A*')[0]).to eql 'test'
+      # Option TLV Type
+      expect(buffer[27].unpack('C')[0]).to eql 4 # 5.4.4 Fault Handler Override
+      # Option TLV Length
+      expect(buffer[28].unpack('C')[0]).to eql 1
+      # Option TLV Value
+      expect(buffer[29].unpack('C')[0] >> 4).to eql 3
+      expect(buffer[29].unpack('C')[0] & 0xF).to eql 4
+
+      hash = {}
+      # decom takes just the Metadata specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_metadata_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['CLOSURE_REQUESTED']).to eql 'CLOSURE_NOT_REQUESTED'
+      expect(hash['CHECKSUM_TYPE']).to eql 0
+      expect(hash['FILE_SIZE']).to eql 0xDEADBEEF
+      expect(hash['SOURCE_FILE_NAME']).to eql 'filename'
+      expect(hash['DESTINATION_FILE_NAME']).to eql 'test'
+      tlv = hash['TLVS'][0]
+      expect(tlv['TYPE']).to eql 'FAULT_HANDLER_OVERRIDE'
+      expect(tlv['CONDITION_CODE']).to eql 'INVALID_TRANSMISSION_MODE'
+      expect(tlv['HANDLER_CODE']).to eql 'ABONDON_TRANSACTION'
+    end
+
+    it "builds a Metadata PDU with option: flow label" do
+      buffer = CfdpPdu.build_metadata_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        source_file_name: "filename",
+        destination_file_name: "test",
+        closure_requested: 0,
+        options: [{
+          "TYPE" => "FLOW_LABEL",
+          "FLOW_LABEL" => "flow"
+        }])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 35
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 7 # Metadata per Table 5-4
+      # Closure requested
+      expect(buffer[8].unpack('C')[0] >> 6).to eql 0
+      # Checksum type
+      expect(buffer[8].unpack('C')[0] & 0xF).to eql 0 # legacy modular checksum
+      # File Size
+      expect(buffer[9..12].unpack('N')[0]).to eql 0xDEADBEEF
+      # Source File Name
+      expect(buffer[13].unpack('C')[0]).to eql 8
+      expect(buffer[14..21].unpack('A*')[0]).to eql 'filename'
+      # Destination File Name
+      expect(buffer[22].unpack('C')[0]).to eql 4
+      expect(buffer[23..26].unpack('A*')[0]).to eql 'test'
+      # Option TLV Type
+      expect(buffer[27].unpack('C')[0]).to eql 5 # 5.4.5 Flow Label
+      # Option TLV Length
+      expect(buffer[28].unpack('C')[0]).to eql 4
+      # Option TLV Value
+      expect(buffer[29..32].unpack('A*')[0]).to eql 'flow'
+
+      hash = {}
+      # decom takes just the Metadata specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_metadata_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['CLOSURE_REQUESTED']).to eql 'CLOSURE_NOT_REQUESTED'
+      expect(hash['CHECKSUM_TYPE']).to eql 0
+      expect(hash['FILE_SIZE']).to eql 0xDEADBEEF
+      expect(hash['SOURCE_FILE_NAME']).to eql 'filename'
+      expect(hash['DESTINATION_FILE_NAME']).to eql 'test'
+      tlv = hash['TLVS'][0]
+      expect(tlv['TYPE']).to eql 'FLOW_LABEL'
+      expect(tlv['FLOW_LABEL']).to eql 'flow'
+    end
+  end
+end

data/microservices/CFDP/spec/models/cfdp_pdu_nak_spec.rb

@@ -0,0 +1,126 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+
+require 'rails_helper'
+require 'cfdp_pdu'
+require 'openc3/models/microservice_model'
+require 'openc3/utilities/store_autoload'
+
+RSpec.describe CfdpPdu, type: :model do
+  before(:each) do
+    mock_redis()
+    @source_entity_id = 1
+    @destination_entity_id = 2
+    ENV['OPENC3_MICROSERVICE_NAME'] = 'DEFAULT__API__CFDP'
+    # Create the model that is consumed by CfdpMib.setup
+    model = OpenC3::MicroserviceModel.new(name: ENV['OPENC3_MICROSERVICE_NAME'], scope: "DEFAULT",
+      options: [
+        ["source_entity_id", @source_entity_id],
+        ["destination_entity_id", @destination_entity_id],
+        ["root_path", SPEC_DIR],
+      ],
+    )
+    model.create
+    CfdpMib.setup
+  end
+
+  # Validate Table 5-10: NAK PDU Contents
+  describe "build_nak_pdu" do
+    it "builds a NAK PDU with no segement requests" do
+      buffer = CfdpPdu.build_nak_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        start_of_scope: 0x12345678,
+        end_of_scope: 0xABCDEFFF,
+        segment_requests: [])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 18
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 8 # NAK per Table 5-4
+      # Start of scope
+      expect(buffer[8..11].unpack('N')[0]).to eql 0x12345678
+      # End of scope
+      expect(buffer[12..15].unpack('N')[0]).to eql 0xABCDEFFF
+
+      hash = {}
+      # decom takes just the NAK specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_nak_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['START_OF_SCOPE']).to eql 0x12345678
+      expect(hash['END_OF_SCOPE']).to eql 0xABCDEFFF
+      expect(hash['SEGMENT_REQUESTS']).to eql []
+    end
+
+    # Validate Table 5-11: Segment Request Form
+    it "builds a NAK PDU with segement requests" do
+      buffer = CfdpPdu.build_nak_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        file_size: 0xDEADBEEF,
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        start_of_scope: 0,
+        end_of_scope: 0x1F,
+        segment_requests: [
+          [0, 0xF],
+          [0x10, 0x1F],
+        ])
+      # puts buffer.formatted
+      expect(buffer.length).to eql 34
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 8 # NAK per Table 5-4
+      # Start of scope
+      expect(buffer[8..11].unpack('N')[0]).to eql 0
+      # End of scope
+      expect(buffer[12..15].unpack('N')[0]).to eql 0x1F
+      # Segment requests
+      expect(buffer[16..19].unpack('N')[0]).to eql 0
+      expect(buffer[20..23].unpack('N')[0]).to eql 0xF
+      expect(buffer[24..27].unpack('N')[0]).to eql 0x10
+      expect(buffer[28..31].unpack('N')[0]).to eql 0x1F
+
+      hash = {}
+      # decom takes just the NAK specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_nak_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['START_OF_SCOPE']).to eql 0
+      expect(hash['END_OF_SCOPE']).to eql 0x1F
+      expect(hash['SEGMENT_REQUESTS']).to eql [
+        {
+          "START_OFFSET" => 0,
+          "END_OFFSET" => 0xF,
+        },
+        {
+          "START_OFFSET" => 0x10,
+          "END_OFFSET" => 0x1F,
+        }
+      ]
+    end
+  end
+end

data/microservices/CFDP/spec/models/cfdp_pdu_prompt_spec.rb

@@ -0,0 +1,94 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+
+require 'rails_helper'
+require 'cfdp_pdu'
+require 'openc3/models/microservice_model'
+require 'openc3/utilities/store_autoload'
+
+RSpec.describe CfdpPdu, type: :model do
+  before(:each) do
+    mock_redis()
+    @source_entity_id = 1
+    @destination_entity_id = 2
+    ENV['OPENC3_MICROSERVICE_NAME'] = 'DEFAULT__API__CFDP'
+    # Create the model that is consumed by CfdpMib.setup
+    model = OpenC3::MicroserviceModel.new(name: ENV['OPENC3_MICROSERVICE_NAME'], scope: "DEFAULT",
+      options: [
+        ["source_entity_id", @source_entity_id],
+        ["destination_entity_id", @destination_entity_id],
+        ["root_path", SPEC_DIR],
+      ],
+    )
+    model.create
+    CfdpMib.setup
+  end
+
+  # Validate Table 5-12: Prompt PDU Contents
+  describe "build_prompt_pdu" do
+    it "builds a Prompt PDU with nak response" do
+      buffer = CfdpPdu.build_prompt_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        response_required: 'NAK')
+      # puts buffer.formatted
+      expect(buffer.length).to eql 11
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 9 # Prompt per Table 5-4
+      # Response required
+      expect(buffer[8].unpack('C')[0] >> 7).to eql 0
+
+      hash = {}
+      # decom takes just the Prompt specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_prompt_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['RESPONSE_REQUIRED']).to eql 'NAK'
+    end
+
+    it "builds a Prompt PDU with keep alive response" do
+      buffer = CfdpPdu.build_prompt_pdu(
+        source_entity: CfdpMib.entity(@source_entity_id),
+        transaction_seq_num: 1,
+        destination_entity: CfdpMib.entity(@destination_entity_id),
+        segmentation_control: "NOT_PRESERVED",
+        transmission_mode: nil,
+        response_required: 'KEEP_ALIVE')
+      # puts buffer.formatted
+      expect(buffer.length).to eql 11
+
+      # By default the first 7 bytes are the header
+      # This assumes 1 byte per entity ID and sequence number
+
+      # Directive Code
+      expect(buffer[7].unpack('C')[0]).to eql 9 # Prompt per Table 5-4
+      # Response required
+      expect(buffer[8].unpack('C')[0] >> 7).to eql 1
+
+      hash = {}
+      # decom takes just the Prompt specific part of the buffer
+      # so start at offset 8 and ignore the 2 checksum bytes
+      CfdpPdu.decom_prompt_pdu_contents(CfdpPdu.new(crcs_required: false), hash, buffer[8..-3])
+      expect(hash['RESPONSE_REQUIRED']).to eql 'KEEP_ALIVE'
+    end
+  end
+end

data/microservices/CFDP/spec/models/cfdp_pdu_spec.rb

@@ -0,0 +1,111 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+
+require 'rails_helper'
+
+RSpec.describe CfdpPdu, type: :model do
+  # Validate Table 5-1: Fixed PDU Header Fields
+  describe "initialize" do
+    it "builds a PDU with crcs" do
+      pdu = CfdpPdu.new(crcs_required: true)
+      expect(pdu.items.keys).to include("CRC")
+      expect(pdu.buffer.length).to eql 6
+    end
+
+    it "builds a PDU without crcs" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      expect(pdu.items.keys).to_not include("CRC")
+      expect(pdu.buffer.length).to eql 4
+    end
+
+    it "sets the version field" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.version = 1
+      expect(pdu.buffer[0].unpack('C')[0] >> 5).to eql 1
+    end
+
+    it "sets the PDU type" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.type = 1
+      expect(pdu.buffer[0].unpack('C')[0] >> 4).to eql 1
+    end
+
+    it "sets the direction" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.direction = 1
+      expect(pdu.buffer[0].unpack('C')[0] >> 3).to eql 1
+    end
+
+    it "sets the transmission mode" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.transmission_mode = 1
+      expect(pdu.buffer[0].unpack('C')[0] >> 2).to eql 1
+    end
+
+    it "sets the crc flag" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.crc_flag = 1
+      expect(pdu.buffer[0].unpack('C')[0] >> 1).to eql 1
+    end
+
+    it "sets the large file flag" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.large_file_flag = 1
+      expect(pdu.buffer[0].unpack('C')[0]).to eql 1
+    end
+
+    it "sets the length" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.pdu_data_length = 0x1234
+      expect(pdu.buffer[1..2].unpack('n')[0]).to eql 0x1234
+    end
+
+    it "sets the segmentation control" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.segmentation_control = 1
+      expect(pdu.buffer[3].unpack('C')[0] >> 7).to eql 1
+    end
+
+    it "sets the entity id length" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.entity_id_length = 7
+      expect(pdu.buffer[3].unpack('C')[0] >> 4).to eql 7
+    end
+
+    it "sets the segment metadata flag" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.segment_metadata_flag = 1
+      expect(pdu.buffer[3].unpack('C')[0] >> 3).to eql 1
+    end
+
+    it "sets the sequence number length" do
+      pdu = CfdpPdu.new(crcs_required: false)
+      pdu.enable_method_missing
+      pdu.sequence_number_length = 7
+      expect(pdu.buffer[3].unpack('C')[0]).to eql 7
+    end
+  end
+end