hiera-file 1.0.0

data/lib/hiera/backend/file_backend.rb

@@ -0,0 +1,44 @@
+class Hiera
+  module Backend
+    class File_backend
+      def initialize
+        Hiera.debug("Hiera File backend starting")
+      end
+
+      def lookup(key, scope, order_override, resolution_type)
+        answer = nil
+
+        Hiera.debug("Looking up #{key} in JSON backend")
+
+        Backend.datasources(scope, order_override) do |source|
+          Hiera.debug("Hiera File_backend: looking for data source '#{source}'")
+
+          datadir = Backend.datafile(:file, scope, source, "d") or next
+
+          # Expand the datadir and path, and ensure that the datadir contains
+          # the given key. If the expanded key is outside of the datadir then
+          # this is a directory traversal attack and should be aborted.
+          abs_datadir = File.expand_path(datadir)
+          abs_path    = File.expand_path(File.join(abs_datadir, key))
+          unless abs_path.index(abs_datadir) == 0
+            raise Exception, "Hiera File backend: key lookup outside of datadir '#{key}'"
+          end
+
+          next unless File.exist?(abs_path)
+          data = File.read(abs_path)
+
+          case resolution_type
+          when :array
+            answer ||= []
+            answer << Backend.parse_answer(data, scope)
+          else
+            answer = Backend.parse_answer(data, scope)
+            break
+          end
+        end
+
+        answer
+      end
+    end
+  end
+end

data/spec/unit/file_backend_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'hiera/backend/file_backend'
+
+class Hiera
+  module Backend
+    describe File_backend do
+      before do
+        Hiera.stubs(:debug)
+        Hiera.stubs(:warn)
+      end
+
+
+      describe "#initialize" do
+        it "should announce its creation" do # because other specs checks this
+          Hiera.expects(:debug).with("Hiera File backend starting")
+
+          File_backend.new
+        end
+      end
+
+      describe "#lookup" do
+        before :each do
+          Backend.stubs(:datasources).multiple_yields(["one"], ["two"])
+        end
+
+        subject { File_backend.new }
+
+        it "should look for data in all sources" do
+          Backend.expects(:datafile).with(:file, {}, "one", "d")
+          Backend.expects(:datafile).with(:file, {}, "two", "d")
+
+          subject.lookup("key", {}, nil, :priority)
+        end
+
+        describe 'when searching' do
+
+          before :each do
+            Backend.stubs(:datafile).with(:file, {}, "one", "d").returns("/datadir/one.d")
+            Backend.stubs(:datafile).with(:file, {}, "two", "d").returns("/datadir/two.d")
+          end
+
+          it "should pick data earliest source that has it for priority searches" do
+            File.expects(:exist?).with("/datadir/one.d/key").returns true
+            File.expects(:read).with("/datadir/one.d/key").returns 'value'
+
+            File.expects(:exist?).with("/datadir/two.d/key").never
+            File.expects(:read).with("/datadir/two.d/key").never
+
+            subject.lookup("key", {}, nil, :priority).should == 'value'
+          end
+
+          it "should build an array of all data sources for array searches" do
+            File.expects(:exist?).with("/datadir/one.d/key").returns true
+            File.expects(:read).with("/datadir/one.d/key").returns 'value one'
+
+            File.expects(:exist?).with("/datadir/two.d/key").returns true
+            File.expects(:read).with("/datadir/two.d/key").returns 'value two'
+
+            subject.lookup("key", {}, nil, :array).should == ['value one', 'value two']
+          end
+
+          it "should parse the answer for scope variables" do
+            scope = {'scope_val' => 'v'}
+
+            Backend.expects(:datafile).with(:file, scope, "one", "d").returns("/datadir/one.d")
+            Backend.expects(:datafile).with(:file, scope, "two", "d").never
+
+            File.expects(:exist?).with("/datadir/one.d/key").returns true
+            File.expects(:read).with("/datadir/one.d/key").returns '%{scope_val}alue'
+
+            subject.lookup("key", scope, nil, :priority).should == 'value'
+          end
+
+          it "should prevent directory traversal attacks" do
+            File.expects(:exist?).never
+            File.expects(:read).never
+
+            expect do
+              subject.lookup("../../../../../etc/passwd", {}, nil, :priority)
+            end.to raise_error
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: hiera-file
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- adrien@puppetlabs.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hiera
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 10
+        - 5
+        version: 0.10.5
+  type: :development
+  version_requirements: *id003
+description: A data backend for Hiera that can return the content of whole files
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/hiera/backend/file_backend.rb
+- spec/unit/file_backend_spec.rb
+has_rdoc: true
+homepage: http://github.com/adrienthebo/hiera-file
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: File backend for Hiera
+test_files: 
+- spec/unit/file_backend_spec.rb