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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
# frozen_string_literal: true
require 'pathname'
require 'uri'
require 'puppet/util'
require 'puppet/parameter/boolean'
Puppet::Type.newtype(:archive) do
@doc = 'Manage archive file download, extraction, and cleanup.'
ensurable do
desc 'whether archive file should be present/absent (default: present)'
newvalue(:present) do
provider.create
end
newvalue(:absent) do
provider.destroy
end
defaultto(:present)
# The following changes allows us to notify if the resource is being replaced
def is_to_s(value)
return "(#{resource[:checksum_type]})#{provider.archive_checksum}" if provider.archive_checksum
super
end
def should_to_s(value)
return "(#{resource[:checksum_type]})#{resource[:checksum]}" if provider.archive_checksum
super
end
def change_to_s(currentvalue, newvalue)
if currentvalue == :absent || currentvalue.nil?
extract = resource[:extract] == :true ? "and extracted in #{resource[:extract_path]}" : ''
cleanup = resource[:cleanup] == :true ? 'with cleanup' : 'without cleanup'
if provider.archive_checksum
"replace archive: #{provider.archive_filepath} from #{is_to_s(currentvalue)} to #{should_to_s(newvalue)}"
else
"download archive from #{resource[:source]} to #{provider.archive_filepath} #{extract} #{cleanup}"
end
elsif newvalue == :absent
"remove archive: #{provider.archive_filepath} "
else
super
end
rescue StandardError
super
end
end
newparam(:path, namevar: true) do
desc 'namevar, archive file fully qualified file path.'
validate do |value|
raise ArgumentError, "archive path must be absolute: #{value}" unless Puppet::Util.absolute_path? value
end
end
newparam(:filename) do
desc 'archive file name (derived from path).'
end
newparam(:extract) do
desc 'whether archive will be extracted after download (true|false).'
newvalues(:true, :false)
defaultto(:false)
end
newparam(:extract_path) do
desc 'target folder path to extract archive.'
validate do |value|
raise ArgumentError, "archive extract_path must be absolute: #{value}" unless Puppet::Util.absolute_path? value
end
end
newparam(:target) do
desc 'target folder path to extract archive. (this parameter is for camptocamp/archive compatibility)'
validate do |value|
raise ArgumentError, "archive extract_path must be absolute: #{value}" unless Puppet::Util.absolute_path? value
end
munge do |val|
resource[:extract_path] = val
end
end
newparam(:extract_command) do
desc "custom extraction command ('tar xvf example.tar.gz'), also support sprintf format ('tar xvf %s') which will be processed with the filename: sprintf('tar xvf %s', filename)"
end
newparam(:temp_dir) do
desc 'Specify an alternative temporary directory to use for copying files, if unset then the operating system default will be used.'
validate do |value|
raise ArgumentError, "Invalid temp_dir #{value}" unless Puppet::Util.absolute_path?(value)
end
end
newparam(:extract_flags) do
desc "custom extraction options, this replaces the default flags. A string such as 'xvf' for a tar file would replace the default xf flag. A hash is useful when custom flags are needed for different platforms. {'tar' => 'xzf', '7z' => 'x -aot'}."
defaultto(:undef)
end
newproperty(:creates) do
desc 'if file/directory exists, will not download/extract archive.'
def should_to_s(value)
"extracting in #{resource[:extract_path]} to create #{value}"
end
end
newparam(:cleanup) do
desc 'whether archive file will be removed after extraction (true|false).'
newvalues(:true, :false)
defaultto(:true)
end
newparam(:source) do
desc 'archive file source, supports puppet|http|https|ftp|file|s3|gs uri.'
validate do |value|
raise ArgumentError, "invalid source url: #{value}" unless value =~ %r{puppet|http|https|ftp|file|s3|gs} || Puppet::Util.absolute_path?(value)
end
end
newparam(:url) do
desc 'archive file source, supports http|https|ftp|file uri.
(for camptocamp/archive compatibility)'
validate do |value|
raise ArgumentError, "invalid source url: #{value}" unless value =~ %r{http|https|file|ftp}
end
munge do |val|
resource[:source] = val
end
end
newparam(:cookie) do
desc 'archive file download cookie.'
end
newparam(:checksum) do
desc 'archive file checksum (match checksum_type).'
newvalues(%r{\b[0-9a-f]{5,128}\b}, :true, :false, :undef, nil, '')
munge do |val|
if val.nil? || val.empty? || val == :undef
:false
elsif %i[true false].include? val
resource[:checksum_verify] = val
else
val
end
end
end
newparam(:digest_string) do
desc 'archive file checksum (match checksum_type)
(this parameter is for camptocamp/archive compatibility).'
newvalues(%r{\b[0-9a-f]{5,128}\b})
munge do |val|
if !val.nil? && !val.empty?
resource[:checksum] = val
else
val
end
end
end
newparam(:checksum_url) do
desc 'archive file checksum source (instead of specifying checksum)'
end
newparam(:digest_url) do
desc 'archive file checksum source (instead of specifying checksum)
(this parameter is for camptocamp/archive compatibility)'
munge do |val|
resource[:checksum_url] = val
end
end
newparam(:checksum_type) do
desc 'archive file checksum type (none|md5|sha1|sha2|sha256|sha384|sha512).'
newvalues(:none, :md5, :sha1, :sha2, :sha256, :sha384, :sha512)
defaultto(:none)
end
newparam(:digest_type) do
desc 'archive file checksum type (none|md5|sha1|sha2|sha256|sha384|sha512)
(this parameter is camptocamp/archive compatibility).'
newvalues(:none, :md5, :sha1, :sha2, :sha256, :sha384, :sha512)
munge do |val|
resource[:checksum_type] = val
end
end
newparam(:checksum_verify) do
desc 'whether checksum wil be verified (true|false).'
newvalues(:true, :false)
defaultto(:true)
end
newparam(:username) do
desc 'username to download source file.'
end
newparam(:password) do
desc 'password to download source file.'
end
newparam(:headers) do
desc 'optional header(s) to pass.'
validate do |val|
raise ArgumentError, "headers must be an array: #{val}" unless val.is_a?(Array)
end
end
newparam(:user) do
desc 'extract command user (using this option will configure the archive file permission to 0644 so the user can read the file).'
end
newparam(:group) do
desc 'extract command group (using this option will configure the archive file permisison to 0644 so the user can read the file).'
end
newparam(:proxy_type) do
desc 'proxy type (none|ftp|http|https)'
newvalues(:none, :ftp, :http, :https)
end
newparam(:proxy_server) do
desc 'proxy address to use when accessing source'
end
newparam(:allow_insecure, boolean: true, parent: Puppet::Parameter::Boolean) do
desc 'ignore HTTPS certificate errors'
defaultto :false
end
newparam(:download_options) do
desc 'provider download options (affects curl, wget, gs, and only s3 downloads for ruby provider)'
validate do |val|
raise ArgumentError, "download_options should be String or Array: #{val}" unless val.is_a?(String) || val.is_a?(Array)
end
munge do |val|
case val
when String
[val]
else
val
end
end
end
autorequire(:file) do
[
Pathname.new(self[:path]).parent.to_s,
self[:extract_path],
'/root/.aws/config',
'/root/.aws/credentials'
].compact
end
autorequire(:exec) do
['install_aws_cli']
end
autorequire(:exec) do
['install_gsutil']
end
validate do
filepath = Pathname.new(self[:path])
self[:filename] = filepath.basename.to_s
raise ArgumentError, "invalid parameter: url (#{self[:url]}) and source (#{self[:source]}) are mutually exclusive." if !self[:source].nil? && !self[:url].nil? && self[:source] != self[:url]
raise ArgumentError, "invalid parameter: checksum_url (#{self[:checksum_url]}) and digest_url (#{self[:digest_url]}) are mutually exclusive." if !self[:checksum_url].nil? && !self[:digest_url].nil? && self[:checksum_url] != self[:digest_url]
if self[:proxy_server]
self[:proxy_type] ||= URI(self[:proxy_server]).scheme.to_sym
else
self[:proxy_type] = :none
end
end
end
|