Class: RemoteExecutionFeature

Inherits:
ApplicationRecord
  • Object
show all
Extended by:
FriendlyId
Defined in:
app/models/remote_execution_feature.rb

Constant Summary collapse

VALID_OPTIONS = 
[:provided_inputs, :description, :host_action_button, :notification_builder, :proxy_selector_override].freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.feature(label) ⇒ Object 



22
23
24
 
# File 'app/models/remote_execution_feature.rb', line 22

def self.feature(label)
  self.find_by(label: label)
end

.feature!(label) ⇒ Object 



26
27
28
 
# File 'app/models/remote_execution_feature.rb', line 26

def self.feature!(label)
  feature(label) || raise(::Foreman::Exception.new(N_('Unknown remote execution feature %s'), label))
end

.register(label, name, options = {}) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'app/models/remote_execution_feature.rb', line 30

def self.register(label, name, options = {})
  pending_migrations = ::Foreman::Plugin.registered_plugins[:foreman_remote_execution]&.pending_migrations
  begin
    # Let's not try to register features if rex is not registered as a plugin
    return false if pending_migrations || pending_migrations.nil?
  rescue ActiveRecord::NoDatabaseError => e
    # just ignore the problem if DB does not exist yet (rake db:create call)
    return false
  end

  options.assert_valid_keys(*VALID_OPTIONS)
  options[:host_action_button] = false unless options.key?(:host_action_button)

  feature = self.find_by(label: label)
  builder = options[:notification_builder] ? options[:notification_builder].to_s : nil

  if options[:provided_inputs]
    provided_inputs = Array(options[:provided_inputs]).join(',')
  end

  attributes = { :name => name,
                 :provided_inputs => provided_inputs,
                 :description => options[:description],
                 :host_action_button => options[:host_action_button],
                 :proxy_selector_override => options[:proxy_selector_override],
                 :notification_builder => builder }
  # in case DB does not have the attribute created yet but plugin initializer registers the feature, we need to skip this attribute
  attrs = [ :host_action_button, :notification_builder ]
  attrs.each do |attr|
    unless self.attribute_names.include?(attr.to_s)
      attributes.delete(attr)
    end
  end

  self.without_auditing do
    # The only validation we currently have is uniqueness validation, which
    # the upsert will enforce
    # rubocop:disable Rails/SkipsModelValidations
    result = self.upsert({ label: label }.merge(attributes), unique_by: :label)
    self.find(result.first.to_h['id'])
    # rubocop:enable Rails/SkipsModelValidations
  end
end

Instance Method Details

#provided_input_names ⇒ Object 



14
15
16
 
# File 'app/models/remote_execution_feature.rb', line 14

def provided_input_names
  self.provided_inputs.to_s.split(',').map(&:strip)
end

#provided_input_names=(values) ⇒ Object 



18
19
20
 
# File 'app/models/remote_execution_feature.rb', line 18

def provided_input_names=(values)
  self.provided_inputs = Array(values).join(',')
end