Allow loading of external fact hashes #62

logicminds · 2017-10-13T23:37:08Z

previously there was no way to supply facterdb with
external facts that contain sensitive information. This
fixes that by allowing the user to set an environment variable
that take precedence over the facts from this gem.

coveralls · 2017-10-13T23:42:09Z

Coverage increased (+6.5%) to 80.0% when pulling f56468c on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-13T23:42:09Z

Coverage increased (+6.5%) to 80.0% when pulling f56468c on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-13T23:42:09Z

Coverage increased (+6.5%) to 80.0% when pulling f56468c on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-14T00:45:29Z

Coverage increased (+6.5%) to 80.0% when pulling fd30a03 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-14T00:52:36Z

Coverage increased (+6.5%) to 80.0% when pulling c3b14c3 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-14T00:52:36Z

Coverage increased (+6.5%) to 80.0% when pulling c3b14c3 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-14T00:52:36Z

Coverage increased (+6.5%) to 80.0% when pulling c3b14c3 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-14T01:30:41Z

Coverage increased (+4.02%) to 77.551% when pulling 22d0c11 on nwops:external_facts into 369c1ec on camptocamp:master.

mcanevet · 2017-10-14T06:02:53Z

LGTM. @DavidS @rodjek what do you think about this PR?

rodjek · 2017-10-14T19:26:17Z

Gemfile

@@ -7,3 +7,7 @@ if facterversion = ENV['FACTER_GEM_VERSION']
 else
  gem 'facter', :require => false
 end
+
+group :dev do
+  gem 'pry'


Can you add this to the gemspec as a development dependency instead of here?

added to gemspec

then you can remove it here?

rodjek · 2017-10-14T19:29:07Z

lib/facterdb.rb

+  def self.external_fact_files(fact_paths = ENV['FACTERDB_SEARCH_PATH'])
+    fact_paths ||= ''
+    return [] if fact_paths.empty?
+    paths = fact_paths.split(',').map do |fact_path|


Rather than splitting by ,, can we change this to File::PATH_SEPARATOR which will be a bit more idiomatic to users (: on Linux/BSD/etc, ; on Windows)

rodjek · 2017-10-14T19:34:11Z

lib/facterdb.rb

+      end
+      File.join(fact_path.strip, '**', '*.facts')
+    end.compact
+    Dir.glob(paths)


Dir.glob behaves badly when passed Windows style backslash delimited paths, so I'd recommend adding the following line to the above map before the final File.join to convert the backslashes.

fact_path = fact_path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR

These are great suggestions. Fixed in latest push.

coveralls · 2017-10-14T20:30:01Z

Coverage increased (+4.5%) to 78.0% when pulling e95cb33 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-14T20:30:01Z

Coverage increased (+4.5%) to 78.0% when pulling e95cb33 on nwops:external_facts into 369c1ec on camptocamp:master.

logicminds · 2017-10-16T02:07:19Z

This is ready to go after adding the suggested fixes. @rodjek

DavidS · 2017-10-16T13:51:44Z

I like the idea, and given that there is already https://github.com/mcanevet/rspec-puppet-facts#set-global-custom-facts there is surely a need for it, too. In the light of #61 , I wonder if it wouldn't make sense to extend this even further and make the first/default entry of FACTERDB_SEARCH_PATH a special value, like BUILTIN, so that folks can override the DB contents completely, if they want?

logicminds · 2017-10-16T15:17:19Z

@DavidS we can do something like this:

# @return [Array[String]] -  list of all files found in the default facterdb facts path
  def self.default_fact_files
    proj_root = File.join(File.dirname(File.dirname(__FILE__)))
    facts_dir = ENV['FACTERDB_DEFAULT_SEARCH_PATH'] || File.expand_path(File.join(proj_root, 'facts'))
    Dir.glob(File.join(facts_dir, "**", '*.facts'))
  end

logicminds · 2017-10-16T15:22:42Z

Also now that I look at this. I am going to change FACTERDB_SEARCH_PATH to FACTERDB_SEARCH_PATHS since we can supply multiple paths.

DavidS · 2017-10-17T08:52:13Z

*_PATH sounds fine to me.

Re the default search path, I've spent some more time on that, and I think we should optimize strongly for the default case of folks using the built-in facts. What about return [] if ENV['FACTERDB_SKIP_DEFAULTDB'] == 'yes', adding "Set FACTERDB_SKIP_DEFAULTDB=yes to instruct facterdb to look at its built-in facts, if you want to completely replace which facts are used." to the README.

* previously there was no way to supply facterdb with external facts that contain sensitive information. This fixes that by allowing the user to set an environment variable that take precedence over the facts from this gem.

coveralls · 2017-10-17T17:20:35Z

Coverage increased (+5.7%) to 79.245% when pulling 695e103 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-17T17:20:35Z

Coverage increased (+5.7%) to 79.245% when pulling 695e103 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-17T17:20:35Z

Coverage increased (+5.7%) to 79.245% when pulling 695e103 on nwops:external_facts into 369c1ec on camptocamp:master.

coveralls · 2017-10-17T17:20:45Z

Coverage increased (+5.7%) to 79.245% when pulling 695e103 on nwops:external_facts into 369c1ec on camptocamp:master.

logicminds · 2017-10-17T17:22:26Z

I have added @DavidS suggestions and updated the readme to include this additional info on how to skip the default database. I think this feature will be a big hit.

DavidS · 2017-10-18T15:39:06Z

Gemfile

@@ -6,4 +6,4 @@ if facterversion = ENV['FACTER_GEM_VERSION']
  gem 'facter', facterversion, :require => false
 else
  gem 'facter', :require => false
-end
+end


I didn't want to get rubocop involved as it would have changed a whole lot of code. But now that this is merged, let the games begin. Also we need to bump the version.

rubocop++, and I would suggest the PDK template, obviously. But final say is with @mcanevet and @raphink .

the version gets bumped during release-prep in accordance with the changes in the release.

@DavidS I didn't have time to check PDK yet but feel free to add this in this module. Ping me onde it's OK for release.

logicminds force-pushed the external_facts branch from f56468c to fd30a03 Compare October 14, 2017 00:43

logicminds force-pushed the external_facts branch from fd30a03 to c3b14c3 Compare October 14, 2017 00:50

logicminds force-pushed the external_facts branch from c3b14c3 to 22d0c11 Compare October 14, 2017 01:28

rodjek requested changes Oct 14, 2017

View reviewed changes

logicminds force-pushed the external_facts branch from 22d0c11 to e95cb33 Compare October 14, 2017 20:27

Fixes voxpupuli#27 - allow loading of external fact hashes

695e103

* previously there was no way to supply facterdb with external facts that contain sensitive information. This fixes that by allowing the user to set an environment variable that take precedence over the facts from this gem.

logicminds force-pushed the external_facts branch from e95cb33 to 695e103 Compare October 17, 2017 17:16

rodjek approved these changes Oct 18, 2017

View reviewed changes

DavidS reviewed Oct 18, 2017

View reviewed changes

DavidS merged commit 6dbac7e into voxpupuli:master Oct 18, 2017

DavidS added the enhancement label Oct 24, 2017

DavidS changed the title ~~Fixes #27 - allow loading of external fact hashes~~ Allow loading of external fact hashes Oct 24, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow loading of external fact hashes #62

Allow loading of external fact hashes #62

logicminds commented Oct 13, 2017

coveralls commented Oct 13, 2017 •

edited

coveralls commented Oct 13, 2017 •

edited

coveralls commented Oct 13, 2017 •

edited

coveralls commented Oct 14, 2017 •

edited

coveralls commented Oct 14, 2017

coveralls commented Oct 14, 2017

coveralls commented Oct 14, 2017 •

edited

coveralls commented Oct 14, 2017 •

edited

mcanevet commented Oct 14, 2017

rodjek Oct 14, 2017

logicminds Oct 14, 2017

DavidS Oct 16, 2017

rodjek Oct 14, 2017

rodjek Oct 14, 2017

logicminds Oct 14, 2017

coveralls commented Oct 14, 2017

coveralls commented Oct 14, 2017 •

edited

logicminds commented Oct 16, 2017

DavidS commented Oct 16, 2017

logicminds commented Oct 16, 2017

logicminds commented Oct 16, 2017

DavidS commented Oct 17, 2017

coveralls commented Oct 17, 2017 •

edited

coveralls commented Oct 17, 2017

coveralls commented Oct 17, 2017

coveralls commented Oct 17, 2017

logicminds commented Oct 17, 2017

DavidS Oct 18, 2017

logicminds Oct 18, 2017

DavidS Oct 18, 2017

mcanevet Oct 19, 2017

Allow loading of external fact hashes #62

Allow loading of external fact hashes #62

Conversation

logicminds commented Oct 13, 2017

coveralls commented Oct 13, 2017 • edited

coveralls commented Oct 13, 2017 • edited

coveralls commented Oct 13, 2017 • edited

coveralls commented Oct 14, 2017 • edited

coveralls commented Oct 14, 2017

coveralls commented Oct 14, 2017

coveralls commented Oct 14, 2017 • edited

coveralls commented Oct 14, 2017 • edited

mcanevet commented Oct 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Oct 14, 2017

coveralls commented Oct 14, 2017 • edited

logicminds commented Oct 16, 2017

DavidS commented Oct 16, 2017

logicminds commented Oct 16, 2017

logicminds commented Oct 16, 2017

DavidS commented Oct 17, 2017

coveralls commented Oct 17, 2017 • edited

coveralls commented Oct 17, 2017

coveralls commented Oct 17, 2017

coveralls commented Oct 17, 2017

logicminds commented Oct 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Oct 13, 2017 •

edited

coveralls commented Oct 13, 2017 •

edited

coveralls commented Oct 13, 2017 •

edited

coveralls commented Oct 14, 2017 •

edited

coveralls commented Oct 14, 2017 •

edited

coveralls commented Oct 14, 2017 •

edited

coveralls commented Oct 14, 2017 •

edited

coveralls commented Oct 17, 2017 •

edited