def test_should_start_one_watcher_for_dirs_inside_cwd(
self, caplog: pytest.LogCaptureFixture
) -> None:
app_file = self.reload_path / "app" / "src" / "main.py"
app_first_file = self.reload_path / "app_first" / "src" / "main.py"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app", reload=True, reload_includes=["app*"]
)
reloader = self._setup_reloader(config)
assert len(reloader.watchers) == 1
assert self.reload_path == reloader.watchers[0].resolved_root
assert self._reload_tester(reloader, app_file)
assert (
caplog.records[-1].message
== f"WatchGodReload detected file change in '{[str(app_file)]}'."
" Reloading..."
)
assert caplog.records[-1].levelno == WARNING
assert self._reload_tester(reloader, app_first_file)
assert "WatchGodReload detected file change" in caplog.records[-1].message
assert (
caplog.records[-1].message == "WatchGodReload detected file change in "
f"'{[str(app_first_file)]}'. Reloading..."
)
assert caplog.records[-1].levelno == WARNING
reloader.shutdown()
def test_should_start_separate_watchers_for_dirs_outside_cwd(
self, caplog: pytest.LogCaptureFixture
) -> None:
app_dir = self.reload_path / "app"
app_file = self.reload_path / "app" / "src" / "main.py"
app_first_dir = self.reload_path / "app_first"
app_first_file = app_first_dir / "src" / "main.py"
with as_cwd(app_dir):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_dirs=[str(app_dir), str(app_first_dir)],
)
reloader = self._setup_reloader(config)
assert len(reloader.watchers) == 2
assert frozenset([app_dir, app_first_dir]) == frozenset(
[x.resolved_root for x in reloader.watchers]
)
assert self._reload_tester(reloader, app_file)
assert caplog.records[-1].levelno == WARNING
assert (
caplog.records[-1].message == "WatchGodReload detected file change in "
f"'{[str(app_file)]}'. Reloading..."
)
assert self._reload_tester(reloader, app_first_file)
assert caplog.records[-1].levelno == WARNING
assert (
caplog.records[-1].message == "WatchGodReload detected file change in "
f"'{[str(app_first_file)]}'. Reloading..."
)
reloader.shutdown()
def test_should_detect_new_reload_dirs(
self, caplog: pytest.LogCaptureFixture, tmp_path: Path
) -> None:
app_dir = tmp_path / "app"
app_file = app_dir / "file.py"
app_dir.mkdir()
app_file.touch()
app_first_dir = tmp_path / "app_first"
app_first_file = app_first_dir / "file.py"
with as_cwd(tmp_path), caplog.at_level(INFO):
config = Config(
app="tests.test_config:asgi_app", reload=True, reload_includes=["app*"]
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, app_file)
app_first_dir.mkdir()
assert self._reload_tester(reloader, app_first_file)
assert caplog.records[-2].levelno == INFO
assert (
caplog.records[-2].message == "WatchGodReload detected a new reload "
f"dir '{app_first_dir.name}' in '{tmp_path}'; Adding to watch list."
)
reloader.shutdown()
def test_should_detect_new_exclude_dirs(
self, caplog: pytest.LogCaptureFixture, tmp_path: Path
) -> None:
app_dir = tmp_path / "app"
app_file = app_dir / "file.py"
app_dir.mkdir()
app_file.touch()
app_first_dir = tmp_path / "app_first"
app_first_file = app_first_dir / "file.py"
with as_cwd(tmp_path), caplog.at_level(DEBUG):
config = Config(
app="tests.test_config:asgi_app", reload=True, reload_excludes=["app*"]
)
reloader = self._setup_reloader(config)
caplog.set_level(DEBUG, logger="uvicorn.error")
assert not self._reload_tester(reloader, app_file)
app_first_dir.mkdir()
assert not self._reload_tester(reloader, app_first_file)
assert caplog.records[-1].levelno == DEBUG
assert (
caplog.records[-1].message == "WatchGodReload detected a new excluded "
f"dir '{app_first_dir.name}' in '{tmp_path}'; Adding to exclude list."
)
reloader.shutdown()
def test_reload_subdir_removal(reload_directory_structure: Path) -> None:
app_dir = reload_directory_structure / "app"
reload_dirs = [str(reload_directory_structure), "app", str(app_dir)]
with as_cwd(reload_directory_structure):
config = Config(app="tests.test_config:asgi_app",
reload=True,
reload_dirs=reload_dirs)
assert config.reload_dirs == [reload_directory_structure]
def test_should_reload_when_python_file_in_subdir_is_changed(self) -> None:
file = self.reload_path / "app" / "sub" / "sub.py"
with as_cwd(self.reload_path):
config = Config(app="tests.test_config:asgi_app", reload=True)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, file)
reloader.shutdown()
def test_should_not_reload_when_dot_file_is_changed(self) -> None:
file = self.reload_path / ".dotted"
with as_cwd(self.reload_path):
config = Config(app="tests.test_config:asgi_app", reload=True)
reloader = self._setup_reloader(config)
assert not self._reload_tester(reloader, file)
reloader.shutdown()
def test_reloader_should_initialize(self) -> None:
"""
A basic sanity check.
Simply run the reloader against a no-op server, and signal for it to
quit immediately.
"""
with as_cwd(self.reload_path):
config = Config(app="tests.test_config:asgi_app", reload=True)
reloader = self._setup_reloader(config)
reloader.shutdown()
def test_non_existant_reload_dir_is_not_set(
reload_directory_structure: Path,
caplog: pytest.LogCaptureFixture) -> None:
with as_cwd(reload_directory_structure), caplog.at_level(logging.WARNING):
config = Config(app="tests.test_config:asgi_app",
reload=True,
reload_dirs=["reload"])
assert config.reload_dirs == [reload_directory_structure]
assert (
caplog.records[-1].message ==
"Provided reload directories ['reload'] did not contain valid " +
"directories, watching current working directory.")
def test_reload_when_pattern_matched_file_is_changed(self, result: bool) -> None:
file = self.reload_path / "app" / "js" / "main.js"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app", reload=True, reload_includes=["*.js"]
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, file) == result
reloader.shutdown()
def test_reload_included_dir_is_added_to_reload_dirs(
reload_directory_structure: Path, ) -> None:
app_dir = reload_directory_structure / "app"
ext_dir = reload_directory_structure / "ext"
with as_cwd(reload_directory_structure):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_dirs=[str(app_dir)],
reload_includes=["*.js", str(ext_dir)],
)
assert frozenset(config.reload_dirs), frozenset([app_dir, ext_dir])
assert frozenset(config.reload_includes) == frozenset(
["*.js", str(ext_dir)])
def test_should_not_reload_when_python_file_in_excluded_subdir_is_changed(
self, ) -> None:
sub_dir = self.reload_path / "app" / "sub"
sub_file = sub_dir / "sub.py"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_excludes=[str(sub_dir)],
)
reloader = self._setup_reloader(config)
assert not self._reload_tester(reloader, sub_file)
reloader.shutdown()
def test_reload_excluded_subdirectories_are_removed(
reload_directory_structure: Path, ) -> None:
app_dir = reload_directory_structure / "app"
app_sub_dir = app_dir / "sub"
with as_cwd(reload_directory_structure):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_excludes=[str(app_dir), str(app_sub_dir)],
)
assert frozenset(config.reload_dirs) == frozenset(
[reload_directory_structure])
assert frozenset(config.reload_dirs_excludes) == frozenset([app_dir])
assert frozenset(config.reload_excludes) == frozenset(
[str(app_dir), str(app_sub_dir)])
def test_should_not_reload_when_only_subdirectory_is_watched(self) -> None:
app_dir = self.reload_path / "app"
app_dir_file = self.reload_path / "app" / "src" / "main.py"
root_file = self.reload_path / "main.py"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_dirs=[str(app_dir)],
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, app_dir_file)
assert not self._reload_tester(reloader, root_file)
reloader.shutdown()
def test_should_parse_dir_from_includes(self) -> None:
app_dir = self.reload_path / "app"
app_file = app_dir / "src" / "main.py"
app_first_dir = self.reload_path / "app_first"
app_first_file = app_first_dir / "src" / "main.py"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_includes=[str(app_dir)],
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, app_file)
assert not self._reload_tester(reloader, app_first_file)
reloader.shutdown()
def test_should_reload_when_directories_have_same_prefix(self) -> None:
app_dir = self.reload_path / "app"
app_file = app_dir / "src" / "main.py"
app_first_dir = self.reload_path / "app_first"
app_first_file = app_first_dir / "src" / "main.py"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_dirs=[str(app_dir), str(app_first_dir)],
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, app_file)
assert self._reload_tester(reloader, app_first_file)
reloader.shutdown()
def test_should_not_reload_when_exclude_pattern_match_file_is_changed(self) -> None:
python_file = self.reload_path / "app" / "src" / "main.py"
css_file = self.reload_path / "app" / "css" / "main.css"
js_file = self.reload_path / "app" / "js" / "main.js"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_includes=["*"],
reload_excludes=["*.js"],
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, python_file)
assert self._reload_tester(reloader, css_file)
assert not self._reload_tester(reloader, js_file)
reloader.shutdown()
def test_override_defaults(self) -> None:
dotted_file = self.reload_path / ".dotted"
dotted_dir_file = self.reload_path / ".dotted_dir" / "file.txt"
python_file = self.reload_path / "main.py"
with as_cwd(self.reload_path):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
# We need to add *.txt otherwise no regular files will match
reload_includes=[".*", "*.txt"],
reload_excludes=["*.py"],
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, dotted_file)
assert self._reload_tester(reloader, dotted_dir_file)
assert not self._reload_tester(reloader, python_file)
reloader.shutdown()
def test_reload_includes_exclude_dir_patterns_are_matched(
reload_directory_structure: Path,
caplog: pytest.LogCaptureFixture) -> None:
with caplog.at_level(logging.INFO):
first_app_dir = reload_directory_structure / "app_first" / "src"
second_app_dir = reload_directory_structure / "app_second" / "src"
with as_cwd(reload_directory_structure):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_includes=["*/src"],
reload_excludes=["app", "*third*"],
)
assert len(caplog.records) == 1
assert (caplog.records[-1].message ==
"Will watch for changes in these directories: "
f"{sorted([str(first_app_dir), str(second_app_dir)])}")
assert frozenset(config.reload_dirs) == frozenset(
[first_app_dir, second_app_dir])
assert config.reload_includes == ["*/src"]
def test_should_print_full_path_for_non_relative(
self, caplog: pytest.LogCaptureFixture) -> None:
app_dir = self.reload_path / "app"
app_first_dir = self.reload_path / "app_first"
app_first_file = app_first_dir / "src" / "main.py"
with as_cwd(app_dir):
config = Config(
app="tests.test_config:asgi_app",
reload=True,
reload_dirs=[str(app_first_dir)],
)
reloader = self._setup_reloader(config)
assert self._reload_tester(reloader, app_first_file)
assert (
caplog.records[-1].message ==
f"StatReload detected file change in '{str(app_first_file)}'."
" Reloading...")
reloader.shutdown()
