Puppet Function: archive::artifactory_checksum

Defined in:
lib/puppet/functions/archive/artifactory_checksum.rb
Function type:
Ruby 4.x API

Summary

A function that returns the checksum value of an artifact stored in Artifactory

Overview

archive::artifactory_checksum(Stdlib::HTTPUrl $url, Optional[Enum['sha1','sha256','md5']] $checksum_type) ⇒ String

Parameters:

  • url (Stdlib::HTTPUrl) —

    The URL of the artifact.

  • checksum_type (Optional[Enum['sha1','sha256','md5']]) —

    The checksum type. Note the function will raise an error if you ask for sha256 but your artifactory instance doesn’t have the sha256 value calculated.

Returns:

  • (String) —

    Returns the checksum.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/puppet/functions/archive/artifactory_checksum.rb', line 6

Puppet::Functions.create_function(:'archive::artifactory_checksum') do
  # @summary A function that returns the checksum value of an artifact stored in Artifactory
  # @param url The URL of the artifact.
  # @param checksum_type The checksum type.
  #        Note the function will raise an error if you ask for sha256 but your artifactory instance doesn't have the sha256 value calculated.
  # @return [String] Returns the checksum.
  dispatch :artifactory_checksum do
    param 'Stdlib::HTTPUrl', :url
    optional_param "Enum['sha1','sha256','md5']", :checksum_type
    return_type 'String'
  end

  def artifactory_checksum(url, checksum_type = 'sha1')
    uri = URI(url.sub('/artifactory/', '/artifactory/api/storage/'))

    response = PuppetX::Bodeco::Util.content(uri)
    content = JSON.parse(response)

    checksum = content['checksums'] && content['checksums'][checksum_type]
    raise("Could not parse #{checksum_type} from url: #{uri}\nresponse: #{response.body}") unless checksum =~ %r{\b[0-9a-f]{5,64}\b}

    checksum
  end
end