File: load_module_metadata.rb

package info (click to toggle)
puppet-module-puppetlabs-stdlib 9.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,448 kB
  • sloc: ruby: 3,522; sh: 46; makefile: 2
file content (40 lines) | stat: -rw-r--r-- 1,217 bytes parent folder | download
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
# frozen_string_literal: true

#
# load_module_metadata.rb
#
module Puppet::Parser::Functions
  newfunction(:load_module_metadata, type: :rvalue, doc: <<-DOC
    @summary
      This function loads the metadata of a given module.

    @example Example Usage:
      $metadata = load_module_metadata('archive')
      notify { $metadata['author']: }

    @return
      The modules metadata
  DOC
  ) do |args|
    raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size)

    mod = args[0]
    allow_empty_metadata = args[1]
    module_path = function_get_module_path([mod])
    metadata_json = File.join(module_path, 'metadata.json')

    metadata_exists = File.exist?(metadata_json)
    if metadata_exists
      metadata = if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative?
                   PSON.load(File.read(metadata_json))
                 else
                   JSON.parse(File.read(metadata_json))
                 end
    else
      metadata = {}
      raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") unless allow_empty_metadata
    end

    return metadata
  end
end