openc3-cosmos-cfdp 1.0.2 → 2.0.0

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

@@ -0,0 +1,331 @@
+# 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'
+
+RSpec.describe CfdpTransaction do
+  before(:each) do
+    # Mock CfdpTopic
+    allow(CfdpTopic).to receive(:write_indication)
+
+    # Mock CfdpMib
+    @source_entity = {
+      'id' => 1,
+      'name' => 'SOURCE',
+      'fault_handler' => {
+        'NO_ERROR' => 'IGNORE_ERROR',
+        'FILESTORE_REJECTION' => 'ISSUE_NOTICE_OF_CANCELLATION',
+        'FILE_CHECKSUM_FAILURE' => 'ISSUE_NOTICE_OF_SUSPENSION',
+        'FILE_SIZE_ERROR' => 'ABANDON_TRANSACTION',
+        'CHECK_LIMIT_REACHED' => 'IGNORE_ERROR'
+      },
+      'suspended_indication' => true,
+      'resume_indication' => true,
+      'keep_alive_interval' => 5
+    }
+
+    allow(CfdpMib).to receive(:source_entity).and_return(@source_entity)
+
+    # Mock logging
+    allow(OpenC3::Logger).to receive(:info)
+    allow(OpenC3::Logger).to receive(:error)
+
+    # Mock Api module
+    allow_any_instance_of(CfdpTransaction).to receive(:cmd)
+
+    ENV['OPENC3_SCOPE'] = 'DEFAULT'
+  end
+
+  describe "initialize" do
+    it "initializes with default values" do
+      transaction = CfdpTransaction.new
+
+      expect(transaction.frozen).to be false
+      expect(transaction.state).to eq("ACTIVE")
+      expect(transaction.transaction_status).to eq("ACTIVE")
+      expect(transaction.progress).to eq(0)
+      expect(transaction.condition_code).to eq("NO_ERROR")
+      expect(transaction.delivery_code).to be_nil
+      expect(transaction.instance_variable_get(:@metadata_pdu_hash)).to be_nil
+      expect(transaction.instance_variable_get(:@metadata_pdu_count)).to eq(0)
+      expect(transaction.proxy_response_info).to be_nil
+      expect(transaction.proxy_response_needed).to be false
+      expect(transaction.instance_variable_get(:@source_file_name)).to be_nil
+      expect(transaction.instance_variable_get(:@destination_file_name)).to be_nil
+      expect(transaction.create_time).to be_a(Time)
+      expect(transaction.complete_time).to be_nil
+    end
+  end
+
+  describe "class methods" do
+    it "builds a transaction id" do
+      id = CfdpTransaction.build_transaction_id(1, 123)
+      expect(id).to eq("1__123")
+    end
+  end
+
+  describe "instance methods" do
+    let(:transaction) { CfdpTransaction.new }
+
+    describe "suspend" do
+      it "suspends an active transaction" do
+        transaction.suspend
+
+        expect(transaction.state).to eq("SUSPENDED")
+        expect(transaction.condition_code).to eq("SUSPEND_REQUEST_RECEIVED")
+        expect(CfdpTopic).to have_received(:write_indication).with("Suspended", hash_including(transaction_id: nil, condition_code: "SUSPEND_REQUEST_RECEIVED"))
+      end
+
+      it "does nothing if transaction is not active" do
+        transaction.instance_variable_set(:@state, "FINISHED")
+        transaction.suspend
+
+        expect(transaction.state).to eq("FINISHED")
+      end
+    end
+
+    describe "resume" do
+      it "resumes a suspended transaction" do
+        transaction.instance_variable_set(:@state, "SUSPENDED")
+        transaction.resume
+
+        expect(transaction.state).to eq("ACTIVE")
+        expect(transaction.condition_code).to eq("NO_ERROR")
+        expect(CfdpTopic).to have_received(:write_indication).with("Resumed", hash_including(transaction_id: nil, progress: 0))
+      end
+
+      it "does nothing if transaction is not suspended" do
+        transaction.resume
+
+        expect(transaction.state).to eq("ACTIVE")
+        expect(CfdpTopic).not_to have_received(:write_indication).with("Resumed", any_args)
+      end
+    end
+
+    describe "cancel" do
+      it "cancels an active transaction" do
+        transaction.cancel
+
+        expect(transaction.state).to eq("CANCELED")
+        expect(transaction.transaction_status).to eq("TERMINATED")
+        expect(transaction.condition_code).to eq("CANCEL_REQUEST_RECEIVED")
+        expect(transaction.complete_time).to be_a(Time)
+      end
+
+      it "cancels with a canceling entity id" do
+        transaction.cancel(3)
+
+        expect(transaction.state).to eq("CANCELED")
+        expect(transaction.instance_variable_get(:@canceling_entity_id)).to eq(3)
+      end
+
+      it "does nothing if transaction is already finished" do
+        transaction.instance_variable_set(:@state, "FINISHED")
+        original_time = Time.now.utc - 10
+        transaction.instance_variable_set(:@complete_time, original_time)
+
+        transaction.cancel
+
+        expect(transaction.state).to eq("FINISHED")
+        expect(transaction.complete_time).to eq(original_time)
+      end
+    end
+
+    describe "abandon" do
+      it "abandons an active transaction" do
+        transaction.abandon
+
+        expect(transaction.state).to eq("ABANDONED")
+        expect(transaction.transaction_status).to eq("TERMINATED")
+        expect(CfdpTopic).to have_received(:write_indication).with("Abandoned", hash_including(transaction_id: nil, condition_code: "NO_ERROR", progress: 0))
+        expect(transaction.complete_time).to be_a(Time)
+      end
+
+      it "does nothing if transaction is already finished" do
+        transaction.instance_variable_set(:@state, "FINISHED")
+        original_time = Time.now.utc - 10
+        transaction.instance_variable_set(:@complete_time, original_time)
+
+        transaction.abandon
+
+        expect(transaction.state).to eq("FINISHED")
+        expect(transaction.complete_time).to eq(original_time)
+      end
+    end
+
+    describe "report" do
+      it "sends a report indication" do
+        transaction.report
+
+        expect(CfdpTopic).to have_received(:write_indication).with("Report", hash_including(transaction_id: nil))
+      end
+    end
+
+    describe "freeze and unfreeze" do
+      it "freezes the transaction" do
+        transaction.freeze
+        expect(transaction.instance_variable_get(:@freeze)).to be true
+      end
+
+      it "unfreezes the transaction" do
+        transaction.instance_variable_set(:@freeze, true)
+        transaction.unfreeze
+        expect(transaction.instance_variable_get(:@freeze)).to be false
+      end
+    end
+
+    describe "build_report" do
+      it "generates a JSON report" do
+        transaction.instance_variable_set(:@id, "1__123")
+        report = transaction.build_report
+
+        expect(report).to be_a(String)
+
+        # Parse and verify JSON structure
+        json = JSON.parse(report)
+        expect(json["id"]).to eq("1__123")
+        expect(json["state"]).to eq("ACTIVE")
+        expect(json["transaction_status"]).to eq("ACTIVE")
+        expect(json["progress"]).to eq(0)
+        expect(json["frozen"]).to be false
+      end
+    end
+
+    describe "as_json" do
+      it "returns a hash representation of the transaction" do
+        transaction.instance_variable_set(:@id, "1__123")
+        transaction.instance_variable_set(:@source_file_name, "source.txt")
+        transaction.instance_variable_set(:@destination_file_name, "dest.txt")
+
+        json = transaction.as_json
+
+        expect(json).to be_a(Hash)
+        expect(json["id"]).to eq("1__123")
+        expect(json["state"]).to eq("ACTIVE")
+        expect(json["source_file_name"]).to eq("source.txt")
+        expect(json["destination_file_name"]).to eq("dest.txt")
+        expect(json["create_time"]).to be_a(String)
+        expect(json["complete_time"]).to be_nil
+      end
+
+      it "includes complete_time when available" do
+        transaction.instance_variable_set(:@complete_time, Time.now.utc)
+
+        json = transaction.as_json
+
+        expect(json["complete_time"]).to be_a(String)
+      end
+    end
+
+    describe "handle_fault" do
+      it "handles ISSUE_NOTICE_OF_CANCELLATION response" do
+        transaction.instance_variable_set(:@condition_code, "FILESTORE_REJECTION")
+
+        expect(transaction).to receive(:cancel)
+        transaction.handle_fault
+      end
+
+      it "handles ISSUE_NOTICE_OF_SUSPENSION response" do
+        transaction.instance_variable_set(:@condition_code, "FILE_CHECKSUM_FAILURE")
+
+        expect(transaction).to receive(:suspend)
+        transaction.handle_fault
+      end
+
+      it "handles ABANDON_TRANSACTION response" do
+        transaction.instance_variable_set(:@condition_code, "FILE_SIZE_ERROR")
+
+        expect(transaction).to receive(:abandon)
+        transaction.handle_fault
+      end
+
+      it "handles IGNORE_ERROR response" do
+        transaction.instance_variable_set(:@condition_code, "CHECK_LIMIT_REACHED")
+
+        expect(transaction).to receive(:ignore_fault)
+        transaction.handle_fault
+      end
+
+      it "uses fault handler overrides" do
+        transaction.instance_variable_set(:@condition_code, "CHECK_LIMIT_REACHED")
+        transaction.instance_variable_set(:@fault_handler_overrides, {"CHECK_LIMIT_REACHED" => "ISSUE_NOTICE_OF_CANCELLATION"})
+
+        expect(transaction).to receive(:cancel)
+        transaction.handle_fault
+      end
+    end
+
+    describe "ignore_fault" do
+      it "sends a fault indication" do
+        transaction.instance_variable_set(:@condition_code, "FILE_SIZE_ERROR")
+
+        transaction.ignore_fault
+
+        expect(CfdpTopic).to have_received(:write_indication).with("Fault", hash_including(transaction_id: nil, condition_code: "FILE_SIZE_ERROR", progress: 0))
+      end
+    end
+
+    describe "get_checksum" do
+      it "returns a CfdpChecksum for type 0" do
+        checksum = transaction.get_checksum(0)
+        expect(checksum).to be_a(CfdpChecksum)
+      end
+
+      it "returns a CfdpCrcChecksum for type 1" do
+        checksum = transaction.get_checksum(1)
+        expect(checksum).to be_a(CfdpCrcChecksum)
+      end
+
+      it "returns a CfdpCrcChecksum for type 2" do
+        checksum = transaction.get_checksum(2)
+        expect(checksum).to be_a(CfdpCrcChecksum)
+      end
+
+      it "returns a CfdpCrcChecksum for type 3" do
+        checksum = transaction.get_checksum(3)
+        expect(checksum).to be_a(CfdpCrcChecksum)
+      end
+
+      it "returns a CfdpNullChecksum for type 15" do
+        checksum = transaction.get_checksum(15)
+        expect(checksum).to be_a(CfdpNullChecksum)
+      end
+
+      it "returns nil for unknown checksum types" do
+        checksum = transaction.get_checksum(10)
+        expect(checksum).to be_nil
+      end
+    end
+
+    describe "cfdp_cmd" do
+      it "sends a command with the correct parameters" do
+        entity = {'cmd_delay' => 0.1}
+
+        expect(transaction).to receive(:cmd).with('TARGET', 'PACKET', {'PARAM' => 'value'}, scope: 'DEFAULT')
+
+        transaction.cfdp_cmd(entity, 'TARGET', 'PACKET', {'PARAM' => 'value'}, scope: 'DEFAULT')
+      end
+    end
+
+    describe "update" do
+      it "does nothing in the base class" do
+        # Just verifying it doesn't raise an error
+        transaction.update
+      end
+    end
+  end
+end