mirror of
https://github.com/ilri/dspace-statistics-api.git
synced 2024-11-25 15:48:20 +01:00
Alan Orth
2f8e4f8a0a
Mostly it seems we just need to use resp.text instead of resp.body, including in falcon-swagger-ui (I forked the upstream one to make this change). See: https://falcon.readthedocs.io/en/latest/changes/3.0.0.html
380 lines
12 KiB
Python
380 lines
12 KiB
Python
# SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
import json
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
from falcon import testing
|
|
|
|
from dspace_statistics_api.app import app
|
|
|
|
|
|
@pytest.fixture
|
|
def client():
|
|
return testing.TestClient(app)
|
|
|
|
|
|
def test_get_item(client):
|
|
"""Test requesting a single item."""
|
|
|
|
response = client.simulate_get("/item/fd8a46d5-1480-4e69-b187-cd3db96d8e4d")
|
|
response_doc = json.loads(response.text)
|
|
|
|
assert isinstance(response_doc["downloads"], int)
|
|
assert isinstance(response_doc["id"], str)
|
|
assert isinstance(response_doc["views"], int)
|
|
assert response.status_code == 200
|
|
|
|
|
|
def test_get_missing_item(client):
|
|
"""Test requesting a single non-existing item."""
|
|
|
|
response = client.simulate_get("/item/c3910974-c3a5-4053-9dce-104aa7bb1620")
|
|
|
|
assert response.status_code == 404
|
|
|
|
|
|
def test_get_items(client):
|
|
"""Test requesting 100 items."""
|
|
|
|
response = client.simulate_get("/items", query_string="limit=100")
|
|
response_doc = json.loads(response.text)
|
|
|
|
assert isinstance(response_doc["currentPage"], int)
|
|
assert isinstance(response_doc["totalPages"], int)
|
|
assert isinstance(response_doc["statistics"], list)
|
|
assert response.status_code == 200
|
|
|
|
|
|
def test_get_items_invalid_limit(client):
|
|
"""Test requesting 100 items with an invalid limit parameter."""
|
|
|
|
response = client.simulate_get("/items", query_string="limit=101")
|
|
|
|
assert response.status_code == 400
|
|
|
|
|
|
def test_get_items_invalid_page(client):
|
|
"""Test requesting 100 items with an invalid page parameter."""
|
|
|
|
response = client.simulate_get("/items", query_string="page=-1")
|
|
|
|
assert response.status_code == 400
|
|
|
|
|
|
@pytest.mark.xfail
|
|
def test_post_items_valid_dateFrom(client):
|
|
"""Test POSTing a request to /items with a valid dateFrom parameter in the request body."""
|
|
|
|
request_body = {
|
|
"dateFrom": "2020-01-01T00:00:00Z",
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 100
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 2
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
assert isinstance(response.json["statistics"][1]["views"], int)
|
|
assert isinstance(response.json["statistics"][1]["downloads"], int)
|
|
|
|
|
|
def test_post_items_valid_dateFrom_mocked(client):
|
|
"""Mock test POSTing a request to /items with a valid dateFrom parameter in the request body."""
|
|
|
|
request_body = {
|
|
"dateFrom": "2020-01-01T00:00:00Z",
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
get_views_return_value = {
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21,
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1": 0,
|
|
}
|
|
get_downloads_return_value = {
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575,
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1": 899,
|
|
}
|
|
|
|
with patch(
|
|
"dspace_statistics_api.app.get_views", return_value=get_views_return_value
|
|
):
|
|
with patch(
|
|
"dspace_statistics_api.app.get_downloads",
|
|
return_value=get_downloads_return_value,
|
|
):
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 100
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 2
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
assert isinstance(response.json["statistics"][1]["views"], int)
|
|
assert isinstance(response.json["statistics"][1]["downloads"], int)
|
|
|
|
|
|
def test_post_items_invalid_dateFrom(client):
|
|
"""Test POSTing a request to /items with an invalid dateFrom parameter in the request body."""
|
|
|
|
request_body = {
|
|
"dateFrom": "2020-01-01T00:00:00",
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 400
|
|
|
|
|
|
@pytest.mark.xfail
|
|
def test_post_items_valid_dateTo(client):
|
|
"""Test POSTing a request to /items with a valid dateTo parameter in the request body."""
|
|
|
|
request_body = {
|
|
"dateTo": "2020-01-01T00:00:00Z",
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 100
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 2
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
assert isinstance(response.json["statistics"][1]["views"], int)
|
|
assert isinstance(response.json["statistics"][1]["downloads"], int)
|
|
|
|
|
|
def test_post_items_valid_dateTo_mocked(client):
|
|
"""Mock test POSTing a request to /items with a valid dateTo parameter in the request body."""
|
|
|
|
request_body = {
|
|
"dateTo": "2020-01-01T00:00:00Z",
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
get_views_return_value = {
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21,
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1": 0,
|
|
}
|
|
get_downloads_return_value = {
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575,
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1": 899,
|
|
}
|
|
|
|
with patch(
|
|
"dspace_statistics_api.app.get_views", return_value=get_views_return_value
|
|
):
|
|
with patch(
|
|
"dspace_statistics_api.app.get_downloads",
|
|
return_value=get_downloads_return_value,
|
|
):
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 100
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 2
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
assert isinstance(response.json["statistics"][1]["views"], int)
|
|
assert isinstance(response.json["statistics"][1]["downloads"], int)
|
|
|
|
|
|
def test_post_items_invalid_dateTo(client):
|
|
"""Test POSTing a request to /items with an invalid dateTo parameter in the request body."""
|
|
|
|
request_body = {
|
|
"dateFrom": "2020-01-01T00:00:00",
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 400
|
|
|
|
|
|
@pytest.mark.xfail
|
|
def test_post_items_valid_limit(client):
|
|
"""Test POSTing a request to /items with a valid limit parameter in the request body."""
|
|
|
|
request_body = {
|
|
"limit": 1,
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 1
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 1
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
|
|
|
|
def test_post_items_valid_limit_mocked(client):
|
|
"""Mock test POSTing a request to /items with a valid limit parameter in the request body."""
|
|
|
|
request_body = {
|
|
"limit": 1,
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
get_views_return_value = {"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21}
|
|
get_downloads_return_value = {"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575}
|
|
|
|
with patch(
|
|
"dspace_statistics_api.app.get_views", return_value=get_views_return_value
|
|
):
|
|
with patch(
|
|
"dspace_statistics_api.app.get_downloads",
|
|
return_value=get_downloads_return_value,
|
|
):
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 1
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 1
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
|
|
|
|
def test_post_items_invalid_limit(client):
|
|
"""Test POSTing a request to /items with an invalid limit parameter in the request body."""
|
|
|
|
request_body = {
|
|
"limit": -1,
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 400
|
|
|
|
|
|
@pytest.mark.xfail
|
|
def test_post_items_valid_page(client):
|
|
"""Test POSTing a request to /items with a valid page parameter in the request body."""
|
|
|
|
request_body = {
|
|
"page": 0,
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 100
|
|
assert response.json["currentPage"] == 0
|
|
assert response.json["totalPages"] == 0
|
|
assert len(response.json["statistics"]) == 2
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
assert isinstance(response.json["statistics"][1]["views"], int)
|
|
assert isinstance(response.json["statistics"][1]["downloads"], int)
|
|
|
|
|
|
def test_post_items_valid_page_mocked(client):
|
|
"""Mock test POSTing a request to /items with a valid page parameter in the request body."""
|
|
|
|
request_body = {
|
|
"page": 0,
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
get_views_return_value = {
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 21,
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1": 0,
|
|
}
|
|
get_downloads_return_value = {
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d": 575,
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1": 899,
|
|
}
|
|
|
|
with patch(
|
|
"dspace_statistics_api.app.get_views", return_value=get_views_return_value
|
|
):
|
|
with patch(
|
|
"dspace_statistics_api.app.get_downloads",
|
|
return_value=get_downloads_return_value,
|
|
):
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 200
|
|
assert response.json["limit"] == 100
|
|
assert response.json["currentPage"] == 0
|
|
assert isinstance(response.json["totalPages"], int)
|
|
assert len(response.json["statistics"]) == 2
|
|
assert isinstance(response.json["statistics"][0]["views"], int)
|
|
assert isinstance(response.json["statistics"][0]["downloads"], int)
|
|
assert isinstance(response.json["statistics"][1]["views"], int)
|
|
assert isinstance(response.json["statistics"][1]["downloads"], int)
|
|
|
|
|
|
def test_post_items_invalid_page(client):
|
|
"""Test POSTing a request to /items with an invalid page parameter in the request body."""
|
|
|
|
request_body = {
|
|
"page": -1,
|
|
"items": [
|
|
"fd8a46d5-1480-4e69-b187-cd3db96d8e4d",
|
|
"e53a2eab-1e31-448d-907b-3656ca4e86c1",
|
|
],
|
|
}
|
|
|
|
response = client.simulate_post("/items", json=request_body)
|
|
|
|
assert response.status_code == 400
|
|
|
|
|
|
# vim: set sw=4 ts=4 expandtab:
|