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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
|
# frozen_string_literal: true
require 'fileutils'
begin
require_relative '../lib/filewatcher'
rescue LoadError
require 'filewatcher'
end
describe Filewatcher do
subject(:processed) { watch_run.processed }
after do
logger.debug "FileUtils.rm_r #{tmp_dir}"
FileUtils.rm_r tmp_dir if File.exist?(tmp_dir)
described_class::SpecHelper.wait seconds: 5, interval: 0.2 do
!File.exist?(tmp_dir)
end
end
def initialize_filewatcher(path, options = {})
described_class.new(path, options.merge(logger: logger))
end
def transform_spec_files(file)
ruby_watch_run_class.transform_spec_files(file)
end
let(:ruby_watch_run_class) { described_class::SpecHelper::RubyWatchRun }
let(:tmp_dir) { ruby_watch_run_class::TMP_DIR }
let(:tmp_files_dir) { ruby_watch_run_class::TMP_FILES_DIR }
let(:logger) { described_class::SpecHelper.logger }
let(:raw_file_name) { 'tmp_file.txt' }
let(:initial_files) { { raw_file_name => {} } }
let(:change_event) { :update }
let(:change_directory) { false }
let(:changes) do
files = Array(initial_files.keys)
files << raw_file_name if files.empty?
files.to_h do |file|
[transform_spec_files(file), { event: change_event, directory: change_directory }]
end
end
let(:result_transformed_filename) do
transform_spec_files(initial_files.any? ? initial_files.keys.first : raw_file_name)
end
## TODO: Check its needless
let(:every) { false }
let(:immediate) { false }
let(:interval) { 0.2 }
let(:filewatcher_files) { File.expand_path("#{tmp_files_dir}/**/*") }
let(:filewatcher) do
initialize_filewatcher filewatcher_files, interval: interval, every: every, immediate: immediate
end
let(:watch_run) do
ruby_watch_run_class.new(
initial_files: initial_files, filewatcher: filewatcher, changes: changes
)
end
let(:processed_files) { watch_run.processed.flat_map(&:keys) }
describe '.print_version' do
subject(:method_call) { described_class.print_version }
let(:ruby_version_regexp) { '(j|truffle)?ruby \d+\.\d+\.\d+.*' }
let(:filewatcher_version_regexp) { "Filewatcher #{described_class::VERSION}" }
it do
expect { method_call }.to output(
/^#{ruby_version_regexp}\n#{filewatcher_version_regexp}$/
).to_stdout_from_any_process
end
end
describe '#initialize' do
describe 'regular run' do
before { watch_run.run }
context 'with excluding selected file patterns' do
let(:filewatcher) do
initialize_filewatcher(
filewatcher_files,
exclude: File.expand_path("#{tmp_files_dir}/**/*.txt")
)
end
it { is_expected.to be_empty }
end
context 'with absolute paths including globs' do
let(:filewatcher_files) { File.expand_path("#{tmp_files_dir}/**/*") }
it { is_expected.to eq [{ result_transformed_filename => :updated }] }
end
context 'with globs' do
let(:filewatcher_files) { "#{tmp_files_dir}/**/*" }
it { is_expected.to eq [{ result_transformed_filename => :updated }] }
end
context 'with explicit relative paths with globs' do
let(:filewatcher_files) { "./#{tmp_files_dir}/**/*" }
it { is_expected.to eq [{ result_transformed_filename => :updated }] }
end
context 'with explicit relative paths' do
let(:filewatcher_files) { "./#{tmp_files_dir}" }
it { is_expected.to eq [{ result_transformed_filename => :updated }] }
end
context 'with tilde expansion' do
let(:filewatcher_files) { '~/file_watcher_1.txt' }
let(:raw_file_name) { File.expand_path('~/file_watcher_1.txt') }
it { is_expected.to eq [{ raw_file_name => :updated }] }
end
context 'with Array of paths' do
let(:initial_file) { 'tmp_initial_file.txt' }
let(:subdir) { 'subdir' }
let(:new_file) { "#{subdir}/tmp_new_file.txt" }
let(:filewatcher_files) do
["#{tmp_files_dir}/#{initial_file}", "#{tmp_files_dir}/#{subdir}"]
end
let(:initial_files) do
{
initial_file => {}
}
end
let(:changes) do
initial_files.to_h { |key, _value| [transform_spec_files(key), { event: :update }] }
.merge(
transform_spec_files(new_file) => { event: :create }
)
end
let(:expected_changes) do
[
initial_files.to_h { |key, _value| [transform_spec_files(key), :updated] }
.merge(
expected_new_file_change
)
]
end
let(:expected_new_file_change) do
{
transform_spec_files(new_file) => :created
}
end
specify do
## For case when changes detected separately, in CI for example, probably just slowly
expect(processed).to eq(expected_changes)
.or contain_exactly(
*initial_files.map { |key, _value| { transform_spec_files(key) => :updated } },
expected_new_file_change
)
end
end
end
describe '`:immediate` option' do
before do
watch_run.start
watch_run.stop
end
context 'when is `true`' do
let(:immediate) { true }
it { is_expected.to eq [{ '' => '' }] }
describe 'when watched' do
subject { watch_run.watched }
it { is_expected.to be > 0 }
end
end
context 'when is `false`' do
let(:immediate) { false }
it { is_expected.to be_empty }
describe 'when watched' do
subject { watch_run.watched }
it { is_expected.to eq 0 }
end
end
end
end
describe '#watch' do
context 'when action is known' do
before do
FileUtils.mkdir_p subdirectory if defined? subdirectory
watch_run.run
end
context 'when there are file deletions' do
let(:change_event) { :delete }
it { is_expected.to eq [{ result_transformed_filename => :deleted }] }
end
context 'when there are file additions' do
let(:initial_files) { {} }
let(:changes) { { result_transformed_filename => { event: :create } } }
it { is_expected.to eq [{ result_transformed_filename => :created }] }
end
context 'when there are file updates' do
let(:change_event) { :update }
it { is_expected.to eq [{ result_transformed_filename => :updated }] }
end
context 'when there are new files in subdirectories' do
let(:subdirectory) { File.expand_path("#{tmp_files_dir}/new_sub_directory") }
let(:initial_files) { {} }
let(:created_filename) { File.join(subdirectory, 'file.txt') }
let(:changes) { { created_filename => { event: :create } } }
let(:every) { true }
## https://github.com/filewatcher/filewatcher/pull/115#issuecomment-674581595
let(:interval) { 0.4 }
it do
expect(processed).to eq [
{ subdirectory => :updated, created_filename => :created }
]
end
end
context 'when there are new subdirectories' do
let(:initial_files) { {} }
let(:raw_file_name) { 'new_sub_directory' }
let(:change_event) { :create }
let(:change_directory) { true }
it { is_expected.to eq [{ result_transformed_filename => :created }] }
end
end
context 'when action is unknown' do
let(:change_event) { :foo }
specify { expect { watch_run.run }.to raise_error(RuntimeError, 'Unknown change `foo`') }
end
end
describe '#stop' do
subject { watch_run.thread.join }
before do
watch_run.start
watch_run.filewatcher.stop
end
it { is_expected.to eq watch_run.thread }
end
def write_tmp_files(range)
logger.debug "#{__method__} #{range}"
FileUtils.mkdir_p tmp_files_dir
range.to_a.map do |n|
File.write(file = "#{tmp_files_dir}/file#{n}.txt", "content#{n}")
Filewatcher::SpecHelper.wait seconds: 1
file
end
end
shared_context 'when paused' do
let(:action) { :create }
let(:every) { true }
before do
watch_run.start
logger.debug 'filewatcher.pause'
watch_run.filewatcher.pause
described_class::SpecHelper.wait seconds: 1
write_tmp_files 1..4
end
end
describe '#pause' do
include_context 'when paused'
# update block should not have been called
it { is_expected.to be_empty }
end
describe '#resume' do
include_context 'when paused'
before do
logger.debug 'filewatcher.resume'
watch_run.filewatcher.resume
end
after do
watch_run.stop
end
describe 'changes while paused' do
# update block still should not have been called
it { is_expected.to be_empty }
end
describe 'changes after resumed' do
subject { processed_files }
let(:added_files) { write_tmp_files 5..7 }
before do
added_files
watch_run.wait
watch_run.filewatcher.stop
watch_run.stop
end
it { is_expected.to include_all_files added_files }
end
end
describe '#finalize' do
subject { processed_files }
let(:action) { :create }
let(:every) { true }
let(:added_files) { write_tmp_files 1..4 }
before do
watch_run.start
watch_run.filewatcher.stop
watch_run.thread.join
added_files
watch_run.filewatcher.finalize
end
it { is_expected.to include_all_files added_files }
end
end
|