File: watcher_test.rb

package info (click to toggle)
ruby-spring 1.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 364 kB
  • ctags: 429
  • sloc: ruby: 2,762; makefile: 6
file content (169 lines) | stat: -rw-r--r-- 3,214 bytes parent folder | download
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
require "helper"
require "tmpdir"
require "fileutils"
require "timeout"
require "active_support/core_ext/numeric/time"
require "spring/watcher"
require "spring/watcher/polling"

module WatcherTests
  LATENCY = 0.001
  TIMEOUT = 1

  attr_accessor :dir

  def watcher
    @watcher ||= watcher_class.new(dir, LATENCY)
  end

  def setup
    @dir = File.realpath(Dir.mktmpdir)
  end

  def teardown
    FileUtils.remove_entry_secure @dir
    watcher.stop
  end

  def touch(file, mtime = nil)
    options = {}
    options[:mtime] = mtime if mtime
    FileUtils.touch(file, options)
  end

  def assert_stale
    timeout = Time.now + TIMEOUT
    sleep LATENCY until watcher.stale? || Time.now > timeout
    assert watcher.stale?
  end

  def assert_not_stale
    sleep LATENCY * 10
    assert !watcher.stale?
  end

  def test_starting_with_no_file
    file = "#{@dir}/omg"
    touch file, Time.now - 2.seconds

    watcher.start
    watcher.add file

    assert_not_stale
    touch file, Time.now
    assert_stale
  end

  def test_is_stale_when_a_watched_file_is_updated
    file = "#{@dir}/omg"
    touch file, Time.now - 2.seconds

    watcher.add file
    watcher.start

    assert_not_stale
    touch file, Time.now
    assert_stale
  end

  def test_is_stale_when_removing_files
    file = "#{@dir}/omg"
    touch file, Time.now

    watcher.add file
    watcher.start

    assert_not_stale
    FileUtils.rm(file)
    assert_stale
  end

  def test_is_stale_when_files_are_added_to_a_watched_directory
    subdir = "#{@dir}/subdir"
    FileUtils.mkdir(subdir)

    watcher.add subdir
    watcher.start

    assert_not_stale
    touch "#{subdir}/foo", Time.now - 1.minute
    assert_stale
  end

  def test_is_stale_when_a_file_is_changed_in_a_watched_directory
    subdir = "#{@dir}/subdir"
    FileUtils.mkdir(subdir)
    touch "#{subdir}/foo", Time.now - 1.minute

    watcher.add subdir
    watcher.start

    assert_not_stale
    touch "#{subdir}/foo", Time.now
    assert_stale
  end

  def test_adding_doesnt_wipe_stale_state
    file = "#{@dir}/omg"
    file2 = "#{@dir}/foo"
    touch file, Time.now - 2.seconds
    touch file2, Time.now - 2.seconds

    watcher.add file
    watcher.start

    assert_not_stale

    touch file, Time.now
    watcher.add file2

    assert_stale
  end

  def test_on_stale
    file = "#{@dir}/omg"
    touch file, Time.now - 2.seconds

    stale = false
    watcher.on_stale { stale = true }

    watcher.add file
    watcher.start

    touch file, Time.now

    Timeout.timeout(1) { sleep 0.01 until stale }
    assert stale

    # Check that we only get notified once
    stale = false
    sleep LATENCY * 3
    assert !stale
  end

  def test_add_relative_path
    File.write("#{dir}/foo", "foo")
    watcher.add "foo"
    assert_equal ["#{dir}/foo"], watcher.files.to_a
  end

  def test_add_dot_relative_path
    File.write("#{dir}/foo", "foo")
    watcher.add "./foo"
    assert_equal ["#{dir}/foo"], watcher.files.to_a
  end

  def test_add_non_existant_file
    watcher.add './foobar'
    assert watcher.files.empty?
  end
end


class PollingWatcherTest < ActiveSupport::TestCase
  include WatcherTests

  def watcher_class
    Spring::Watcher::Polling
  end
end