nucliadb-utils 4.0.3.post573__py3-none-any.whl → 4.0.3.post576__py3-none-any.whl

nucliadb_utils/tests/unit/test_run.py

@@ -1,57 +0,0 @@
-# Copyright (C) 2021 Bosutech XXI S.L.
-#
-# nucliadb is offered under the AGPL v3.0 and as commercial software.
-# For commercial licensing, contact us at info@nuclia.com.
-#
-# AGPL:
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-import asyncio
-from unittest.mock import AsyncMock, MagicMock, patch
-
-import pytest
-
-from nucliadb_utils import run
-
-pytestmark = pytest.mark.asyncio
-
-
-async def test_run_until_exit():
-    loop = MagicMock()
-    with patch("nucliadb_utils.run.asyncio.get_running_loop", return_value=loop):
-        finalizer = AsyncMock()
-        asyncio.create_task(run.run_until_exit([finalizer], sleep=0.01))
-
-        await asyncio.sleep(0.05)
-
-        assert len(loop.add_signal_handler.mock_calls) == 2
-        callback = loop.add_signal_handler.mock_calls[0].args[1]
-        callback()  # cause exit
-
-        await asyncio.sleep(0.05)
-
-        finalizer.assert_called_once()
-
-
-async def test_run_until_exit_handles_hard_exit():
-    loop = MagicMock()
-    with patch("nucliadb_utils.run.asyncio.get_running_loop", return_value=loop):
-        finalizer = AsyncMock(side_effect=Exception())
-        task = asyncio.create_task(run.run_until_exit([finalizer]))
-
-        await asyncio.sleep(0.05)
-        task.cancel()
-        await asyncio.sleep(0.05)
-
-        finalizer.assert_called_once()

nucliadb_utils/tests/unit/test_signals.py

@@ -1,81 +0,0 @@
-# Copyright (C) 2021 Bosutech XXI S.L.
-#
-# nucliadb is offered under the AGPL v3.0 and as commercial software.
-# For commercial licensing, contact us at info@nuclia.com.
-#
-# AGPL:
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-from dataclasses import dataclass
-from unittest.mock import AsyncMock, patch
-
-import pytest
-
-from nucliadb_utils.signals import Signal
-
-
-class TestSignals:
-    @dataclass
-    class TestPayload:
-        payload: int
-
-    @pytest.fixture
-    def signal(self):
-        yield Signal(payload_model=TestSignals.TestPayload)
-
-    @pytest.fixture
-    def payload(self):
-        yield TestSignals.TestPayload(payload=1)
-
-    @pytest.fixture
-    def listener(self):
-        yield AsyncMock()
-
-    # Tests
-
-    def test_add_same_listener_twice_fails(self, signal, listener):
-        id = "test-listener"
-        signal.add_listener(id, listener)
-        with pytest.raises(ValueError):
-            signal.add_listener(id, listener)
-
-    async def test_signal_dispatch(self, signal, listener, payload):
-        id = "test-listener"
-        signal.add_listener(id, listener)
-        await signal.dispatch(payload)
-        assert listener.await_count == 1
-
-    async def test_signal_despatch_with_failure(self, signal, listener, payload):
-        ok_listener = AsyncMock()
-        signal.add_listener("ok-listener", ok_listener)
-        nok_listener = AsyncMock(side_effect=Exception)
-        signal.add_listener("nok-listener", nok_listener)
-
-        with patch("nucliadb_utils.signals.capture_exception") as mock:
-            await signal.dispatch(payload)
-            assert mock.call_count == 1
-
-        assert ok_listener.await_count == 1
-        assert nok_listener.await_count == 1
-
-    async def test_remove_listener(self, signal, listener, payload):
-        id = "test-listener"
-
-        signal.add_listener(id, listener)
-        await signal.dispatch(payload)
-        assert listener.await_count == 1
-
-        signal.remove_listener(id)
-        await signal.dispatch(payload)
-        assert listener.await_count == 1

nucliadb_utils/tests/unit/test_tests.py

@@ -1,27 +0,0 @@
-# Copyright (C) 2021 Bosutech XXI S.L.
-#
-# nucliadb is offered under the AGPL v3.0 and as commercial software.
-# For commercial licensing, contact us at info@nuclia.com.
-#
-# AGPL:
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-from nucliadb_utils.tests import asyncbenchmark  # noqa: F401
-from nucliadb_utils.tests import indexing  # noqa: F401
-from nucliadb_utils.tests import nats  # noqa: F401
-
-# placeholder for test modules
-# AND these test modules do not get coverage
-# but we don't want to be penalized for them
-# AND we don't want to deal with test config files not working

nucliadb_utils/tests/unit/test_transaction.py

@@ -1,119 +0,0 @@
-# Copyright (C) 2021 Bosutech XXI S.L.
-#
-# nucliadb is offered under the AGPL v3.0 and as commercial software.
-# For commercial licensing, contact us at info@nuclia.com.
-#
-# AGPL:
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-import asyncio
-from unittest import mock
-
-import pytest
-from nucliadb_protos.writer_pb2 import BrokerMessage, Notification
-
-from nucliadb_utils.transaction import (
-    TransactionCommitTimeoutError,
-    TransactionUtility,
-    WaitFor,
-)
-
-
-@pytest.fixture()
-def pubsub():
-    pubsub = mock.AsyncMock()
-    pubsub.parse = lambda msg: msg.data
-    with mock.patch("nucliadb_utils.transaction.get_pubsub", return_value=pubsub):
-        yield pubsub
-
-
-@pytest.fixture()
-async def txn(pubsub):
-    nats_conn = mock.AsyncMock()
-    with mock.patch("nucliadb_utils.transaction.nats.connect", return_value=nats_conn):
-        txn = TransactionUtility(nats_servers=["foobar"])
-        await txn.initialize()
-        yield txn
-        await txn.finalize()
-
-
-@pytest.mark.asyncio
-async def test_wait_for_commited(txn: TransactionUtility, pubsub):
-    waiting_for = WaitFor(uuid="foo")
-    request_id = "request1"
-    kbid = "kbid"
-    notification = Notification()
-    notification.uuid = waiting_for.uuid
-    notification.action = Notification.Action.COMMIT
-
-    async def _subscribe(handler, key, subscription_id):
-        # call it immediately
-        handler(mock.Mock(data=notification.SerializeToString()))
-
-    pubsub.subscribe.side_effect = _subscribe
-
-    await (await txn.wait_for_commited(kbid, waiting_for, request_id=request_id)).wait()
-
-
-@pytest.mark.asyncio
-async def test_wait_for_indexed(txn: TransactionUtility, pubsub):
-    waiting_for = WaitFor(uuid="foo")
-    request_id = "request1"
-    kbid = "kbid"
-    notification = Notification()
-    notification.uuid = waiting_for.uuid
-    notification.action = Notification.Action.INDEXED
-
-    async def _subscribe(handler, key, subscription_id):
-        # call it immediately
-        handler(mock.Mock(data=notification.SerializeToString()))
-
-    pubsub.subscribe.side_effect = _subscribe
-
-    with mock.patch("nucliadb_utils.transaction.has_feature", return_value=True):
-        await (
-            await txn.wait_for_commited(kbid, waiting_for, request_id=request_id)
-        ).wait()
-
-
-@pytest.mark.asyncio
-async def test_wait_for_commit_stop_waiting(txn: TransactionUtility, pubsub):
-    pubsub.unsubscribe.side_effect = [
-        "sub_id",
-        KeyError(),
-    ]  # second call raises KeyError
-
-    waiting_for = WaitFor(uuid="foo", seq=1)
-    request_id = "request1"
-    kbid = "kbid"
-
-    _ = await txn.wait_for_commited(kbid, waiting_for, request_id=request_id)
-
-    await txn.stop_waiting(kbid, request_id=request_id)
-
-    # Unsubscribing twice with the same request_id should raise KeyError
-    with pytest.raises(KeyError):
-        await txn.stop_waiting(kbid, request_id=request_id)
-
-
-@pytest.mark.asyncio
-async def test_commit_timeout(txn: TransactionUtility, pubsub):
-    txn.js = mock.AsyncMock()
-    bm = BrokerMessage()
-
-    waiting_event = mock.Mock(wait=mock.Mock(side_effect=asyncio.TimeoutError))
-    txn.wait_for_commited = mock.AsyncMock(return_value=waiting_event)  # type: ignore
-
-    with pytest.raises(TransactionCommitTimeoutError):
-        await txn.commit(bm, 1, wait=True, target_subject="foo")

nucliadb_utils/tests/unit/test_utilities.py

@@ -1,173 +0,0 @@
-# Copyright (C) 2021 Bosutech XXI S.L.
-#
-# nucliadb is offered under the AGPL v3.0 and as commercial software.
-# For commercial licensing, contact us at info@nuclia.com.
-#
-# AGPL:
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-import hashlib
-from unittest.mock import AsyncMock, MagicMock, patch
-
-import pytest
-
-from nucliadb_utils import featureflagging, utilities
-from nucliadb_utils.exceptions import ConfigurationError
-from nucliadb_utils.settings import FileBackendConfig
-
-
-@pytest.fixture(autouse=True)
-def reset_main():
-    utilities.MAIN.clear()
-
-
-def test_clean_utility():
-    utilities.set_utility(utilities.Utility.PUBSUB, "test")
-    assert utilities.get_utility(utilities.Utility.PUBSUB) == "test"
-    utilities.clean_utility(utilities.Utility.PUBSUB)
-    assert utilities.get_utility(utilities.Utility.PUBSUB) is None
-
-
-@pytest.mark.asyncio
-async def test_get_storage_s3():
-    s3 = AsyncMock()
-    with (
-        patch.object(
-            utilities.storage_settings, "file_backend", FileBackendConfig("s3")
-        ),
-        patch("nucliadb_utils.storages.s3.S3Storage", return_value=s3),
-    ):
-        assert await utilities.get_storage() == s3
-
-
-@pytest.mark.asyncio
-async def test_get_storage_gcs():
-    gcs = AsyncMock()
-    with (
-        patch.object(
-            utilities.storage_settings, "file_backend", FileBackendConfig("gcs")
-        ),
-        patch("nucliadb_utils.storages.gcs.GCSStorage", return_value=gcs),
-    ):
-        assert await utilities.get_storage() == gcs
-
-
-@pytest.mark.asyncio
-async def test_get_storage_pg():
-    pg = AsyncMock()
-    with (
-        patch.object(
-            utilities.storage_settings, "file_backend", FileBackendConfig("pg")
-        ),
-        patch("nucliadb_utils.storages.pg.PostgresStorage", return_value=pg),
-    ):
-        assert await utilities.get_storage() == pg
-
-
-@pytest.mark.asyncio
-async def test_get_storage_local():
-    local = AsyncMock()
-    with (
-        patch.object(
-            utilities.storage_settings, "file_backend", FileBackendConfig("local")
-        ),
-        patch.object(utilities.storage_settings, "local_files", "/files"),
-        patch("nucliadb_utils.storages.local.LocalStorage", return_value=local),
-    ):
-        assert await utilities.get_storage() == local
-
-
-@pytest.mark.asyncio
-async def test_get_storage_missing():
-    with patch.object(utilities.storage_settings, "file_backend", "missing"):
-        with pytest.raises(ConfigurationError):
-            await utilities.get_storage()
-
-
-@pytest.mark.asyncio
-async def test_get_local_storage():
-    assert utilities.get_local_storage() is not None
-
-
-@pytest.mark.asyncio
-async def test_get_nuclia_storage():
-    assert await utilities.get_nuclia_storage() is not None
-
-
-@pytest.mark.asyncio
-async def test_get_pubsub():
-    with patch("nucliadb_utils.utilities.NatsPubsub", return_value=AsyncMock()):
-        assert await utilities.get_pubsub() is not None
-
-
-@pytest.mark.asyncio
-async def test_finalize_utilities():
-    util = AsyncMock()
-    utilities.MAIN["test"] = util
-
-    await utilities.finalize_utilities()
-
-    util.finalize.assert_called_once()
-    assert len(utilities.MAIN) == 0
-
-
-@pytest.mark.asyncio
-async def test_start_audit_utility():
-    with (
-        patch("nucliadb_utils.utilities.NatsPubsub", return_value=AsyncMock()),
-        patch("nucliadb_utils.utilities.StreamAuditStorage", return_value=AsyncMock()),
-    ):
-        await utilities.start_audit_utility("service")
-
-        assert "audit" in utilities.MAIN
-
-
-@pytest.mark.asyncio
-async def test_stop_audit_utility():
-    with (
-        patch("nucliadb_utils.utilities.NatsPubsub", return_value=AsyncMock()),
-        patch("nucliadb_utils.utilities.StreamAuditStorage", return_value=AsyncMock()),
-    ):
-        await utilities.start_audit_utility("service")
-        await utilities.stop_audit_utility()
-
-        assert "audit" not in utilities.MAIN
-
-
-def test_get_feature_flags():
-    ff = utilities.get_feature_flags()
-    assert ff is not None
-    assert isinstance(ff, featureflagging.FlagService)
-
-
-def test_has_feature():
-    ff = MagicMock()
-    headers = {
-        utilities.X_USER_HEADER: "user",
-        utilities.X_ACCOUNT_HEADER: "account",
-        utilities.X_ACCOUNT_TYPE_HEADER: "account-type",
-    }
-    with patch("nucliadb_utils.utilities.get_feature_flags", return_value=ff):
-        ff.enabled.return_value = True
-        assert utilities.has_feature("test", default=False, headers=headers)
-
-        ff.enabled.assert_called_once_with(
-            "test",
-            default=False,
-            context={
-                "user_id_md5": hashlib.md5(b"user").hexdigest(),
-                "account_id_md5": hashlib.md5(b"account").hexdigest(),
-                "account_type": "account-type",
-            },
-        )