summaryrefslogtreecommitdiffstats
path: root/spec/unit/util/cacher_spec.rb
blob: 16414c8582781a3e4490dda00715610825e5386e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
#!/usr/bin/env rspec
require 'spec_helper'

require 'puppet/util/cacher'

class CacheTest
  @@count = 0

  def self.count
    @@count
  end

  include Puppet::Util::Cacher

  cached_attr(:instance_cache, 10) do
    @@count += 1
    {:number => @@count}
  end
end

describe Puppet::Util::Cacher do
  before :each do
    CacheTest.set_attr_ttl(:instance_cache, 10)
    @object = CacheTest.new
  end

  it "should return a value calculated from the provided block" do
    @object.instance_cache.should == {:number => CacheTest.count}
  end

  it "should return the cached value from the getter every time if the value is not expired" do
    @object.instance_cache.should equal(@object.instance_cache)
  end

  it "should regenerate and return a new value using the provided block if the value has expired" do
    initial = @object.instance_cache

    # Ensure the value is expired immediately
    CacheTest.set_attr_ttl(:instance_cache, -10)
    @object.send(:set_expiration, :instance_cache)

    @object.instance_cache.should_not equal(initial)
  end

  it "should be able to cache false values" do
    @object.expects(:init_instance_cache).once.returns false
    @object.instance_cache.should be_false
    @object.instance_cache.should be_false
  end

  it "should cache values again after expiration" do
    initial = @object.instance_cache

    # Ensure the value is expired immediately
    CacheTest.set_attr_ttl(:instance_cache, -10)
    @object.send(:set_expiration, :instance_cache)

    # Reset ttl so this new value doesn't get expired
    CacheTest.set_attr_ttl(:instance_cache, 10)
    after_expiration = @object.instance_cache

    after_expiration.should_not == initial
    @object.instance_cache.should == after_expiration
  end

  it "should allow writing of the attribute" do
    initial = @object.instance_cache

    @object.instance_cache = "another value"
    @object.instance_cache.should == "another value"
  end

  it "should update the expiration when the cached attribute is set manually" do
    # Freeze time
    now = Time.now
    Time.stubs(:now).returns now

    @object.instance_cache

    # Set expiration to something far in the future
    CacheTest.set_attr_ttl(:instance_cache, 60)
    @object.send(:set_expiration, :instance_cache)

    CacheTest.set_attr_ttl(:instance_cache, 10)

    @object.instance_cache = "foo"
    @object.instance_variable_get(:@attr_expirations)[:instance_cache].should == now + 10
  end

  it "should allow specification of a ttl as a string" do
    klass = Class.new do
      include Puppet::Util::Cacher
    end

    klass.cached_attr(:myattr, "5")  { 10 }

    klass.attr_ttl(:myattr).should == 5
  end

  it "should fail helpfully if the ttl cannot be converted to an integer" do
    klass = Class.new do
      include Puppet::Util::Cacher
    end

    lambda { klass.cached_attr(:myattr, "yep") { 10 } }.should raise_error(ArgumentError)
  end
end