from contextlib import contextmanager from typing import Any, Dict, Generator, List, NamedTuple, Optional, Tuple, Union from warnings import warn import reactivex from reactivex import Observable, typing from reactivex.notification import Notification, OnError, OnNext from reactivex.observable.marbles import parse from reactivex.scheduler import NewThreadScheduler from reactivex.typing import Callable, RelativeTime from .reactivetest import ReactiveTest from .recorded import Recorded from .testscheduler import TestScheduler new_thread_scheduler = NewThreadScheduler() class MarblesContext(NamedTuple): start: Callable[ [Union[Observable[Any], Callable[[], Observable[Any]]]], List[Recorded[Any]] ] cold: Callable[ [str, Optional[Dict[Union[str, float], Any]], Optional[Exception]], Observable[Any], ] hot: Callable[ [str, Optional[Dict[Union[str, float], Any]], Optional[Exception]], Observable[Any], ] exp: Callable[ [str, Optional[Dict[Union[str, float], Any]], Optional[Exception]], List[Recorded[Any]], ] @contextmanager def marbles_testing( timespan: RelativeTime = 1.0, ) -> Generator[MarblesContext, None, None]: """ Initialize a :class:`rx.testing.TestScheduler` and return a namedtuple containing the following functions that wrap its methods. :func:`cold()`: Parse a marbles string and return a cold observable :func:`hot()`: Parse a marbles string and return a hot observable :func:`start()`: Start the test scheduler, invoke the create function, subscribe to the resulting sequence, dispose the subscription and return the resulting records :func:`exp()`: Parse a marbles string and return a list of records Examples: >>> with marbles_testing() as (start, cold, hot, exp): ... obs = hot("-a-----b---c-|") ... ex = exp( "-a-----b---c-|") ... results = start(obs) ... assert results == ex The underlying test scheduler is initialized with the following parameters: - created time = 100.0s - subscribed = 200.0s - disposed = 1000.0s **IMPORTANT**: regarding :func:`hot()`, a marble declared as the first character will be skipped by the test scheduler. E.g. hot("a--b--") will only emit b. """ scheduler = TestScheduler() created = 100.0 disposed = 1000.0 subscribed = 200.0 start_called = False outside_of_context = False def check() -> None: if outside_of_context: warn( "context functions should not be called outside of " "with statement.", UserWarning, stacklevel=3, ) if start_called: warn( "start() should only be called one time inside " "a with statement.", UserWarning, stacklevel=3, ) def test_start( create: Union[Observable[Any], Callable[[], Observable[Any]]] ) -> List[Recorded[Any]]: nonlocal start_called check() if isinstance(create, Observable): create_ = create def default_create() -> Observable[Any]: return create_ create_function = default_create else: create_function = create mock_observer = scheduler.start( create=create_function, created=created, subscribed=subscribed, disposed=disposed, ) start_called = True return mock_observer.messages def test_expected( string: str, lookup: Optional[Dict[Union[str, float], Any]] = None, error: Optional[Exception] = None, ) -> List[Recorded[Any]]: messages = parse( string, timespan=timespan, time_shift=subscribed, lookup=lookup, error=error, ) return messages_to_records(messages) def test_cold( string: str, lookup: Optional[Dict[Union[str, float], Any]] = None, error: Optional[Exception] = None, ) -> Observable[Any]: check() return reactivex.from_marbles( string, timespan=timespan, lookup=lookup, error=error, ) def test_hot( string: str, lookup: Optional[Dict[Union[str, float], Any]] = None, error: Optional[Exception] = None, ) -> Observable[Any]: check() hot_obs: Observable[Any] = reactivex.hot( string, timespan=timespan, duetime=subscribed, lookup=lookup, error=error, scheduler=scheduler, ) return hot_obs try: yield MarblesContext(test_start, test_cold, test_hot, test_expected) finally: outside_of_context = True def messages_to_records( messages: List[Tuple[typing.RelativeTime, Notification[Any]]] ) -> List[Recorded[Any]]: """ Helper function to convert messages returned by parse() to a list of Recorded. """ records: List[Recorded[Any]] = [] for message in messages: time, notification = message if isinstance(time, float): time_ = int(time) else: time_ = time.microseconds // 1000 if isinstance(notification, OnNext): record = ReactiveTest.on_next(time_, notification.value) elif isinstance(notification, OnError): record = ReactiveTest.on_error(time_, notification.exception) else: record = ReactiveTest.on_completed(time_) records.append(record) return records