test/bdd/steps/http_responses.py

   1 """
   2 Classes wrapping HTTP responses from the Nominatim API.
   3 """
   4 from collections import OrderedDict
   5 import re
   6 import json
   7 import xml.etree.ElementTree as ET
   8
   9 from check_functions import Almost
  10
  11 OSM_TYPE = {'N' : 'node', 'W' : 'way', 'R' : 'relation'}
  12
  13 def _geojson_result_to_json_result(geojson_result):
  14     result = geojson_result['properties']
  15     result['geojson'] = geojson_result['geometry']
  16     if 'bbox' in geojson_result:
  17         # bbox is  minlon, minlat, maxlon, maxlat
  18         # boundingbox is minlat, maxlat, minlon, maxlon
  19         result['boundingbox'] = [geojson_result['bbox'][1],
  20                                  geojson_result['bbox'][3],
  21                                  geojson_result['bbox'][0],
  22                                  geojson_result['bbox'][2]]
  23     return result
  24
  25 class BadRowValueAssert:
  26     """ Lazily formatted message for failures to find a field content.
  27     """
  28
  29     def __init__(self, response, idx, field, value):
  30         self.idx = idx
  31         self.field = field
  32         self.value = value
  33         self.row = response.result[idx]
  34
  35     def __str__(self):
  36         return "\nBad value for row {} field '{}'. Expected: {}, got: {}.\nFull row: {}"""\
  37                    .format(self.idx, self.field, self.value,
  38                            self.row[self.field], json.dumps(self.row, indent=4))
  39
  40
  41 class GenericResponse:
  42     """ Common base class for all API responses.
  43     """
  44     def __init__(self, page, fmt, errorcode=200):
  45         fmt = fmt.strip()
  46         if fmt == 'jsonv2':
  47             fmt = 'json'
  48
  49         self.page = page
  50         self.format = fmt
  51         self.errorcode = errorcode
  52         self.result = []
  53         self.header = dict()
  54
  55         if errorcode == 200 and fmt != 'debug':
  56             getattr(self, '_parse_' + fmt)()
  57
  58     def _parse_json(self):
  59         m = re.fullmatch(r'([\w$][^(]*)\((.*)\)', self.page)
  60         if m is None:
  61             code = self.page
  62         else:
  63             code = m.group(2)
  64             self.header['json_func'] = m.group(1)
  65         self.result = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(code)
  66         if isinstance(self.result, OrderedDict):
  67             self.result = [self.result]
  68
  69     def _parse_geojson(self):
  70         self._parse_json()
  71         if 'error' in self.result[0]:
  72             self.result = []
  73         else:
  74             self.result = list(map(_geojson_result_to_json_result, self.result[0]['features']))
  75
  76     def _parse_geocodejson(self):
  77         self._parse_geojson()
  78         if self.result is not None:
  79             self.result = [r['geocoding'] for r in self.result]
  80
  81     def assert_field(self, idx, field, value):
  82         """ Check that result row `idx` has a field `field` with value `value`.
  83             Float numbers are matched approximately. When the expected value
  84             starts with a carat, regular expression matching is used.
  85         """
  86         assert field in self.result[idx], \
  87                "Result row {} has no field '{}'.\nFull row: {}"\
  88                    .format(idx, field, json.dumps(self.result[idx], indent=4))
  89
  90         if isinstance(value, float):
  91             assert Almost(value) == float(self.result[idx][field]), \
  92                    BadRowValueAssert(self, idx, field, value)
  93         elif value.startswith("^"):
  94             assert re.fullmatch(value, self.result[idx][field]), \
  95                    BadRowValueAssert(self, idx, field, value)
  96         else:
  97             assert str(self.result[idx][field]) == str(value), \
  98                    BadRowValueAssert(self, idx, field, value)
  99
 100     def assert_address_field(self, idx, field, value):
 101         """ Check that result rows`idx` has a field `field` with value `value`
 102             in its address. If idx is None, then all results are checked.
 103         """
 104         if idx is None:
 105             todo = range(len(self.result))
 106         else:
 107             todo = [int(idx)]
 108
 109         for idx in todo:
 110             assert 'address' in self.result[idx], \
 111                    "Result row {} has no field 'address'.\nFull row: {}"\
 112                        .format(idx, json.dumps(self.result[idx], indent=4))
 113
 114             address = self.result[idx]['address']
 115             assert field in address, \
 116                    "Result row {} has no field '{}' in address.\nFull address: {}"\
 117                        .format(idx, field, json.dumps(address, indent=4))
 118
 119             assert address[field] == value, \
 120                    "\nBad value for row {} field '{}' in address. Expected: {}, got: {}.\nFull address: {}"""\
 121                        .format(idx, field, value, address[field], json.dumps(address, indent=4))
 122
 123     def match_row(self, row):
 124         """ Match the result fields against the given behave table row.
 125         """
 126         if 'ID' in row.headings:
 127             todo = [int(row['ID'])]
 128         else:
 129             todo = range(len(self.result))
 130
 131         for i in todo:
 132             for name, value in zip(row.headings, row.cells):
 133                 if name == 'ID':
 134                     pass
 135                 elif name == 'osm':
 136                     assert 'osm_type' in self.result[i], \
 137                            "Result row {} has no field 'osm_type'.\nFull row: {}"\
 138                                .format(i, json.dumps(self.result[i], indent=4))
 139                     assert self.result[i]['osm_type'] in (OSM_TYPE[value[0]], value[0]), \
 140                            BadRowValueAssert(self, i, 'osm_type', value)
 141                     self.assert_field(i, 'osm_id', value[1:])
 142                 elif name == 'centroid':
 143                     lon, lat = value.split(' ')
 144                     self.assert_field(i, 'lat', float(lat))
 145                     self.assert_field(i, 'lon', float(lon))
 146                 else:
 147                     self.assert_field(i, name, value)
 148
 149     def property_list(self, prop):
 150         return [x[prop] for x in self.result]
 151
 152
 153 class SearchResponse(GenericResponse):
 154     """ Specialised class for search and lookup responses.
 155         Transforms the xml response in a format similar to json.
 156     """
 157
 158     def _parse_xml(self):
 159         xml_tree = ET.fromstring(self.page)
 160
 161         self.header = dict(xml_tree.attrib)
 162
 163         for child in xml_tree:
 164             assert child.tag == "place"
 165             self.result.append(dict(child.attrib))
 166
 167             address = {}
 168             for sub in child:
 169                 if sub.tag == 'extratags':
 170                     self.result[-1]['extratags'] = {}
 171                     for tag in sub:
 172                         self.result[-1]['extratags'][tag.attrib['key']] = tag.attrib['value']
 173                 elif sub.tag == 'namedetails':
 174                     self.result[-1]['namedetails'] = {}
 175                     for tag in sub:
 176                         self.result[-1]['namedetails'][tag.attrib['desc']] = tag.text
 177                 elif sub.tag == 'geokml':
 178                     self.result[-1][sub.tag] = True
 179                 else:
 180                     address[sub.tag] = sub.text
 181
 182             if address:
 183                 self.result[-1]['address'] = address
 184
 185
 186 class ReverseResponse(GenericResponse):
 187     """ Specialised class for reverse responses.
 188         Transforms the xml response in a format similar to json.
 189     """
 190
 191     def _parse_xml(self):
 192         xml_tree = ET.fromstring(self.page)
 193
 194         self.header = dict(xml_tree.attrib)
 195         self.result = []
 196
 197         for child in xml_tree:
 198             if child.tag == 'result':
 199                 assert not self.result, "More than one result in reverse result"
 200                 self.result.append(dict(child.attrib))
 201             elif child.tag == 'addressparts':
 202                 address = {}
 203                 for sub in child:
 204                     address[sub.tag] = sub.text
 205                 self.result[0]['address'] = address
 206             elif child.tag == 'extratags':
 207                 self.result[0]['extratags'] = {}
 208                 for tag in child:
 209                     self.result[0]['extratags'][tag.attrib['key']] = tag.attrib['value']
 210             elif child.tag == 'namedetails':
 211                 self.result[0]['namedetails'] = {}
 212                 for tag in child:
 213                     self.result[0]['namedetails'][tag.attrib['desc']] = tag.text
 214             elif child.tag == 'geokml':
 215                 self.result[0][child.tag] = True
 216             else:
 217                 assert child.tag == 'error', \
 218                        "Unknown XML tag {} on page: {}".format(child.tag, self.page)
 219
 220
 221 class StatusResponse(GenericResponse):
 222     """ Specialised class for status responses.
 223         Can also parse text responses.
 224     """
 225
 226     def _parse_text(self):
 227         pass