tests/data_ingestion_tests.py

#!/usr/bin/env python3
"""Unit tests for data_ingestion.py script."""
#
# (C) Pywikibot team, 2012-2022
#
# Distributed under the terms of the MIT license.
#
from __future__ import annotations

import unittest

from scripts import data_ingestion
from tests import join_data_path, join_images_path
from tests.aspects import ScriptMainTestCase, TestCase
from tests.utils import empty_sites


class TestPhoto(TestCase):

    """Test Photo class."""

    sites = {
        'wm-upload': {
            'hostname': 'upload.wikimedia.org',
        },
        'commons': {
            'family': 'commons',
            'code': 'commons',
        },
    }

    def setUp(self):
        """Set up unit test."""
        super().setUp()
        url = ('http://upload.wikimedia.org/wikipedia/commons/f/'
               'fc/MP_sounds.png')

        meta_url = 'http://commons.wikimedia.org/wiki/File:Sound-icon.svg'
        self.obj = data_ingestion.Photo(
            url=url,
            metadata={'description.en': '"Sounds" icon',
                      'source': meta_url,
                      'author': 'KDE artists | Silstor',
                      'license': 'LGPL',
                      'set': 'Crystal SVG icon set',
                      'name': 'Sound icon'},
            site=self.get_site('commons'))

    def test_download_photo(self):
        """Test download from http://upload.wikimedia.org/."""
        with open(join_images_path('MP_sounds.png'), 'rb') as f:
            self.assertEqual(f.read(), self.obj.download_photo().read())

    def test_find_duplicate_images(self):
        """Test finding duplicates on Wikimedia Commons."""
        duplicates = self.obj.find_duplicate_images()
        self.assertIn('MP sounds.png',
                      [dup.replace('_', ' ') for dup in duplicates])

    def test_get_title(self):
        """Test getTitle()."""
        self.assertEqual(self.obj.get_title('%(name)s - %(set)s.%(_ext)s'),
                         'Sound icon - Crystal SVG icon set.png')

    def test_get_description(self):
        """Test getDescription()."""
        self.assertEqual(self.obj.get_description('CrystalTemplate'),
                         """{{CrystalTemplate
|author=KDE artists {{!}} Silstor
|description.en="Sounds" icon
|license=LGPL
|name=Sound icon
|set=Crystal SVG icon set
|source=http://commons.wikimedia.org/wiki/File:Sound-icon.svg
}}""")


class TestCSVReader(TestCase):

    """Test CSVReader class."""

    family = 'commons'
    code = 'commons'

    def setUp(self):
        """Set up unit test."""
        super().setUp()
        with open(join_data_path('csv_ingestion.csv')) as fileobj:
            self.iterator = data_ingestion.CSVReader(fileobj, 'url',
                                                     site=self.get_site())
            self.obj = next(self.iterator)

    def test_photo_url(self):
        """Test PhotoURL()."""
        self.assertEqual(
            self.obj.URL,
            'http://upload.wikimedia.org/wikipedia/commons/f/fc/MP_sounds.png')

    def test_get_title(self):
        """Test getTitle()."""
        self.assertEqual(self.obj.get_title('%(name)s - %(set)s.%(_ext)s'),
                         'Sound icon - Crystal SVG icon set.png')

    def test_get_description(self):
        """Test getDescription()."""
        self.assertEqual(self.obj.get_description('CrystalTemplate'),
                         """{{CrystalTemplate
|author=KDE artists {{!}} Silstor
|description.en="Sounds" icon
|license=LGPL
|name=Sound icon
|set=Crystal SVG icon set
|source=http://commons.wikimedia.org/wiki/File:Sound-icon.svg
|url=http://upload.wikimedia.org/wikipedia/commons/f/fc/MP_sounds.png
}}""")


class TestDataIngestionBot(ScriptMainTestCase):

    """Test TestDataIngestionBot class."""

    family = 'wikipedia'
    code = 'test'

    def test_existing_file(self):
        """Test uploading a file that already exists."""
        with empty_sites():
            data_ingestion.main(
                '-csvdir:tests/data',
                '-page:User:John_Vandenberg/data_ingestion_test_template')


if __name__ == '__main__':
    unittest.main()