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
|
# wikiget - CLI tool for downloading files from Wikimedia sites
# Copyright (C) 2023 Cody Logan
# SPDX-License-Identifier: GPL-3.0-or-later
#
# Wikiget is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Wikiget is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
"""Define tests related to the wikiget.wikiget module."""
from __future__ import annotations
import logging
from unittest.mock import MagicMock, patch
import pytest
from wikiget import USER_AGENT, __version__
from wikiget.wikiget import cli
@patch("wikiget.wikiget.process_download")
class TestCli:
"""Define tests related to wikiget.wikiget.cli."""
def test_cli_no_args(self, monkeypatch: pytest.MonkeyPatch) -> None:
"""If no arguments are passed, the program should exit with code 2."""
with monkeypatch.context() as m:
m.setattr("sys.argv", ["wikiget"])
with pytest.raises(SystemExit) as e:
cli()
assert e.value.code == 2
def test_cli_completed_successfully(
self, mock_process_download: MagicMock, monkeypatch: pytest.MonkeyPatch
) -> None:
"""If everything is successful, the program should exit with code 0."""
with monkeypatch.context() as m:
# pretend process_download was successful
mock_process_download.return_value = 0
m.setattr("sys.argv", ["wikiget", "File:Example.jpg"])
with pytest.raises(SystemExit) as e:
cli()
assert e.value.code == 0
def test_cli_completed_with_problems(
self, mock_process_download: MagicMock, monkeypatch: pytest.MonkeyPatch
) -> None:
"""If there are problems during execution, the exit code should be 1."""
with monkeypatch.context() as m:
# pretend process_download was unsuccessful
mock_process_download.return_value = 1
m.setattr("sys.argv", ["wikiget", "File:Example.jpg"])
with pytest.raises(SystemExit) as e:
cli()
assert e.value.code == 1
def test_cli_logs(
self,
mock_process_download: MagicMock,
monkeypatch: pytest.MonkeyPatch,
caplog: pytest.LogCaptureFixture,
) -> None:
"""When program execution starts, it should create the right log messages.
There should be an info log record with the program version as well as a debug
record with the user agent we're sending to the API.
"""
with monkeypatch.context() as m:
# pretend process_download was successful
mock_process_download.return_value = 0
m.setattr("sys.argv", ["wikiget", "File:Example.jpg"])
with pytest.raises(SystemExit):
cli()
assert caplog.record_tuples == [
(
"wikiget.wikiget",
logging.INFO,
f"Starting download session using wikiget {__version__}",
),
(
"wikiget.wikiget",
logging.DEBUG,
f"User agent: {USER_AGENT}",
),
]
|
