path: root/spec/unit/parser/scope.rb

#!/usr/bin/env ruby

require File.dirname(__FILE__) + '/../../spec_helper'

describe Puppet::Parser::Scope do
    before :each do
        @topscope = Puppet::Parser::Scope.new()
        # This is necessary so we don't try to use the compiler to discover our parent.
        @topscope.parent = nil
        @scope = Puppet::Parser::Scope.new()
        @scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("foo"))
        @scope.parent = @topscope
    end
 
    it "should be able to store references to class scopes" do
        lambda { @scope.class_set "myname", "myscope" }.should_not raise_error
    end

    it "should be able to retrieve class scopes by name" do
        @scope.class_set "myname", "myscope"
        @scope.class_scope("myname").should == "myscope"
    end

    it "should be able to retrieve class scopes by object" do
        klass = mock 'ast_class'
        klass.expects(:name).returns("myname")
        @scope.class_set "myname", "myscope"
        @scope.class_scope(klass).should == "myscope"
    end

    # #620 - Nodes and classes should conflict, else classes don't get evaluated
    describe "when evaluating nodes and classes with the same name (#620)" do

        before do
            @node = stub :nodescope? => true
            @class = stub :nodescope? => false
        end

        it "should fail if a node already exists with the same name as the class being evaluated" do
            @scope.class_set("one", @node)
            lambda { @scope.class_set("one", @class) }.should raise_error(Puppet::ParseError)
        end

        it "should fail if a class already exists with the same name as the node being evaluated" do
            @scope.class_set("one", @class)
            lambda { @scope.class_set("one", @node) }.should raise_error(Puppet::ParseError)
        end
    end

    it "should get its environment from its compiler" do
        env = stub 'environment'
        compiler = stub 'compiler', :environment => env
        scope = Puppet::Parser::Scope.new :compiler => compiler
        scope.environment.should equal(env)
    end

    it "should use the resource type collection helper to find its known resource types" do
        Puppet::Parser::Scope.ancestors.should include(Puppet::Resource::TypeCollectionHelper)
    end

    describe "when looking up a variable" do
        it "should default to an empty string" do
            @scope.lookupvar("var").should == ""
        end

        it "should return an string when asked for a string" do
            @scope.lookupvar("var", true).should == ""
        end

        it "should return ':undefined' for unset variables when asked not to return a string" do
            @scope.lookupvar("var", false).should == :undefined
        end

        it "should be able to look up values" do
            @scope.setvar("var", "yep")
            @scope.lookupvar("var").should == "yep"
        end

        it "should be able to look up hashes" do
            @scope.setvar("var", {"a" => "b"})
            @scope.lookupvar("var").should == {"a" => "b"}
        end

        it "should be able to look up variables in parent scopes" do
            @topscope.setvar("var", "parentval")
            @scope.lookupvar("var").should == "parentval"
        end

        it "should prefer its own values to parent values" do
            @topscope.setvar("var", "parentval")
            @scope.setvar("var", "childval")
            @scope.lookupvar("var").should == "childval"
        end

        describe "and the variable is qualified" do
            before do
                @compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("foonode"))
                @scope.compiler = @compiler
                @known_resource_types = @scope.known_resource_types
            end

            def newclass(name)
                @known_resource_types.add Puppet::Resource::Type.new(:hostclass, name)
            end

            def create_class_scope(name)
                klass = newclass(name)
                Puppet::Parser::Resource.new("class", name, :scope => @scope, :source => mock('source')).evaluate

                return @scope.class_scope(klass)
            end

            it "should be able to look up explicitly fully qualified variables from main" do
                other_scope = create_class_scope("")

                other_scope.setvar("othervar", "otherval")

                @scope.lookupvar("::othervar").should == "otherval"
            end

            it "should be able to look up explicitly fully qualified variables from other scopes" do
                other_scope = create_class_scope("other")

                other_scope.setvar("var", "otherval")

                @scope.lookupvar("::other::var").should == "otherval"
            end

            it "should be able to look up deeply qualified variables" do
                other_scope = create_class_scope("other::deep::klass")

                other_scope.setvar("var", "otherval")

                @scope.lookupvar("other::deep::klass::var").should == "otherval"
            end

            it "should return an empty string for qualified variables that cannot be found in other classes" do
                other_scope = create_class_scope("other::deep::klass")

                @scope.lookupvar("other::deep::klass::var").should == ""
            end

            it "should warn and return an empty string for qualified variables whose classes have not been evaluated" do
                klass = newclass("other::deep::klass")
                @scope.expects(:warning)
                @scope.lookupvar("other::deep::klass::var").should == ""
            end

            it "should warn and return an empty string for qualified variables whose classes do not exist" do
                @scope.expects(:warning)
                @scope.lookupvar("other::deep::klass::var").should == ""
            end

            it "should return ':undefined' when asked for a non-string qualified variable from a class that does not exist" do
                @scope.stubs(:warning)
                @scope.lookupvar("other::deep::klass::var", false).should == :undefined
            end

            it "should return ':undefined' when asked for a non-string qualified variable from a class that has not been evaluated" do
                @scope.stubs(:warning)
                klass = newclass("other::deep::klass")
                @scope.lookupvar("other::deep::klass::var", false).should == :undefined
            end
        end
    end

    describe "when setvar is called with append=true" do
        it "should raise error if the variable is already defined in this scope" do
            @scope.setvar("var","1", :append => false)
            lambda { @scope.setvar("var","1", :append => true) }.should raise_error(Puppet::ParseError)
        end

        it "should lookup current variable value" do
            @scope.expects(:lookupvar).with("var").returns("2")
            @scope.setvar("var","1", :append => true)
        end

        it "should store the concatenated string '42'" do
            @topscope.setvar("var","4", :append => false)
            @scope.setvar("var","2", :append => true)
            @scope.lookupvar("var").should == "42"
        end

        it "should store the concatenated array [4,2]" do
            @topscope.setvar("var",[4], :append => false)
            @scope.setvar("var",[2], :append => true)
            @scope.lookupvar("var").should == [4,2]
        end

        it "should store the merged hash {a => b, c => d}" do
            @topscope.setvar("var",{"a" => "b"}, :append => false)
            @scope.setvar("var",{"c" => "d"}, :append => true)
            @scope.lookupvar("var").should == {"a" => "b", "c" => "d"}
        end

        it "should raise an error when appending a hash with something other than another hash" do
            @topscope.setvar("var",{"a" => "b"}, :append => false)
            lambda { @scope.setvar("var","not a hash", :append => true) }.should raise_error
        end
    end

    describe "when calling number?" do
        it "should return nil if called with anything not a number" do
            Puppet::Parser::Scope.number?([2]).should be_nil
        end

        it "should return a Fixnum for a Fixnum" do
            Puppet::Parser::Scope.number?(2).should be_an_instance_of(Fixnum)
        end

        it "should return a Float for a Float" do
            Puppet::Parser::Scope.number?(2.34).should be_an_instance_of(Float)
        end

        it "should return 234 for '234'" do
            Puppet::Parser::Scope.number?("234").should == 234
        end

        it "should return nil for 'not a number'" do
            Puppet::Parser::Scope.number?("not a number").should be_nil
        end

        it "should return 23.4 for '23.4'" do
            Puppet::Parser::Scope.number?("23.4").should == 23.4
        end

        it "should return 23.4e13 for '23.4e13'" do
            Puppet::Parser::Scope.number?("23.4e13").should == 23.4e13
        end

        it "should understand negative numbers" do
            Puppet::Parser::Scope.number?("-234").should == -234
        end

        it "should know how to convert exponential float numbers ala '23e13'" do
            Puppet::Parser::Scope.number?("23e13").should == 23e13
        end

        it "should understand hexadecimal numbers" do
            Puppet::Parser::Scope.number?("0x234").should == 0x234
        end

        it "should understand octal numbers" do
            Puppet::Parser::Scope.number?("0755").should == 0755
        end

        it "should return nil on malformed integers" do
            Puppet::Parser::Scope.number?("0.24.5").should be_nil
        end

        it "should convert strings with leading 0 to integer if they are not octal" do
            Puppet::Parser::Scope.number?("0788").should == 788
        end

        it "should convert strings of negative integers" do
            Puppet::Parser::Scope.number?("-0788").should == -788
        end

        it "should return nil on malformed hexadecimal numbers" do
            Puppet::Parser::Scope.number?("0x89g").should be_nil
        end
    end

    describe "when using ephemeral variables" do
        it "should store the variable value" do
            @scope.setvar("1", :value, :ephemeral => true)

            @scope.lookupvar("1").should == :value
        end

        it "should remove the variable value when unset_ephemeral_var is called" do
            @scope.setvar("1", :value, :ephemeral => true)
            @scope.stubs(:parent).returns(nil)

            @scope.unset_ephemeral_var

            @scope.lookupvar("1", false).should == :undefined
        end

        it "should not remove classic variables when unset_ephemeral_var is called" do
            @scope.setvar("myvar", :value1)
            @scope.setvar("1", :value2, :ephemeral => true)
            @scope.stubs(:parent).returns(nil)

            @scope.unset_ephemeral_var

            @scope.lookupvar("myvar", false).should == :value1
        end
    end

    describe "when interpolating string" do
        (0..9).each do |n|
            it "should allow $#{n} to match" do
                @scope.setvar(n.to_s, "value", :ephemeral => true)

                @scope.strinterp("$#{n}").should == "value"
            end
        end

        (0..9).each do |n|
            it "should not allow $#{n} to match if not ephemeral" do
                @scope.setvar(n.to_s, "value", :ephemeral => false)

                @scope.strinterp("$#{n}").should_not == "value"
            end
        end

        it "should not allow $10 to match" do
            @scope.setvar("10", "value", :ephemeral => true)

            @scope.strinterp('==$10==').should_not == "==value=="
        end

        it "should not allow ${10} to match" do
            @scope.setvar("10", "value", :ephemeral => true)

            @scope.strinterp('==${10}==').should == "==value=="
        end

        describe "with qualified variables" do
            before do
                @scopes = {}
                klass = @scope.known_resource_types.add(Puppet::Resource::Type.new(:hostclass, ""))
                Puppet::Parser::Resource.new("class", :main, :scope => @scope, :source => mock('source')).evaluate
                @scopes[""] = @scope.compiler.class_scope(klass)
                @scopes[""].setvar("test", "value")

                %w{one one::two one::two::three}.each do |name|
                    klass = @scope.known_resource_types.add(Puppet::Resource::Type.new(:hostclass, name))
                    Puppet::Parser::Resource.new("class", name, :scope => @scope, :source => mock('source')).evaluate
                    @scopes[name] = @scope.compiler.class_scope(klass)
                    @scopes[name].setvar("test", "value-#{name.sub(/.+::/,'')}")
                end
            end
            {
                "===${one::two::three::test}===" => "===value-three===",
                "===$one::two::three::test===" => "===value-three===",
                "===${one::two::test}===" => "===value-two===",
                "===$one::two::test===" => "===value-two===",
                "===${one::test}===" => "===value-one===",
                "===$one::test===" => "===value-one===",
                "===${::test}===" => "===value===",
                "===$::test===" => "===value==="
            }.each do |input, output|
                it "should parse '#{input}' correctly" do
                    @scope.strinterp(input).should == output
                end
            end
        end

        tests = {
            "===${test}===" => "===value===",
            "===${test} ${test} ${test}===" => "===value value value===",
            "===$test ${test} $test===" => "===value value value===",
            "===\\$test===" => "===$test===",
            '===\\$test string===' => "===$test string===",
            '===$test string===' => "===value string===",
            '===a testing $===' => "===a testing $===",
            '===a testing \$===' => "===a testing $===",
            "===an escaped \\\n carriage return===" => "===an escaped  carriage return===",
            '\$' => "$",
            '\s' => "\s",
            '\t' => "\t",
            '\n' => "\n"
        }

        tests.each do |input, output|
            it "should parse '#{input}' correctly" do
                @scope.setvar("test", "value")
                @scope.strinterp(input).should == output
            end
        end

        # #523
        %w{d f h l w z}.each do |l|
            it "should parse '#{l}' when escaped" do
                string = "\\" + l
                @scope.strinterp(string).should == string
            end
        end
    end

    def test_strinterp
        # Make and evaluate our classes so the qualified lookups work
        parser = mkparser
        klass = parser.newclass("")
        scope = mkscope(:parser => parser)
        Puppet::Parser::Resource.new(:type => "class", :title => :main, :scope => scope, :source => mock('source')).evaluate

        assert_nothing_raised {
            scope.setvar("test","value")
        }

        scopes = {"" => scope}

        %w{one one::two one::two::three}.each do |name|
            klass = parser.newclass(name)
            Puppet::Parser::Resource.new(:type => "class", :title => name, :scope => scope, :source => mock('source')).evaluate
            scopes[name] = scope.compiler.class_scope(klass)
            scopes[name].setvar("test", "value-%s" % name.sub(/.+::/,''))
        end

        assert_equal("value", scope.lookupvar("::test"), "did not look up qualified value correctly")
        tests.each do |input, output|
            assert_nothing_raised("Failed to scan %s" % input.inspect) do
                assert_equal(output, scope.strinterp(input),
                    'did not parserret %s correctly' % input.inspect)
            end
        end

        logs = []
        Puppet::Util::Log.close
        Puppet::Util::Log.newdestination(logs)

        # #523
        %w{d f h l w z}.each do |l|
            string = "\\" + l
            assert_nothing_raised do
                assert_equal(string, scope.strinterp(string),
                    'did not parserret %s correctly' % string)
            end

            assert(logs.detect { |m| m.message =~ /Unrecognised escape/ },
                "Did not get warning about escape sequence with %s" % string)
            logs.clear
        end
    end

    describe "when setting ephemeral vars from matches" do
        before :each do
            @match = stub 'match', :is_a? => true
            @match.stubs(:[]).with(0).returns("this is a string")
            @match.stubs(:captures).returns([])
            @scope.stubs(:setvar)
        end

        it "should accept only MatchData" do
            lambda { @scope.ephemeral_from("match") }.should raise_error
        end

        it "should set $0 with the full match" do
            @scope.expects(:setvar).with { |*arg| arg[0] == "0" and arg[1] == "this is a string" and arg[2][:ephemeral] }

            @scope.ephemeral_from(@match)
        end

        it "should set every capture as ephemeral var" do
            @match.stubs(:captures).returns([:capture1,:capture2])
            @scope.expects(:setvar).with { |*arg| arg[0] == "1" and arg[1] == :capture1 and arg[2][:ephemeral] }
            @scope.expects(:setvar).with { |*arg| arg[0] == "2" and arg[1] == :capture2 and arg[2][:ephemeral] }

            @scope.ephemeral_from(@match)
        end
    end

    describe "when unsetting variables" do
        it "should be able to unset normal variables" do
            @scope.setvar("foo", "bar")
            @scope.unsetvar("foo")
            @scope.lookupvar("foo").should == ""
        end

        it "should be able to unset ephemeral variables" do
            @scope.setvar("foo", "bar", :ephemeral => true)
            @scope.unsetvar("foo")
            @scope.lookupvar("foo").should == ""
        end
    end

    it "should use its namespaces to find hostclasses" do
        klass = @scope.known_resource_types.add Puppet::Resource::Type.new(:hostclass, "a::b::c")
        @scope.add_namespace "a::b"
        @scope.find_hostclass("c").should equal(klass)
    end

    it "should use its namespaces to find definitions" do
        define = @scope.known_resource_types.add Puppet::Resource::Type.new(:definition, "a::b::c")
        @scope.add_namespace "a::b"
        @scope.find_definition("c").should equal(define)
    end

    describe "when managing defaults" do
        it "should be able to set and lookup defaults" do
            param = Puppet::Parser::Resource::Param.new(:name => :myparam, :value => "myvalue", :source => stub("source"))
            @scope.setdefaults(:mytype, param)
            @scope.lookupdefaults(:mytype).should == {:myparam => param}
        end

        it "should fail if a default is already defined and a new default is being defined" do
            param = Puppet::Parser::Resource::Param.new(:name => :myparam, :value => "myvalue", :source => stub("source"))
            @scope.setdefaults(:mytype, param)
            lambda { @scope.setdefaults(:mytype, param) }.should raise_error(Puppet::ParseError)
        end

        it "should return multiple defaults at once" do
            param1 = Puppet::Parser::Resource::Param.new(:name => :myparam, :value => "myvalue", :source => stub("source"))
            @scope.setdefaults(:mytype, param1)
            param2 = Puppet::Parser::Resource::Param.new(:name => :other, :value => "myvalue", :source => stub("source"))
            @scope.setdefaults(:mytype, param2)

            @scope.lookupdefaults(:mytype).should == {:myparam => param1, :other => param2}
        end

        it "should look up defaults defined in parent scopes" do
            param1 = Puppet::Parser::Resource::Param.new(:name => :myparam, :value => "myvalue", :source => stub("source"))
            @scope.setdefaults(:mytype, param1)

            child_scope = @scope.newscope
            param2 = Puppet::Parser::Resource::Param.new(:name => :other, :value => "myvalue", :source => stub("source"))
            child_scope.setdefaults(:mytype, param2)

            child_scope.lookupdefaults(:mytype).should == {:myparam => param1, :other => param2}
        end
    end
end