Forge Home

includable

Provide the `includable()` function to test whether a class has been written and is in the path or not

6,984 downloads

5,576 latest version

3.9 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.2.0 (latest)
  • 0.1.1
  • 0.1.0
released Sep 12th 2018

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'geoffwilliams-includable', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add geoffwilliams-includable
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install geoffwilliams-includable --version 0.2.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

geoffwilliams/includable — version 0.2.0 Sep 12th 2018

Build Status

includable

Table of Contents

  1. Description
  2. Usage - Configuration options and additional functionality
  3. Limitations - OS compatibility, etc.
  4. Development - Guide for contributing to the module

Description

Provide the includable() function to test whether a class has been written and is in the path or not

Usage

includable()

Test whether the class definition for the passed in class name is exists in the environment currently being evaluated.

For example, given:

/etc/puppetlabs/code/environments/production/modules/mock_profile/
└── manifests
    └── myprofile.pp


includable('mock_profile::myprofile') # true
includable('mock_profile::not_here') # false 

Classes will be resolved according the modulepath for the current environment according to Puppet. See function source code for exact implementation details

Limitations

  • Not supported by Puppet, Inc.

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
make

See .travis.yml for a working CI example