cosmos 4.5.2 → 5.0.2.pre.beta2

data/README.md

@@ -1,120 +1,37 @@
-## Welcome to Ball Aerospace COSMOS
-
-> "The User Interface for Embedded Systems"
-
-[Documentation](http://cosmosrb.com)
-
-Ball Aerospace COSMOS provides all the functionality needed to send commands to and receive data from one or more embedded systems referred to as "targets". Out of the box functionality includes: Telemetry Display, Telemetry Graphing, Operational and Test Scripting, Command Sending, Logging, Log File Playback, Table Management, and more.
-
-So what can you use this for?  We use it to test about everything we create and COSMOS is great for automating any system of embedded systems. It can provide a fully featured user interface to any piece of hardware that provides an electronic way of communicating with it (TCP/IP, UDP, Serial, etc).  Potential uses range from testing embedded systems, to home automation, to verifying cell phones, to helping you make that next great thing that changes the world!  The sky is the limit...
-
-After configuring COSMOS to talk to your hardware, you immediately can use the following 15 tools:
-
-![COSMOS Architecture](data/COSMOS_Architecture.png)
-
-1. **Command and Telemetry Server**
-    * This is the heart of the realtime functionality within the Ball Aerospace COSMOS system.  It maintains realtime connections to each target in your system and is the single point for all outgoing commands and incoming telemetry packets.  By default, it logs all commands and telemetry sent/received for later review and analysis.  The Command and Telemetry Server also monitors limits on all telemetry packets received.
-
-1. **Replay**
-    * Replay masquerades as the Command and Telemetry Server but it sources telemetry packets from telemetry log files instead of realtime streams. VCR style controls are provided to move backwards and forwards through telemetry logs and play them back into the other COSMOS realtime tools.  Especially useful with Telemetry Viewer.  Cannot be used at the same time as the Command and Telemetry Server (at least on the same computer).
-
-1. **Limits Monitor**
-    * The Limits Monitor tool provides an overview of all telemetry points in the system that are currently out of limits.  It also maintains a log of limits changes and continues to display items that have gone out of limits even after they have been restored to green status.
-
-1. **Command Sender**
-    * Command Sender allows you to manually send one-off commands with conventient drop downs and descriptions of each command and command parameter.
-
-1. **Script Runner**
-    * Script Runner allows for running COSMOS test procedures or any other Ruby code from a graphical environment that highlights each line as it executes. At anytime during execution, the script can be paused or stopped. If a telemetry check fails or any other exception occurs, the script is immediately stopped and the user notified. Built-in code completion makes writing COSMOS scripts easy.
-
-1. **Test Runner**
-    * Operations and formal testing meet the unit test framework paradigm.   Test Runner allows you to break your operational or test procedures down into discreet test cases that each complete with either SUCCESS or FAILURE.  After running, a test report is automatically created for you.  Convenient features such as the ability to loop testing help get the kinks out of your system before formal runs.
-
-1. **Packet Viewer**
-    * Packet Viewer provide a simple key value list of each telemetry item in the system giving you full view of the most recent realtime value of any telemetry point.
-
-1. **Telemetry Viewer**
-    * Create custom organized telemetry screens using a wide variety of available telemetry widgets for display.  Provide exactly the views that your users need to see for each subsystem in you system.
-
-1. **Telemetry Grapher**
-    * Realtime and offline line graphing and x-y plotting of telemetry points.  Multiple telemetry points per plot, multiple plots per tab, and multiple tabs allow you to efficiently organize your data.  Great for graphing temperatures and voltages both in realtime and post-test.
-
-1. **Data Viewer**
-    * Sometimes data cannot be displayed effectively in telemety widgets or is not as useful without being able to scroll back through a history of values.  Data Viewer is used to provide a textual display of telemetry items and packets with scrollable history.  It provides a great display for log messages, events, memory dumps, and other forms of data that don't fit well into the other display options.
-
-1. **Telemetry Extractor**
-    * Used for offline analysis of telemetry log files.  Telemetry Extracts extracts a given list of telemetry items from a telemetry log file into a CSV file for further analysis in other tools such as Excel or Matlab.
-
-1. **Command Extractor**
-    * Used for offline analysis of command log files.  Takes binary command log files and converts them into human readable text.
-
-1. **Handbook Creator**
-    * Creates Command and Telemetry Handbooks using the information in the COSMOS configuration files in both HTML and PDF formats.  This provides a more human readable reference document to give to people who want to use a COSMOS system.
-
-1. **Table Manager**
-    * Table Manager provides a graphical binary file editor that provides a convenient method for creating and modifying binary configuration files/tables.
-
-1. **OpenGL Builder**
-    * OpenGL Builder helps in building 3d scenes of objects made of STL (stereolithography) files that can then be used within custom written COSMOS applications where they can be animated or change color based on telemetry.
-
-COSMOS is built and maintained by Ryan Melton (ryanatball/ryanmelt) and Jason Thomas (jmthomas) at Ball Aerospace & Technologies Corp.
-
-## Getting Started
-
-1. Install COSMOS at the command prompt if you haven't yet:
-
-        gem install cosmos
-
-   Note on non-windows systems you will need to have all necessary prerequisites installed (primarily cmake and qt 4.8.x). See the [Installation Guide](http://cosmosrb.com/docs/installation/) for detailed instructions.
-
-2. At the command prompt, create a new COSMOS project:
-
-        cosmos demo test
-
-   where "test" is the application name.
-
-3. Change directory to `test` and start the COSMOS Launcher:
-
-        cd test
-        ruby Launcher
-
-   Run with `--help` or `-h` for options.
-
-4. Click on the various tools to start experimenting with COSMOS!
-
-5. Follow the [Documentation](http://cosmosrb.com) to start developing your configuration.
-
-## Docker
-
-See our Docker documentation here:
-[COSMOS Docker Directions](https://github.com/BallAerospace/cosmos-docker)
-
-## Contributing
-
-We encourage you to contribute to COSMOS!
-
-Contributing is easy.
-
-1. Fork the project
-2. Create a feature branch
-3. Make your changes
-4. Submit a pull request
-
-Before any contributions can be incorporated we do require all contributors to sign a Contributor License Agreement here:
-[Contributor License Agreement](https://docs.google.com/forms/d/1ppnHUSXtY1GRTNPIyUaB1OYHbW5Ca67GFMgMRPBG8u0/viewform)
-
-This protects both you and us and you retain full rights to any code you write.
-
-## Vulnerability Disclosure
-
-If you discover a security vulnerability in COSMOS, please do not disclose to any public forum or our Github tickets system.  Please email the vulnerability details to COSMOS@ball.com, and give us 90 days to incorporate any needed changes. Also please also let us know how how you would like to be reffered to for attribution when we post the fix. Thanks!
-
-## Code Status
-
-* [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/gw61r3dvakjamx6o?svg=true)](https://ci.appveyor.com/project/jasonatball/cosmos)
-* [![Code Climate](https://codeclimate.com/github/BallAerospace/COSMOS/badges/gpa.svg)](https://codeclimate.com/github/BallAerospace/COSMOS)
-* [![Codecov](https://img.shields.io/codecov/c/github/codecov/example-python.svg)](https://codecov.io/gh/BallAerospace/COSMOS)
-
-## License
-
-Ball Aerospace COSMOS is released under the GPLv3.0 with a few addendums.   See [LICENSE.txt](LICENSE.txt)
+# COSMOS
+
+## Local gem install
+
+`cd C:\git\cosmos\cosmos`
+
+`rake build`
+
+## Local script install
+
+`set RUBYLIB=C:\git\cosmos\cosmos\lib`
+
+## Windows Environment variables
+```
+set COSMOS_REDIS_USERNAME=cosmos
+set COSMOS_REDIS_PASSWORD=cosmospassword
+set COSMOS_MINIO_USERNAME=cosmosminio
+set COSMOS_MINIO_PASSWORD=cosmosminiopassword
+set COSMOS_SERVICE_PASSWORD=cosmosservice
+set COSMOS_SR_REDIS_USERNAME=scriptrunner
+set COSMOS_SR_REDIS_PASSWORD=scriptrunnerpassword
+set COSMOS_SR_MINIO_USERNAME=scriptrunnerminio
+set COSMOS_SR_MINIO_PASSWORD=scriptrunnerminiopassword
+```
+
+## Linux Environment variables
+```
+COSMOS_REDIS_USERNAME=cosmos
+COSMOS_REDIS_PASSWORD=cosmospassword
+COSMOS_MINIO_USERNAME=cosmosminio
+COSMOS_MINIO_PASSWORD=cosmosminiopassword
+COSMOS_SERVICE_PASSWORD=cosmosservice
+COSMOS_SR_REDIS_USERNAME=scriptrunner
+COSMOS_SR_REDIS_PASSWORD=scriptrunnerpassword
+COSMOS_SR_MINIO_USERNAME=scriptrunnerminio
+COSMOS_SR_MINIO_PASSWORD=scriptrunnerminiopassword
+```

data/Rakefile

@@ -1,130 +1,43 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 Ball Aerospace & Technologies Corp.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
-
-require 'open3'
-
-# Cross-platform way of finding an executable in the $PATH.
 #
-#   which('ruby') #=> /usr/bin/ruby
-def which(cmd)
-  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-    exts.each { |ext|
-      exe = File.join(path, "#{cmd}#{ext}")
-      return exe if File.executable?(exe) && !File.directory?(exe)
-    }
-  end
-  return nil
-end
-
-# Pure Ruby CRC class to avoid circular dependency with c_cosmos
-class RakeCrc32
-  attr_reader :crc32_poly
-  attr_reader :crc32_seed
-  attr_reader :crc32_xor
-  attr_reader :crc32_table
-  attr_reader :crc32_raw_table
-
-  # Default Polynomial for 32-bit CRC
-  DEFAULT_CRC32_POLY = 0x04C11DB7
-
-  # Default Seed for 32-bit CRC
-  DEFAULT_CRC32_SEED = 0xFFFFFFFF
-
-  def initialize(crc32_poly = DEFAULT_CRC32_POLY, crc32_seed = DEFAULT_CRC32_SEED, crc32_xor = true)
-    @crc32_poly = crc32_poly
-    @crc32_seed = crc32_seed
-    @crc32_xor = crc32_xor
-    @crc32_table = []
-
-    (0..255).each do |index|
-      entry = compute_crc32_table_entry(index)
-      @crc32_table << entry
-    end
-  end
-
-  # Calculate a 32-bit CRC
-  def calc(data, seed = nil)
-    seed = @crc32_seed unless seed
-    crc  = seed
-    data.each_byte do |byte|
-      index = ((crc >> 24) ^ byte) & 0xFF
-      crc = ((crc << 8) ^ @crc32_table[index]) & 0xFFFFFFFF
-    end
-    if @crc32_xor
-      crc ^ 0xFFFFFFFF
-    else
-      crc
-    end
-  end
-
-  protected
-
-  # Compute a single entry in the 32-bit crc lookup table
-  def compute_crc32_table_entry(index)
-    crc = index << 24
-
-    8.times do
-      if ((crc & 0x80000000) != 0)
-        crc = (crc << 1) ^ @crc32_poly
-      else
-        crc = crc << 1
-      end
-    end
-
-    return (crc & 0xFFFFFFFF)
-  end
-
-end
+# 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.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
-require 'yard' if RUBY_ENGINE == 'ruby'
+require 'open3'
 
 # Import the rake tasks
-import 'tasks/manifest.rake'
 import 'tasks/spec.rake'
 import 'tasks/gemfile_stats.rake'
 
 # Update the built in task dependencies
 task :default => [:spec] # :test
 
-task :require_version do
-  unless ENV['VERSION']
-    puts "VERSION is required: rake <task> VERSION=X.X.X"
-    exit 1
-  end
-end
-
 task :devkit do
-  if RUBY_ENGINE == 'ruby'
-    if RUBY_PLATFORM[0..2] == 'x64'
-      if File.exist?("C:/msys64/mingw64")
-        ENV['RI_DEVKIT'] = "C:\\msys64"
-        ENV['MSYSTEM']="MINGW64"
-        ENV['PKG_CONFIG_PATH']="/mingw64/lib/pkgconfig:/mingw64/share/pkgconfig"
-        ENV['ACLOCAL_PATH']="/mingw64/share/aclocal:/usr/share/aclocal"
-        ENV['MANPATH']="/mingw64/share/man"
-        ENV['MINGW_PACKAGE_PREFIX']="mingw-w64-x86_64"
-        ENV['LANG']="en_US.UTF-8"
-        ENV['PATH'] = 'C:\\msys64\\mingw64\\bin;C:\\msys64\\usr\\bin;' + ENV['PATH']
-      end
-    else
-      if File.exist?("C:/msys64/mingw32")
-        ENV['RI_DEVKIT'] = "C:\\msys64"
-        ENV['MSYSTEM']="MINGW32"
-        ENV['PKG_CONFIG_PATH']="/mingw32/lib/pkgconfig:/mingw32/share/pkgconfig"
-        ENV['ACLOCAL_PATH']="/mingw32/share/aclocal:/usr/share/aclocal"
-        ENV['MANPATH']="/mingw32/share/man"
-        ENV['MINGW_PACKAGE_PREFIX']="mingw-w64-i686"
-        ENV['LANG']="en_US.UTF-8"
-        ENV['PATH'] = 'C:\\msys64\\mingw32\\bin;C:\\msys64\\usr\\bin;' + ENV['PATH']
-      end
+  if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i and RUBY_ENGINE == 'ruby'
+    msys64_path = File.expand_path(File.join(File.dirname(`where ruby`.split("\n")[0]), '..', 'msys64'))
+    if File.exist?(msys64_path)
+      ENV['RI_DEVKIT'] = msys64_path
+      ENV['MSYSTEM'] = "MINGW64"
+      ENV['PKG_CONFIG_PATH'] = "/mingw64/lib/pkgconfig"
+      ENV['ACLOCAL_PATH'] = "/mingw64/share/aclocal:/usr/share/aclocal"
+      ENV['MANPATH'] = "/mingw64/share/man"
+      ENV['MINGW_PACKAGE_PREFIX'] = "mingw-w64-x86_64"
+      ENV['LANG'] = "en_US.UTF-8"
+      ENV['PATH'] = "#{File.join(msys64_path, "mingw64", "bin").gsub("/", "\\")};#{File.join(msys64_path, "usr", "bin").gsub("/", "\\")};" + ENV['PATH']
     end
   end
 end
@@ -134,11 +47,10 @@ task :build => [:devkit] do
     _, platform, *_ = RUBY_PLATFORM.split("-")
     saved = Dir.pwd
     shared_extension = 'so'
-    shared_extension = 'bundle' if platform =~ /darwin/
+    shared_extension = 'bundle' if /darwin/.match?(platform)
 
     extensions = [
       'crc',
-      'low_fragmentation_array',
       'polynomial_conversion',
       'config_parser',
       'string',
@@ -146,10 +58,10 @@ task :build => [:devkit] do
       'cosmos_io',
       'tabbed_plots_config',
       'telemetry',
-      'line_graph',
       'packet',
       'platform',
-      'buffered_file']
+      'buffered_file'
+    ]
 
     extensions.each do |extension_name|
       Dir.chdir "ext/cosmos/ext/#{extension_name}"
@@ -169,75 +81,14 @@ task :build => [:devkit] do
   end
 end
 
-task :git_checkout do
-  system('git checkout cosmos4')
-end
-
-task :install_crc do
-  saved = Dir.pwd
-  Dir.chdir 'demo'
-  system('bundle exec rake crc_official')
-  Dir.chdir saved
-  saved = Dir.pwd
-  Dir.chdir 'install'
-  system('bundle exec rake crc_official')
-  Dir.chdir saved
-end
-
-task :gem => [:require_version] do
+task :gems do
   _, platform, *_ = RUBY_PLATFORM.split("-")
   if platform == 'mswin32' or platform == 'mingw32'
     raise "Building gem is not supported on Windows because file permissions are lost"
   end
-  system('gem build cosmos.gemspec')
-end
-
-task :commit_release_ticket => [:require_version, :git_checkout] do
-  system('git add data/crc.txt')
-  system('git add demo/config/data/crc.txt')
-  system('git add install/config/data/crc.txt')
-  system('git add lib/cosmos/version.rb')
-  system('git add Manifest.txt')
-  system("git commit -m \"Release COSMOS #{ENV['VERSION']}\"")
-  system("git push")
-end
-
-task :tag_release => [:require_version] do
-  system("git tag -a v#{ENV['VERSION']} -m \"COSMOS #{ENV['VERSION']}\"")
-  system("git push --tags")
-end
-
-task :version => [:require_version] do
-  puts "Getting the revision from git"
-  revision = `git rev-parse HEAD`.chomp
-
-  # Update cosmos_version.rb
-  version = ENV['VERSION'].dup
-  major,minor,patch = version.to_s.split('.')
-  File.open('lib/cosmos/version.rb', 'w') do |file|
-    file.puts "# encoding: ascii-8bit"
-    file.puts ""
-    file.puts "COSMOS_VERSION = '#{version}'"
-    file.puts "module Cosmos"
-    file.puts "  module Version"
-    file.puts "    MAJOR = '#{major}'"
-    file.puts "    MINOR = '#{minor}'"
-    file.puts "    PATCH = '#{patch}'"
-    file.puts "    BUILD = '#{revision}'"
-    file.puts "  end"
-    file.puts "  VERSION = '#{version}'"
-    file.puts "end"
-  end
-  puts "Successfully updated lib/cosmos/version.rb"
 
-  # Create the crc.txt file
-  crc = RakeCrc32.new
-  File.open("data/crc.txt",'w') do |file|
-    Dir[File.join('lib','**','*.rb')].sort.each do |filename|
-      file_data = File.open(filename, 'rb').read.gsub("\x0D\x0A", "\x0A")
-      file.puts "\"#{filename}\" #{sprintf("0x%08X", crc.calc(file_data))}"
-    end
-  end
+  system('gem build cosmos.gemspec')
+  system('gem build cosmosc2.gemspec')
 end
 
 task :metrics do
@@ -247,8 +98,6 @@ task :metrics do
   `flay lib > flay_report.txt`
   puts "\nRunning reek and creating reek_report.txt"
   `reek lib > reek_report.txt`
-  puts "\nRunning roodi and creating roodi_report.txt"
-  `roodi -config=roodi.yml lib > roodi_report.txt`
 end
 
 task :stress do
@@ -262,7 +111,7 @@ task :stress do
     output, status = Open3.capture2e("rspec #{spec_file}")
     if status.success?
       puts "  success (#{status}):"
-      #puts output
+      # puts output
       puts
     else
       puts "  error (#{status}):"
@@ -281,65 +130,3 @@ task :stress do
     puts "Success!"
   end
 end
-
-# Make all the main.sh files executable in the demo and install Mac applications
-task :mac_app_exec_bit do
-  %w(demo install).each do |root|
-    Dir["#{root}/tools/mac/**/Contents/MacOS/main.sh"].each do |main|
-      `git add --chmod=+x #{main}`
-    end
-  end
-end
-
-if RUBY_ENGINE == 'ruby'
-  YARD::Rake::YardocTask.new do |t|
-    t.options = ['--protected'] # See all options by typing 'yardoc --help'
-  end
-end
-
-task :release => [:require_version, :git_checkout, :build, :spec, :manifest, :version, :install_crc, :gem]
-task :commit_release => [:commit_release_ticket, :tag_release]
-
-# HOW-TO: Performing a COSMOS 4 build
-# 1. rake docker_build
-# 2. rake docker_run
-# 3. Follow the individual steps printed out
-# NOTE: When doing git push you will be asked for password
-#       You will need to enter a Github access token value
-#       Create one on Github, User -> Settings -> Developer settings -> Personal access tokens
-
-task :docker_build do
-  _, platform, *_ = RUBY_PLATFORM.split("-")
-  if (platform == 'mswin32' or platform == 'mingw32') and which('winpty')
-    system('winpty docker build --tag cosmos-dev .')
-  else
-    system('docker build --tag cosmos-dev .')
-  end
-end
-
-task :docker_run do
-  STDOUT.puts "Note, this is not automated on purpose to ensure each step is successful (with user entry of credentials for github/rubygems.org)"
-  STDOUT.puts "Steps to perform a COSMOS release:"
-  STDOUT.puts "1. git config --global user.name \"Last, First\""
-  STDOUT.puts "2. git config --global user.email \"me@ball.com\""
-  STDOUT.puts "3. git checkout cosmos4"
-  STDOUT.puts "4. git pull"
-  STDOUT.puts "5. export VERSION=X.X.X"
-  STDOUT.puts "6. rake release"
-  STDOUT.puts "7. rake commit_release"
-  STDOUT.puts "8. export PATH=/opt/jruby/bin:$PATH"
-  STDOUT.puts "9. rake gem"
-  STDOUT.puts "10a. /usr/bin/gem push cosmos-X.X.X.gem"
-  STDOUT.puts "10b. /usr/bin/gem push cosmos-X.X.X-java.gem"
-  STDOUT.puts "11. cd /devel/cosmos-docker"
-  STDOUT.puts "12. git pull"
-  STDOUT.puts "13. Update COSMOS_VERSION in all Dockerfiles. Also update README.md"
-  STDOUT.puts "14. git commit -a -m \"Release COSMOS vX.X.X\""
-  STDOUT.puts "15. git push"
-  STDOUT.puts "16. git checkout -b vX.X.X"
-  STDOUT.puts "17. git push --set-upstream origin vX.X.X"
-  STDOUT.puts "18. Update release notes on github.com and cosmosrb.com"
-  STDOUT.puts "    https://github.com/BallAerospace/COSMOS/pulls?q=is%3Apr+is%3Aclosed+base%3Acosmos4+no%3Amilestone"
-
-  system('docker run -it --rm cosmos-dev')
-end