puppet-repl 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8726c62a0923768b64cf07c7a4a020d331a6dbb4
-  data.tar.gz: 483b212a7d21da6bc76264b2c4efae120b72ba74
+  metadata.gz: 4d8ce23921a5f416b32187a87b404f5175f4bd37
+  data.tar.gz: a510663097037ec81141e66552f253817cb6d9c3
 SHA512:
-  metadata.gz: ee46f50573a316eb2f92a5bd4ff16af968ae691b3d39d1a5f26957d1a71c1f32d22a169df3a8f0511fd8e5a724290c6179484700d5b750d6b71c8e559eb11450
-  data.tar.gz: 61f17a2d77901d5321a996c0fb4bbb0824fd088473ca0e733990d05b0036626c4c0c30168d3becda2384f31812b82d2364bd36a92a4cea2c9a2c35b4460fa6ad
+  metadata.gz: 125c9d2e1024849306165a4371d5468f39179c6adb660cbefe0801343111ae85bb25a1070b8f669893a8efc4d26cd34432192ac1d971bf7ae68c6c803d577b90
+  data.tar.gz: 48d7203e5f8db5a73cc76e4ce3b3be1af12b935955d24a349ef19379e961f36791366fb1fd7a650b818f705ed5092be2264d6095c554fa9206ba99cd9e2af4ac

data/.gitlab-ci.yml

@@ -16,8 +16,6 @@ web_trigger_staging:
   type: web_deploy
   variables:
     REF: staging
-  only:
-    - tags
   script:
     - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
 
@@ -25,6 +23,8 @@ web_trigger_production:
   type: web_deploy
   variables:
     REF: production
+  only:
+    - tags
   script:
     - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
 
@@ -112,3 +112,9 @@ puppet_45_ruby22:
     PUPPET_GEM_VERSION: "~> 4.5"
   <<: *puppet_job_def
   <<: *ruby22
+
+puppet_46_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.6"
+  <<: *puppet_job_def
+  <<: *ruby22

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.3.1
+  * Fixes #28 - puppet 4.6 support
+  * Fixes #27 - repl should throw puppet error message instead of stacktrace
+  * adds support for customizing facterdb filter
+  * adds support for puppet 4.6
+  * Fixes #26 - allow configuration of facter version and facterdb filter
+
 ## 0.3.0
   * Fixes #23 - add quiet flag to suppress banner
   * Fixes #11 - cannot declare and use a class or define
@@ -5,8 +12,8 @@
   * fixes #21 - type display causes error
 ## 0.2.2
   * adds better support for playing back puppet code
-      * this now allows playback of any manifest
-      * allows mixed puppet code and repl commands
+    * this now allows playback of any manifest
+    * allows mixed puppet code and repl commands
 ## 0.2.1
   * Fixes #2 - adds support for multiline input
 

data/Gemfile

@@ -4,6 +4,8 @@ gem 'facterdb', "~> 0.3"
 gem 'awesome_print', "~> 1.6"
 
 group :test do
+  # ruby versions prior to 2.0 cannot install json_pure 2.0.2+
+  gem 'json_pure', '<= 2.0.1'
   gem "rdoc", "~> 3.12"
   gem "rspec"
   gem "bundler"

data/Gemfile.lock

@@ -2,49 +2,48 @@ GEM
   remote: http://rubygems.org/
   specs:
     CFPropertyList (2.2.8)
-    awesome_print (1.6.1)
+    awesome_print (1.7.0)
     coderay (1.1.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
     facter (2.4.6)
       CFPropertyList (~> 2.2.6)
-    facterdb (0.3.5)
+    facterdb (0.3.6)
       facter
       jgrep
-    hiera (3.2.0)
-      json_pure
+    hiera (3.2.1)
     jgrep (1.4.1)
       json
     json (1.8.3)
-    json_pure (2.0.1)
+    json_pure (1.8.3)
     method_source (0.8.2)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    puppet (4.5.2)
+    puppet (4.6.0)
       facter (> 2.0, < 4)
       hiera (>= 2.0, < 4)
-      json_pure
-    rake (11.1.2)
+      json_pure (~> 1.8)
+    rake (11.2.2)
     rdoc (3.12.2)
       json (~> 1.4)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    simplecov (0.11.2)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
@@ -56,6 +55,7 @@ DEPENDENCIES
   awesome_print (~> 1.6)
   bundler
   facterdb (~> 0.3)
+  json_pure (<= 2.0.1)
   pry
   puppet (>= 3.8)
   rake

data/README.md

@@ -199,7 +199,6 @@ pe specific modules in your development environment.  Not doing this step will r
 
   ```
 
-
 ### Usage
 There are two ways of using the remote node feature.  You can either
 pass in the node name from the command line or set the node name from the repl session.
@@ -223,6 +222,22 @@ Press the tab key to engage the auto complete functionality.
 
 Currently native functions are not available in auto complete. See #24
 
+## FacterDB and using different fact sets
+The puppet-repl internally leverages the [facterdb](https://github.com/camptocamp/facterdb/) gem to load pre-cached facts into the repl session.  At some point you
+may need to override the repl's default fact set with something of your own choosing.  You can do this by setting one of the environment variables below.
+
+* `REPL_FACTERDB_FILTER`  Sets the entire filter
+* `REPL_FACTER_OS_VERSION` Sets the OS version (only works with RHEL clones and Fedora)
+* `REPL_FACTER_OS_NAME` Sets the OS name (only works with RHEL clones and Fedora)
+* `REPL_FACTER_VERSION` Sets the facter version to use in the repl session (uses facter 3.1 for puppet 4.4+ and facter 2.4 for 3.8-4.4)
+
+By default it looks something like `operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^3\\.1/`
+depending on the puppet version currently running.
+
+You can display the current facterdb filter by running `facterdb_filter` from the repl session.
+
+Why do facter versions matter? While facter and puppet work independently just fine, newer forge modules utilize certain data structures found only in newer versions of facter. So its really up to the puppet code you use. With facter 3, almost every fact is now a data structure.  So if you are having issues with facts not existing in the repl you may need to change the facter version `REPL_FACTER_VERSION` to something different.
+
 ## Playback support
 Puppet-repl now supports playing back files or urls and loading the content into the repl session.  This means if you want to start a repl session from an existing file or url you can play the content back in the repl.
 You can also playback a file that contains puppet code and repl commands.
@@ -233,13 +248,14 @@ or
 
 `prepl -p https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
 
+or just use STDIN  `prepl <some_file>` or `echo "abs(-3)" | prepl`
 
 ### Web based playback support
 If using the [web based repl](https://www.puppet-repl.com) you can playback a shared url
 which would start a repl session and then load the content from the url or parameter.
 
 Example:
-https://murmuring-plateau-62715.herokuapp.com/play?url=https://gist.github.com/logicminds/64f0fe9f64339f18f097a9f42acd6276
+https://puppet-repl.com/play?url=https://gist.github.com/logicminds/64f0fe9f64339f18f097a9f42acd6276
 
 or for single commands
 

data/lib/puppet-repl/cli.rb

@@ -95,7 +95,7 @@ module PuppetRepl
         begin
           output = ''
           case input
-          when /^play|^classification|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
+          when /^play|^classification|^facterdb_filter|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
             args = input.split(' ')
             command = args.shift.to_sym
             if self.respond_to?(command)
@@ -126,6 +126,8 @@ module PuppetRepl
           output = e.message.fatal
         rescue Puppet::ResourceError => e
           output = e.message.fatal
+        rescue Puppet::Error => e
+          output = e.message.fatal
         rescue Puppet::ParseErrorWithIssue => e
           output = e.message.fatal
         rescue PuppetRepl::Exception::FatalError => e

data/lib/puppet-repl/support.rb

@@ -79,19 +79,19 @@ module PuppetRepl
 
     def known_resource_types
       res = {
-        :hostclasses => scope.known_resource_types.hostclasses.keys,
-        :definitions => scope.known_resource_types.definitions.keys,
-        :nodes => scope.known_resource_types.nodes.keys,
+        :hostclasses => scope.environment.known_resource_types.hostclasses.keys,
+        :definitions => scope.environment.known_resource_types.definitions.keys,
+        :nodes => scope.environment.known_resource_types.nodes.keys,
       }
-      if sites = scope.known_resource_types.instance_variable_get(:@sites)
-        res.merge!(:sites => scope.known_resource_types.instance_variable_get(:@sites).first)
+      if sites = scope.environment.known_resource_types.instance_variable_get(:@sites)
+        res.merge!(:sites => scope.environment.known_resource_types.instance_variable_get(:@sites).first)
       end
-      if scope.known_resource_types.respond_to?(:applications)
-        res.merge!(:applications => scope.known_resource_types.applications.keys)
+      if scope.environment.known_resource_types.respond_to?(:applications)
+        res.merge!(:applications => scope.environment.known_resource_types.applications.keys)
       end
       # some versions of puppet do not support capabilities
-      if scope.known_resource_types.respond_to?(:capability_mappings)
-        res.merge!(:capability_mappings => scope.known_resource_types.capability_mappings.keys)
+      if scope.environment.known_resource_types.respond_to?(:capability_mappings)
+        res.merge!(:capability_mappings => scope.environment.known_resource_types.capability_mappings.keys)
       end
       res
     end
@@ -141,7 +141,7 @@ module PuppetRepl
       ast = generate_ast(input)
       Puppet.override( {:global_scope => scope, :loaders => scope.compiler.loaders } , 'For puppet-repl') do
          # because the repl is not a module we leave the modname blank
-         scope.known_resource_types.import_ast(ast, '')
+         scope.environment.known_resource_types.import_ast(ast, '')
          parser.evaluate_string(scope, input)
       end
     end

data/lib/puppet-repl/support/errors.rb

@@ -19,6 +19,12 @@ EOF
       end
     end
 
+    class BadFilter < FatalError
+      def message
+        data[:message]
+      end
+    end
+
     class UndefinedNode < FatalError
       def message
         out = <<-EOF

data/lib/puppet-repl/support/facts.rb

@@ -3,8 +3,35 @@ module PuppetRepl
     module Facts
       # in the future we will want to grab real facts from real systems via puppetdb
       # or enc data
-      def facterdb_filter
-        'operatingsystem=RedHat and operatingsystemrelease=/^7/ and architecture=x86_64 and facterversion=/^2.4\./'
+
+      # allow the user to specify the facterdb filter
+      def dynamic_facterdb_filter
+        ENV['REPL_FACTERDB_FILTER'] || default_facterdb_filter
+      end
+
+      def default_facterdb_filter
+        "operatingsystem=#{facter_os_name} and operatingsystemrelease=#{facter_os_version} and architecture=x86_64 and facterversion=#{facter_version}"
+      end
+
+      def facter_version
+        ENV['REPL_FACTER_VERSION'] || default_facter_version
+      end
+
+      # return the correct supported version of facter facts
+      def default_facter_version
+        if Gem::Version.new(Puppet.version) >= Gem::Version.new(4.4)
+          '/^3\.1/'
+        else
+          '/^2\.4/'
+        end
+      end
+
+      def facter_os_name
+        ENV['REPL_FACTER_OS_NAME'] || 'Fedora'
+      end
+
+      def facter_os_version
+        ENV['REPL_FACTER_OS_VERSION'] || '23'
       end
 
       def set_facts(value)
@@ -14,18 +41,33 @@ module PuppetRepl
       # uses facterdb (cached facts) and retrives the facts given a filter
       # creates a new facts object
       # we could also use fact_merge to get real facts from the real system or puppetdb
+      def node_facts
+        node_facts = FacterDB.get_facts(dynamic_facterdb_filter).first
+        if node_facts.nil?
+          message = <<-EOS
+Using filter: #{facterdb_filter}
+Bad FacterDB filter, please change the filter so it returns a result set.
+See https://github.com/camptocamp/facterdb/#with-a-string-filter
+          EOS
+          raise PuppetRepl::Exception::BadFilter.new(:message => message)
+        end
+        # fix for when --show-legacy facts are not part of the facter 3 fact set
+        node_facts[:fqdn] = node_facts[:networking].fetch('fqdn',nil) unless node_facts[:fqdn]
+        node_facts
+      end
+
       def default_facts
         unless @facts
-          node_facts = FacterDB.get_facts(facterdb_filter).first
           values = Hash[ node_facts.map { |k, v| [k.to_s, v] } ]
-          @facts ||= Puppet::Node::Facts.new(values['fqdn'], values)
+          name = values['fqdn']
+          @facts ||= Puppet::Node::Facts.new(name, values)
         end
         @facts
       end
 
       def server_facts
         data = {}
-        data["servername"] = Facter.value("fqdn")
+        data["servername"] = Facter.value("fqdn") || Facter.value('networking')['fqdn']
         data['serverip'] = Facter.value("ipaddress")
         data["serverversion"] = Puppet.version.to_s
         data

data/lib/puppet-repl/support/input_responders.rb

@@ -3,11 +3,15 @@ module PuppetRepl
     module InputResponders
 
       def static_responder_list
-        ["exit", "functions", "classification","vars", "krt", "facts",
+        ["exit", "functions", "classification","vars", 'facterdb_filter', "krt", "facts",
          "resources", "classes", "play","reset", "help"
         ]
       end
 
+      def facterdb_filter(args=[])
+        dynamic_facterdb_filter.ai
+      end
+
       def help(args=[])
         PuppetRepl::Cli.print_repl_desc
       end

data/lib/puppet-repl/support/node.rb

@@ -18,7 +18,8 @@ module PuppetRepl
           options[:facts] = default_facts
           options[:classes] = []
           options[:environment] = puppet_environment
-          node_obj = Puppet::Node.new(default_facts.values['fqdn'], options)
+          name = default_facts.values['fqdn']
+          node_obj = Puppet::Node.new(name, options)
           node_obj.add_server_facts(server_facts) if node_obj.respond_to?(:add_server_facts)
           node_obj
         end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module PuppetRepl
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/facts_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe 'facts' do
+  let(:repl) do
+    PuppetRepl::Cli.new(:out_buffer => output)
+  end
+
+  let(:puppet_version) do
+    '4.5.3'
+  end
+
+  let(:facter_version) do
+    repl.default_facter_version
+  end
+
+  before(:each) do
+    allow(Puppet).to receive(:version).and_return(puppet_version)
+  end
+
+  describe '2.4' do
+    before(:each) do
+      ENV['REPL_FACTERDB_FILTER'] = nil
+    end
+    let(:puppet_version) do
+      '4.2.0'
+    end
+    it 'returns 2.4' do
+      expect(facter_version).to eq('/^2\.4/')
+    end
+    it 'return default filter' do
+      expect(repl.dynamic_facterdb_filter).to eq("operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^2\\.4/")
+    end
+    it 'get node_facts' do
+      expect(repl.node_facts).to be_instance_of(Hash)
+    end
+    it 'has fqdn' do
+      expect(repl.node_facts[:fqdn]).to eq('foo.example.com')
+    end
+  end
+
+  describe '3.1' do
+    before(:each) do
+      ENV['REPL_FACTERDB_FILTER'] = nil
+    end
+    let(:puppet_version) do
+      '4.5.3'
+    end
+    it 'get node_facts' do
+      expect(repl.node_facts).to be_instance_of(Hash)
+    end
+    it 'has networking fqdn' do
+      expect(repl.node_facts[:networking]['fqdn']).to eq('foo.example.com')
+    end
+    it 'has fqdn' do
+      expect(repl.node_facts[:fqdn]).to eq('foo.example.com')
+    end
+    it 'returns 3.1' do
+      expect(facter_version).to eq('/^3\.1/')
+    end
+    it 'return default filter' do
+      expect(repl.dynamic_facterdb_filter).to eq("operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^3\\.1/")
+    end
+  end
+
+  describe 'default facts' do
+    describe 'bad filter' do
+      before(:each) do
+        ENV['REPL_FACTERDB_FILTER'] = 'facterversion=/^6\.5/'
+      end
+      it 'return filter' do
+        expect(repl.dynamic_facterdb_filter).to eq("facterversion=/^6\\.5/")
+      end
+      it 'throws error' do
+        expect{repl.default_facts}.to raise_error(PuppetRepl::Exception::BadFilter)
+      end
+    end
+    describe 'good filter' do
+      before(:each) do
+        ENV['REPL_FACTERDB_FILTER'] = 'facterversion=/^3\.1/'
+      end
+      it 'return filter' do
+        expect(repl.dynamic_facterdb_filter).to eq("facterversion=/^3\\.1/")
+      end
+    end
+  end
+end

data/spec/puppet-repl_spec.rb

@@ -37,19 +37,17 @@ describe "PuppetRepl" do
       it do
         repl.handle_input(input)
         expect(output.string).to eq("\n")
-        expect(repl.scope.known_resource_types.hostclasses).to include('testfoo')
+        expect(repl.known_resource_types[:hostclasses]).to include('testfoo')
       end
       it do
         repl.handle_input(input)
-        repl.handle_input("class{'testfoo':}")
+        repl.handle_input("include testfoo")
         expect(repl.scope.compiler.catalog.classes).to include('testfoo')
-        # expect(output.string).to include("\n => Puppet::Type::Component")
-        # expect(output.string).to include("name => \"Testfoo\"")
       end
       it do
         repl.handle_input(input)
-        repl.handle_input("include testfoo")
-        expect(repl.scope.compiler.catalog.classes).to include('testfoo')
+        repl.handle_input('include testfoo')
+        expect(repl.scope.compiler.catalog.resources.map(&:name)).to include('Testfoo')
       end
     end
   end
@@ -64,7 +62,7 @@ describe "PuppetRepl" do
       end
       it do
         repl.handle_input(input)
-        expect(repl.scope.known_resource_types.definitions.keys).to include('testfoo')
+        expect(repl.scope.environment.known_resource_types.definitions.keys).to include('testfoo')
         expect(output.string).to eq("\n")
       end
       it do
@@ -428,10 +426,7 @@ describe "PuppetRepl" do
       repl.handle_input("$var1")
       expect(output.string).to match(/value1/)
     end
-    it 'display productname variable' do
-      repl.handle_input("$productname")
-      expect(output.string).to match(/VirtualBox/)
-    end
+
   end
 
   describe 'execute functions' do
@@ -450,30 +445,25 @@ describe "PuppetRepl" do
     end
   end
 
-  # this code no longer works in puppet 4.5+
-  # describe 'unidentified object' do
-  #   let(:repl_output) { "\n" }
-  #   describe "Node['foot']" do
-  #     let(:input) { subject }
-  #     it 'returns string' do
-  #       repl.handle_input(input)
-  #       expect(output.string).to eq(repl_output)
-  #     end
-  #   end
-  #   describe "Puppet::Pops::Types::PStringType" do
-  #     let(:input) { subject }
-  #     it 'returns string' do
-  #       repl.handle_input(input)
-  #       expect(output.string).to eq(repl_output)
-  #     end
-  #   end
-  #   describe 'Facts' do
-  #     let(:input) { subject }
-  #     it 'returns string' do
-  #       repl.handle_input(input)
-  #       expect(output.string).to eq(repl_output)
-  #     end
-  #   end
-  # end
+  describe 'error message' do
+    let(:input) do
+      "file{'/tmp/test': ensure => present, contact => 'blah'}"
+    end
+    p_version = ENV['PUPPET_GEM_VERSION'].split(' ').last
+    if Gem::Version.new(p_version) >= Gem::Version.new('4.0')
+      it 'show error message' do
+        repl_output =  /no\ parameter\ named\ 'contact'/
+        repl.handle_input(input)
+        expect(output.string).to match(repl_output)
+      end
+    else
+      it 'show error message' do
+        repl_output =  /Invalid\ parameter\ contact/
+        repl.handle_input(input)
+        expect(output.string).to match(repl_output)
+      end
+    end
+
+  end
 
 end

data/spec/spec_helper.rb

@@ -25,7 +25,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec'
 require 'puppet-repl'
-
+ENV['REPL_FACTERDB_FILTER'] = "operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^2\\.4/"
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-repl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Corey Osman
@@ -104,6 +104,7 @@ files:
 - lib/version.rb
 - puppet-repl.gemspec
 - run_container_test.sh
+- spec/facts_spec.rb
 - spec/fixtures/environments/production/manifests/site.pp
 - spec/fixtures/invalid_node_obj.yaml
 - spec/fixtures/node_obj.yaml