Add private() function

[raphink]

private

This function sets the current class or definition as private.
Calling the class or definition from outside the current module will fail.

Examples:

private()

called in class foo::bar will output the following message if class is called
from outside module foo:

Class foo::bar is private

You can specify the error message you want to use as a parameter:

private("You're not supposed to do that!")

• Type: statement

[igalic]

nice!

[jhoblitt]

👍

[hlindberg]

hm... this was added, but "private" is a reserved keyword in future parser in 3.7, and is an error in Puppet 4.0.0 until support for this has been added to the language for classes, defines, and variables (planned for 4.x). This function can then not be called because its name is reserved.

[hlindberg]

You can achieve this without this function:

class foo::bar {
if $module_name != $caller_module_name {
fail 'foo::bar is private'
}
}


[raphink]

Hi @hlindberg,

It's good to know that the future parser will have a private concept. The goal of this function was precisely to make it easier to use the $module_name != $caller_module_name trick, without copying/pasting it into every function. Do you suggest this function be renamed? Does it cover the same scope as the concept in the future parser?

[hlindberg]

The future language concept "private" covers the functionality of this function. My suggestion is to not include the function in standard lib at all.

[raphink]

How about keeping it and specifying that it will be deprecated in Puppet 4?

[hlindberg]

So people have to change their code first to use it, and then change it? At least rename it.

[raphink]

What is the syntax of the private statement in the future parser?

[zaphod42]

@raphink it isn't in yet, at this point we've just reserved the word, but it'll likely be something like private class foo {} and private define bar() {}. I think @hlindberg is also looking at allowing it for variables: class foo(private $data) and private $var = 3.

[raphink]

OK. What do you suggest for a renaming?

[igalic]

@raphink how about privatize()

I'd also suggest checking for the puppet version, and issue a warning for >= 4.

[hlindberg]

Some suggestions, private_class(), make_class_private(), make_private(), assert_private(), assert_module_private(), module_private(), of those I like assert_private() and module_private() best.