test_typosnyper.py

# 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 pytest

from warehouse.packaging import typosnyper
from warehouse.packaging.models import Project
from warehouse.packaging.typosnyper import typo_check_name


@pytest.mark.parametrize(
    ("name", "expected"),
    [
        ("x", None),  # Pass, shorter than 4 characters
        ("numpy", None),  # Pass, no typos, exists
        ("NuMpy", None),  # Pass, same as `numpy` after canonicalization
        ("nuumpy", ("repeated_characters", "numpy")),
        ("reequests", ("repeated_characters", "requests")),
        ("sphnx", ("omitted_characters", "sphinx")),
        ("python-dteutil", ("omitted_characters", "python-dateutil")),
        ("pythondateutil", ("omitted_characters", "python-dateutil")),
        ("jinj2a", ("swapped_characters", "jinja2")),
        ("dateutil-python", ("swapped_words", "python-dateutil")),
        ("numpi", ("common_typos", "numpy")),
        ("requestz", ("common_typos", "requests")),
    ],
)
def test_typo_check_name(name, expected):
    # Set known entries corpus entries for testing
    test_names_corpus = {
        "numpy",
        "requests",
        "sphinx",
        "beautifulsoup4",
        "jinja2",
        "python-dateutil",
    }

    assert typo_check_name(name, corpus=test_names_corpus) == expected


def test_check_typo_after_commit(db_request):
    project = Project(name="foobar")
    db_request.db.add(project)
    db_request.db.commit()

    assert typosnyper.check_typo_after_commit.calls == []