Class: OpenC3::GemModel

Inherits:
Object show all
Extended by:
Api
Defined in:
lib/openc3/models/gem_model.rb

Overview

This class acts like a Model but doesn’t inherit from Model because it doesn’t actual interact with the Store (Redis). Instead we implement names, get, put and destroy to allow interaction with gem files from the PluginModel and the GemsController.

Constant Summary collapse

@@bucket_initialized = 
false

Constants included from Api

Api::SUBSCRIPTION_DELIMITER

Constants included from ApiShared

ApiShared::DEFAULT_TLM_POLLING_RATE

Constants included from Extract

Extract::SCANNING_REGULAR_EXPRESSION

Class Method Summary collapse

Methods included from Api

_limits_group, _validate_tlm_type, build_cmd_output_string, cmd, cmd_implementation, cmd_no_checks, cmd_no_hazardous_check, cmd_no_range_check, cmd_raw, cmd_raw_no_checks, cmd_raw_no_hazardous_check, cmd_raw_no_range_check, connect_interface, connect_router, delete_config, disable_limits, disable_limits_group, disconnect_interface, disconnect_router, enable_limits, enable_limits_group, get_all_command_names, get_all_commands, get_all_interface_info, get_all_router_info, get_all_settings, get_all_target_info, get_all_telemetry, get_all_telemetry_names, get_cmd_buffer, get_cmd_cnt, get_cmd_cnts, get_cmd_hazardous, get_cmd_time, get_cmd_value, get_command, get_interface, get_interface_names, get_item, get_limits, get_limits_events, get_limits_groups, get_limits_set, get_limits_sets, get_oldest_logfile, get_out_of_limits, get_overall_limits_state, get_packet_derived_items, get_packets, get_parameter, get_router, get_router_names, get_saved_config, get_setting, get_settings, get_stale, get_target, get_target_list, get_telemetry, get_tlm_buffer, get_tlm_cnt, get_tlm_cnts, get_tlm_packet, get_tlm_values, inject_tlm, limits_enabled?, list_configs, list_settings, load_config, normalize_tlm, override_tlm, save_config, save_setting, send_raw, set_limits, set_limits_set, set_tlm, set_tlm_process_args, start_raw_logging_interface, start_raw_logging_router, stop_raw_logging_interface, stop_raw_logging_router, subscribe_packets, tlm, tlm_formatted, tlm_process_args, tlm_raw, tlm_variable, tlm_with_units

Class Method Details

.destroy(name) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/openc3/models/gem_model.rb', line 102

def self.destroy(name)
  rubys3_client = initialize_bucket()
  Logger.info "Removing gem: #{name}"
  rubys3_client.delete_object(bucket: 'gems', key: name)
  gem_name, version = self.extract_name_and_version(name)
  begin
    Gem::Uninstaller.new(gem_name, {:version => version, :force => true}).uninstall
  rescue => err
    message = "Gem file #{name} error uninstalling\n#{err.formatted}"
    Logger.error message
  end
end

.extract_name_and_version(name) ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/openc3/models/gem_model.rb', line 115

def self.extract_name_and_version(name)
  split_name = name.split('-')
  gem_name = split_name[0..-2].join('-')
  version = split_name[-1]
  return gem_name, version
end

.get(dir, name) ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/openc3/models/gem_model.rb', line 49

def self.get(dir, name)
  rubys3_client = initialize_bucket()
  path = File.join(dir, name)
  rubys3_client.get_object(bucket: 'gems', key: name, response_target: path)
  return path
end

.initialize_bucket ⇒ Object

private



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/openc3/models/gem_model.rb', line 124

def self.initialize_bucket
  rubys3_client = Aws::S3::Client.new
  unless @@bucket_initialized
    begin
      rubys3_client.head_bucket(bucket: 'gems')
    rescue Aws::S3::Errors::NotFound
      rubys3_client.create_bucket(bucket: 'gems')
    end
    @@bucket_initialized = true
  end
  return rubys3_client
end

.install(name_or_path, scope:) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/openc3/models/gem_model.rb', line 76

def self.install(name_or_path, scope:)
  temp_dir = Dir.mktmpdir
  begin
    if File.exist?(name_or_path)
      gem_file_path = name_or_path
    else
      gem_file_path = get(temp_dir, name_or_path)
    end
    begin
      rubygems_url = get_setting('rubygems_url', scope: scope)
    rescue
      # If Redis isn't running try the ENV, then simply rubygems.org
      rubygems_url = ENV['RUBYGEMS_URL']
      rubygems_url ||= 'https://rubygems.org'
    end
    Gem.sources = [rubygems_url] if rubygems_url
    Gem.done_installing_hooks.clear
    Gem.install(gem_file_path, "> 0.pre", :build_args => ['--no-document'], :prerelease => true)
  rescue => err
    message = "Gem file #{gem_file_path} error installing to /gems\n#{err.formatted}"
    Logger.error message
  ensure
    FileUtils.remove_entry(temp_dir) if temp_dir and File.exist?(temp_dir)
  end
end

.names ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'lib/openc3/models/gem_model.rb', line 40

def self.names
  rubys3_client = initialize_bucket()
  gems = []
  rubys3_client.list_objects(bucket: 'gems').contents.each do |object|
    gems << object.key
  end
  gems
end

.put(gem_file_path, gem_install: true, scope:) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/openc3/models/gem_model.rb', line 56

def self.put(gem_file_path, gem_install: true, scope:)
  rubys3_client = initialize_bucket()
  if File.file?(gem_file_path)
    gem_filename = File.basename(gem_file_path)
    Logger.info "Installing gem: #{gem_filename}"
    File.open(gem_file_path, 'rb') do |file|
      rubys3_client.put_object(bucket: 'gems', key: gem_filename, body: file)
    end
    if gem_install
      result = OpenC3::ProcessManager.instance.spawn(["ruby", "/openc3/bin/openc3cli", "geminstall", gem_filename], "gem_install", gem_filename, Time.now + 3600.0, scope: scope)
      return result
    end
  else
    message = "Gem file #{gem_file_path} does not exist!"
    Logger.error message
    raise message
  end
  return nil
end