openc3-cosmos-cfdp 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 254a8c3fa0ae6e2ec535bc5c565ad7e376706858dbd1a87e394a70998bca8a33
-  data.tar.gz: '08d510acfdb03663b4f3426dff1a6a9dbbeada23e0b1d0b5a3ea2160341b3ac8'
+  metadata.gz: 13e88f3556a631c2f165f5960429dea0b8ebe9d5f6984fc9de89fb1e1f4d3a74
+  data.tar.gz: e8a0e0b293c80d55508b3e1be3435eecb1d9de0e17127df7a5077c1fe7a53e2d
 SHA512:
-  metadata.gz: 3d93dd03e13bcae8c6fea52df4ad07320ab9097c5c3e9d2241c988682189d03edfcef9f274d7a02cde434d930dc0b9b3f851a82efa7d9b6d8dbd8e34e03c877f
-  data.tar.gz: 409424118dd69bd8ee1d14fdd88bc3fcc6759f4e4edb694aa94b2af3ffac387504a70a5167b6f6aef1c2d28ea0c932ab6395af9d261a3693fca03957cabde3f1
+  metadata.gz: c115f598a06588d99ef63ab97d6d85277472de273f8212af2f93b6972769cfc1faaa23303e1695d3ab77fadb206154578cd1410d5bf264b9c3e962c65e68ea2e
+  data.tar.gz: ed1b6971ceb621525768fe60f3a0c326bcd2e1ed59a310cd615d71e4788056bc7d23df0ee6b99000ebe1f19eddc974a5e8fc02413ec1e41f6b171f4855ada68a

data/README.md

@@ -109,18 +109,19 @@ Minimum required settings:
 
 ### Source Entity Configuration
 
-| Setting Name                    | Description                                                                                       | Allowed Values            | Default Value                   |
-| ------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------- | ------------------------------- |
-| root_path                       | The path to send/receive files from                                                               | Valid directory           | N/A - Must be given             |
-| bucket                          | The bucket to send/receive files from                                                             | Valid bucket Name         | nil - Serve from mounted volume |
-| source_entity_id                | The entity id for this CFDP microservice                                                          | Any integer               | N/A - Must be given             |
-| tlm_info                        | A target_name, packet_name, and item_name to receive PDUs. Multiple tlm_info options can be given | COSMOS packet information | N/A - Must be given             |
-| eof_sent_indication             | Issue EOF-Sent.indication                                                                         | true or false             | true                            |
-| eof_recv_indication             | Issue EOF-Recv.indication                                                                         | true or false             | true                            |
-| file_segment_recv_indication    | Issue File-Segment-Recv.indication                                                                | true or false             | true                            |
-| transaction_finished_indication | Issue Transaction-Finished.indication                                                             | true or false             | true                            |
-| suspended_indication            | Issue Suspended.indication                                                                        | true or false             | true                            |
-| resume_indication               | Issue Resume.indication                                                                           | true or false             | true                            |
+| Setting Name                    | Description                                                                                       | Allowed Values                      | Default Value                   |
+| ------------------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------- |
+| root_path                       | The path to send/receive files from                                                               | Valid directory                     | N/A - Must be given             |
+| bucket                          | The bucket to send/receive files from                                                             | Valid bucket Name                   | nil - Serve from mounted volume |
+| source_entity_id                | The entity id for this CFDP microservice                                                          | Any integer                         | N/A - Must be given             |
+| tlm_info                        | A target_name, packet_name, and item_name to receive PDUs. Multiple tlm_info options can be given | COSMOS packet information           | N/A - Must be given             |
+| eof_sent_indication             | Issue EOF-Sent.indication                                                                         | true or false                       | true                            |
+| eof_recv_indication             | Issue EOF-Recv.indication                                                                         | true or false                       | true                            |
+| file_segment_recv_indication    | Issue File-Segment-Recv.indication                                                                | true or false                       | true                            |
+| transaction_finished_indication | Issue Transaction-Finished.indication                                                             | true or false                       | true                            |
+| suspended_indication            | Issue Suspended.indication                                                                        | true or false                       | true                            |
+| resume_indication               | Issue Resume.indication                                                                           | true or false                       | true                            |
+| transaction_retain_seconds      | Time to keep completed transactions in seconds.                                                   | Floating point value greater than 0 | 86400                           |
 
 ### Remote Entity Configuration
 
@@ -150,6 +151,7 @@ Minimum required settings:
 | transaction_closure_requested | Default closure requested setting                                                                    | CLOSURE_REQUESTED or CLOSURE_NOT_REQUESTED                                                                                                                                                                                                                                                                                                                            | CLOSURE_REQUESTED         |
 | incomplete_file_disposition   | What to do with an incomplete file                                                                   | DISCARD or RETAIN                                                                                                                                                                                                                                                                                                                                                     | DISCARD                   |
 | fault_handler                 | Fault handler setting                                                                                | (ACK_LIMIT_REACHED, KEEP_ALIVE_LIMIT_REACHED, INVALID_TRANSMISSION_MODE, FILESTORE_REJECTION, FILE_CHECKSUM_FAILURE, FILE_SIZE_ERROR, NAK_LIMIT_REACHED, INACTIVITY_DETECTED, INVALID_FILE_STRUCTURE, CHECK_LIMIT_REACHED, or UNSUPPORTED_CHECKSUM_TYPE) followed by (ISSUE_NOTICE_OF_CANCELLATION, ISSUE_NOTICE_OF_SUSPENSION, IGNORE_ERROR, or ABANDON_TRANSACTION) | See Code                  |
+| cmd_delay                     | Delay after sending each PDU in seconds. Defaults to no delay.                                       | Floating point value greater than 0                                                                                                                                                                                                                                                                                                                                   | nil                       |
 
 ## Known Limitations
 

data/lib/cfdp_api.rb

@@ -23,25 +23,26 @@ require 'openc3/io/json_api'
 #
 # In ScriptRunner:
 # require 'cfdp_api'
-# api = CfdpApi.new
+# api = CfdpApi.new()
 # api.put(...)
 #
 # Outside cluster - Open Source:
-# require 'cfdp_api'
 # $openc3_scope = 'DEFAULT'
 # ENV['OPENC3_API_PASSWORD'] = 'password'
-# api = CfdpApi.new(hostname: '127.0.0.1', port: 2900)
+# require 'cfdp_api'
+# api = CfdpApi.new(url: "http://127.0.0.1:2900/cfdp")
 # api.put(...)
 #
 # Outside cluster - Enterprise
-# require 'cfdp_api'
 # $openc3_scope = 'DEFAULT'
-# ENV['OPENC3_KEYCLOAK_URL'] = '127.0.0.1:2900'
+# ENV['OPENC3_KEYCLOAK_URL'] = 'http://127.0.0.1:2900/auth'
 # ENV['OPENC3_API_USER'] = 'operator'
 # ENV['OPENC3_API_PASSWORD'] = 'operator'
-# api = CfdpApi.new(hostname: '127.0.0.1', port: 2900)
+# require 'cfdp_api'
+# api = CfdpApi.new(url: "http://127.0.0.1:2900/cfdp")
 # api.put(...)
 #
+
 class CfdpApi < OpenC3::JsonApi
   def put(
     destination_entity_id:,

data/microservices/CFDP/Gemfile

@@ -2,13 +2,13 @@ source ENV['RUBYGEMS_URL'] || "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '>= 7.0.0'
+gem 'rails', '~> 7.1.0'
 
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', '>= 1.9.3', require: false
 
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
-gem 'rack-cors', '>= 1.1'
+gem 'rack-cors', '~> 2.0'
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data'
@@ -21,7 +21,7 @@ group :development, :test do
 end
 
 group :test do
-  gem 'mock_redis'
+  gem 'mock_redis', '>0.39'
 end
 
 if ENV['OPENC3_DEVEL']

data/microservices/CFDP/app/controllers/cfdp_controller.rb

@@ -33,9 +33,9 @@ class CfdpController < ApplicationController
     transaction = $cfdp_user.start_source_transaction(params)
     render json: transaction.id
   rescue ActionController::ParameterMissing => error
-    render :json => { :status => 'error', :message => error.message }, :status => 400
+    render :json => { :status => 'error', :message => error.message }.as_json(:allow_nan => true), :status => 400
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   # Cancel.request (transaction ID)
@@ -46,10 +46,10 @@ class CfdpController < ApplicationController
     if transaction
       render json: transaction.id
     else
-      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   # Suspend.request (transaction ID)
@@ -60,10 +60,10 @@ class CfdpController < ApplicationController
     if transaction
       render json: transaction.id
     else
-      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   # Resume.request (transaction ID)
@@ -74,10 +74,10 @@ class CfdpController < ApplicationController
     if transaction
       render json: transaction.id
     else
-      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   # Report.request (transaction ID)
@@ -88,10 +88,10 @@ class CfdpController < ApplicationController
     if transaction
       render json: transaction.id
     else
-      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   def directory_listing
@@ -100,17 +100,17 @@ class CfdpController < ApplicationController
     transaction = $cfdp_user.start_directory_listing(params)
     render json: transaction.id
   rescue ActionController::ParameterMissing => error
-    render :json => { :status => 'error', :message => error.message }, :status => 400
+    render :json => { :status => 'error', :message => error.message }.as_json(:allow_nan => true), :status => 400
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   def subscribe
     return unless check_authorization()
     result = CfdpTopic.subscribe_indications
-    render json: result
+    render json: result.as_json(:allow_nan => true)
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   # Transaction.indication (transaction ID)
@@ -149,9 +149,9 @@ class CfdpController < ApplicationController
   def indications
     return unless check_authorization()
     result = CfdpTopic.read_indications(transaction_id: params[:transaction_id], continuation: params[:continuation], limit: params[:limit])
-    render json: result
+    render json: result.as_json(:allow_nan => true)
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   def transactions
@@ -166,9 +166,9 @@ class CfdpController < ApplicationController
       end
     end
     result = result.sort {|a, b| a.id <=> b.id}
-    render json: result
+    render json: result.as_json(:allow_nan => true)
   rescue => error
-    render :json => { :status => 'error', :message => error.message }, :status => 500
+    render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
 
   # private
@@ -179,14 +179,14 @@ class CfdpController < ApplicationController
 
     if params[:remote_entity_id]
       if params[:remote_entity_id].to_i.to_s != params[:remote_entity_id].to_s
-        render :json => { :status => 'error', :message => "remote_entity_id must be numeric" }, :status => 400
+        render :json => { :status => 'error', :message => "remote_entity_id must be numeric" }.as_json(:allow_nan => true), :status => 400
         return false
       end
       cmd_entity_id = Integer(params[:remote_entity_id])
       cmd_entity = CfdpMib.entity(cmd_entity_id)
     elsif params[:destination_entity_id]
       if params[:destination_entity_id].to_i.to_s != params[:destination_entity_id].to_s
-        render :json => { :status => 'error', :message => "destination_entity_id must be numeric" }, :status => 400
+        render :json => { :status => 'error', :message => "destination_entity_id must be numeric" }.as_json(:allow_nan => true), :status => 400
         return
       end
       cmd_entity_id = Integer(params[:destination_entity_id])
@@ -207,15 +207,16 @@ class CfdpController < ApplicationController
         # Caller must be able to send this command
         return false unless authorization('cmd', target_name: target_name, packet_name: packet_name)
       else
-        render :json => { :status => 'error', :message => "info not configured for entity: #{cmd_entity_id}" }, :status => 400
+        render :json => { :status => 'error', :message => "info not configured for entity: #{cmd_entity_id}" }.as_json(:allow_nan => true), :status => 400
         return false
       end
     else
-      render :json => { :status => 'error', :message => "Unknown entity: #{cmd_entity_id}" }, :status => 400
+      render :json => { :status => 'error', :message => "Unknown entity: #{cmd_entity_id}" }.as_json(:allow_nan => true), :status => 400
       return false
     end
 
     # Authorized
+    CfdpMib.cleanup_old_transactions()
     return true
   end
 

data/microservices/CFDP/app/models/cfdp_mib.rb

@@ -101,6 +101,7 @@ class CfdpMib
     'enable_keep_alive',
     'enable_finished',
     'enable_eof_nak',
+    'cmd_delay',
     'tlm_info',
     'eof_sent_indication',
     'eof_recv_indication',
@@ -108,7 +109,8 @@ class CfdpMib
     'transaction_finished_indication',
     'suspended_indication',
     'resume_indication',
-    'fault_handler'
+    'fault_handler',
+    'transaction_retain_seconds'
   ]
 
   @@source_entity_id = 0
@@ -184,6 +186,7 @@ class CfdpMib
     entity['enable_keep_alive'] = true
     entity['enable_finished'] = true
     entity['enable_eof_nak'] = false
+    entity['cmd_delay'] = nil
 
     # Local Entity Settings
     entity['tlm_info'] = []
@@ -205,6 +208,7 @@ class CfdpMib
     entity['fault_handler']["INVALID_FILE_STRUCTURE"] = "IGNORE_ERROR"
     entity['fault_handler']["CHECK_LIMIT_REACHED"] = "IGNORE_ERROR"
     entity['fault_handler']["UNSUPPORTED_CHECKSUM_TYPE"] = "IGNORE_ERROR"
+    entity['transaction_retain_seconds'] = 86400.0
 
     # TODO: Use interface connected? to limit opportunities?
     @@entities[entity_id] = entity
@@ -236,7 +240,7 @@ class CfdpMib
   def self.get_source_file(source_file_name)
     file_name = File.join(@@root_path, source_file_name)
     if self.bucket
-      file = Tempfile.new
+      file = Tempfile.new('cfdp', binmode: true)
       OpenC3::Bucket.getClient().get_object(bucket: self.bucket, key: file_name, path: file.path)
     else
       file = File.open(file_name, 'rb')
@@ -316,7 +320,7 @@ class CfdpMib
           elsif not client.check_object(bucket: self.bucket, key: first_file_name)
             status_code = "OLD_FILE_DOES_NOT_EXIST"
           else
-            temp = Tempfile.new
+            temp = Tempfile.new('cfdp', binmode: true)
             client.get_object(bucket: self.bucket, key: first_file_name, path: temp.path)
             client.put_object(bucket: self.bucket, key: second_file_name, body: temp.read)
             client.delete_object(bucket: self.bucket, key: first_file_name)
@@ -342,8 +346,8 @@ class CfdpMib
           elsif not client.check_object(bucket: self.bucket, key: second_file_name)
             status_code = "FILE_2_DOES_NOT_EXIST"
           else
-            temp1 = Tempfile.new
-            temp2 = Tempfile.new
+            temp1 = Tempfile.new('cfdp', binmode: true)
+            temp2 = Tempfile.new('cfdp', binmode: true)
             client.get_object(bucket: self.bucket, key: first_file_name, path: temp1.path)
             client.get_object(bucket: self.bucket, key: second_file_name, path: temp2.path)
             client.put_object(bucket: self.bucket, key: first_file_name, body: temp1.read + temp2.read)
@@ -372,7 +376,7 @@ class CfdpMib
           elsif not client.check_object(bucket: self.bucket, key: second_file_name)
             status_code = "FILE_2_DOES_NOT_EXIST"
           else
-            temp = Tempfile.new
+            temp = Tempfile.new('cfdp', binmode: true)
             client.get_object(bucket: self.bucket, key: second_file_name, path: temp.path)
             client.put_object(bucket: self.bucket, key: first_file_name, body: temp.read)
             temp.unlink
@@ -499,6 +503,13 @@ class CfdpMib
             else
               raise "Value for MIB setting #{field_name} must be a three part array of target_name, packet_name, item_name"
             end
+          when 'cmd_delay', 'transaction_retain_seconds'
+            value = Float(value)
+            if value >= 0
+              CfdpMib.set_entity_value(current_entity_id, field_name, value)
+            else
+              raise "Value for MIB setting #{field_name} must be greater than or equal to zero"
+            end
           when 'immediate_nak_mode', 'crcs_required', 'eof_sent_indication', 'eof_recv_indication', 'file_segment_recv_indication', 'transaction_finished_indication', 'suspended_indication', 'resume_indication',
             'enable_acks', 'enable_keep_alive', 'enable_finished', 'enable_eof_nak'
             value = OpenC3::ConfigParser.handle_true_false(value)
@@ -610,4 +621,18 @@ class CfdpMib
     @@root_path = "/"
     @@transactions = {}
   end
+
+  def self.cleanup_old_transactions
+    to_remove = []
+    current_time = Time.now.utc
+    transaction_retain_seconds = @@entities[@@source_entity_id]['transaction_retain_seconds']
+    @@transactions.each do |id, transaction|
+      if transaction.complete_time and (current_time - transaction.complete_time) > transaction_retain_seconds
+        to_remove << id
+      end
+    end
+    to_remove.each do |id|
+      @@transactions.delete(id)
+    end
+  end
 end

data/microservices/CFDP/app/models/cfdp_pdu.rb

@@ -30,6 +30,9 @@ require 'cfdp_pdu/cfdp_pdu_file_data'
 require 'cfdp_pdu/cfdp_pdu_user_ops'
 
 class CfdpPdu < OpenC3::Packet
+  DIRECTIVE_CODE_BYTE_SIZE = 1
+  CRC_BYTE_SIZE = 2
+
   def initialize(crcs_required:)
     super()
     append_item("VERSION", 3, :UINT)

data/microservices/CFDP/app/models/cfdp_receive_transaction.rb

@@ -80,7 +80,7 @@ class CfdpReceiveTransaction < CfdpTransaction
 
     if @source_file_name and @destination_file_name
       if complete_file_received?
-        @tmp_file ||= Tempfile.new('cfdp')
+        @tmp_file ||= Tempfile.new('cfdp', binmode: true)
 
         # Complete
         if @checksum.check(@tmp_file, @eof_pdu_hash['FILE_CHECKSUM'], @full_checksum_needed)
@@ -174,7 +174,7 @@ class CfdpReceiveTransaction < CfdpTransaction
           fault_location_entity_id: nil)
         cmd_params = {}
         cmd_params[item_name] = @finished_pdu
-        cmd(target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(source_entity, target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
       rescue => err
         abandon() if @state == "CANCELED"
         raise err
@@ -184,6 +184,7 @@ class CfdpReceiveTransaction < CfdpTransaction
 
     @state = "FINISHED" unless @state == "CANCELED" or @state == "ABANDONED"
     @transaction_status = "TERMINATED"
+    @complete_time = Time.now.utc
     OpenC3::Logger.info("CFDP Finished Receive Transaction #{@id}, #{@condition_code}", scope: ENV['OPENC3_SCOPE'])
 
     if CfdpMib.source_entity['transaction_finished_indication']
@@ -297,7 +298,7 @@ class CfdpReceiveTransaction < CfdpTransaction
             raise "cmd_info not defined for source entity: #{@metadata_pdu_hash['SOURCE_ENTITY_ID']}" unless target_name and packet_name and item_name
             cmd_params = {}
             cmd_params[item_name] = @finished_pdu
-            cmd(target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+            cfdp_cmd(source_entity, target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
             @finished_count += 1
             if @finished_count > CfdpMib.entity(@source_entity_id)['ack_timer_expiration_limit']
               # Positive ACK Limit Reached Fault
@@ -328,7 +329,7 @@ class CfdpReceiveTransaction < CfdpTransaction
       progress: @progress)
     cmd_params = {}
     cmd_params[item_name] = keep_alive_pdu
-    cmd(target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+    cfdp_cmd(source_entity, target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
   end
 
   def send_naks(force = false)
@@ -421,7 +422,7 @@ class CfdpReceiveTransaction < CfdpTransaction
         start_of_scope = end_of_scope
         cmd_params = {}
         cmd_params[item_name] = nak_pdu
-        cmd(target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(source_entity, target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
       end
       break if segment_requests.length <= 0
     end
@@ -520,7 +521,7 @@ class CfdpReceiveTransaction < CfdpTransaction
           transaction_status: "ACTIVE")
         cmd_params = {}
         cmd_params[item_name] = ack_pdu
-        cmd(target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(source_entity, target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
       end
 
       # Note: This also handles canceled
@@ -554,7 +555,7 @@ class CfdpReceiveTransaction < CfdpTransaction
     else # File Data
       @source_entity_id = @metadata_pdu_hash['SOURCE_ENTITY_ID']
 
-      @tmp_file ||= Tempfile.new('cfdp')
+      @tmp_file ||= Tempfile.new('cfdp', binmode: true)
       offset = pdu_hash['OFFSET']
       file_data = pdu_hash['FILE_DATA']
       progress = offset + file_data.length

data/microservices/CFDP/app/models/cfdp_source_transaction.rb

@@ -96,7 +96,7 @@ class CfdpSourceTransaction < CfdpTransaction
         # Resend eof pdu
         cmd_params = {}
         cmd_params[@item_name] = @eof_pdu
-        cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
         @eof_count += 1
         if @eof_count > @destination_entity['ack_timer_expiration_limit']
           # Positive ACK Limit Reached Fault
@@ -206,7 +206,7 @@ class CfdpSourceTransaction < CfdpTransaction
       transmission_mode: @transmission_mode)
     cmd_params = {}
     cmd_params[@item_name] = @metadata_pdu
-    cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+    cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
 
     if source_file
       checksum = get_checksum(@destination_entity['default_checksum_type'])
@@ -236,7 +236,7 @@ class CfdpSourceTransaction < CfdpTransaction
           transmission_mode: @transmission_mode)
         cmd_params = {}
         cmd_params[@item_name] = file_data_pdu
-        cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
         checksum.add(offset, file_data)
         offset += file_data.length
         @progress = offset
@@ -271,7 +271,7 @@ class CfdpSourceTransaction < CfdpTransaction
         canceling_entity_id: @canceling_entity_id)
       cmd_params = {}
       cmd_params[@item_name] = @eof_pdu
-      cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+      cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
     rescue => err
       abandon() if @canceling_entity_id
       raise err
@@ -327,6 +327,7 @@ class CfdpSourceTransaction < CfdpTransaction
     end
     @state = "FINISHED" unless @state == "CANCELED" or @state == "ABANDONED"
     @transaction_status = "TERMINATED"
+    @complete_time = Time.now.utc
     OpenC3::Logger.info("CFDP Finished Source Transaction #{@id}, #{@condition_code}", scope: ENV['OPENC3_SCOPE'])
 
     if CfdpMib.source_entity['transaction_finished_indication']
@@ -369,7 +370,7 @@ class CfdpSourceTransaction < CfdpTransaction
           transaction_status: @transaction_status)
         cmd_params = {}
         cmd_params[@item_name] = ack_pdu
-        cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
       end
 
     when "ACK"
@@ -412,7 +413,7 @@ class CfdpSourceTransaction < CfdpTransaction
         # Send Metadata PDU
         cmd_params = {}
         cmd_params[@item_name] = @metadata_pdu
-        cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+        cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
       else
         # Send File Data PDU(s)
         offset = start_offset
@@ -438,7 +439,7 @@ class CfdpSourceTransaction < CfdpTransaction
             transmission_mode: @transmission_mode)
           cmd_params = {}
           cmd_params[@item_name] = file_data_pdu
-          cmd(@target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+          cfdp_cmd(@destination_entity, @target_name, @packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
           offset += file_data.length
         end
       end

data/microservices/CFDP/app/models/cfdp_transaction.rb

@@ -37,6 +37,8 @@ class CfdpTransaction
   attr_reader :file_status
   attr_reader :metadata_pdu_hash
   attr_reader :metadata_pdu_count
+  attr_reader :create_time
+  attr_reader :complete_time
   attr_accessor :proxy_response_info
   attr_accessor :proxy_response_needed
 
@@ -59,10 +61,12 @@ class CfdpTransaction
     @proxy_response_needed = false
     @source_file_name = nil
     @destination_file_name = nil
+    @create_time = Time.now.utc
+    @complete_time = nil
   end
 
   def as_json(*args)
-    return {
+    result = {
       "id" => @id,
       "frozen" => @frozen,
       "state" => @state,
@@ -70,8 +74,11 @@ class CfdpTransaction
       "progress" => @progress,
       "condition_code" => @condition_code,
       "source_file_name" => @source_file_name,
-      "destination_file_name" => @destination_file_name
+      "destination_file_name" => @destination_file_name,
+      "create_time" => @create_time.iso8601(6)
     }
+    result["complete_time"] = @complete_time.iso8601(6) if @complete_time
+    return result
   end
 
   def suspend
@@ -104,6 +111,7 @@ class CfdpTransaction
       end
       @state = "CANCELED"
       @transaction_status = "TERMINATED"
+      @complete_time = Time.now.utc
     end
   end
 
@@ -113,6 +121,7 @@ class CfdpTransaction
       @state = "ABANDONED"
       @transaction_status = "TERMINATED"
       CfdpTopic.write_indication("Abandoned", transaction_id: @id, condition_code: @condition_code, progress: @progress)
+      @complete_time = Time.now.utc
     end
   end
 
@@ -185,4 +194,9 @@ class CfdpTransaction
       return nil
     end
   end
+
+  def cfdp_cmd(entity, target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+    cmd(target_name, packet_name, cmd_params, scope: ENV['OPENC3_SCOPE'])
+    sleep(entity['cmd_delay']) if entity['cmd_delay']
+  end
 end

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

@@ -35,9 +35,10 @@ class CfdpPdu < OpenC3::Packet
     transaction_status:)
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: 0, segmentation_control: segmentation_control)
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "ACK")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     if ack_directive_code == "FINISHED" or ack_directive_code == 5
       pdu.write("DIRECTION", "TOWARD_FILE_RECEIVER")
     else

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

@@ -39,9 +39,10 @@ class CfdpPdu < OpenC3::Packet
     canceling_entity_id: nil)
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: file_size, segmentation_control: segmentation_control)
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "EOF")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     pdu_contents = pdu.build_eof_pdu_contents(condition_code: condition_code, file_checksum: file_checksum, file_size: file_size, canceling_entity_id: canceling_entity_id)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)

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

@@ -43,7 +43,8 @@ class CfdpPdu < OpenC3::Packet
     segment_metadata: nil)
 
     pdu = build_initial_pdu(type: "FILE_DATA", destination_entity: destination_entity, file_size: file_size, segmentation_control: segmentation_control, transmission_mode: transmission_mode)
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'])
     pdu_header_part_2_length = pdu_header.length
     pdu_contents = pdu.build_file_data_pdu_contents(offset: offset, file_data: file_data, record_continuation_state: record_continuation_state, segment_metadata: segment_metadata)

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

@@ -41,9 +41,10 @@ class CfdpPdu < OpenC3::Packet
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: 0, segmentation_control: segmentation_control)
     pdu.write("DIRECTION", "TOWARD_FILE_SENDER")
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "FINISHED")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     pdu_contents = pdu.build_finished_pdu_contents(condition_code: condition_code, delivery_code: delivery_code, file_status: file_status, filestore_responses: filestore_responses, fault_location_entity_id: fault_location_entity_id)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)

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

@@ -32,9 +32,10 @@ class CfdpPdu < OpenC3::Packet
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: file_size, segmentation_control: segmentation_control)
     pdu.write("DIRECTION", "TOWARD_FILE_SENDER")
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "KEEP_ALIVE")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     pdu_contents = pdu.build_keep_alive_pdu_contents(progress: progress)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)

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

@@ -50,9 +50,10 @@ class CfdpPdu < OpenC3::Packet
     options: [])
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: file_size, segmentation_control: segmentation_control)
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "METADATA")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     if checksum_type_implemented(destination_entity['default_checksum_type'])
       checksum_type = destination_entity['default_checksum_type']
     else

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

@@ -44,9 +44,10 @@ class CfdpPdu < OpenC3::Packet
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: file_size, segmentation_control: segmentation_control)
     pdu.write("DIRECTION", "TOWARD_FILE_SENDER")
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "NAK")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     pdu_contents = pdu.build_nak_pdu_contents(start_of_scope: start_of_scope, end_of_scope: end_of_scope, segment_requests: segment_requests)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)

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

@@ -30,9 +30,10 @@ class CfdpPdu < OpenC3::Packet
     response_required:)
 
     pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: 0, segmentation_control: segmentation_control)
-    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data - Includes CRC if present
+    pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "PROMPT")
-    pdu_header_part_2_length = pdu_header.length
+    pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
     pdu_contents = pdu.build_prompt_pdu_contents(response_required: response_required)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)

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

@@ -53,6 +53,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 5 # PDU_DATA_LENGTH - Directive Code plus Ack Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 6 # ACK per Table 5-4

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

@@ -55,6 +55,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 12 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 4 # EOF per Table 5-4

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

@@ -56,6 +56,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 8 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # PDU Type
       expect((buffer[0].unpack('C')[0] >> 4) & 0x1).to eql 1 # File Data per Table 5-1

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

@@ -56,6 +56,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 4 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 5 # Finished per Table 5-4

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

@@ -53,6 +53,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 7 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 0x0C # Keep Alive per Table 5-4

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

@@ -56,6 +56,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 22 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 7 # Metadata per Table 5-4

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

@@ -55,6 +55,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 11 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 8 # NAK per Table 5-4

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

@@ -52,6 +52,7 @@ RSpec.describe CfdpPdu, type: :model do
 
       # By default the first 7 bytes are the header
       # This assumes 1 byte per entity ID and sequence number
+      expect(buffer[1..2].unpack('n')[0]).to eql 4 # PDU_DATA_LENGTH - Directive Code plus Data plus CRC
 
       # Directive Code
       expect(buffer[7].unpack('C')[0]).to eql 9 # Prompt per Table 5-4

data/microservices/CFDP/spec/requests/cfdp_spec.rb

@@ -1687,7 +1687,7 @@ module OpenC3
               expect(fsr['FIRST_FILE_NAME']).to eql 'another'
             end
             if ENV['MINIO'] && type == 'bucket'
-              file = Tempfile.new
+              file = Tempfile.new('cfdp', binmode: true)
               OpenC3::Bucket.getClient().get_object(bucket: @bucket, key: File.join(@root_path, 'first.txt'), path: file.path)
               expect(file.read).to eql 'FIRSTSECOND'
               file.unlink
@@ -1764,7 +1764,7 @@ module OpenC3
               expect(fsr['FIRST_FILE_NAME']).to eql 'another'
             end
             if ENV['MINIO'] && type == 'bucket'
-              file = Tempfile.new
+              file = Tempfile.new('cfdp', binmode: true)
               OpenC3::Bucket.getClient().get_object(bucket: @bucket, key: File.join(@root_path, 'orig.txt'), path: file.path)
               expect(file.read).to eql 'REPLACE'
               file.rewind

data/targets/CFDPTEST/procedures/cfdp_test_suite.rb

@@ -99,7 +99,7 @@ class CfdpTestGroup < OpenC3::Group
     data = "\x00" * 1000
 
     # small.bin
-    file = Tempfile.new('cfdp')
+    file = Tempfile.new('cfdp', binmode: true)
     1000.times do
       file.write(data)
     end
@@ -108,7 +108,7 @@ class CfdpTestGroup < OpenC3::Group
     file.unlink
 
     # medium.bin
-    file = Tempfile.new('cfdp')
+    file = Tempfile.new('cfdp', binmode: true)
     10000.times do
       file.write(data)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3-cosmos-cfdp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies: []
 description: "    This plugin provides COSMOS Support for CFDP\n"
 email:
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: OpenC3 COSMOS CFDP