Class: Bolt::ModuleInstaller::Specs::GitSpec

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/module_installer/specs/git_spec.rb

Constant Summary collapse

NAME_REGEX = 
%r{\A(?:[a-zA-Z0-9]+[-/])?(?<name>[a-z][a-z0-9_]*)\z}.freeze
REQUIRED_KEYS = 
Set.new(%w[git ref]).freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(init_hash) ⇒ GitSpec

Returns a new instance of GitSpec.



19
20
21
22
23
24
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 19

def initialize(init_hash)
  @name       = parse_name(init_hash['name'])
  @git, @repo = parse_git(init_hash['git'])
  @ref        = init_hash['ref']
  @type       = :git
end

Instance Attribute Details

#git ⇒ Object (readonly)

Returns the value of attribute git.



17
18
19
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 17

def git
  @git
end

#ref ⇒ Object (readonly)

Returns the value of attribute ref.



17
18
19
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 17

def ref
  @ref
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



17
18
19
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 17

def type
  @type
end

Class Method Details

.implements?(hash) ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 26

def self.implements?(hash)
  REQUIRED_KEYS == hash.keys.to_set
end

Instance Method Details

#name ⇒ Object

Resolves the module’s title from the module metadata. This is lazily resolved since Bolt does not always need to know a Git module’s name.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 91

def name
  @name ||= begin
    url      = "https://raw.githubusercontent.com/#{@repo}/#{sha}/metadata.json"
    response = make_request(:Get, url)

    case response
    when Net::HTTPOK
      body = JSON.parse(response.body)

      unless body.key?('name')
        raise Bolt::Error.new(
          "Missing name in metadata.json at #{git}. This is not a valid module.",
          "bolt/missing-module-name-error"
        )
      end

      parse_name(body['name'])
    else
      raise Bolt::Error.new(
        "Missing metadata.json at #{git}. This is not a valid module.",
        "bolt/missing-module-metadata-error"
      )
    end
  end
end

#satisfied_by?(mod) ⇒ Boolean

Returns true if the specification is satisfied by the module.

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 64

def satisfied_by?(mod)
  @type == mod.type && @git == mod.git
end

#sha ⇒ Object

Resolves the SHA for the specified ref. This is lazily resolved since Bolt does not always need to know a Git module’s SHA.



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
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 120

def sha
  @sha ||= begin
    url      = "https://api.github.com/repos/#{@repo}/commits/#{ref}"
    headers  = ENV['GITHUB_TOKEN'] ? { "Authorization" => "token #{ENV['GITHUB_TOKEN']}" } : {}
    response = make_request(:Get, url, headers)

    case response
    when Net::HTTPOK
      body = JSON.parse(response.body)
      body['sha']
    when Net::HTTPUnauthorized
      raise Bolt::Error.new(
        "Invalid token at GITHUB_TOKEN, unable to resolve git modules.",
        "bolt/invalid-git-token-error"
      )
    when Net::HTTPForbidden
      message = "GitHub API rate limit exceeded, unable to resolve git modules. "

      unless ENV['GITHUB_TOKEN']
        message += "To increase your rate limit, set the GITHUB_TOKEN environment "\
                  "variable with a GitHub personal access token."
      end

      raise Bolt::Error.new(message, 'bolt/github-api-rate-limit-error')
    when Net::HTTPNotFound
      raise Bolt::Error.new(
        "#{git} is not a git repository.",
        "bolt/missing-git-repository-error"
      )
    else
      raise Bolt::Error.new(
        "Ref #{ref} at #{git} is not a commit, tag, or branch.",
        "bolt/invalid-git-ref-error"
      )
    end
  end
end

#to_hash ⇒ Object

Returns a hash matching the module spec in bolt-project.yaml



70
71
72
73
74
75
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 70

def to_hash
  {
    'git' => @git,
    'ref' => @ref
  }
end

#to_resolver_module ⇒ Object

Returns a PuppetfileResolver::Model::GitModule object for resolving.



79
80
81
82
83
84
85
86
 
# File 'lib/bolt/module_installer/specs/git_spec.rb', line 79

def to_resolver_module
  require 'puppetfile-resolver'

  PuppetfileResolver::Puppetfile::GitModule.new(name).tap do |mod|
    mod.remote = @git
    mod.ref    = sha
  end
end