singer_sdk.testing.runners.SingerTestRunner

class singer_sdk.testing.runners.SingerTestRunner[source]

Base Singer Test Runner.

__init__(singer_class, config=None, suite_config=None, **kwargs)[source]

Initialize the test runner object.

Parameters:
  • singer_class (type[PluginBase]) – Singer class to be tested.

  • config (dict) – Tap/Target configuration for testing.

  • suite_config (SuiteConfig) – SuiteConfig instance to be used when instantiating tests.

  • kwargs (dict) – Default arguments to be passed to tap/target on create.

Return type:

None

create(kwargs=None)[source]

Create a new tap/target from the runner defaults.

Parameters:

kwargs (dict, optional) – [description]. Defaults to None.

Returns:

An instantiated Tap or Target.

Return type:

T

abstractmethod sync_all(**kwargs)[source]

Sync all records.

Parameters:

kwargs (Any) – Keyword arguments.

Return type:

None