Files
pygeoapi/tests/test_api.py
T

381 lines
11 KiB
Python

# =================================================================
#
# Authors: Tom Kralidis <tomkralidis@gmail.com>
#
# Copyright (c) 2019 Tom Kralidis
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================
import json
import os
import pytest
from werkzeug.test import create_environ
from werkzeug.wrappers import Request
from pygeoapi.api import API, check_format
from pygeoapi.util import yaml_load
def get_test_file_path(filename):
"""helper function to open test file safely"""
if os.path.isfile(filename):
return filename
else:
return 'tests/{}'.format(filename)
def make_req_headers(**kwargs):
environ = create_environ('/collections/obs/items',
'http://localhost:5000/')
environ.update(kwargs)
request = Request(environ)
return request.headers
@pytest.fixture()
def config():
with open(get_test_file_path('pygeoapi-test-config.yml')) as fh:
return yaml_load(fh)
@pytest.fixture()
def openapi():
with open(get_test_file_path('pygeoapi-test-openapi.yml')) as fh:
return yaml_load(fh)
@pytest.fixture()
def api_(config):
return API(config)
def test_api(config, api_, openapi):
assert api_.config == config
assert isinstance(api_.config, dict)
req_headers = make_req_headers(HTTP_CONTENT_TYPE='application/json')
rsp_headers, code, response = api_.api(req_headers, {}, openapi)
assert rsp_headers['Content-Type'] ==\
'application/openapi+json;version=3.0'
root = json.loads(response)
assert isinstance(root, dict)
a = 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'
req_headers = make_req_headers(HTTP_ACCEPT=a)
rsp_headers, code, response = api_.api(req_headers, {}, openapi)
assert rsp_headers['Content-Type'] == 'text/html'
def test_api_exception(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.root(req_headers, {'f': 'foo'})
assert code == 400
def test_root(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.root(req_headers, {})
root = json.loads(response)
assert rsp_headers['Content-Type'] == 'application/json'
assert rsp_headers['X-Powered-By'].startswith('pygeoapi')
assert isinstance(root, dict)
assert 'links' in root
assert len(root['links']) == 6
assert 'title' in root
assert root['title'] == 'pygeoapi default instance'
assert 'description' in root
assert root['description'] == 'pygeoapi provides an API to geospatial data'
rsp_headers, code, response = api_.root(req_headers, {'f': 'html'})
assert rsp_headers['Content-Type'] == 'text/html'
def test_api_conformance(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.api_conformance(req_headers, {})
root = json.loads(response)
assert isinstance(root, dict)
assert 'conformsTo' in root
assert len(root['conformsTo']) == 4
rsp_headers, code, response = api_.api_conformance(
req_headers, {'f': 'foo'})
assert code == 400
rsp_headers, code, response = api_.api_conformance(
req_headers, {'f': 'html'})
assert rsp_headers['Content-Type'] == 'text/html'
def test_describe_collections(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.describe_collections(
req_headers, {'f': 'foo'})
assert code == 400
req_headers = make_req_headers()
rsp_headers, code, response = api_.describe_collections(
req_headers, {'f': 'html'})
assert rsp_headers['Content-Type'] == 'text/html'
rsp_headers, code, response = api_.describe_collections(
req_headers, {})
collections = json.loads(response)
assert len(collections) == 2
assert len(collections['collections']) == 1
assert len(collections['links']) == 2
rsp_headers, code, response = api_.describe_collections(
req_headers, {}, 'foo')
collection = json.loads(response)
assert code == 400
rsp_headers, code, response = api_.describe_collections(
req_headers, {}, 'obs')
collection = json.loads(response)
assert collection['name'] == 'obs'
assert collection['title'] == 'Observations'
assert collection['description'] == 'Observations'
assert len(collection['links']) == 8
rsp_headers, code, response = api_.describe_collections(
req_headers, {'f': 'html'}, 'obs')
assert rsp_headers['Content-Type'] == 'text/html'
def test_get_features(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.get_features(
req_headers, {}, 'foo')
features = json.loads(response)
assert code == 400
rsp_headers, code, response = api_.get_features(
req_headers, {'f': 'foo'}, 'obs')
features = json.loads(response)
assert code == 400
rsp_headers, code, response = api_.get_features(
req_headers, {'bbox': '1,2,3'}, 'obs')
features = json.loads(response)
assert code == 400
rsp_headers, code, response = api_.get_features(
req_headers, {'f': 'html'}, 'obs')
assert rsp_headers['Content-Type'] == 'text/html'
rsp_headers, code, response = api_.get_features(req_headers, {}, 'obs')
features = json.loads(response)
assert len(features['features']) == 5
rsp_headers, code, response = api_.get_features(
req_headers, {'resulttype': 'hits'}, 'obs')
features = json.loads(response)
assert len(features['features']) == 0
rsp_headers, code, response = api_.get_features(
req_headers, {'limit': 2}, 'obs')
features = json.loads(response)
assert len(features['features']) == 2
assert features['features'][1]['properties']['stn_id'] == '35'
rsp_headers, code, response = api_.get_features(
req_headers, {'startindex': 2}, 'obs')
features = json.loads(response)
assert len(features['features']) == 3
assert features['features'][1]['properties']['stn_id'] == '2147'
rsp_headers, code, response = api_.get_features(
req_headers, {'sortby': 'stn_id', 'stn_id': '35'}, 'obs')
assert code == 400
rsp_headers, code, response = api_.get_features(
req_headers, {'sortby': 'stn_id:FOO', 'stn_id': '35', 'value': '89.9'},
'obs')
assert code == 400
rsp_headers, code, response = api_.get_features(
req_headers, {'sortby': 'stn_id:A'}, 'obs')
assert features['features'][1]['properties']['stn_id'] == '2147'
rsp_headers, code, response = api_.get_features(
req_headers, {'f': 'csv'}, 'obs')
assert rsp_headers['Content-Type'] == 'text/csv; charset=utf-8'
def test_get_feature(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.get_feature(
req_headers, {'f': 'foo'}, 'obs', '371')
assert code == 400
rsp_headers, code, response = api_.get_feature(
req_headers, {}, 'foo', '371')
assert code == 400
rsp_headers, code, response = api_.get_feature(
req_headers, {}, 'obs', 'notfound')
assert code == 404
rsp_headers, code, response = api_.get_feature(
req_headers, {'f': 'html'}, 'obs', '371')
assert rsp_headers['Content-Type'] == 'text/html'
rsp_headers, code, response = api_.get_feature(
req_headers, {}, 'obs', '371')
features = json.loads(response)
assert features['properties']['stn_id'] == '35'
def test_describe_processes(config, api_):
req_headers = make_req_headers()
rsp_headers, code, response = api_.describe_processes(
req_headers, {}, 'foo')
processes = json.loads(response)
assert code == 404
rsp_headers, code, response = api_.describe_processes(
req_headers, {})
processes = json.loads(response)
assert len(processes['processes']) == 1
rsp_headers, code, response = api_.describe_processes(
req_headers, {}, 'hello-world')
process = json.loads(response)
assert process['id'] == 'hello-world'
assert process['title'] == 'Hello World process'
assert process['description'] == 'Hello World process'
assert len(process['links']) == 1
assert len(process['inputs']) == 1
assert len(process['outputs']) == 1
assert len(process['outputTransmission']) == 1
assert len(process['jobControlOptions']) == 1
def test_execute_process(config, api_):
req_body = {
'inputs': [{
'id': 'name',
'value': 'test'
}]
}
req_headers = make_req_headers()
rsp_headers, code, response = api_.execute_process(
req_headers, {}, '', 'hello-world')
response = json.loads(response)
assert code == 400
rsp_headers, code, response = api_.execute_process(
req_headers, {}, json.dumps(req_body), 'foo')
response = json.loads(response)
assert code == 404
rsp_headers, code, response = api_.execute_process(
req_headers, {}, json.dumps(req_body), 'hello-world')
response = json.loads(response)
assert response['outputs'][0]['value'] == 'test'
def test_check_format():
args = {
'f': 'html'
}
req_headers = {}
assert check_format({}, req_headers) is None
assert check_format(args, req_headers) == 'html'
args['f'] = 'json'
assert check_format(args, req_headers) == 'json'
args['f'] = 'html'
assert check_format(args, req_headers) == 'html'
req_headers['Accept'] = 'text/html'
assert check_format({}, req_headers) == 'html'
req_headers['Accept'] = 'application/json'
assert check_format({}, req_headers) == 'json'
req_headers['accept'] = 'text/html'
assert check_format({}, req_headers) == 'html'
hh = 'text/html,application/xhtml+xml,application/xml;q=0.9,'
req_headers['Accept'] = hh
assert check_format({}, req_headers) == 'html'
req_headers['accept'] = hh
assert check_format({}, req_headers) == 'html'
req_headers = make_req_headers(HTTP_ACCEPT=hh)
assert check_format({}, req_headers) == 'html'
req_headers = make_req_headers(HTTP_ACCEPT='text/html')
assert check_format({}, req_headers) == 'html'
req_headers = make_req_headers(HTTP_ACCEPT='application/json')
assert check_format({}, req_headers) == 'json'
# Overrule HTTP content negotiation
args['f'] = 'html'
assert check_format(args, req_headers) == 'html'
req_headers = make_req_headers(HTTP_ACCEPT='text/html')
args['f'] = 'json'
assert check_format(args, req_headers) == 'json'