Page MenuHomeSoftware Heritage
Differential D2464 Diff 8798 swh/deposit/tests/cli/test_client.py

Changeset View

Standalone View

View Options

swh/deposit/tests/cli/test_client.py

# Copyright (C) 2019 The Software Heritage developers # Copyright (C) 2019 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution # See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version # License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information # See top-level LICENSE file for more information
import pytest import logging
import os
from unittest.mock import MagicMock from unittest.mock import MagicMock
from click.testing import CliRunner
import pytest
from swh.deposit.client import PublicApiDepositClient from swh.deposit.client import PublicApiDepositClient
from swh.deposit.cli.client import _url, _client, _collection, InputError from swh.deposit.cli.client import (
generate_slug, _url, _client, _collection, InputError)
from swh.deposit.cli import deposit as cli
from ..conftest import TEST_USER
EXAMPLE_SERVICE_DOCUMENT = {
'service': {
'workspace': {
'collection': {
'sword:name': 'softcol',
}
}
}
}
@pytest.fixture
def slug():
return generate_slug()
@pytest.fixture
def client_mock(mocker, slug):
mocker.patch('swh.deposit.cli.client.generate_slug', return_value=slug)
mock_client = MagicMock()
mocker.patch(
'swh.deposit.cli.client._client',
return_value=mock_client)
mock_client.service_document.return_value = EXAMPLE_SERVICE_DOCUMENT
mock_client.deposit_create.return_value = '{"foo": "bar"}'
return mock_client
def test_url(): def test_url():
assert _url('http://deposit') == 'http://deposit/1' assert _url('http://deposit') == 'http://deposit/1'
assert _url('https://other/1') == 'https://other/1' assert _url('https://other/1') == 'https://other/1'
def test_client(): def test_client():
Show All 10 Linesdef test_collection_error():
with pytest.raises(InputError) as e: with pytest.raises(InputError) as e:
_collection(mock_client) _collection(mock_client)
assert 'Service document retrieval: something went wrong' == str(e.value) assert 'Service document retrieval: something went wrong' == str(e.value)
def test_collection_ok(): def test_collection_ok():
mock_client = MagicMock() mock_client = MagicMock()
mock_client.service_document.return_value = { mock_client.service_document.return_value = EXAMPLE_SERVICE_DOCUMENT
ardumontUnsubmitted
Done
Inline Actions

why don't you make that a fixture?

@pytest.fixture
def cli_client(mocker):
    mock_client = MagicMock()
    mock_client.service_document.return_value = EXAMPLE_SERVICE_DOCUMENT
    mock_client.deposit_create.return_value = '{"foo": "bar"}'
    mocker.patch(
        'swh.deposit.cli.client._client',
        return_value=mock_client)
    return mock_client

That will unclutter a bit the scenario below.
If that makes sense.

Note:
you can use the factory pattern if you need some different output in the deposit.create.return_value mock.

ardumont: why don't you make that a fixture? ``` @pytest.fixture def cli_client(mocker): mock_client…
'service': {
'workspace': {
'collection': {
'sword:name': 'softcol',
}
}
}
}
collection_name = _collection(mock_client) collection_name = _collection(mock_client)
assert collection_name == 'softcol' assert collection_name == 'softcol'
def test_single_minimal_deposit(
sample_archive, mocker, caplog, client_mock, slug):
""" from:
https://docs.softwareheritage.org/devel/swh-deposit/getting-started.html#single-deposit
""" # noqa
runner = CliRunner()
result = runner.invoke(cli, [
'upload',
'--url', 'mock://deposit.swh/1',
'--username', TEST_USER['username'],
'--password', TEST_USER['password'],
'--name', 'test-project',
'--archive', sample_archive['path'],
])
assert result.exit_code == 0, result.output
assert result.output == ''
assert caplog.record_tuples == [
('swh.deposit.cli.client', logging.INFO, '{"foo": "bar"}'),
]
client_mock.deposit_create.assert_called_once_with(
archive=sample_archive['path'],
collection='softcol', in_progress=False, metadata=None,
ardumontUnsubmitted
Done
Inline Actions

that's interesting! [1]

[1] https://docs.pytest.org/en/latest/logging.html#caplog-fixture

ardumont: that's interesting! [1] [1] https://docs.pytest.org/en/latest/logging.html#caplog-fixture
slug=slug)
def test_single_deposit_slug_collection(
sample_archive, mocker, caplog, client_mock):
""" from:
https://docs.softwareheritage.org/devel/swh-deposit/getting-started.html#single-deposit
""" # noqa
slug = 'my-slug'
collection = 'my-collection'
runner = CliRunner()
result = runner.invoke(cli, [
'upload',
ardumontUnsubmitted
Not Done
Inline Actions

jsyk, as @moranegg probably already told you this is kind of a pain in deposit.

The slug is a word used in the sword v2 protocol (it makes no sense to me).
It's needed because it's required in the spec.
Thus, the uuid generation somewhere in the cli here when it's not provided (it needs to be unique).

We decided to use this as external_id, so whenever you see that, think external_id as a unique identifier for the client system...

I don't like the fact that we use both terms but i was a bit worried to unify it under what term and hide that somewhere at the time. Maybe it'd make more sense to rename it once and for all though (later, not right now ;).

ardumont: jsyk, as @moranegg probably already told you this is kind of a pain in deposit. The slug is a…
ardumontUnsubmitted
Not Done
Inline Actions

s/what term/one term/

ardumont: s/what term/one term/
'--url', 'mock://deposit.swh/1',
'--username', TEST_USER['username'],
'--password', TEST_USER['password'],
'--name', 'test-project',
'--archive', sample_archive['path'],
'--slug', slug,
'--collection', collection,
])
assert result.exit_code == 0, result.output
assert result.output == ''
assert caplog.record_tuples == [
('swh.deposit.cli.client', logging.INFO, '{"foo": "bar"}'),
]
client_mock.deposit_create.assert_called_once_with(
archive=sample_archive['path'],
collection=collection, in_progress=False, metadata=None,
slug=slug)
def test_multisteps_deposit(
sample_archive, atom_dataset, mocker, caplog, datadir,
client_mock, slug):
""" from:
https://docs.softwareheritage.org/devel/swh-deposit/getting-started.html#multisteps-deposit
""" # noqa
slug = generate_slug()
mocker.patch('swh.deposit.cli.client.generate_slug', return_value=slug)
# https://docs.softwareheritage.org/devel/swh-deposit/getting-started.html#create-an-incomplete-deposit
client_mock.deposit_create.return_value = '{"deposit_id": "42"}'
runner = CliRunner()
result = runner.invoke(cli, [
'upload',
'--url', 'mock://deposit.swh/1',
'--username', TEST_USER['username'],
'--password', TEST_USER['password'],
'--archive', sample_archive['path'],
'--partial',
])
assert result.exit_code == 0, result.output
assert result.output == ''
assert caplog.record_tuples == [
('swh.deposit.cli.client', logging.INFO, '{"deposit_id": "42"}'),
]
client_mock.deposit_create.assert_called_once_with(
archive=sample_archive['path'],
collection='softcol', in_progress=True, metadata=None,
slug=slug)
# Clear mocking state
caplog.clear()
client_mock.reset_mock()
# https://docs.softwareheritage.org/devel/swh-deposit/getting-started.html#add-content-or-metadata-to-the-deposit
metadata_path = os.path.join(
datadir, 'atom', 'entry-data-deposit-binary.xml')
result = runner.invoke(cli, [
'upload',
'--url', 'mock://deposit.swh/1',
'--username', TEST_USER['username'],
'--password', TEST_USER['password'],
'--metadata', metadata_path,
])
assert result.exit_code == 0, result.output
assert result.output == ''
assert caplog.record_tuples == [
('swh.deposit.cli.client', logging.INFO, '{"deposit_id": "42"}'),
]
client_mock.deposit_create.assert_called_once_with(
archive=None,
collection='softcol', in_progress=False, metadata=metadata_path,
slug=slug)
# Clear mocking state
caplog.clear()
client_mock.reset_mock()
About · Developer information · Legal