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