aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/test/file_update_checker_shared_tests.rb
blob: bd056a157617bc2327244a0478191787e1104ff4 (plain) (blame)
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# frozen_string_literal: true

require "fileutils"

module FileUpdateCheckerSharedTests
  def self.included(kls)
    kls.class_eval do
      extend ActiveSupport::Testing::Declarative
      include FileUtils

      def tmpdir
        @tmpdir
      end

      def tmpfile(name)
        File.join(tmpdir, name)
      end

      def tmpfiles
        @tmpfiles ||= %w(foo.rb bar.rb baz.rb).map { |f| tmpfile(f) }
      end

      def run(*args)
        capture_exceptions do
          Dir.mktmpdir(nil, __dir__) { |dir| @tmpdir = dir; super }
        end
      end

      test "should not execute the block if no paths are given" do
        silence_warnings { require "listen" }
        i = 0

        checker = new_checker { i += 1 }

        assert_not checker.execute_if_updated
        assert_equal 0, i
      end

      test "should not execute the block if no files change" do
        i = 0

        FileUtils.touch(tmpfiles)

        checker = new_checker(tmpfiles) { i += 1 }

        assert_not checker.execute_if_updated
        assert_equal 0, i
      end

      test "should execute the block once when files are created" do
        i = 0

        checker = new_checker(tmpfiles) { i += 1 }

        touch(tmpfiles)
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "should execute the block once when files are modified" do
        i = 0

        FileUtils.touch(tmpfiles)

        checker = new_checker(tmpfiles) { i += 1 }

        touch(tmpfiles)
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "should execute the block once when files are deleted" do
        i = 0

        FileUtils.touch(tmpfiles)

        checker = new_checker(tmpfiles) { i += 1 }

        rm_f(tmpfiles)
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "updated should become true when watched files are created" do
        i = 0

        checker = new_checker(tmpfiles) { i += 1 }
        assert_not_predicate checker, :updated?

        touch(tmpfiles)
        wait

        assert_predicate checker, :updated?
      end

      test "updated should become true when watched files are modified" do
        i = 0

        FileUtils.touch(tmpfiles)

        checker = new_checker(tmpfiles) { i += 1 }
        assert_not_predicate checker, :updated?

        touch(tmpfiles)
        wait

        assert_predicate checker, :updated?
      end

      test "updated should become true when watched files are deleted" do
        i = 0

        FileUtils.touch(tmpfiles)

        checker = new_checker(tmpfiles) { i += 1 }
        assert_not_predicate checker, :updated?

        rm_f(tmpfiles)
        wait

        assert_predicate checker, :updated?
      end

      test "should be robust to handle files with wrong modified time" do
        i = 0

        FileUtils.touch(tmpfiles)

        now  = Time.now
        time = Time.mktime(now.year + 1, now.month, now.day) # wrong mtime from the future
        File.utime(time, time, tmpfiles[0])

        checker = new_checker(tmpfiles) { i += 1 }

        touch(tmpfiles[1..-1])
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "should return max_time for files with mtime = Time.at(0)" do
        i = 0

        FileUtils.touch(tmpfiles)

        time = Time.at(0) # wrong mtime from the future
        File.utime(time, time, tmpfiles[0])

        checker = new_checker(tmpfiles) { i += 1 }

        touch(tmpfiles[1..-1])
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "should cache updated result until execute" do
        i = 0

        checker = new_checker(tmpfiles) { i += 1 }
        assert_not_predicate checker, :updated?

        touch(tmpfiles)
        wait

        assert_predicate checker, :updated?
        checker.execute
        assert_not_predicate checker, :updated?
      end

      test "should execute the block if files change in a watched directory one extension" do
        i = 0

        checker = new_checker([], tmpdir => :rb) { i += 1 }

        touch(tmpfile("foo.rb"))
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "should execute the block if files change in a watched directory any extensions" do
        i = 0

        checker = new_checker([], tmpdir => []) { i += 1 }

        touch(tmpfile("foo.rb"))
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "should execute the block if files change in a watched directory several extensions" do
        i = 0

        checker = new_checker([], tmpdir => [:rb, :txt]) { i += 1 }

        touch(tmpfile("foo.rb"))
        wait

        assert checker.execute_if_updated
        assert_equal 1, i

        touch(tmpfile("foo.txt"))
        wait

        assert checker.execute_if_updated
        assert_equal 2, i
      end

      test "should not execute the block if the file extension is not watched" do
        i = 0

        checker = new_checker([], tmpdir => :txt) { i += 1 }

        touch(tmpfile("foo.rb"))
        wait

        assert_not checker.execute_if_updated
        assert_equal 0, i
      end

      test "does not assume files exist on instantiation" do
        i = 0

        non_existing = tmpfile("non_existing.rb")
        checker = new_checker([non_existing]) { i += 1 }

        touch(non_existing)
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "detects files in new subdirectories" do
        i = 0

        checker = new_checker([], tmpdir => :rb) { i += 1 }

        subdir = tmpfile("subdir")
        mkdir(subdir)
        wait

        assert_not checker.execute_if_updated
        assert_equal 0, i

        touch(File.join(subdir, "nested.rb"))
        wait

        assert checker.execute_if_updated
        assert_equal 1, i
      end

      test "looked up extensions are inherited in subdirectories not listening to them" do
        i = 0

        subdir = tmpfile("subdir")
        mkdir(subdir)

        checker = new_checker([], tmpdir => :rb, subdir => :txt) { i += 1 }

        touch(tmpfile("new.txt"))
        wait

        assert_not checker.execute_if_updated
        assert_equal 0, i

        # subdir does not look for Ruby files, but its parent tmpdir does.
        touch(File.join(subdir, "nested.rb"))
        wait

        assert checker.execute_if_updated
        assert_equal 1, i

        touch(File.join(subdir, "nested.txt"))
        wait

        assert checker.execute_if_updated
        assert_equal 2, i
      end

      test "initialize raises an ArgumentError if no block given" do
        assert_raise ArgumentError do
          new_checker([])
        end
      end
    end
  end
end