Skip to content

(#12357) Make facter_dot_d look in Puppet[:confdir]/facts.d #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README_DEVELOPER.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Puppet Specific Facts
=====================

Facter is meant to stand alone and apart from Puppet. However, Facter often
runs inside Puppet and all custom facts included in the stdlib module will
almost always be evaluated in the context of Puppet and Facter working
together.

Still, we don't want to write custom facts that blow up in the users face if
Puppet is not loaded in memory. This is often the case if the user run
`facter` without also supplying the `--puppet` flag.

Ah! But Jeff, the custom fact won't be in the `$LOAD_PATH` unless the user
supplies `--facter`! You might say...

Not (always) true I say! If the user happens to have a CWD of
`<modulepath>/stdlib/lib` then the facts will automatically be evaluated and
blow up.

In any event, it's pretty easy to write a fact that has no value if Puppet is
not loaded. Simply do it like this:

Facter.add(:node_vardir) do
setcode do
# This will be nil if Puppet is not available.
Facter::Util::PuppetSettings.with_puppet do
Puppet[:vardir]
end
end
end

The `Facter::Util::PuppetSettings.with_puppet` method accepts a block and
yields to it only if the Puppet library is loaded. If the Puppet library is
not loaded, then the method silently returns `nil` which Facter interprets as
an undefined fact value. The net effect is that the fact won't be set.
8 changes: 8 additions & 0 deletions lib/facter/facter_dot_d.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
# The cache is stored in /tmp/facts_cache.yaml as a mode
# 600 file and will have the end result of not calling your
# fact scripts more often than is needed

require 'facter/util/puppet_settings'

class Facter::Util::DotD
require 'yaml'

Expand Down Expand Up @@ -182,3 +185,8 @@ def create

Facter::Util::DotD.new("/etc/facter/facts.d").create
Facter::Util::DotD.new("/etc/puppetlabs/facter/facts.d").create

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems as though those values might not be applicable on Windows, so should be conditionally out or something?

In the same vein, perhaps it is worth considering using a platform independent path, so that we can figure out which one is applicable and not, eg, load your FOSS facts in PE, and vice-versa? Coexistence, on Unix, is considered a required feature, and separating the paths feels like a good decision in supporting those.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On Fri, Mar 2, 2012 at 6:44 PM, Daniel Pittman <
[email protected]

wrote:

@@ -182,3 +182,8 @@ def create

Facter::Util::DotD.new("/etc/facter/facts.d").create
Facter::Util::DotD.new("/etc/puppetlabs/facter/facts.d").create
+

Seems as though those values might not be applicable on Windows, so should
be conditionally out or something?

The intent is currently to add facts located at the path if the path
exists. The initialization methods do not add anything if the path doesn't
exist, and the path doesn't exist on Windows so it works itself out.

In the same vein, perhaps it is worth considering using a platform
independent path, so that we can figure out which one is applicable and
not, eg, load your FOSS facts in PE, and vice-versa? Coexistence, on Unix,
is considered a required feature, and separating the paths feels like a
good decision in supporting those.

I'd like to move to platform independent paths eventually but the existing
behavior is intended to work with Puppet FOSS and Puppet Enterprise. The
current paths aren't ideal since they're hard-coded but they work for the
default configuration scenarios.

Luckily, the new path works with any platform and any Puppet scenario
because the path is relative to Puppet[:confdir]. Rather than change the
existing behavior I recommend moving facts that are meant for a specific
Puppet configuration to go under /facts.d/

-Jeff

# The Windows installer creates TXT facts in <confdir>/facts.d/
Facter::Util::PuppetSettings.with_puppet do
Facter::Util::DotD.new(File.join(Puppet[:confdir], "facts.d")).create
end
16 changes: 16 additions & 0 deletions lib/facter/puppet_vardir.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# This facter fact returns the value of the Puppet vardir setting for the node
# running puppet or puppet agent. The intent is to enable Puppet modules to
# automatically have insight into a place where they can place variable data,
# regardless of the node's platform.
#
# The value should be directly usable in a File resource path attribute.
require 'facter/util/puppet_settings'

Facter.add(:puppet_vardir) do
setcode do
# This will be nil if Puppet is not available.
Facter::Util::PuppetSettings.with_puppet do
Puppet[:vardir]
end
end
end
17 changes: 17 additions & 0 deletions lib/facter/util/puppet_settings.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
module Facter
module Util
module PuppetSettings
class << self
def with_puppet
begin
Module.const_get("Puppet")
rescue NameError
nil
else
yield
end
end
end
end
end
end
35 changes: 35 additions & 0 deletions spec/unit/facter/util/puppet_settings_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
require 'spec_helper'
require 'facter/util/puppet_settings'

describe Facter::Util::PuppetSettings do

describe "#with_puppet" do
context "Without Puppet loaded" do
before(:each) do
Module.expects(:const_get).with("Puppet").raises(NameError)
end

it 'should be nil' do
subject.with_puppet { Puppet[:vardir] }.should be_nil
end
it 'should not yield to the block' do
Puppet.expects(:[]).never
subject.with_puppet { Puppet[:vardir] }.should be_nil
end
end
context "With Puppet loaded" do
module Puppet; end
let(:vardir) { "/var/lib/puppet" }

before :each do
Puppet.expects(:[]).with(:vardir).returns vardir
end
it 'should yield to the block' do
subject.with_puppet { Puppet[:vardir] }
end
it 'should return the nodes vardir' do
subject.with_puppet { Puppet[:vardir] }.should eq vardir
end
end
end
end