Module: Simp::Metadata

Defined in:
lib/simp/metadata.rb,
lib/simp/metadata/engine.rb,
lib/simp/metadata/source.rb,
lib/simp/metadata/command.rb,
lib/simp/metadata/release.rb,
lib/simp/metadata/version.rb,
lib/simp/metadata/commands.rb,
lib/simp/metadata/fake_uri.rb,
lib/simp/metadata/location.rb,
lib/simp/metadata/releases.rb,
lib/simp/metadata/buildinfo.rb,
lib/simp/metadata/component.rb,
lib/simp/metadata/locations.rb,
lib/simp/metadata/components.rb,
lib/simp/metadata/commands/pry.rb,
lib/simp/metadata/commands/base.rb,
lib/simp/metadata/commands/save.rb,
lib/simp/metadata/commands/clone.rb,
lib/simp/metadata/commands/delete.rb,
lib/simp/metadata/commands/script.rb,
lib/simp/metadata/commands/search.rb,
lib/simp/metadata/commands/update.rb,
lib/simp/metadata/bootstrap_source.rb,
lib/simp/metadata/commands/release.rb,
lib/simp/metadata/commands/releases.rb,
lib/simp/metadata/commands/component.rb,
lib/simp/metadata/commands/set-write.rb,
lib/simp/metadata/commands/set-write-url.rb

Defined Under Namespace

Modules: Commands Classes: Bootstrap_source, Buildinfo, Command, Component, Components, Engine, FakeURI, Location, Locations, Release, Releases, Source, Version

Class Method Summary collapse

Class Method Details

.convert_level(level) ⇒ Object 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/simp/metadata.rb', line 338

def self.convert_level(level)
  case level
  when 'disabled'
    0
  when 'critical'
    1
  when 'error'
    2
  when 'warning'
    3
  when 'info'
    4
  when 'debug1'
    5
  when 'debug2'
    6
  else
    3
  end
end

.critical(message) ⇒ Object 



396
397
398
399
400
 
# File 'lib/simp/metadata.rb', line 396

def self.critical(message)
  if Simp::Metadata.level?('critical')
    Simp::Metadata.print_message('CRITICAL', message)
  end
end

.debug1(message) ⇒ Object 



366
367
368
369
370
 
# File 'lib/simp/metadata.rb', line 366

def self.debug1(message)
  if Simp::Metadata.level?('debug1')
    Simp::Metadata.print_message('DEBUG1', message)
  end
end

.debug2(message) ⇒ Object 



372
373
374
375
376
 
# File 'lib/simp/metadata.rb', line 372

def self.debug2(message)
  if Simp::Metadata.level?('debug2')
    Simp::Metadata.print_message('DEBUG2', message)
  end
end

.directory_name(component, options) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/simp/metadata.rb', line 24

def self.directory_name(component, options)
  if options['target'].nil?
    raise "Must specify 'target'"
  else
    basedir = options['target']
  end

  case component.class.to_s
  when 'String'
    "#{basedir}/#{component}"
  when 'Simp::Metadata::Component'
    "#{basedir}/#{component.output_filename}"
  end
end

.download_component(component, options) ⇒ Object

XXX: ToDo this entire logic stream is crappy.

We need to replace this with a much more simplified version.



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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/simp/metadata.rb', line 41

def self.download_component(component, options)
  directory_name = self.directory_name(component, options)
  retval = {}
  case component.class.to_s
  when 'String'
    retval['path'] = self.directory_name(component, options)
    # XXX: ToDo We can bootstrap this with a hard coded source in the simp engine
    bootstrapped_components = {
      'simp-metadata' => {
        'url' => 'https://github.com/simp/simp-metadata',
        'method' => 'git'
      },
      'enterprise-metadata' => {
        'url' => 'simp-enterprise:///enterprise-metadata?version=master&filetype=tgz',
        'method' => 'file',
        'extract' => true
      }
    }
    # All this should be removed and be based on component.file_type
    componentspec = bootstrapped_components[component]
    if componentspec['extract']
      tarball = "#{directory_name}.tgz"
      fetch_from_url(componentspec, tarball, nil, options)
      Dir.mkdir(retval['path']) unless Dir.exist?(retval['path'])
      `tar -xvpf #{tarball} -C #{retval['path']}`
    else
      fetch_from_url(componentspec, retval['path'], nil, options)
    end
  when 'Simp::Metadata::Component'
    retval['path'] = directory_name
    if options['url']
      location = component.primary
      location.url = options['url']
      urlspec = location
      location.method = 'git'
    else
      urlspec = component.primary
    end
    if component.method == 'file'
      FileUtils.cp_r component.url, directory_name
    else
      fetch_from_url(urlspec, retval['path'], component, options)
    end
  else
    raise "component.class=#{component.class}, #{component.class} is not in ['String', 'Simp::Metadata::Component']"
  end
  retval
end

.error(message) ⇒ Object 



390
391
392
393
394
 
# File 'lib/simp/metadata.rb', line 390

def self.error(message)
  if Simp::Metadata.level?('error')
    Simp::Metadata.print_message('ERROR', message)
  end
end

.fetch_from_url(urlspec, target, component = nil, options) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/simp/metadata.rb', line 101

def self.fetch_from_url(urlspec, target, component = nil, options)
  case urlspec.class.to_s
  when 'Simp::Metadata::Location'
    url = urlspec.url
    uri = uri(url)
    method = urlspec.method
  when 'Hash'
    url = urlspec['url']
    uri = uri(urlspec['url'])
    if urlspec.key?('method')
      method = urlspec['method']
    else
      # XXX ToDo remove once the upstream simp-metadata has been updated so type != method
      if urlspec.key?('type')
        method = if urlspec['type'] == 'git'
                   'git'
                 else
                   'file'
                 end
      else
        method = 'file'
      end
    end
  when 'String'
    url = urlspec
    uri = uri(urlspec)
    method = 'file'
  end

  case method
  when 'git'
    case uri.scheme
    when 'simp'
      fetch_simp_enterprise(url, target, component, urlspec, options)
    when 'simp-enterprise'
      fetch_simp_enterprise(url, target, component, urlspec, options)
    else
      if Dir.exist?(target)
        Dir.chdir(target) do
          info("Updating from #{url}")
          run('git pull origin')
        end
      else
        info("Cloning from #{url}")
        run("git clone #{url} #{target}")
      end
    end
  when 'file'
    case uri.scheme
    when 'simp'
      fetch_simp_enterprise(url, target, component, urlspec, options)
    when 'simp-enterprise'
      fetch_simp_enterprise(url, target, component, urlspec, options)
    when 'http'
      fetch_simp_enterprise(url, target, component, urlspec, options)
    when 'https'
      fetch_simp_enterprise(url, target, component, urlspec, options)
    else
      raise "unsupported url type #{uri.scheme}"
    end
  end
end

.fetch_simp_enterprise(url, destination, component, location = nil, options) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/simp/metadata.rb', line 197

def self.fetch_simp_enterprise(url, destination, component, location = nil, options)
  extract = if location.class.to_s == 'Simp::Metadata::Location'
              location.extract
            else
              false
            end
  uri = uri(url)

  case uri.scheme
  when 'simp-enterprise'
    scheme = 'https'
    host = 'enterprise-download.simp-project.com'
    filetype = 'tgz'
    unless component.nil?
      filetype = component.extension if component.extension != ''
    end
    version = 'latest'
    unless component.nil?
      version = component.version if component.version != ''
    end
    unless uri.query.nil?
      uri.query.split('&').each do |element|
        next unless element.class.to_s == 'String'
        elements = element.split('=')
        next unless elements.size > 1
        case elements[0]
        when 'version'
          version = elements[1]
        when 'filetype'
          filetype = elements[1]
        end
      end
    end

    name = if !component.nil?
             "/#{component.name}/#{component.binaryname}"
           else
             "#{uri.path}#{uri.path}#{name}-#{version}.#{filetype}"
           end
    path = "/products/simp-enterprise#{name}"
  when 'simp'
    scheme = 'https'
    host = 'download.simp-project.com'
    filetype = 'tgz'
    unless component.nil?
      filetype = component.extension if component.extension != ''
    end
    version = 'latest'
    unless component.nil?
      version = component.version if component.version != ''
    end
    unless uri.query.nil?
      uri.query.split('&').each do |element|
        next unless element.class.to_s == 'String'
        elements = element.split('=')
        next unless elements.size > 1
        case elements[0]
        when 'version'
          version = elements[1]
        when 'filetype'
          filetype = elements[1]
        end
      end
    end
    name = if !component.nil?
             "/#{component.name}/#{component.binaryname}"
           else
             "#{uri.path}#{uri.path}#{name}-#{version}.#{filetype}"
           end
    path = "/SIMP/assets#{name}"
  else
    scheme = uri.scheme
    host = uri.host
    path = uri.path
  end
  port = uri.port ? uri.port : 443
  http = Net::HTTP.new(host, port)

  case scheme
  when 'https'
    http.use_ssl = true
    case uri.scheme
    when 'simp-enterprise'
      filename, data = get_license_data(options['license'])
      http.ca_file = filename unless filename.nil?
      unless data.nil?
        http.cert = OpenSSL::X509::Certificate.new(data)
        http.key = OpenSSL::PKey::RSA.new(data)
        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
      end

      debug2("using the following certificate (#{filename}) for client certificate auth: #{http.cert.subject}")
    end
  end
  info("Fetching from #{scheme}://#{host}:#{port}#{path}")
  req = Net::HTTP::Get.new(path)
  response = http.request(req)
  case response.code
  when '200'
    if extract
      File.open("#{destination}.tgz", 'w') do |f|
        f.write response.body
      end
      FileUtils.mkdir_p(destination)
      run("tar -xvpf #{destination}.tgz -C #{destination}")
    else
      File.open(destination, 'w') do |f|
        f.write response.body
      end
    end
  when '302'
    fetch_simp_enterprise(response['location'], destination, component, location)
  when '301'
    fetch_simp_enterprise(response['location'], destination, component, location)
  else
    $errorcode = response.code.to_i
    raise "HTTP Error Code: #{response.code}"
  end
end

.get_license_data(filename) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/simp/metadata.rb', line 164

def self.get_license_data(filename)
  ret_filename = nil
  ret_data = ''
  license_data = ENV.fetch('SIMP_LICENSE_KEY', nil)
  if !license_data.nil?
    # Environment data trumps all
    ret_data = license_data
    if $simp_license_temp.nil?
      $simp_license_temp = Tempfile.new('license_data')
      $simp_license_temp.write(license_data)
    end
    ret_filename = $simp_license_temp.path
  else
    ret_filename = if filename.class.to_s == 'String'
                     # Attempt to load from the filename passed
                     filename
                   else
                     # Try to load from /etc/simp/license.key file
                     '/etc/simp/license.key'
                   end
    if File.exist?(ret_filename)
      ret_data = File.read(ret_filename)
    else
      if $simp_license_temp.nil?
        $simp_license_temp = Tempfile.new('license_data')
        $simp_license_temp.write('')
      end
      ret_filename = $simp_license_temp.path
    end
  end
  [ret_filename, ret_data]
end

.info(message) ⇒ Object 



378
379
380
381
382
 
# File 'lib/simp/metadata.rb', line 378

def self.info(message)
  if Simp::Metadata.level?('info')
    Simp::Metadata.print_message('INFO', message)
  end
end

.level?(level) ⇒ Boolean

Returns:

  • (Boolean) 


328
329
330
331
332
333
334
335
336
 
# File 'lib/simp/metadata.rb', line 328

def self.level?(level)
  setlevel = Simp::Metadata.convert_level($simp_metadata_debug_level)
  checklevel = Simp::Metadata.convert_level(level)
  if checklevel <= setlevel
    true
  else
    false
  end
end

.print_message(prefix, message) ⇒ Object 



359
360
361
362
363
364
 
# File 'lib/simp/metadata.rb', line 359

def self.print_message(prefix, message)
  message.split("\n").each do |line|
    output = "#{prefix}: #{line}"
    STDERR.puts output unless $simp_metadata_debug_output_disabled
  end
end

.run(command) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/simp/metadata.rb', line 317

def self.run(command)
  exitcode = nil
  Open3.popen3(command) do |_stdin, stdout, stderr, thread|
    pid = thread.pid
    Simp::Metadata.debug2(stdout.read.chomp)
    Simp::Metadata.debug1(stderr.read.chomp)
    exitcode = thread.value
  end
  exitcode
end

.uri(url) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/simp/metadata.rb', line 90

def self.uri(url)
  case url
  when /git@/
    uri = Simp::Metadata::FakeURI.new(uri)
    uri.scheme = 'ssh'
    uri
  else
    URI(url)
  end
end

.warning(message) ⇒ Object 



384
385
386
387
388
 
# File 'lib/simp/metadata.rb', line 384

def self.warning(message)
  if Simp::Metadata.level?('warning')
    Simp::Metadata.print_message('WARN', message)
  end
end