Class: LicenseAcceptance::ProductReader

Inherits:
Object
  • Object
show all
Includes:
Logger
Defined in:
lib/license_acceptance/product_reader.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logger

initialize, logger, #logger

Instance Attribute Details

#productsObject

Returns the value of attribute products


10
11
12
# File 'lib/license_acceptance/product_reader.rb', line 10

def products
  @products
end

#relationshipsObject

Returns the value of attribute relationships


10
11
12
# File 'lib/license_acceptance/product_reader.rb', line 10

def relationships
  @relationships
end

Instance Method Details

#get_locationObject


48
49
50
51
52
53
54
55
56
# File 'lib/license_acceptance/product_reader.rb', line 48

def get_location
  # For local development point this to the product_info.toml at the root of the repo.
  # When bundled as a gem we will use the the relative path to find the file in the
  # gem package.
  if ENV["CHEF_LICENSE_PRODUCT_INFO"]
    return ENV["CHEF_LICENSE_PRODUCT_INFO"]
  end
  File.absolute_path(File.join(__FILE__, "../../../config/product_info.toml"))
end

#lookup(parent_id, parent_version) ⇒ Object


58
59
60
61
62
63
64
65
66
67
# File 'lib/license_acceptance/product_reader.rb', line 58

def lookup(parent_id, parent_version)
  parent_product = products.fetch(parent_id) do
    raise UnknownProduct.new(parent_id)
  end
  children = relationships.fetch(parent_product, [])
  if !parent_version.is_a? String
    raise ProductVersionTypeError.new(parent_version)
  end
  ProductRelationship.new(parent_product, children, parent_version)
end

#lookup_by_mixlib(mixlib_name) ⇒ Object


69
70
71
72
73
74
# File 'lib/license_acceptance/product_reader.rb', line 69

def lookup_by_mixlib(mixlib_name)
  found_product = products.values.find(nil) do |p|
    p.mixlib_name == mixlib_name
  end
  found_product
end

#readObject

Raises:


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/license_acceptance/product_reader.rb', line 12

def read
  logger.debug("Reading products and relationships...")
  location = get_location
  self.products = {}
  self.relationships = {}

  toml = Tomlrb.load_file(location, symbolize_keys: false)
  raise InvalidProductInfo.new(location) if toml.empty? || toml["products"].nil? || toml["relationships"].nil?

  for product in toml["products"]
    products[product["id"]] = Product.new(
      product["id"], product["pretty_name"],
      product["filename"], product["mixlib_name"],
      product["license_required_version"]
    )
  end

  for parent_id, children in toml["relationships"]
    parent = products[parent_id]
    raise UnknownParent.new(parent_id) if parent.nil?
    # Its fine to not have a relationship entry, but not fine to have
    # a relationship where the children are nil or empty.
    if children.nil? || children.empty? || !children.is_a?(Array)
      raise NoChildRelationships.new(parent)
    end
    children.map! do |child_id|
      child = products[child_id]
      raise UnknownChild.new(child_id) if child.nil?
      child
    end
    relationships[parent] = children
  end

  logger.debug("Successfully read products and relationships")
end