ayx_python_sdk.test_harness package

Submodules

ayx_python_sdk.test_harness.plugin_runner module

Class for running a plugin out of process.

class ayx_python_sdk.test_harness.plugin_runner.PluginRunner(plugin_entrypoint: Path, plugins_package: str, tool_name: str, input_metadata: List[Metadata], input_data: List[pd.DataFrame], config_xml: Path, transport_type: str)[source]

Bases: object

Class for running a plugin out of process with test data.

async control_consumer(event_notify_complete: Event, event_plugin_ready: Event, resp_iterator: AsyncIterable[RecordTransferOut]) None[source]

Receives and handles Control msg responses from the server.

async control_producer(event_notify_complete: Event, event_plugin_ready: Event) ControlIn[source]

Generate initial control messages, then wait for any new msgs to send from the queue.

record_transfer_consumer(**kwargs)[source]
async record_transfer_producer(event_plugin_ready: Event) RecordTransferIn[source]

Send records to the plugin, notify client is done sending record data.

async run_plugin_v2(mode: RunMode) None[source]

Run the plugin out of process.

class ayx_python_sdk.test_harness.plugin_runner.RunMode(value)[source]

Bases: str, Enum

Run mode types.

full_run = 'full'
update_only = 'update_only'

ayx_python_sdk.test_harness.process_lifecycle_manager module

OS independent process management class.

class ayx_python_sdk.test_harness.process_lifecycle_manager.ProcessLifecycleManager(args: List[str])[source]

Bases: ABC

Class for managing the lifecycle of a process.

process_alive() bool[source]

Check if the process is still running.

ayx_python_sdk.test_harness.sdk_engine_service module

Test harness implementation of the SDK Engine service.

class ayx_python_sdk.test_harness.sdk_engine_service.SdkEngineService[source]

Bases: SdkEngineServicer

Implementation of the SDK Engine service for the test harness.

ConfirmSdkEngineServiceConnection(request, context)[source]

Confirm the connection with this server.

DecryptPassword(request, context)[source]

Decrypt a passsword.

OutputMessage(request, context)[source]

Push output message.

PushOutgoingMetadata(request, context)[source]

Send any outgoing metadata from Sdk Plugin to SDK Engine Server.

PushOutgoingRecordPacket(request, context)[source]

Push any record packets from SDK Plugin to SDK Engine Server.

TranslateMessage(request, context)[source]

Translate message into the correct locale, passing in any interpolation items.

Module contents

Python SDK gRPC Plugin Test harness.