path: root/spec/unit/provider/augeas/augeas_spec.rb

#!/usr/bin/env ruby

require 'spec_helper'

provider_class = Puppet::Type.type(:augeas).provider(:augeas)

describe provider_class do

  describe "command parsing" do
    before do
      @resource = stub("resource")
      @provider = provider_class.new(@resource)
    end

    it "should break apart a single line into three tokens and clean up the context" do
      @resource.stubs(:[]).returns("/context")
      tokens = @provider.parse_commands("set Jar/Jar Binks")
      tokens.size.should == 1
      tokens[0].size.should == 3
      tokens[0][0].should == "set"
      tokens[0][1].should == "/context/Jar/Jar"
      tokens[0][2].should == "Binks"
    end

    it "should break apart a multiple line into six tokens" do
      @resource.stubs(:[]).returns("")
      tokens = @provider.parse_commands("set /Jar/Jar Binks\nrm anakin")
      tokens.size.should == 2
      tokens[0].size.should == 3
      tokens[1].size.should == 2
      tokens[0][0].should == "set"
      tokens[0][1].should == "/Jar/Jar"
      tokens[0][2].should == "Binks"
      tokens[1][0].should == "rm"
      tokens[1][1].should == "anakin"
    end

    it "should strip whitespace and ignore blank lines" do
      @resource.stubs(:[]).returns("")
      tokens = @provider.parse_commands("  set /Jar/Jar Binks \t\n  \n\n  rm anakin ")
      tokens.size.should == 2
      tokens[0].size.should == 3
      tokens[1].size.should == 2
      tokens[0][0].should == "set"
      tokens[0][1].should == "/Jar/Jar"
      tokens[0][2].should == "Binks"
      tokens[1][0].should == "rm"
      tokens[1][1].should == "anakin"
    end

    it "should handle arrays" do
      @resource.stubs(:[]).returns("/foo/")
      commands = ["set /Jar/Jar Binks", "rm anakin"]
      tokens = @provider.parse_commands(commands)
      tokens.size.should == 2
      tokens[0].size.should == 3
      tokens[1].size.should == 2
      tokens[0][0].should == "set"
      tokens[0][1].should == "/Jar/Jar"
      tokens[0][2].should == "Binks"
      tokens[1][0].should == "rm"
      tokens[1][1].should == "/foo/anakin"
    end

    # This is not supported in the new parsing class
    #it "should concat the last values" do
    #    provider = provider_class.new
    #    tokens = provider.parse_commands("set /Jar/Jar Binks is my copilot")
    #    tokens.size.should == 1
    #    tokens[0].size.should == 3
    #    tokens[0][0].should == "set"
    #    tokens[0][1].should == "/Jar/Jar"
    #    tokens[0][2].should == "Binks is my copilot"
    #end

    it "should accept spaces in the value and single ticks" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands("set JarJar 'Binks is my copilot'")
      tokens.size.should == 1
      tokens[0].size.should == 3
      tokens[0][0].should == "set"
      tokens[0][1].should == "/foo/JarJar"
      tokens[0][2].should == "Binks is my copilot"
    end

    it "should accept spaces in the value and double ticks" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands('set /JarJar "Binks is my copilot"')
      tokens.size.should == 1
      tokens[0].size.should == 3
      tokens[0][0].should == "set"
      tokens[0][1].should == '/JarJar'
      tokens[0][2].should == 'Binks is my copilot'
    end

    it "should accept mixed ticks" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands('set JarJar "Some \'Test\'"')
      tokens.size.should == 1
      tokens[0].size.should == 3
      tokens[0][0].should == "set"
      tokens[0][1].should == '/foo/JarJar'
      tokens[0][2].should == "Some \'Test\'"
    end

    it "should handle predicates with literals" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands("rm */*[module='pam_console.so']")
      tokens.should == [["rm", "/foo/*/*[module='pam_console.so']"]]
    end

    it "should handle whitespace in predicates" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands("ins 42 before /files/etc/hosts/*/ipaddr[ . = '127.0.0.1' ]")
      tokens.should == [["ins", "42", "before","/files/etc/hosts/*/ipaddr[ . = '127.0.0.1' ]"]]
    end

    it "should handle multiple predicates" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands("clear pam.d/*/*[module = 'system-auth'][type = 'account']")
      tokens.should == [["clear", "/foo/pam.d/*/*[module = 'system-auth'][type = 'account']"]]
    end

    it "should handle nested predicates" do
      @resource.stubs(:[]).returns("/foo/")
      args = ["clear", "/foo/pam.d/*/*[module[ ../type = 'type] = 'system-auth'][type[last()] = 'account']"]
      tokens = @provider.parse_commands(args.join(" "))
      tokens.should == [ args ]
    end

    it "should handle escaped doublequotes in doublequoted string" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands("set /foo \"''\\\"''\"")
      tokens.should == [[ "set", "/foo", "''\\\"''" ]]
    end

    it "should allow escaped spaces and brackets in paths" do
      @resource.stubs(:[]).returns("/foo/")
      args = [ "set", "/white\\ space/\\[section", "value" ]
      tokens = @provider.parse_commands(args.join(" \t "))
      tokens.should == [ args ]
    end

    it "should allow single quoted escaped spaces in paths" do
      @resource.stubs(:[]).returns("/foo/")
      args = [ "set", "'/white\\ space/key'", "value" ]
      tokens = @provider.parse_commands(args.join(" \t "))
      tokens.should == [[ "set", "/white\\ space/key", "value" ]]
    end

    it "should allow double quoted escaped spaces in paths" do
      @resource.stubs(:[]).returns("/foo/")
      args = [ "set", '"/white\\ space/key"', "value" ]
      tokens = @provider.parse_commands(args.join(" \t "))
      tokens.should == [[ "set", "/white\\ space/key", "value" ]]
    end

    it "should remove trailing slashes" do
      @resource.stubs(:[]).returns("/foo/")
      tokens = @provider.parse_commands("set foo/ bar")
      tokens.should == [[ "set", "/foo/foo", "bar" ]]
    end
  end

  describe "get filters" do
    before do
      augeas_stub = stub("augeas", :get => "value")
      @provider = provider_class.new
      @provider.aug= augeas_stub
    end

    it "should return false for a = nonmatch" do
      command = ["get", "fake value", "==", "value"]
      @provider.process_get(command).should == true
    end

    it "should return true for a != match" do
      command = ["get", "fake value", "!=", "value"]
      @provider.process_get(command).should == false
    end

    it "should return true for a =~ match" do
      command = ["get", "fake value", "=~", "val*"]
      @provider.process_get(command).should == true
    end

    it "should return false for a == nonmatch" do
      command = ["get", "fake value", "=~", "num*"]
      @provider.process_get(command).should == false
    end
  end

  describe "match filters" do
    before do
      resource = stub("resource", :[] => "")
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      @provider = provider_class.new(resource)
      @provider.aug= augeas_stub
    end

    it "should return true for size match" do
      command = ["match", "fake value", "size == 3"]
      @provider.process_match(command).should == true
    end

    it "should return false for a size non match" do
      command = ["match", "fake value", "size < 3"]
      @provider.process_match(command).should == false
    end

    it "should return true for includes match" do
      command = ["match", "fake value", "include values"]
      @provider.process_match(command).should == true
    end

    it "should return false for includes non match" do
      command = ["match", "fake value", "include JarJar"]
      @provider.process_match(command).should == false
    end

    it "should return true for includes match" do
      command = ["match", "fake value", "not_include JarJar"]
      @provider.process_match(command).should == true
    end

    it "should return false for includes non match" do
      command = ["match", "fake value", "not_include values"]
      @provider.process_match(command).should == false
    end

    it "should return true for an array match" do
      command = ["match", "fake value", "== ['set', 'of', 'values']"]
      @provider.process_match(command).should == true
    end

    it "should return false for an array non match" do
      command = ["match", "fake value", "== ['this', 'should', 'not', 'match']"]
      @provider.process_match(command).should == false
    end

    it "should return false for an array match with noteq" do
      command = ["match", "fake value", "!= ['set', 'of', 'values']"]
      @provider.process_match(command).should == false
    end

    it "should return true for an array non match with noteq" do
      command = ["match", "fake value", "!= ['this', 'should', 'not', 'match']"]
      @provider.process_match(command).should == true
    end
  end

  describe "need to run" do
    it "should handle no filters" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("").then.returns("")
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      augeas_stub.stubs("close")
      provider = provider_class.new(resource)
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == true
    end

    it "should return true when a get filter matches" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("get path == value").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :get => "value")
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == true
    end

    it "should return false when a get filter does not match" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("get path == another value").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :get => "value")
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == false
    end

    it "should return true when a match filter matches" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("match path size == 3").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == true
    end

    it "should return false when a match filter does not match" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("match path size == 2").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == false
    end

    #This is a copy of the last one, with setting the force to true
    it "setting force should not change the above logic" do
      resource = stub("resource")
      resource.stubs(:[]).returns(true).then.returns("match path size == 2").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == false
    end

    #Ticket 5211 testing
    it "should return true when a size != the provided value" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("match path size != 17").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == true
    end

    #Ticket 5211 testing
    it "should return false when a size doeas equal the provided value" do
      resource = stub("resource")
      resource.stubs(:[]).returns(false).then.returns("match path size != 3").then.returns("")
      provider = provider_class.new(resource)
      augeas_stub = stub("augeas", :match => ["set", "of", "values"])
      augeas_stub.stubs("close")
      provider.aug= augeas_stub
      provider.stubs(:get_augeas_version).returns("0.3.5")
      provider.need_to_run?.should == false
    end
  end

  describe "augeas execution integration" do

    before do
      @resource = stub("resource")
      @provider = provider_class.new(@resource)
      @augeas = stub("augeas")
      @provider.aug= @augeas
      @provider.stubs(:get_augeas_version).returns("0.3.5")
    end

    it "should handle set commands" do
      command = "set JarJar Binks"
      context = "/some/path/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:set).with("/some/path/JarJar", "Binks").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle rm commands" do
      command = "rm /Jar/Jar"
      context = ""
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:rm).with("/Jar/Jar")
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle remove commands" do
      command = "remove /Jar/Jar"
      context = ""
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:rm).with("/Jar/Jar")
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle clear commands" do
      command = "clear Jar/Jar"
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:clear).with("/foo/Jar/Jar").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end


    it "should handle ins commands with before" do
      command = "ins Binks before Jar/Jar"
      context = "/foo"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:insert).with("/foo/Jar/Jar", "Binks", true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle ins commands with after" do
      command = "ins Binks after /Jar/Jar"
      context = "/foo"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:insert).with("/Jar/Jar", "Binks", false)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle ins with no context" do
      command = "ins Binks after /Jar/Jar"
      context = "" # this is the default
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:insert).with("/Jar/Jar", "Binks", false)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle multiple commands" do
      command = ["ins Binks after /Jar/Jar", "clear Jar/Jar"]
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:insert).with("/Jar/Jar", "Binks", false)
      @augeas.expects(:clear).with("/foo/Jar/Jar").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle defvar commands" do
      command = "defvar myjar Jar/Jar"
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:defvar).with("myjar", "/foo/Jar/Jar").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should pass through augeas variables without context" do
      command = ["defvar myjar Jar/Jar","set $myjar/Binks 1"]
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:defvar).with("myjar", "/foo/Jar/Jar").returns(true)
      # this is the important bit, shouldn't be /foo/$myjar/Binks
      @augeas.expects(:set).with("$myjar/Binks", "1").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle defnode commands" do
      command = "defnode newjar Jar/Jar[last()+1] Binks"
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:defnode).with("newjar", "/foo/Jar/Jar[last()+1]", "Binks").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle mv commands" do
      command = "mv Jar/Jar Binks"
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:mv).with("/foo/Jar/Jar", "/foo/Binks").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end

    it "should handle setm commands" do
      command = ["set test[1]/Jar/Jar Foo","set test[2]/Jar/Jar Bar","setm test Jar/Jar Binks"]
      context = "/foo/"
      @resource.expects(:[]).times(2).returns(command).then.returns(context)
      @augeas.expects(:set).with("/foo/test[1]/Jar/Jar", "Foo").returns(true)
      @augeas.expects(:set).with("/foo/test[2]/Jar/Jar", "Bar").returns(true)
      @augeas.expects(:setm).with("/foo/test", "Jar/Jar", "Binks").returns(true)
      @augeas.expects(:save).returns(true)
      @augeas.expects(:close)
      @provider.execute_changes.should == :executed
    end
  end
end