aboutsummaryrefslogtreecommitdiff
path: root/tests/test_dl.py
blob: 297c59d670f4a3e02e95721d1f5690b6167644b6 (plain)
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
# 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/>.

from pathlib import Path

import pytest

from wikiget.dl import prep_download, process_download
from wikiget.file import File
from wikiget.wikiget import parse_args


class TestPrepDownload:
    # TODO: don't hit the actual API when doing tests
    @pytest.mark.skip(reason="skip tests that query a live API")
    def test_prep_download(self) -> None:
        """The prep_download function should create a file object."""
        args = parse_args(["File:Example.jpg"])
        file = prep_download(args.FILE, args)
        assert file is not None

    def test_prep_download_with_existing_file(self, tmp_path: Path) -> None:
        """
        Attempting to download a file with the same destination name as an existing file
        should raise a FileExistsError.
        """
        tmp_file = tmp_path / "File:Example.jpg"
        tmp_file.write_text("nothing")
        args = parse_args(["File:Example.jpg", "-o", str(tmp_file)])
        with pytest.raises(FileExistsError):
            _ = prep_download(args.FILE, args)


class TestProcessDownload:
    def test_batch_download(self, monkeypatch: pytest.MonkeyPatch) -> None:
        """A successful batch download should not return any errors."""

        def mock_batch_download(*args, **kwargs):  # noqa: ARG001
            return 0

        with monkeypatch.context() as m:
            m.setattr("wikiget.dl.batch_download", mock_batch_download)

            args = parse_args(["-a", "batch.txt"])
            exit_code = process_download(args)
            assert exit_code == 0

    def test_batch_download_with_errors(
        self, monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture
    ) -> None:
        """
        Any errors during batch download should create a log message containing the
        number of errors and result in a non-zero exit code.
        """

        def mock_batch_download(*args, **kwargs):  # noqa: ARG001
            return 4

        with monkeypatch.context() as m:
            m.setattr("wikiget.dl.batch_download", mock_batch_download)

            args = parse_args(["-a", "batch.txt"])
            exit_code = process_download(args)
            assert exit_code == 1
            assert "4 problems encountered during batch processing" in caplog.text

    def test_single_download(self, monkeypatch: pytest.MonkeyPatch) -> None:
        """A successful download should not return any errors."""

        def mock_download(*args, **kwargs):  # noqa: ARG001
            return 0

        def mock_prep_download(*args, **kwargs):  # noqa ARG001
            return File("Example.jpg")

        with monkeypatch.context() as m:
            m.setattr("wikiget.dl.download", mock_download)
            m.setattr("wikiget.dl.prep_download", mock_prep_download)

            args = parse_args(["File:Example.jpg"])
            exit_code = process_download(args)
            assert exit_code == 0

    def test_single_download_with_errors(self, monkeypatch: pytest.MonkeyPatch) -> None:
        """Any errors during download should result in a non-zero exit code."""

        def mock_download(*args, **kwargs):  # noqa: ARG001
            return 1

        def mock_prep_download(*args, **kwargs):  # noqa ARG001
            return File("Example.jpg")

        with monkeypatch.context() as m:
            m.setattr("wikiget.dl.download", mock_download)
            m.setattr("wikiget.dl.prep_download", mock_prep_download)

            args = parse_args(["File:Example.jpg"])
            exit_code = process_download(args)
            assert exit_code == 1