1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
|
from __future__ import annotations
import asyncio
import json
import logging
from pathlib import Path
from typing import TYPE_CHECKING, Any, cast
from zoneinfo import ZoneInfo
import dateutil.parser
import dateutil.tz
import time_machine
from web_poet import ItemPage
from web_poet.serialization import (
SerializedDataFileStorage,
deserialize,
load_class,
serialize,
)
from web_poet.utils import ensure_awaitable, get_fq_class_name, memoizemethod_noargs
from ..serialization.utils import _exception_from_dict, _exception_to_dict, _format_json
from .exceptions import (
ExceptionNotRaised,
FieldMissing,
FieldsUnexpected,
FieldValueIncorrect,
ItemValueIncorrect,
WrongExceptionRaised,
)
from .itemadapter import WebPoetTestItemAdapter
if TYPE_CHECKING:
import datetime
import os
from collections.abc import Iterable
from itemadapter import ItemAdapter
# typing.Self requires Python 3.11
from typing_extensions import Self
logger = logging.getLogger(__name__)
INPUT_DIR_NAME = "inputs"
OUTPUT_FILE_NAME = "output.json"
EXCEPTION_FILE_NAME = "exception.json"
META_FILE_NAME = "meta.json"
def _get_available_filename(template: str, directory: str | os.PathLike[str]) -> str:
i = 1
while True:
result = Path(directory, template.format(i))
if not result.exists():
return result.name
i += 1
class Fixture:
"""Represents a directory containing one test."""
def __init__(self, path: Path) -> None:
self.path = path
self._output_error: Exception | None = None
@property
def type_name(self) -> str:
"""The name of the type being tested."""
return self.path.parent.name
@property
def test_name(self) -> str:
"""The name of the test."""
return self.path.name
@property
def short_name(self) -> str:
"""The name of this fixture"""
return f"{self.type_name}/{self.test_name}"
@property
def input_path(self) -> Path:
"""The inputs subdirectory path."""
return self.path / INPUT_DIR_NAME
@property
def output_path(self) -> Path:
"""The output file path."""
return self.path / OUTPUT_FILE_NAME
@property
def exception_path(self) -> Path:
"""The exception file path."""
return self.path / EXCEPTION_FILE_NAME
@property
def meta_path(self) -> Path:
"""The metadata file path."""
return self.path / META_FILE_NAME
def is_valid(self) -> bool:
"""Return True if the fixture file structure is correct, False otherwise."""
return self.input_path.is_dir() and (
self.output_path.is_file() or self.exception_path.is_file()
)
def get_page(self) -> ItemPage:
"""Return the page object created from the saved input."""
cls = load_class(self.type_name)
if not issubclass(cls, ItemPage):
raise TypeError(f"{self.type_name} is not a descendant of ItemPage")
storage = SerializedDataFileStorage(self.input_path)
return deserialize(cls, storage.read())
def get_meta(self) -> dict:
"""Return the test metadata."""
if not self.meta_path.exists():
return {}
meta_dict = json.loads(self.meta_path.read_bytes())
if meta_dict.get("adapter"):
meta_dict["adapter"] = load_class(meta_dict["adapter"])
return meta_dict
def _get_adapter_cls(self) -> type[ItemAdapter]:
cls = self.get_meta().get("adapter")
if not cls:
return WebPoetTestItemAdapter
return cast("type[ItemAdapter]", cls)
def _get_output(self) -> dict:
page = self.get_page()
item = asyncio.run(ensure_awaitable(page.to_item()))
return self._get_adapter_cls()(item).asdict()
@memoizemethod_noargs
def get_output(self) -> dict:
"""
Return the output from the recreated Page Object,
taking frozen time in account.
"""
try:
meta = self.get_meta()
frozen_time: str | None = meta.get("frozen_time")
if frozen_time:
frozen_time_parsed = self._parse_frozen_time(frozen_time)
with time_machine.travel(frozen_time_parsed):
return self._get_output()
else:
return self._get_output()
except Exception as e:
self._output_error = e
raise
def item_to_json(self, item: Any) -> str:
"""Convert an item to a JSON string."""
return _format_json(self._get_adapter_cls()(item).asdict())
@memoizemethod_noargs
def get_expected_output(self) -> dict:
"""Return the saved output."""
return json.loads(self.output_path.read_bytes())
@memoizemethod_noargs
def get_expected_exception(self) -> Exception:
"""Return the saved exception."""
data = json.loads(self.exception_path.read_bytes())
return _exception_from_dict(data)
@staticmethod
def _parse_frozen_time(meta_value: str) -> datetime.datetime:
"""Parse and possibly fix the frozen_time metadata string."""
parsed_value = dateutil.parser.parse(meta_value)
if parsed_value.tzinfo is None:
# if it's left as None, time_machine will set it to timezone.utc,
# but we want to interpret the value as local time
return parsed_value.astimezone()
if not time_machine.HAVE_TZSET:
logger.warning(
f"frozen_time {meta_value} includes timezone data which"
f" is not supported on Windows, converting to local"
)
return parsed_value.astimezone()
if parsed_value.tzinfo == dateutil.tz.UTC:
return parsed_value.replace(tzinfo=ZoneInfo("UTC"))
offset = parsed_value.tzinfo.utcoffset(None)
assert offset is not None # typing
offset_hours = int(offset.days * 24 + offset.seconds / 3600)
tzinfo = ZoneInfo(f"Etc/GMT{-offset_hours:+d}")
return parsed_value.replace(tzinfo=tzinfo)
def get_expected_output_fields(self):
"""Return a list of the expected output field names."""
output = self.get_expected_output()
return list(output.keys())
def assert_full_item_correct(self) -> None:
"""Get the output and assert that it matches the expected output."""
output = _format_json(self.get_output())
expected_output = _format_json(self.get_expected_output())
if output != expected_output:
raise ItemValueIncorrect(output, expected_output)
def assert_field_correct(
self, name: str, user_props: list[tuple[str, object]] | None = None
) -> None:
"""Assert that a certain field in the output matches the expected value"""
expected_field = json.loads(_format_json(self.get_expected_output()[name]))
self._append_user_prop(user_props, "expected_value", expected_field)
actual_item = self.get_output()
if name not in actual_item:
raise FieldMissing(name)
actual_field = json.loads(_format_json(actual_item[name]))
self._append_user_prop(user_props, "actual_value", actual_field)
if actual_field != expected_field:
raise FieldValueIncorrect(actual_field, expected_field)
def assert_no_extra_fields(self) -> None:
"""Assert that there are no extra fields in the output"""
output = self.get_output()
expected_output = self.get_expected_output()
extra_field_keys = output.keys() - expected_output.keys()
extra_fields = {key: output[key] for key in extra_field_keys}
if extra_fields:
raise FieldsUnexpected(extra_fields)
def to_item_raised(self) -> bool:
"""Return True if to_item raised an error.
Note that if to_item hasn't been called yet, this method returns False.
"""
return self._output_error is not None
def assert_no_toitem_exceptions(self) -> None:
"""Assert that to_item() can be run (doesn't raise an error)"""
self.get_output()
def assert_toitem_exception(
self, user_props: list[tuple[str, object]] | None = None
) -> None:
"""Assert that to_item() raises an exception of the expected type"""
expected_exception = self.get_expected_exception()
self._append_user_prop(
user_props, "expected_exception", _exception_to_dict(expected_exception)
)
try:
self.get_output()
except Exception as ex:
self._append_user_prop(
user_props, "actual_exception", _exception_to_dict(ex)
)
if type(ex) is not type(expected_exception):
raise WrongExceptionRaised from ex
else:
raise ExceptionNotRaised
@staticmethod
def _append_user_prop(
user_props: list[tuple[str, object]] | None, name: str, value: object
) -> None:
"""A replacement for the ``record_property`` fixture."""
if user_props is not None:
user_props.append((f"web_poet_{name}", json.dumps(value)))
@classmethod
def save(
cls,
base_directory: str | os.PathLike[str],
*,
inputs: Iterable[Any],
item: Any = None,
exception: Exception | None = None,
meta: dict | None = None,
fixture_name=None,
) -> Self:
"""Save and return a fixture."""
if not fixture_name:
fixture_name = _get_available_filename("test-{}", base_directory)
fixture_dir = Path(base_directory, fixture_name)
fixture = cls(fixture_dir)
fixture.input_path.mkdir(parents=True)
serialized_inputs = serialize(inputs)
storage = SerializedDataFileStorage(fixture.input_path)
storage.write(serialized_inputs)
if meta:
if meta.get("adapter"):
meta["adapter"] = get_fq_class_name(meta["adapter"])
fixture.meta_path.write_text(_format_json(meta), encoding="utf-8")
if item is not None:
with fixture.output_path.open("w", encoding="utf-8") as f:
f.write(fixture.item_to_json(item))
if exception:
exc_data = _exception_to_dict(exception)
fixture.exception_path.write_text(_format_json(exc_data), encoding="utf-8")
return fixture
|