1 2 3 4 5 6 7 8 9 10 11 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 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 89 90 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 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 163 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 196 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
|
# frozen_string_literal: true
require_relative '../../../puppet_x/bodeco/archive'
require_relative '../../../puppet_x/bodeco/util'
require 'securerandom'
require 'tempfile'
# This provider implements a simple state-machine. The following attempts to #
# document it. In general, `def adjective?` implements a [state], while `def
# verb` implements an {action}.
# Some states are more complex, as they might depend on other states, or trigger
# actions. Since this implements an ad-hoc state-machine, many actions or states
# have to guard themselves against being called out of order.
#
# [exists?]
# |
# v
# [extracted?] -> no -> [checksum?]
# |
# v
# yes
# |
# v
# [path.exists?] -> no -> {cleanup}
# | | |
# v v v
# [checksum?] yes. [extracted?] && [cleanup?]
# |
# v
# {destroy}
#
# Now, with [exists?] defined, we can define [ensure]
# But that's just part of the standard puppet provider state-machine:
#
# [ensure] -> absent -> [exists?] -> no.
# | |
# v v
# present yes
# | |
# v v
# [exists?] {destroy}
# |
# v
# {create}
#
# Here's how we would extend archive for an `ensure => latest`:
#
# [exists?] -> no -> {create}
# |
# v
# yes
# |
# v
# [ttl?] -> expired -> {destroy} -> {create}
# |
# v
# valid.
#
Puppet::Type.type(:archive).provide(:ruby) do
optional_commands aws: 'aws'
optional_commands gsutil: 'gsutil'
defaultfor feature: :microsoft_windows
attr_reader :archive_checksum
def exists?
return checksum? unless extracted?
return checksum? if File.exist? archive_filepath
cleanup
true
end
def create
transfer_download(archive_filepath) unless checksum?
extract
ensure
cleanup
end
def destroy
FileUtils.rm_f(archive_filepath) if File.exist?(archive_filepath)
end
def archive_filepath
resource[:path]
end
def tempfile_name
if resource[:checksum] == 'none'
"#{resource[:filename]}_#{SecureRandom.base64}"
else
"#{resource[:filename]}_#{resource[:checksum]}"
end
end
def creates
if resource[:extract] == :true
extracted? ? resource[:creates] : 'archive not extracted'
else
resource[:creates]
end
end
def creates=(_value)
extract
end
def checksum
resource[:checksum] || (resource[:checksum] = remote_checksum if resource[:checksum_url])
end
def remote_checksum
PuppetX::Bodeco::Util.content(
resource[:checksum_url],
username: resource[:username],
password: resource[:password],
cookie: resource[:cookie],
proxy_server: resource[:proxy_server],
proxy_type: resource[:proxy_type],
insecure: resource[:allow_insecure]
)[%r{\b[\da-f]{32,128}\b}i]
end
# Private: See if local archive checksum matches.
# returns boolean
def checksum?(store_checksum = true)
return false unless File.exist? archive_filepath
return true if resource[:checksum_type] == :none
archive = PuppetX::Bodeco::Archive.new(archive_filepath)
archive_checksum = archive.checksum(resource[:checksum_type])
@archive_checksum = archive_checksum if store_checksum
checksum == archive_checksum
end
def cleanup
return unless resource[:cleanup] == :true && resource[:extract] == :true
Puppet.debug("Cleanup archive #{archive_filepath}")
destroy
end
def extract
return unless resource[:extract] == :true
raise(ArgumentError, 'missing archive extract_path') unless resource[:extract_path]
PuppetX::Bodeco::Archive.new(archive_filepath).extract(
resource[:extract_path],
custom_command: resource[:extract_command],
options: resource[:extract_flags],
uid: resource[:user],
gid: resource[:group]
)
end
def extracted?
resource[:creates] && File.exist?(resource[:creates])
end
def transfer_download(archive_filepath)
raise Puppet::Error, "Temporary directory #{resource[:temp_dir]} doesn't exist" if resource[:temp_dir] && !File.directory?(resource[:temp_dir])
tempfile = Tempfile.new(tempfile_name, resource[:temp_dir])
temppath = tempfile.path
tempfile.close!
case resource[:source]
when %r{^(puppet)}
puppet_download(temppath)
when %r{^(http|ftp)}
download(temppath)
when %r{^file}
uri = URI(resource[:source])
FileUtils.copy(Puppet::Util.uri_to_path(uri), temppath)
when %r{^s3}
s3_download(temppath)
when %r{^gs}
gs_download(temppath)
when nil
raise(Puppet::Error, 'Unable to fetch archive, the source parameter is nil.')
else
raise(Puppet::Error, "Source file: #{resource[:source]} does not exists.") unless File.exist?(resource[:source])
FileUtils.copy(resource[:source], temppath)
end
# conditionally verify checksum:
if resource[:checksum_verify] == :true && resource[:checksum_type] != :none
archive = PuppetX::Bodeco::Archive.new(temppath)
actual_checksum = archive.checksum(resource[:checksum_type])
if actual_checksum != checksum
destroy
raise(Puppet::Error, "Download file checksum mismatch (expected: #{checksum} actual: #{actual_checksum})")
end
end
move_file_in_place(temppath, archive_filepath)
ensure
FileUtils.rm_f(temppath) if File.exist?(temppath)
end
def move_file_in_place(from, to)
# Ensure to directory exists.
FileUtils.mkdir_p(File.dirname(to))
FileUtils.mv(from, to)
end
def download(filepath)
PuppetX::Bodeco::Util.download(
resource[:source],
filepath,
username: resource[:username],
password: resource[:password],
cookie: resource[:cookie],
proxy_server: resource[:proxy_server],
proxy_type: resource[:proxy_type],
insecure: resource[:allow_insecure]
)
end
def puppet_download(filepath)
PuppetX::Bodeco::Util.puppet_download(
resource[:source],
filepath
)
end
def s3_download(path)
params = [
's3',
'cp',
resource[:source],
path
]
params += resource[:download_options] if resource[:download_options]
aws(params)
end
def gs_download(path)
params = [
'cp',
resource[:source],
path
]
params += resource[:download_options] if resource[:download_options]
gsutil(params)
end
def optional_switch(value, option)
if value
Array(value).map { |item| option.map { |flags| flags % item } }.flatten
else
[]
end
end
end
|