= Eclipse uProtocol TCK Library :toc:

== Overview

This library implements the uProtocol Test Compatibility Kit for the use of a Test Manager and Test Agents. A Test Manager will be responsible for sending commands to multiple connected Test Agents. The Test Agents, in turn, will carry out the tests specified in the commands, and return results back to the Test Manager for validation and processing.

image::screenshots/RegisterListenerv2.drawio.svg[]

Figure 1: Test Manager --> Test Agent: Trigger Send/RegisterListener/UnregisterListener

image::screenshots/DispatcherCommunication.drawio.svg[]

Figure 2: Test Agent: Dispatcher Communication

The Dispatcher is a socket-utransport-specific module, created to quickly test SDK Interoperability.

image::screenshots/TestManagerTestAgentv2.drawio.svg[]

Figure 3: Test Manager --> Test Agent: Integrated Communication

== Getting Started

=== Prerequisites

=== Importing the up-tck-python

Set up upclient-socket-python local repository and install [source]

$ git clone https://github.com/eclipse-uprotocol/up-tck.git $ cd scripts $ python install_dependencies.py

This will install the up-tck dependencies, making its classes and modules available for import in your python code.

=== Building Java Test Agent Jar

If you would like to run any tests with the Java Test Agent, follow these instructions:

1. Inside a terminal/command prompt, go to up_client_socket folder (cd up_client_socket/java).
2. Run "mvn clean install".This will install the up-client-socket-java.
3. Go to test_agent folder (cd test_agent/java) and run "mvn clean install".This will generate the tck-test-agent-java JAR file under the target folder.

=== Running BDD Tests

For information about running BDD Tests, refer to https://github.com/eclipse-uprotocol/up-tck/blob/main/test_manager/README.adoc[BDD/README.adoc]