Class: PDK::Util::PuppetVersion

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/pdk/util/puppet_version.rb

Constant Summary collapse

PE_VERSIONS_URL = 
'https://forgeapi.puppet.com/private/versions/pe'.freeze

Class Attribute Summary collapse

Instance Method Summary collapse

Class Attribute Details

.instance ⇒ Object 



13
14
15
 
# File 'lib/pdk/util/puppet_version.rb', line 13

def instance
  @instance ||= new
end

Instance Method Details

#find_gem_for(version_str) ⇒ 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
 
# File 'lib/pdk/util/puppet_version.rb', line 30

def find_gem_for(version_str)
  version = parse_specified_version(version_str)

  # Look for a gem matching exactly the version passed in.
  if version.segments.length == 3
    exact_match_gem = find_gem(Gem::Requirement.create(version))
    return exact_match_gem unless exact_match_gem.nil?
  end

  # Construct a pessimistic version constraint to find the latest
  # available gem matching the level of specificity of version_str.
  requirement_string = version.approximate_recommendation
  requirement_string += '.0' unless version.segments.length == 1
  latest_requirement = Gem::Requirement.create(requirement_string)

  latest_available_gem = find_gem(latest_requirement)

  if latest_available_gem.nil?
    raise ArgumentError, _('Unable to find a Puppet gem matching %{requirement}.') % {
      requirement: latest_requirement,
    }
  end

  # Only issue this warning if they requested an exact version that isn't available.
  if version.segments.length == 3
    PDK.logger.warn(_('Puppet %{requested_version} is not available, activating %{found_version} instead.') % {
      requested_version: version_str,
      found_version:     latest_available_gem[:gem_version].version,
    })
  end

  latest_available_gem
end

#from_module_metadata(metadata = nil) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/pdk/util/puppet_version.rb', line 85

def from_module_metadata(metadata = nil)
  if metadata.nil?
    metadata_file = PDK::Util.find_upwards('metadata.json')

    unless metadata_file
      PDK.logger.warn _('Unable to determine Puppet version for module: no metadata.json present in module.')
      return nil
    end

    metadata = PDK::Module::Metadata.from_file(metadata_file)
  end

  metadata.validate_puppet_version_requirement!
  metadata_requirement = metadata.puppet_requirement

  # Split combined requirements like ">= 4.7.0 < 6.0.0" into their
  # component requirements [">= 4.7.0", "< 6.0.0"]
  pattern = %r{#{Gem::Requirement::PATTERN_RAW}}
  requirement_strings = metadata_requirement['version_requirement'].scan(pattern).map do |req|
    req.compact.join(' ')
  end

  gem_requirement = Gem::Requirement.create(requirement_strings)
  find_gem(gem_requirement)
end

#from_pe_version(version_str) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/pdk/util/puppet_version.rb', line 64

def from_pe_version(version_str)
  version = parse_specified_version(version_str)

  gem_version = pe_version_map.find do |version_map|
    version_map[:requirement].satisfied_by?(version)
  end

  if gem_version.nil?
    raise ArgumentError, _('Unable to map Puppet Enterprise version %{pe_version} to a Puppet version.') % {
      pe_version: version_str,
    }
  end

  PDK.logger.info _('Puppet Enterprise %{pe_version} maps to Puppet %{puppet_version}.') % {
    pe_version:     version_str,
    puppet_version: gem_version[:gem_version],
  }

  find_gem_for(gem_version[:gem_version])
end

#latest_available ⇒ Object 



20
21
22
23
24
25
26
27
28
 
# File 'lib/pdk/util/puppet_version.rb', line 20

def latest_available
  latest = find_gem(Gem::Requirement.create('>= 0'))

  if latest.nil?
    raise ArgumentError, _('Unable to find a Puppet gem in current Ruby environment or from Rubygems.org.')
  end

  latest
end