Differential D3173 Diff 11273 swh/deposit/tests/api/test_deposit_list.py

Changeset View

Standalone View

swh/deposit/tests/api/test_deposit_list.py

	# Copyright (C) 2017-2019 The Software Heritage developers			# Copyright (C) 2017-2020 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

	from django.urls import reverse			from django.urls import reverse
	from rest_framework import status			from rest_framework import status

	from swh.deposit.api.converters import convert_status_detail			from swh.deposit.api.converters import convert_status_detail
	from swh.deposit.config import (			from swh.deposit.config import (
	DEPOSIT_STATUS_PARTIAL,			DEPOSIT_STATUS_PARTIAL,
	PRIVATE_LIST_DEPOSITS,			PRIVATE_LIST_DEPOSITS,
	DEPOSIT_STATUS_DEPOSITED,			DEPOSIT_STATUS_DEPOSITED,
	)			)

				STATUS_DETAIL = {
	def test_deposit_list(partial_deposit, deposited_deposit, authenticated_client):
	"""Deposit list api should return the deposits

	"""
	status_detail = {
	"url": {			"url": {
	"summary": "At least one compatible url field. Failed",			"summary": "At least one compatible url field. Failed",
	"fields": ["testurl"],			"fields": ["testurl"],
	},			},
	"metadata": [			"metadata": [{"summary": "Mandatory fields missing", "fields": ["9", 10, 1.212],},],
	{"summary": "Mandatory fields missing", "fields": ["9", 10, 1.212],},
	],
	"archive": [			"archive": [
	{"summary": "Invalid archive", "fields": ["3"],},			{"summary": "Invalid archive", "fields": ["3"],},
	{"summary": "Unsupported archive", "fields": [2],},			{"summary": "Unsupported archive", "fields": [2],},
	],			],
	}			}
	partial_deposit.status_detail = status_detail

				def test_deposit_list(partial_deposit, deposited_deposit, authenticated_client):
				"""Deposit list api should return all deposits in a paginated way

				"""
				partial_deposit.status_detail = STATUS_DETAIL
	partial_deposit.save()			partial_deposit.save()

	deposit_id = partial_deposit.id			deposit_id = partial_deposit.id
	deposit_id2 = deposited_deposit.id			deposit_id2 = deposited_deposit.id

	# NOTE: does not work as documented			# NOTE: does not work as documented
	# https://docs.djangoproject.com/en/1.11/ref/urlresolvers/#django.core.urlresolvers.reverse # noqa			# https://docs.djangoproject.com/en/1.11/ref/urlresolvers/#django.core.urlresolvers.reverse # noqa
	# url = reverse(PRIVATE_LIST_DEPOSITS, kwargs={'page_size': 1})			# url = reverse(PRIVATE_LIST_DEPOSITS, kwargs={'page_size': 1})
	main_url = reverse(PRIVATE_LIST_DEPOSITS)			main_url = reverse(PRIVATE_LIST_DEPOSITS)
	url = "%s?page_size=1" % main_url			url = "%s?page_size=1" % main_url
	response = authenticated_client.get(url)			response = authenticated_client.get(url)

	assert response.status_code == status.HTTP_200_OK			assert response.status_code == status.HTTP_200_OK
	data = response.json()			data = response.json()
	assert data["count"] == 2 # 2 deposits			assert data["count"] == 2 # 2 deposits
	expected_next = "%s?page=2&page_size=1" % main_url			expected_next = f"{main_url}?page=2&page_size=1"
	assert data["next"].endswith(expected_next) is True			assert data["next"].endswith(expected_next) is True
	assert data["previous"] is None			assert data["previous"] is None
	assert len(data["results"]) == 1 # page of size 1			assert len(data["results"]) == 1 # page of size 1
	deposit = data["results"][0]			deposit = data["results"][0]
	assert deposit["id"] == deposit_id			assert deposit["id"] == deposit_id
	assert deposit["status"] == DEPOSIT_STATUS_PARTIAL			assert deposit["status"] == DEPOSIT_STATUS_PARTIAL
	expected_status_detail = convert_status_detail(status_detail)			expected_status_detail = convert_status_detail(STATUS_DETAIL)
	assert deposit["status_detail"] == expected_status_detail			assert deposit["status_detail"] == expected_status_detail

	# then 2nd page			# then 2nd page
	response2 = authenticated_client.get(expected_next)			response2 = authenticated_client.get(expected_next)

	assert response2.status_code == status.HTTP_200_OK			assert response2.status_code == status.HTTP_200_OK
	data2 = response2.json()			data2 = response2.json()

	assert data2["count"] == 2 # still 2 deposits			assert data2["count"] == 2 # still 2 deposits
	assert data2["next"] is None			assert data2["next"] is None

	expected_previous = "%s?page_size=1" % main_url			expected_previous = f"{main_url}?page_size=1"
	assert data2["previous"].endswith(expected_previous) is True			assert data2["previous"].endswith(expected_previous) is True
	assert len(data2["results"]) == 1 # page of size 1			assert len(data2["results"]) == 1 # page of size 1

	deposit2 = data2["results"][0]			deposit2 = data2["results"][0]
	assert deposit2["id"] == deposit_id2			assert deposit2["id"] == deposit_id2
	assert deposit2["status"] == DEPOSIT_STATUS_DEPOSITED			assert deposit2["status"] == DEPOSIT_STATUS_DEPOSITED


				def test_deposit_list_exclude(partial_deposit, deposited_deposit, authenticated_client):
				"""Exclusion pattern on external_id should be respected

				"""
				partial_deposit.status_detail = STATUS_DETAIL
				partial_deposit.save()

				main_url = reverse(PRIVATE_LIST_DEPOSITS)

				# Testing exclusion pattern
				exclude_pattern = "external-id"
				assert partial_deposit.external_id.startswith(exclude_pattern)
				assert deposited_deposit.external_id.startswith(exclude_pattern)
				url = f"{main_url}?page_size=1&exclude=external-id"
				response = authenticated_client.get(url)
				assert response.status_code == status.HTTP_200_OK
				data = response.json()
				assert data["count"] == 0

				url = "%s?page_size=1&exclude=dummy" % main_url # that won't exclude anything
				response = authenticated_client.get(url)
				assert response.status_code == status.HTTP_200_OK
				data = response.json()
				assert data["count"] == 2