Class: Machinery::SystemDescription

Inherits:
Object show all
Defined in:
lib/system_description.rb

Overview

The responsibility of the SystemDescription class is to represent a system description. This is our main data model.

The content of the system description is stored in a directory, which contains a manifest and sub directories for individual scopes. SystemDescription handles all the data which is in the top level of the system description directory.

The sub directories storing the data for specific scopes are handled by the ScopeFileStore class.

Constant Summary collapse

CURRENT_FORMAT_VERSION = 
10
EXTRACTABLE_SCOPES = 
[
  "changed_managed_files",
  "changed_config_files",
  "unmanaged_files"
]

Instance Attribute Summary collapse

Attributes inherited from Object

#attributes, #scope

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#==, #[], #[]=, #as_json, #compare_with, convert_element, convert_raw_hash, #empty?, from_json, has_property, #hash, #initialize_copy, #method_missing, #respond_to?, #set_attributes

Constructor Details

#initialize(name, store, hash = {}) ⇒ SystemDescription

Returns a new instance of SystemDescription.



114
115
116
117
118
119
120
121
 
# File 'lib/system_description.rb', line 114

def initialize(name, store, hash = {})
  @name = name
  @store = store
  @format_version = CURRENT_FORMAT_VERSION
  @filter_definitions = {}

  super(create_scopes(hash))
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Machinery::Object

Instance Attribute Details

#filter_definitions(command) ⇒ Object

Returns the value of attribute filter_definitions.



39
40
41
 
# File 'lib/system_description.rb', line 39

def filter_definitions
  @filter_definitions
end

#format_version ⇒ Object

Returns the value of attribute format_version.



38
39
40
 
# File 'lib/system_description.rb', line 38

def format_version
  @format_version
end

#name ⇒ Object

Returns the value of attribute name.



36
37
38
 
# File 'lib/system_description.rb', line 36

def name
  @name
end

#store ⇒ Object

Returns the value of attribute store.



37
38
39
 
# File 'lib/system_description.rb', line 37

def store
  @store
end

Class Method Details

.from_hash(name, store, hash) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/system_description.rb', line 89

def from_hash(name, store, hash)
  begin
    json_format_version = hash["meta"]["format_version"] if hash["meta"]
    description = Machinery::SystemDescription.new(name, store, hash)
  rescue NameError, TypeError, RuntimeError
    if json_format_version &&
        json_format_version != Machinery::SystemDescription::CURRENT_FORMAT_VERSION
      raise Machinery::Errors::SystemDescriptionIncompatible.new(name, json_format_version)
    else
      raise Machinery::Errors::SystemDescriptionError.new(
        "#{name}: This description is broken."
      )
    end
  end

  description.format_version = json_format_version

  if hash["meta"] && hash["meta"]["filters"]
    description.filter_definitions = hash["meta"]["filters"]
  end

  description
end

.load(name, store, options = {}) ⇒ Object

Load the system description with the given name

If there are file validation errors these are put out as warnings but the loading of the system description succeeds.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/system_description.rb', line 63

def load(name, store, options = {})
  manifest = Machinery::Manifest.load(name, store.manifest_path(name))
  manifest.validate unless options[:skip_validation]

  description = from_hash(name, store, manifest.to_hash)
  description.validate_file_data unless options[:skip_validation]

  description.validate_format_compatibility unless options[:skip_format_compatibility]

  description
end

.load!(name, store, options = {}) ⇒ Object

Load the system description with the given name

If there are file validation errors the call fails with an exception



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/system_description.rb', line 45

def load!(name, store, options = {})
  manifest = Machinery::Manifest.load(name, store.manifest_path(name))
  manifest.validate!

  description = from_hash(name, store, manifest.to_hash)
  description.validate_file_data!

  unless options[:skip_format_compatibility]
    description.validate_format_compatibility
  end

  description
end

.valid_name?(name) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/system_description.rb', line 75

def valid_name?(name)
  !!/^[\w:-][\w\.:-]*$/.match(name)
end

.validate_name(name) ⇒ Object 



79
80
81
82
83
84
85
86
87
 
# File 'lib/system_description.rb', line 79

def validate_name(name)
  unless valid_name?(name)
    raise Machinery::Errors::SystemDescriptionError.new(
      "System description name '#{name}' is invalid. " \
      "Only 'a-zA-Z0-9_:.-' are valid characters and a dot " \
      "is not allowed at the begginning."
    )
  end
end

Instance Method Details

#assert_scopes(*scopes) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/system_description.rb', line 217

def assert_scopes(*scopes)
  missing = scopes.select { |scope| !self[scope] }.map { |scope|
    Machinery::Ui.internal_scope_list_to_string(scope)
  }

  unless missing.empty?
    raise Machinery::Errors::SystemDescriptionError.new(
      "The system description misses the following" \
        " #{Machinery.pluralize(missing.size, "scope")}: #{missing.join(",")}."
    )
  end
end

#compatible? ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
151
 
# File 'lib/system_description.rb', line 148

def compatible?
  !format_version.nil? &&
    format_version == Machinery::SystemDescription::CURRENT_FORMAT_VERSION
end

#create_scopes(hash) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/system_description.rb', line 123

def create_scopes(hash)
  scopes = hash.map do |scope_name, json|
    next if scope_name == "meta"

    if store.persistent?
      scope_file_store = scope_file_store(scope_name)
    end

    if json.is_a?(Hash) || json.is_a?(Array)
      scope_object = Machinery::Scope.for(scope_name, json, scope_file_store)

      # Set metadata
      if hash["meta"] && hash["meta"][scope_name]
        scope_object.meta = Machinery::Object.from_json(hash["meta"][scope_name])
      end
    else
      scope_object = json
    end

    [scope_name, scope_object]
  end.compact

  Hash[scopes]
end

#description_path ⇒ Object 



279
280
281
 
# File 'lib/system_description.rb', line 279

def description_path
  @store.description_path(name)
end

#has_file?(name) ⇒ Boolean

Returns:

  • (Boolean) 


287
288
289
290
291
292
293
294
 
# File 'lib/system_description.rb', line 287

def has_file?(name)
  EXTRACTABLE_SCOPES.each do |scope|
    if scope_extracted?(scope)
      return true if self[scope] && self[scope].has_file?(name)
    end
  end
  false
end

#host ⇒ Object 



274
275
276
277
 
# File 'lib/system_description.rb', line 274

def host
  all_hosts = attributes.keys.map { |scope| self[scope].meta.try(:[], "hostname") }
  all_hosts.uniq.compact
end

#latest_update ⇒ Object 



269
270
271
272
 
# File 'lib/system_description.rb', line 269

def latest_update
  attributes.keys.map { |scope| self[scope].meta.try(:[], "modified") }
    .compact.map { |t| Time.parse(t) }.sort.last
end

#load_existing_diffs ⇒ Object

Enrich description with the config file diffs



306
307
308
309
310
311
312
313
 
# File 'lib/system_description.rb', line 306

def load_existing_diffs
  diffs_dir = scope_file_store("analyze/changed_config_files_diffs").path
  return unless changed_config_files && diffs_dir
  changed_config_files.each do |file|
    path = File.join(diffs_dir, file.name + ".diff")
    file.diff = Machinery::Ui::DiffWidget.new(File.read(path)).widget if File.exist?(path)
  end
end

#read_config(path, key) ⇒ Object 



296
297
298
299
300
301
302
303
 
# File 'lib/system_description.rb', line 296

def read_config(path, key)
  EXTRACTABLE_SCOPES.each do |scope|
    if scope_extracted?(scope)
      file = self[scope].find { |f| f.name == path }
      return parse_variable_assignment(file.content, key) if file
    end
  end
end

#runs_service?(name) ⇒ Boolean

Returns:

  • (Boolean) 


283
284
285
 
# File 'lib/system_description.rb', line 283

def runs_service?(name)
  self["services"].any? { |service| service.name == "#{name}.service" }
end

#save ⇒ Object 



190
191
192
193
194
195
196
197
 
# File 'lib/system_description.rb', line 190

def save
  Machinery::SystemDescription.validate_name(name)
  @store.directory_for(name)
  path = @store.manifest_path(name)
  created = !File.exist?(path)
  File.write(path, to_json)
  File.chmod(0600, path) if created
end

#scope_extracted?(scope) ⇒ Boolean

Returns:

  • (Boolean) 


243
244
245
 
# File 'lib/system_description.rb', line 243

def scope_extracted?(scope)
  self[scope] && self[scope].is_extractable? && self[scope].extracted
end

#scope_file_store(store_name) ⇒ Object 



247
248
249
 
# File 'lib/system_description.rb', line 247

def scope_file_store(store_name)
  Machinery::ScopeFileStore.new(description_path, store_name)
end

#scopes ⇒ Object 



213
214
215
 
# File 'lib/system_description.rb', line 213

def scopes
  Machinery::Inspector.sort_scopes(attributes.keys.map(&:to_s).sort)
end

#set_filter_definitions(command, filter) ⇒ Object 



203
204
205
206
207
208
209
210
211
 
# File 'lib/system_description.rb', line 203

def set_filter_definitions(command, filter)
  unless ["inspect"].include?(command)
    raise Machinery::Errors::MachineryError.new(
      "Storing the filter for command '#{command}' is not supported."
    )
  end

  @filter_definitions[command] = filter
end

#short_os_version ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/system_description.rb', line 230

def short_os_version
  assert_scopes("os")

  case self.os.name
    when /^SUSE Linux Enterprise Server/
      "sles" + self.os.version[/\d+( SP\d+)*/].gsub(" ", "").downcase
    when /^openSUSE/
      self.os.version[/^\d+.\d+/]
    else
      "unknown"
  end
end

#to_hash ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/system_description.rb', line 169

def to_hash
  meta = {}
  meta["format_version"] = self.format_version if self.format_version

  attributes.keys.each do |key|
    meta[key] = self[key].meta.as_json if self[key].meta
  end
  @filter_definitions.each do |command, filter|
    meta["filters"] ||= {}
    meta["filters"][command] = filter
  end

  hash = as_json
  hash["meta"] = meta unless meta.empty?
  hash
end

#to_json ⇒ Object 



186
187
188
 
# File 'lib/system_description.rb', line 186

def to_json
  JSON.pretty_generate(to_hash)
end

#validate_analysis_compatibility ⇒ Object 



159
160
161
162
163
164
165
166
167
 
# File 'lib/system_description.rb', line 159

def validate_analysis_compatibility
  Machinery::Zypper.isolated(arch: os.architecture) do |zypper|
    major, minor, patch = zypper.version
    if major <= 1 && minor <= 11 && patch < 4
      raise Machinery::Errors::AnalysisFailed.new("Analyzing command requires zypper 1.11.4 " \
        "or grater to be installed.")
    end
  end
end

#validate_file_data ⇒ Object 



251
252
253
254
255
256
257
258
 
# File 'lib/system_description.rb', line 251

def validate_file_data
  errors = Machinery::FileValidator.new(to_hash, description_path).validate
  unless errors.empty?
    Machinery::Ui.warn("Warning: File validation errors:")
    Machinery::Ui.warn("Error validating description '#{@name}'\n\n")
    Machinery::Ui.warn(errors.join("\n"))
  end
end

#validate_file_data! ⇒ Object 



260
261
262
263
264
265
266
267
 
# File 'lib/system_description.rb', line 260

def validate_file_data!
  errors = Machinery::FileValidator.new(to_hash, description_path).validate
  unless errors.empty?
    e = Machinery::Errors::SystemDescriptionValidationFailed.new(errors)
    e.header = "Error validating description '#{@name}'"
    raise e
  end
end

#validate_format_compatibility ⇒ Object 



153
154
155
156
157
 
# File 'lib/system_description.rb', line 153

def validate_format_compatibility
  unless compatible?
    raise Machinery::Errors::SystemDescriptionIncompatible.new(name, format_version)
  end
end