openc3-cosmos-cfdp 1.0.2 → 2.0.0

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_tlv.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 class CfdpPdu < OpenC3::Packet
   def self.decom_tlv(pdu, pdu_hash, variable_data)
@@ -77,7 +80,7 @@ class CfdpPdu < OpenC3::Packet
           s = define_message_to_user_tlv()
           s.buffer = tlv_data
           tlv["MESSAGE_TO_USER"] = s.read("MESSAGE_TO_USER")
-          tlv.merge!(pdu.decom_message_to_user(tlv["MESSAGE_TO_USER"]))
+          tlv.merge!(pdu.decom_message_to_user(tlv["MESSAGE_TO_USER"], version: pdu_hash["VERSION"]))
 
         when "FAULT_HANDLER_OVERRIDE"
           s = define_fault_handler_override_tlv()

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_user_ops.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 class CfdpPdu < OpenC3::Packet
 
@@ -495,19 +498,23 @@ class CfdpPdu < OpenC3::Packet
   end
 
   # Table 6-16
-  def define_directory_listing_response_message
+  def define_directory_listing_response_message(version:)
     s1 = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
     item = s1.append_item("RESPONSE_CODE", 1, :UINT)
-    item.states = { "SUCCESSFUL" => 0, "UNSUCCESSFUL" => 1 }
+    if version >= 1
+      item.states = { "SUCCESSFUL" => 0, "UNSUCCESSFUL" => 1 }
+    else
+      item.states = { "SUCCESSFUL" => 0, "UNSUCCESSFUL" => 0xFF }
+    end
     s1.append_item("SPARE", 7, :UINT)
     return s1, define_length_value(), define_length_value()
   end
 
-  def build_directory_listing_response_message(response_code:, directory_name:, directory_file_name:)
+  def build_directory_listing_response_message(response_code:, directory_name:, directory_file_name:, version:)
     s1 = define_reserved_cfdp_message_header()
     s1.write("MSG_ID", "cfdp")
     s1.write("MSG_TYPE", "DIRECTORY_LISTING_RESPONSE")
-    fixed, s2, s3 = define_directory_listing_response_message()
+    fixed, s2, s3 = define_directory_listing_response_message(version: version)
     fixed.write("RESPONSE_CODE", response_code)
     fixed.write("SPARE", 0)
     s2.write("LENGTH", directory_name.to_s.length)
@@ -517,10 +524,10 @@ class CfdpPdu < OpenC3::Packet
     return s1.buffer(false) + fixed.buffer(false) + s2.buffer(false) + s3.buffer(false)
   end
 
-  def decom_directory_listing_response_message(message_to_user)
+  def decom_directory_listing_response_message(message_to_user, version:)
     result = {}
     message_to_user = message_to_user[5..-1] # Remove header
-    fixed, s2, s3 = define_directory_listing_response_message()
+    fixed, s2, s3 = define_directory_listing_response_message(version: version)
     fixed.buffer = message_to_user[0..(fixed.defined_length - 1)]
     result["RESPONSE_CODE"] = fixed.read("RESPONSE_CODE")
     message_to_user = message_to_user[fixed.defined_length..-1]
@@ -689,7 +696,7 @@ class CfdpPdu < OpenC3::Packet
     return result
   end
 
-  def decom_message_to_user(message_to_user)
+  def decom_message_to_user(message_to_user, version:)
     s1 = define_reserved_cfdp_message_header()
     if message_to_user.length >= 5 # Minimum size
       s1.buffer = message_to_user[0..(s1.defined_length - 1)]
@@ -723,7 +730,7 @@ class CfdpPdu < OpenC3::Packet
         when "DIRECTORY_LISTING_REQUEST"
           return decom_directory_listing_request_message(message_to_user)
         when "DIRECTORY_LISTING_RESPONSE"
-          return decom_directory_listing_response_message(message_to_user)
+          return decom_directory_listing_response_message(message_to_user, version: version)
         when "REMOTE_STATUS_REPORT_REQUEST"
           return decom_remote_status_report_request_message(message_to_user)
         when "REMOTE_STATUS_REPORT_RESPONSE"

data/microservices/CFDP/spec/controllers/cfdp_controller_spec.rb

@@ -0,0 +1,373 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 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 Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
+
+require 'rails_helper'
+
+$orig_cfdp_user = $cfdp_user
+
+RSpec.describe CfdpController, type: :controller do
+  before(:each) do
+    @mock_user = double("CfdpUser")
+    @mock_transaction = double("CfdpTransaction")
+    allow(@mock_transaction).to receive(:id).and_return("1__123")
+    $cfdp_user = @mock_user
+
+    # Setup authorization mock
+    allow(controller).to receive(:check_authorization).and_return(true)
+    allow(controller).to receive(:authorization).and_return(true)
+  end
+
+  after(:each) do
+    $cfdp_user = $orig_cfdp_user
+  end
+
+  describe "PUT requests" do
+    it "handles put request successfully" do
+      params = {
+        destination_entity_id: "2",
+        destination_file_name: "dest.txt",
+        source_file_name: "source.txt",
+        controller: "cfdp",
+        action: "put"
+      }
+
+      # Expect CfdpUser to be called with proper parameters
+      expect(@mock_user).to receive(:start_source_transaction).with(
+        ActionController::Parameters.new(params)
+      ).and_return(@mock_transaction)
+
+      post :put, params: params
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("1__123")
+    end
+
+    it "requires destination_entity_id" do
+      post :put, params: {}
+
+      expect(response).to have_http_status(:bad_request)
+      expect(JSON.parse(response.body)["message"]).to include("destination_entity_id")
+    end
+
+    it "handles errors" do
+      allow(@mock_user).to receive(:start_source_transaction).and_raise("Test error")
+
+      post :put, params: { destination_entity_id: "2" }
+
+      expect(response).to have_http_status(:internal_server_error)
+      expect(JSON.parse(response.body)["message"]).to include("Test error")
+    end
+  end
+
+  describe "CANCEL requests" do
+    it "handles cancel request successfully" do
+      params = { action: "cancel", controller: "cfdp", transaction_id: "1__123"  }
+
+      # Expect CfdpUser to be called with proper parameters
+      expect(@mock_user).to receive(:cancel).with(
+        ActionController::Parameters.new(params)
+      ).and_return(@mock_transaction)
+
+      post :cancel, params: params
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("1__123")
+    end
+
+    it "requires transaction_id" do
+      post :cancel, params: {}
+
+      expect(response).to have_http_status(:bad_request)
+    end
+
+    it "handles transaction not found" do
+      allow(@mock_user).to receive(:cancel).and_return(nil)
+
+      post :cancel, params: { transaction_id: "1__123" }
+
+      expect(response).to have_http_status(:not_found)
+      expect(JSON.parse(response.body)["message"]).to include("not found")
+    end
+
+    it "handles errors" do
+      allow(@mock_user).to receive(:cancel).and_raise("Test error")
+
+      post :cancel, params: { transaction_id: "1__123" }
+
+      expect(response).to have_http_status(:internal_server_error)
+      expect(JSON.parse(response.body)["message"]).to include("Test error")
+    end
+  end
+
+  describe "SUSPEND requests" do
+    it "handles suspend request successfully" do
+      params = { transaction_id: "1__123", controller: "cfdp", action: "suspend" }
+
+      # Expect CfdpUser to be called with proper parameters
+      expect(@mock_user).to receive(:suspend).with(
+        ActionController::Parameters.new(params)
+      ).and_return(@mock_transaction)
+
+      post :suspend, params: params
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("1__123")
+    end
+
+    it "requires transaction_id" do
+      post :suspend, params: {}
+
+      expect(response).to have_http_status(:bad_request)
+    end
+
+    it "handles transaction not found" do
+      allow(@mock_user).to receive(:suspend).and_return(nil)
+
+      post :suspend, params: { transaction_id: "1__123" }
+
+      expect(response).to have_http_status(:not_found)
+      expect(JSON.parse(response.body)["message"]).to include("not found")
+    end
+  end
+
+  describe "RESUME requests" do
+    it "handles resume request successfully" do
+      params = { action: "resume", controller: "cfdp", transaction_id: "1__123" }
+
+      # Expect CfdpUser to be called with proper parameters
+      expect(@mock_user).to receive(:resume).with(
+        ActionController::Parameters.new(params)
+      ).and_return(@mock_transaction)
+
+      post :resume, params: params
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("1__123")
+    end
+
+    it "requires transaction_id" do
+      post :resume, params: {}
+
+      expect(response).to have_http_status(:bad_request)
+    end
+
+    it "handles transaction not found" do
+      allow(@mock_user).to receive(:resume).and_return(nil)
+
+      post :resume, params: { transaction_id: "1__123" }
+
+      expect(response).to have_http_status(:not_found)
+      expect(JSON.parse(response.body)["message"]).to include("not found")
+    end
+  end
+
+  describe "REPORT requests" do
+    it "handles report request successfully" do
+      params = { transaction_id: "1__123", controller: "cfdp", action: "report" }
+
+      # Expect CfdpUser to be called with proper parameters
+      expect(@mock_user).to receive(:report).with(
+        ActionController::Parameters.new(params)
+      ).and_return(@mock_transaction)
+
+      post :report, params: params
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("1__123")
+    end
+
+    it "requires transaction_id" do
+      post :report, params: {}
+
+      expect(response).to have_http_status(:bad_request)
+    end
+
+    it "handles transaction not found" do
+      allow(@mock_user).to receive(:report).and_return(nil)
+
+      post :report, params: { transaction_id: "1__123" }
+
+      expect(response).to have_http_status(:not_found)
+      expect(JSON.parse(response.body)["message"]).to include("not found")
+    end
+  end
+
+  describe "DIRECTORY_LISTING requests" do
+    it "handles directory listing request successfully" do
+      params = {
+        remote_entity_id: "2",
+        directory_name: "test_dir",
+        directory_file_name: "result.txt",
+        controller: "cfdp",
+        action: "directory_listing"
+      }
+
+      # Expect CfdpUser to be called with proper parameters
+      expect(@mock_user).to receive(:start_directory_listing).with(
+        ActionController::Parameters.new(params)
+      ).and_return(@mock_transaction)
+
+      post :directory_listing, params: params
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("1__123")
+    end
+
+    it "requires remote_entity_id, directory_name and directory_file_name" do
+      post :directory_listing, params: {}
+
+      expect(response).to have_http_status(:bad_request)
+      expect(JSON.parse(response.body)["message"]).to include("missing")
+    end
+  end
+
+  describe "SUBSCRIBE requests" do
+    before(:each) do
+      allow(CfdpTopic).to receive(:subscribe_indications).and_return("0-0")
+    end
+
+    it "handles subscribe request successfully" do
+      post :subscribe
+
+      expect(response).to have_http_status(:success)
+      expect(response.body).to eq("0-0")
+    end
+
+    it "handles errors" do
+      allow(CfdpTopic).to receive(:subscribe_indications).and_raise("Test error")
+
+      post :subscribe
+
+      expect(response).to have_http_status(:internal_server_error)
+      expect(JSON.parse(response.body)["message"]).to include("Test error")
+    end
+  end
+
+  describe "INDICATIONS requests" do
+    before(:each) do
+      @indications = {
+        continuation: "1-1",
+        indications: [
+          {
+            "time" => Time.now.to_nsec_from_epoch,
+            "indication_type" => "Transaction-Finished",
+            "transaction_id" => "1__123",
+            "condition_code" => "NO_ERROR"
+          }
+        ]
+      }
+      allow(CfdpTopic).to receive(:read_indications).and_return(@indications)
+    end
+
+    it "gets indications for all transactions" do
+      get :indications
+
+      expect(response).to have_http_status(:success)
+      parsed = JSON.parse(response.body)
+      expect(parsed["continuation"]).to eq("1-1")
+      expect(parsed["indications"]).to be_an(Array)
+      expect(parsed["indications"].length).to eq(1)
+    end
+
+    it "gets indications for a specific transaction" do
+      get :indications, params: { transaction_id: "1__123" }
+
+      expect(response).to have_http_status(:success)
+      expect(CfdpTopic).to have_received(:read_indications).with(
+        hash_including(transaction_id: "1__123")
+      )
+    end
+
+    it "handles errors" do
+      allow(CfdpTopic).to receive(:read_indications).and_raise("Test error")
+
+      get :indications
+
+      expect(response).to have_http_status(:internal_server_error)
+      expect(JSON.parse(response.body)["message"]).to include("Test error")
+    end
+  end
+
+  describe "TRANSACTIONS requests" do
+    before(:each) do
+      @transactions = {
+        "1__123" => @mock_transaction,
+        "1__124" => @mock_transaction
+      }
+
+      allow(CfdpMib).to receive(:transactions).and_return(@transactions)
+      allow(CfdpMib).to receive(:cleanup_old_transactions)
+
+      allow(@mock_transaction).to receive(:as_json).and_return({"id" => "1__123", "state" => "ACTIVE"})
+      allow(@mock_transaction).to receive(:transaction_status).and_return("ACTIVE")
+      allow(@mock_transaction).to receive(:id).and_return("1__123")
+    end
+
+    it "gets all transactions" do
+      get :transactions
+
+      expect(response).to have_http_status(:success)
+
+      parsed = JSON.parse(response.body)
+      expect(parsed).to be_an(Array)
+      expect(parsed.length).to eq(2)
+    end
+
+    it "gets only active transactions" do
+      get :transactions, params: { active: "true" }
+
+      expect(response).to have_http_status(:success)
+
+      parsed = JSON.parse(response.body)
+      expect(parsed).to be_an(Array)
+      expect(parsed.length).to eq(2)
+    end
+
+    it "handles errors" do
+      allow(CfdpMib).to receive(:transactions).and_raise("Test error")
+
+      get :transactions
+
+      expect(response).to have_http_status(:internal_server_error)
+      expect(JSON.parse(response.body)["message"]).to include("Test error")
+    end
+  end
+
+  describe "check_authorization" do
+    before(:each) do
+      # Reset the mock to allow the real method to be called
+      allow(controller).to receive(:check_authorization).and_call_original
+
+      # Setup mocks needed by the method
+      @entity = {
+        "id" => 1,
+        "cmd_info" => ["TARGET", "PACKET", "ITEM"],
+        "tlm_info" => []
+      }
+
+      allow(CfdpMib).to receive(:entity).and_return(@entity)
+      allow(CfdpMib).to receive(:source_entity_id).and_return(1)
+      allow(CfdpMib).to receive(:cleanup_old_transactions)
+    end
+
+    it "authorizes when entity_id is numeric" do
+      allow(controller).to receive(:authorization).and_return(true)
+
+      expect(controller.send(:check_authorization)).to be true
+    end
+  end
+end

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

@@ -0,0 +1,134 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 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 Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
+
+require 'rails_helper'
+require 'tempfile'
+
+RSpec.describe CfdpCrcChecksum do
+  before(:each) do
+    # Mock OpenC3::Crc32
+    @mock_crc32 = double("OpenC3::Crc32")
+    allow(@mock_crc32).to receive(:calc).and_return(0x12345678)
+    allow(OpenC3::Crc32).to receive(:new).and_return(@mock_crc32)
+  end
+
+  describe "initialize" do
+    it "initializes with default values" do
+      checksum = CfdpCrcChecksum.new
+      expect(checksum.crc).to eq(@mock_crc32)
+      expect(checksum.instance_variable_get(:@checksum)).to eq(0)
+    end
+
+    it "initializes with custom values" do
+      # These are the defaults from the OpenC3::Crc32 class
+      poly = 0x04C11DB7
+      seed = 0xFFFFFFFF
+      xor = true
+      reflect = true
+
+      # Expect it to be called with these specific parameters
+      expect(OpenC3::Crc32).to receive(:new).with(poly, seed, xor, reflect).and_return(@mock_crc32)
+
+      checksum = CfdpCrcChecksum.new(poly, seed, xor, reflect)
+      expect(checksum.crc).to eq(@mock_crc32)
+    end
+  end
+
+  describe "add" do
+    it "always returns 0 (not supported)" do
+      checksum = CfdpCrcChecksum.new
+      result = checksum.add(100, "test data")
+      expect(result).to eq(0)
+    end
+  end
+
+  describe "checksum" do
+    it "calculates checksum from file" do
+      # Create a tempfile with content
+      file = Tempfile.new('crc_test')
+      file.write("test data")
+      file.rewind
+
+      # Expect the calc method to be called with the file data
+      expect(@mock_crc32).to receive(:calc).with("test data").and_return(0xABCDEF12)
+
+      checksum = CfdpCrcChecksum.new
+      result = checksum.checksum(file, false)
+
+      # The result should be masked to 32 bits
+      expect(result).to eq(0xABCDEF12)
+
+      file.close
+      file.unlink
+    end
+  end
+
+  describe "check" do
+    it "returns true when checksums match" do
+      # Create a tempfile with content
+      file = Tempfile.new('crc_test')
+      file.write("test data")
+      file.rewind
+
+      checksum = CfdpCrcChecksum.new
+
+      # First, mock the internal checksum call to return a specific value
+      expect(checksum).to receive(:checksum).with(file, false).and_return(0x12345678)
+
+      # Then check against the same value
+      expect(checksum.check(file, 0x12345678, false)).to be true
+
+      file.close
+      file.unlink
+    end
+
+    it "returns false when checksums don't match" do
+      # Create a tempfile with content
+      file = Tempfile.new('crc_test')
+      file.write("test data")
+      file.rewind
+
+      checksum = CfdpCrcChecksum.new
+
+      # First, mock the internal checksum call to return a specific value
+      expect(checksum).to receive(:checksum).with(file, false).and_return(0x12345678)
+
+      # Then check against a different value
+      expect(checksum.check(file, 0x87654321, false)).to be false
+
+      file.close
+      file.unlink
+    end
+
+    it "handles an empty file" do
+      # Create an empty tempfile
+      file = Tempfile.new('crc_test')
+      file.rewind
+
+      checksum = CfdpCrcChecksum.new
+
+      # For an empty file, mock the CRC to return a specific value
+      expect(checksum).to receive(:checksum).with(file, false).and_return(0)
+
+      # The check should pass when comparing with the same value
+      expect(checksum.check(file, 0, false)).to be true
+
+      file.close
+      file.unlink
+    end
+  end
+end