openc3-cosmos-cfdp 1.0.0

data/microservices/CFDP/spec/spec_helper.rb

@@ -0,0 +1,200 @@
+# 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.
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+
+require 'openc3'
+
+# NOTE: You MUST require simplecov before anything else!
+if !ENV['OPENC3_NO_SIMPLECOV']
+  require 'simplecov'
+  if ENV['GITHUB_WORKFLOW']
+    require 'simplecov-cobertura'
+    SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+  else
+    SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+  end
+  SimpleCov.start do
+    merge_timeout 60 * 60 # merge the last hour of results
+    add_filter '/spec/' # no coverage on spec files
+    root = File.dirname(__FILE__)
+    root.to_s
+  end
+  SimpleCov.at_exit do
+    OpenC3.disable_warnings do
+      Encoding.default_external = Encoding::UTF_8
+      Encoding.default_internal = nil
+    end
+    SimpleCov.result.format!
+  end
+end
+
+# Disable Redis and Fluentd in the Logger
+ENV['OPENC3_NO_STORE'] = 'true'
+ENV['OPENC3_LOGS_BUCKET'] = 'logs'
+ENV['OPENC3_TOOLS_BUCKET'] = 'tools'
+ENV['OPENC3_CONFIG_BUCKET'] = 'config'
+ENV['OPENC3_REDIS_HOSTNAME'] = '127.0.0.1'
+ENV['OPENC3_REDIS_PORT'] = '6379'
+ENV['OPENC3_REDIS_EPHEMERAL_HOSTNAME'] = '127.0.0.1'
+ENV['OPENC3_REDIS_EPHEMERAL_PORT'] = '6380'
+# Set some usernames / passwords
+ENV['OPENC3_API_PASSWORD'] = 'openc3'
+ENV['OPENC3_SERVICE_PASSWORD'] = 'openc3service'
+ENV['OPENC3_REDIS_USERNAME'] = 'openc3'
+ENV['OPENC3_REDIS_PASSWORD'] = 'openc3password'
+ENV['OPENC3_BUCKET_USERNAME'] = 'openc3minio'
+ENV['OPENC3_BUCKET_PASSWORD'] = 'openc3miniopassword'
+ENV['OPENC3_SCOPE'] = 'DEFAULT'
+ENV['OPENC3_CLOUD'] = 'local'
+
+$openc3_scope = ENV['OPENC3_SCOPE']
+$openc3_token = ENV['OPENC3_API_PASSWORD']
+
+def mock_redis
+  require 'redis'
+  require 'mock_redis'
+  redis = MockRedis.new
+  allow(Redis).to receive(:new).and_return(redis)
+  OpenC3::Store.instance_variable_set(:@instance, nil)
+  OpenC3::EphemeralStore.instance_variable_set(:@instance, nil)
+  redis
+end
+
+# def setup_system(targets = %w[CFDPTEST])
+#   result = nil
+#   capture_io do |stdout|
+#     require 'openc3/system'
+#     dir = File.join(__dir__, 'targets')
+#     OpenC3::System.class_variable_set(:@@instance, nil)
+#     OpenC3::System.instance(targets, dir)
+#     result = stdout
+#   end
+#   result
+# end
+
+# def get_all_redis_keys
+#   cursor = 0
+#   keys = []
+#   loop do
+#     cursor, result = OpenC3::Store.scan(cursor)
+#     keys.concat(result)
+#     cursor = cursor.to_i # cursor is returned as a string
+#     break if cursor == 0
+#   end
+#   keys
+# end
+
+# Create a easy alias to the base of the spec directory
+SPEC_DIR = File.dirname(__FILE__)
+
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.before(:all) do
+    # Most tests want to disable authorization for simplicity
+    $openc3_authorize = false
+  end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/plugin.txt

@@ -0,0 +1,67 @@
+VARIABLE cfdp_microservice_name CFDP
+VARIABLE cfdp_route_prefix /cfdp
+VARIABLE cfdp_port 2905
+
+VARIABLE cfdp_cmd_target_name CFDP2
+VARIABLE cfdp_cmd_packet_name CFDP_PDU
+VARIABLE cfdp_cmd_item_name PDU
+
+VARIABLE cfdp_tlm_target_name CFDP2
+VARIABLE cfdp_tlm_packet_name CFDP_PDU
+VARIABLE cfdp_tlm_item_name PDU
+
+VARIABLE source_entity_id 1
+VARIABLE destination_entity_id 2
+VARIABLE root_path /DEFAULT/targets_modified/CFDP/tmp
+VARIABLE bucket config
+
+# Set to true to enable a test configuration
+VARIABLE plugin_test_mode "false"
+
+MICROSERVICE CFDP <%= cfdp_microservice_name %>
+  WORK_DIR .
+  ROUTE_PREFIX <%= cfdp_route_prefix %>
+  ENV OPENC3_ROUTE_PREFIX <%= cfdp_route_prefix %>
+  ENV SECRET_KEY_BASE 324973597349867207430793759437697498769349867349674
+  PORT <%= cfdp_port %>
+  CMD rails s -b 0.0.0.0 -p <%= cfdp_port %> -e production
+  # MIB Options Follow -
+  # You will need to modify these for your mission
+  OPTION source_entity_id <%= source_entity_id %>
+  OPTION tlm_info <%= cfdp_tlm_target_name %> <%= cfdp_tlm_packet_name %> <%= cfdp_tlm_item_name %>
+  OPTION destination_entity_id <%= destination_entity_id %>
+  OPTION cmd_info <%= cfdp_cmd_target_name %> <%= cfdp_cmd_packet_name %> <%= cfdp_cmd_item_name %>
+  OPTION root_path <%= root_path %>
+  <% if bucket.to_s.strip != '' %>
+    OPTION bucket <%= bucket %>
+  <% end %>
+
+<% include_test = (plugin_test_mode.to_s.strip.downcase == "true") %>
+<% if include_test %>
+  TARGET CFDPTEST CFDP
+  TARGET CFDPTEST CFDP2
+
+  MICROSERVICE CFDP CFDP2
+    WORK_DIR .
+    ROUTE_PREFIX /cfdp2
+    ENV OPENC3_ROUTE_PREFIX /cfdp2
+    ENV SECRET_KEY_BASE 324973597349867207430793759437697498769349867349674
+    PORT 2906
+    CMD rails s -b 0.0.0.0 -p 2906 -e production
+    OPTION source_entity_id <%= destination_entity_id %>
+    OPTION tlm_info CFDP CFDP_PDU PDU
+    OPTION destination_entity_id <%= source_entity_id %>
+    OPTION cmd_info CFDP CFDP_PDU PDU
+    OPTION root_path <%= root_path %>
+    <% if bucket.to_s.strip != '' %>
+      OPTION bucket <%= bucket %>
+    <% end %>
+
+  <% test_host = ENV['KUBERNETES_SERVICE_HOST'] ? (scope.to_s.downcase + "-interface-cfdp2-int-service") : "openc3-operator" %>
+  INTERFACE CFDP_INT tcpip_client_interface.rb <%= test_host %> 2907 2907 10.0 nil LENGTH 0 32 4 1 BIG_ENDIAN 0 nil nil true
+    MAP_TARGET CFDP
+
+  INTERFACE CFDP2_INT tcpip_server_interface.rb 2907 2907 10.0 nil LENGTH 0 32 4 1 BIG_ENDIAN 0 nil nil true
+    PORT 2907
+    MAP_TARGET CFDP2
+<% end %>

data/targets/CFDPTEST/cmd_tlm/cmd.txt

@@ -0,0 +1,5 @@
+COMMAND <%= target_name %> CFDP_PDU BIG_ENDIAN "Example wrapper command containing a PDU"
+  DISABLE_MESSAGES
+  APPEND_PARAMETER LENGTH 32 UINT MIN MAX 0
+  APPEND_PARAMETER ID 32 UINT 1 1 1
+  APPEND_PARAMETER PDU 0 BLOCK ""

data/targets/CFDPTEST/cmd_tlm/tlm.txt

@@ -0,0 +1,4 @@
+TELEMETRY <%= target_name %> CFDP_PDU BIG_ENDIAN "Example wrapper telemetry packet containing a PDU"
+  APPEND_ITEM LENGTH 32 UINT
+  APPEND_ITEM ID 32 UINT 1
+  APPEND_ITEM PDU 0 BLOCK ""

data/targets/CFDPTEST/procedures/cfdp_test_suite.rb

@@ -0,0 +1,130 @@
+require 'openc3/script/suite.rb'
+require 'cfdp'
+require 'tempfile'
+
+# Group class name should indicate what the scripts are testing
+class CfdpTestGroup < OpenC3::Group
+  def test_standard_ops
+    set_line_delay(0)
+
+    # Simple put and wait for complete
+    cfdp_put(destination_entity_id: 2, source_file_name: 'small.bin', destination_file_name: 'small2.bin', transmission_mode: "ACKNOWLEDGED")
+
+    # Start and cancel
+    transaction_id = cfdp_put(destination_entity_id: 2, source_file_name: 'medium.bin', destination_file_name: 'medium2.bin', transmission_mode: "ACKNOWLEDGED", timeout: nil)
+    wait(1)
+    cfdp_cancel(transaction_id: transaction_id)
+
+    # Longer put and interact while running
+    continuation = cfdp_subscribe()
+    transaction_id = cfdp_put(destination_entity_id: 2, source_file_name: 'medium.bin', destination_file_name: 'medium2.bin', transmission_mode: "ACKNOWLEDGED", timeout: nil)
+    wait(1)
+    puts cfdp_suspend(transaction_id: transaction_id)
+    wait(1)
+    puts cfdp_report(transaction_id: transaction_id)
+    wait(1)
+    puts cfdp_transactions()
+    wait(1)
+    puts cfdp_resume(transaction_id: transaction_id)
+    # Watch the transaction progress
+    set_line_delay(0.1)
+    done = false
+    while true
+      indications, continuation = cfdp_indications(continuation: continuation)
+      indications.each do |indication|
+        puts indication.inspect
+        if indication['indication_type'] == 'Transaction-Finished'
+          done = true
+          break
+        end
+      end
+      #puts cfdp_report(transaction_id: transaction_id)
+      puts cfdp_transactions().inspect
+      break if done
+    end
+  end
+
+  def test_proxy_ops
+    set_line_delay(0)
+
+    # Simple proxy put and wait for complete
+    cfdp_put(remote_entity_id: 2, destination_entity_id: 1, source_file_name: 'small.bin', destination_file_name: 'small2.bin', transmission_mode: "ACKNOWLEDGED")
+
+    # Start and cancel
+    transaction_id = cfdp_put(remote_entity_id: 2, destination_entity_id: 1, source_file_name: 'medium.bin', destination_file_name: 'medium2.bin', transmission_mode: "ACKNOWLEDGED", timeout: nil)
+    wait(1)
+    cfdp_cancel(remote_entity_id: 2, transaction_id: transaction_id)
+
+    puts cfdp_transactions(microservice_name: 'CFDP2', prefix: '/cfdp2', port: 2906)
+
+    # Longer proxy put and interact while running
+    continuation = cfdp_subscribe()
+    source_transaction_id = cfdp_put(remote_entity_id: 2, destination_entity_id: 1, source_file_name: 'medium.bin', destination_file_name: 'medium2.bin', transmission_mode: "ACKNOWLEDGED", timeout: nil)
+    wait(1)
+
+    # Get the most recent transaction id from the other entity and assume that is the right one...
+    # The CFDP spec is lacking here
+    transactions = cfdp_transactions(microservice_name: 'CFDP2', prefix: '/cfdp2', port: 2906)
+    transaction_id = transactions[-1]['id']
+    puts cfdp_suspend(remote_entity_id: 2, transaction_id: transaction_id)
+    wait(1)
+    puts cfdp_report(remote_entity_id: 2, transaction_id: transaction_id, report_file_name: "myreport.txt")
+    wait(1)
+    puts cfdp_transactions(microservice_name: 'CFDP2', prefix: '/cfdp2', port: 2906)
+    wait(1)
+    puts cfdp_resume(remote_entity_id: 2, transaction_id: transaction_id)
+    # Watch the transaction progress
+    set_line_delay(0)
+    done = false
+    while true
+      indications, continuation = cfdp_indications(continuation: continuation)
+      indications.each do |indication|
+        puts indication.inspect unless indication['indication_type'] == 'File-Segment-Recv'
+        if indication['indication_type'] == 'Proxy-Put-Response' and indication['transaction_id'] == source_transaction_id
+          done = true
+          break
+        end
+      end
+      wait(0.1)
+      #puts cfdp_report(transaction_id: transaction_id)
+      puts cfdp_transactions(microservice_name: 'CFDP2', prefix: '/cfdp2', port: 2906)
+      break if done
+    end
+  end
+
+  def setup
+    set_line_delay(0)
+
+    # Create test files
+    data = "\x00" * 1000
+
+    # small.bin
+    file = Tempfile.new('cfdp')
+    1000.times do
+      file.write(data)
+    end
+    file.rewind
+    put_target_file("/CFDP/tmp/small.bin", file)
+    file.unlink
+
+    # medium.bin
+    file = Tempfile.new('cfdp')
+    10000.times do
+      file.write(data)
+    end
+    file.rewind
+    put_target_file("/CFDP/tmp/medium.bin", file)
+    file.unlink
+  end
+
+  def teardown
+    delete_target_file("/CFDP/tmp/small.bin")
+    delete_target_file("/CFDP/tmp/medium.bin")
+  end
+end
+
+class CfdpTestSuite < OpenC3::Suite
+  def initialize
+    add_group('CfdpTestGroup')
+  end
+end

data/targets/CFDPTEST/target.txt

@@ -0,0 +1,4 @@
+IGNORE_ITEM LENGTH
+IGNORE_ITEM ID
+IGNORE_PARAMETER LENGTH
+IGNORE_PARAMETER ID

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: openc3-cosmos-cfdp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Melton
+- Jason Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-15 00:00:00.000000000 Z
+dependencies: []
+description: "    This plugin provides COSMOS Support for CFDP\n"
+email:
+- ryan@openc3.com
+- jason@openc3.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cfdp.rb
+- lib/cfdp_api.rb
+- microservices/CFDP/Gemfile
+- microservices/CFDP/Rakefile
+- microservices/CFDP/app/controllers/application_controller.rb
+- microservices/CFDP/app/controllers/cfdp_controller.rb
+- microservices/CFDP/app/models/cfdp_checksum.rb
+- microservices/CFDP/app/models/cfdp_crc_checksum.rb
+- microservices/CFDP/app/models/cfdp_mib.rb
+- microservices/CFDP/app/models/cfdp_model.rb
+- microservices/CFDP/app/models/cfdp_null_checksum.rb
+- microservices/CFDP/app/models/cfdp_pdu.rb
+- microservices/CFDP/app/models/cfdp_receive_transaction.rb
+- microservices/CFDP/app/models/cfdp_source_transaction.rb
+- microservices/CFDP/app/models/cfdp_topic.rb
+- microservices/CFDP/app/models/cfdp_transaction.rb
+- microservices/CFDP/app/models/cfdp_user.rb
+- microservices/CFDP/bin/rails
+- microservices/CFDP/bin/rake
+- microservices/CFDP/bin/setup
+- microservices/CFDP/config.ru
+- microservices/CFDP/config/application.rb
+- microservices/CFDP/config/boot.rb
+- microservices/CFDP/config/credentials.yml.enc
+- microservices/CFDP/config/environment.rb
+- microservices/CFDP/config/environments/development.rb
+- microservices/CFDP/config/environments/production.rb
+- microservices/CFDP/config/environments/test.rb
+- microservices/CFDP/config/initializers/application_controller_renderer.rb
+- microservices/CFDP/config/initializers/backtrace_silencers.rb
+- microservices/CFDP/config/initializers/cfdp_initializer.rb
+- microservices/CFDP/config/initializers/cors.rb
+- microservices/CFDP/config/initializers/filter_parameter_logging.rb
+- microservices/CFDP/config/initializers/inflections.rb
+- microservices/CFDP/config/initializers/mime_types.rb
+- microservices/CFDP/config/initializers/wrap_parameters.rb
+- microservices/CFDP/config/locales/en.yml
+- microservices/CFDP/config/puma.rb
+- microservices/CFDP/config/routes.rb
+- microservices/CFDP/init.sh
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_ack.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_enum.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_eof.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_file_data.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_finished.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_keep_alive.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_metadata.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_nak.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_prompt.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_tlv.rb
+- microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_user_ops.rb
+- microservices/CFDP/public/robots.txt
+- microservices/CFDP/spec/models/cfdp_pdu_ack_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_eof_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_file_data_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_finished_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_keep_alive_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_metadata_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_nak_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_prompt_spec.rb
+- microservices/CFDP/spec/models/cfdp_pdu_spec.rb
+- microservices/CFDP/spec/rails_helper.rb
+- microservices/CFDP/spec/requests/cfdp_spec.rb
+- microservices/CFDP/spec/spec_helper.rb
+- plugin.txt
+- targets/CFDPTEST/cmd_tlm/cmd.txt
+- targets/CFDPTEST/cmd_tlm/tlm.txt
+- targets/CFDPTEST/procedures/cfdp_test_suite.rb
+- targets/CFDPTEST/target.txt
+homepage: https://github.com/OpenC3/openc3
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- microservices/CFDP/app/models
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: OpenC3 COSMOS CFDP
+test_files: []