"""Simple assertions which print the expected and received values on failure."""
+import os.path
import typing as T
+from pathlib import Path
from .log import log
Num = T.TypeVar("Num", int, float)
+def blank(value: T.AnyStr) -> None:
+ """Check that value is an empty or blank string."""
+ if not isinstance(value, str) or value.strip():
+ raise ValueError(f'expected "{value!r}" to be a blank string')
+
+
def false(value: T.Any) -> None:
"""Check that value is falsy."""
if value:
raise ValueError(f'expected "{value}" to be truthy', value)
+def port(value: int) -> None:
+ """Check that value resembles a port."""
+ if not isinstance(value, int) or value < 1 or value > 65535:
+ raise ValueError(f'expected "{value}" to be be a port')
+
+
def equals(expected: Val, actual: Val) -> None:
"""Check that the two values are equal."""
if expected != actual:
raise ValueError(f"expected {text!r} to start with {prefix!r}")
+def greater(value: Num, than: Num) -> None:
+ """Check that value is greater than the other value."""
+ if value <= than:
+ raise ValueError(f"value {value} must be greater than {than}")
+
+
def in_range(value: Num, gte: Num, lte: Num) -> None:
"""Check that value lies in the range [min, max]."""
if not gte >= value >= lte:
raise ValueError(f"value {value} must be between {gte} and {lte}")
+def lines(text: T.AnyStr, num: int) -> None:
+ """Check that text splits into `num` lines."""
+ rows = text.splitlines()
+ if len(rows) != num:
+ raise ValueError(f"expected {num} lines, got {len(rows)}: {rows}")
+
+
def is_in(needle: Val, *haystacks: T.Container[Val]) -> None:
"""Check that at least one haystack includes needle."""
for haystack in haystacks:
if content0 != content1:
raise ValueError(f"expected files {path0} and {path1} to match")
+
+
+def file_exists(path: T.Union[str, Path]) -> None:
+ """Check that file exists."""
+ if not os.path.isfile(path):
+ raise ValueError(f"expected file '{path}' to exist")
+
+
+def dir_exists(path: T.Union[str, Path]) -> None:
+ """Check that directory exists."""
+ if not os.path.isdir(path):
+ raise ValueError(f"expected directory '{path}' to exist")