test_utils_validators.py

import unittest
from pathlib import Path
from unittest.mock import Mock, patch

from huggingface_hub.utils import (
    HFValidationError,
    smoothly_deprecate_use_auth_token,
    validate_hf_hub_args,
    validate_repo_id,
)


@patch("huggingface_hub.utils._validators.validate_repo_id")
class TestHfHubValidator(unittest.TestCase):
    """Test `validate_hf_hub_args` decorator calls all default validators."""

    def test_validate_repo_id_as_arg(self, validate_repo_id_mock: Mock) -> None:
        """Test `validate_repo_id` is called when `repo_id` is passed as arg."""
        self.dummy_function(123)
        validate_repo_id_mock.assert_called_once_with(123)

    def test_validate_repo_id_as_kwarg(self, validate_repo_id_mock: Mock) -> None:
        """Test `validate_repo_id` is called when `repo_id` is passed as kwarg."""
        self.dummy_function(repo_id=123)
        validate_repo_id_mock.assert_called_once_with(123)

    @staticmethod
    @validate_hf_hub_args
    def dummy_function(repo_id: str) -> None:
        pass


class TestRepoIdValidator(unittest.TestCase):
    VALID_VALUES = (
        "123",
        "foo",
        "foo/bar",
        "Foo-BAR_foo.bar123",
    )
    NOT_VALID_VALUES = (
        Path("foo/bar"),  # Must be a string
        "a" * 100,  # Too long
        "datasets/foo/bar",  # Repo_type forbidden in repo_id
        ".repo_id",  # Cannot start with .
        "repo_id.",  # Cannot end with .
        "foo--bar",  # Cannot contain "--"
        "foo..bar",  # Cannot contain "."
        "foo.git",  # Cannot end with ".git"
    )

    def test_valid_repo_ids(self) -> None:
        """Test `repo_id` validation on valid values."""
        for repo_id in self.VALID_VALUES:
            validate_repo_id(repo_id)

    def test_not_valid_repo_ids(self) -> None:
        """Test `repo_id` validation on not valid values."""
        for repo_id in self.NOT_VALID_VALUES:
            with self.assertRaises(HFValidationError, msg=f"'{repo_id}' must not be valid"):
                validate_repo_id(repo_id)


class TestSmoothlyDeprecateUseAuthToken(unittest.TestCase):
    def test_token_normal_usage_as_arg(self) -> None:
        self.assertEqual(
            self.dummy_token_function("this_is_a_token"),
            ("this_is_a_token", {}),
        )

    def test_token_normal_usage_as_kwarg(self) -> None:
        self.assertEqual(
            self.dummy_token_function(token="this_is_a_token"),
            ("this_is_a_token", {}),
        )

    def test_token_normal_usage_with_more_kwargs(self) -> None:
        self.assertEqual(
            self.dummy_token_function(token="this_is_a_token", foo="bar"),
            ("this_is_a_token", {"foo": "bar"}),
        )

    def test_token_with_smoothly_deprecated_use_auth_token(self) -> None:
        self.assertEqual(
            self.dummy_token_function(use_auth_token="this_is_a_use_auth_token"),
            ("this_is_a_use_auth_token", {}),
        )

    def test_input_kwargs_not_mutated_by_smooth_deprecation(self) -> None:
        initial_kwargs = {"a": "b", "use_auth_token": "token"}
        kwargs = smoothly_deprecate_use_auth_token(fn_name="name", has_token=False, kwargs=initial_kwargs)
        self.assertEqual(kwargs, {"a": "b", "token": "token"})
        self.assertEqual(initial_kwargs, {"a": "b", "use_auth_token": "token"})  # not mutated!

    def test_with_both_token_and_use_auth_token(self) -> None:
        with self.assertWarns(UserWarning):
            # `use_auth_token` is ignored !
            self.assertEqual(
                self.dummy_token_function(token="this_is_a_token", use_auth_token="this_is_a_use_auth_token"),
                ("this_is_a_token", {}),
            )

    def test_not_deprecated_use_auth_token(self) -> None:
        # `use_auth_token` is accepted by `dummy_use_auth_token_function`
        # => `smoothly_deprecate_use_auth_token` is not called
        self.assertEqual(
            self.dummy_use_auth_token_function(use_auth_token="this_is_a_use_auth_token"),
            ("this_is_a_use_auth_token", {}),
        )

    @staticmethod
    @validate_hf_hub_args
    def dummy_token_function(token: str, **kwargs) -> None:
        return token, kwargs

    @staticmethod
    @validate_hf_hub_args
    def dummy_use_auth_token_function(use_auth_token: str, **kwargs) -> None:
        return use_auth_token, kwargs