brozzler/tests/test_cli.py
Misty De Méo 0f0ae4fbc3 remove unnecessary imports, use find_spec
This was flagged by ruff check - if we just want to find out if a
package is available, and don't need to actually import it, we can
use importlib.util.find_spec() to resolve it. This can lead to a
moderate speedup too, since the import might be slow.
2025-07-18 15:09:45 -07:00

110 lines
3.5 KiB
Python

#!/usr/bin/env python
"""
test_cli.py - test brozzler commands
Copyright (C) 2017 Internet Archive
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import importlib.metadata
import importlib.util
import os
import subprocess
import doublethink
import pytest
import brozzler.cli
@pytest.fixture(scope="module")
def rethinker(request):
db = request.param if hasattr(request, "param") else "ignoreme"
servers = os.environ.get("BROZZLER_RETHINKDB_SERVERS", "localhost")
return doublethink.Rethinker(db=db, servers=servers.split(","))
def console_scripts():
# We do a dict comprehension here because the select filters aren't
# available until Python 3.10's importlib.
return {
ep.name: ep
for ep in importlib.metadata.distribution("brozzler").entry_points
if ep.group == "console_scripts"
}
def cli_commands():
commands = set(console_scripts().keys())
commands.remove("brozzler-wayback")
if not importlib.util.find_spec("gunicorn"):
commands.remove("brozzler-dashboard")
if not importlib.util.find_spec("pywb"):
commands.remove("brozzler-easy")
return commands
@pytest.mark.parametrize("cmd", cli_commands())
def test_call_entrypoint(capsys, cmd):
entrypoint = console_scripts()[cmd]
callable = entrypoint.load()
with pytest.raises(SystemExit):
callable(["/whatever/bin/%s" % cmd, "--version"])
out, err = capsys.readouterr()
assert out == "brozzler %s - %s\n" % (brozzler.__version__, cmd)
assert err == ""
@pytest.mark.parametrize("cmd", cli_commands())
def test_run_command(capsys, cmd):
proc = subprocess.Popen(
[cmd, "--version"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
out, err = proc.communicate()
# Remove lines from syntax warning in imported library
filtered_lines = [
line
for line in err.decode("utf-8").splitlines()
if "reppy" not in line and "re.compile" not in line
]
assert filtered_lines == []
assert out == ("brozzler %s - %s\n" % (brozzler.__version__, cmd)).encode("ascii")
@pytest.mark.parametrize("rethinker", ["rethinkdb"], indirect=True) # build-in db
def test_rethinkdb_up(rethinker):
"""Check that rethinkdb is up and running."""
# check that rethinkdb is listening and looks sane
rr = rethinker
tbls = rr.table_list().run()
assert len(tbls) > 10
# XXX don't know why this test is failing in travis-ci and vagrant while
# test_call_entrypoint tests pass :( (also fails with capfd)
@pytest.mark.xfail
def test_stop_nonexistent_crawl(capsys):
with pytest.raises(SystemExit):
brozzler.cli.brozzler_stop_crawl(["brozzler-stop-crawl", "--site=123"])
out, err = capsys.readouterr()
assert err.endswith("site not found with id=123\n")
assert out == ""
with pytest.raises(SystemExit):
brozzler.cli.brozzler_stop_crawl(["brozzler-stop-crawl", "--job=abc"])
out, err = capsys.readouterr()
assert err.endswith("""job not found with id='abc'\n""")
assert out == ""