Architecture

Automatics provides support to execute test script that uses Candela Lanforge system. 

The RDKB test scripts that uses Candela Lanforge are mentioned as WT-Tests and its utility APIs are available in RDKB-test-utils. The utility APIs communicates with the Lanforge Client via service WT REST API service(wt-service).  And, the service uses Lanforge JSON APIs to communicate with Lanforge client.

The diagram shows interaction of Automatics system with the Candela Lanforge system. 

Execution of Automatics-Candela Scripts

To execute Automatics-Candela scripts, partner should have a Candela Lanforge system with gateway device connected to it and wt-service deployed in Automatics system.

Setup of WT REST API(wt-service)

Build wt-service

Softwares Required:

Following softwares are required to build wt-service

• Jdk 8 
• Maven 3

1. Clone the source code from https://code.rdkcentral.com/r/admin/repos/rdk/tools/wt-service
2. Open command prompt from directory wt-service and run the command mvn clean install. This will generate wt-service.jar file in target directory.
3. Copy the jar file to the VM where the service to be deployed.
4. Ensure that Candela Lanforge JSON APIs are accessible from wt-service deploying VM.

Deployment of wt-service

Deployment as standalone java application

Softwares Required:

Following softwares are required to deploy wt-service

• Jdk 8 

1. Copy the jar file to the VM where the service to be deployed
2. Rename the jar to WTService.jar.
3. Run the command java -jar WTService.jar . The service should be up and running.

Deployment using apache-tomcat

Softwares Required:

Following softwares are required to deploy wt-service

• Jdk 8 
• Apache-tomcat 8

1. Change the packaging in pom.xml to war.
2. Run the command mvn clean install. This will generate wt-service.war file in target directory.
3. Rename the jar to WTService.war.
4. Copy the file to {apache-tomcat_base_dir}/webapps . Start the server by executing ./startup.sh in {apache-tomcat_base_dir}/bin
5. The service should be up and running. The logs will be generating in {apache-tomcat_base_dir}/bin/logs directory

Configuration

• Configure the property 'wtSimulatorBaseUrl' in extra properties of Device from Device Manager UI. This property holds the base url to the lanforge JSON API. eg: http://localhost:8080. The gateway device ti be used for candela testing should have this property configured.
• Configure the property 'wt.service.base.url' in Automatics Properties and this holds the base url of WTService. To add property please follow steps in Add Property

WT-Service REST API Specification

WT Service REST API specification - WTService_REST_API_Specification_v1.0.docx