RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Page History
| Table of Contents |
|---|
Introduction
To use Automatics system, partner will be providing implementation of APIs based on specification. This document gives details on how to integrate partner implementation project to Automatics system.
Automatics Core is a maven project. So partner can add core as maven dependency to their maven project. After the development of APIs, partner can deploy the project to their maven repository by executing “mvn clean deploy”.
Quick Guide to Partner
...
Java API Project
- Create Maven Java Project.
- Add Automatics Core as maven dependency so all providers are available for implementation.
- Provide Java implementation for Providers based on API specification, refer Automatics API Specification .
- When the implementation is completed, deploy the project to partner repository.
- Update pom.xml of Automatics Generic Tests project with partner implementation as dependency.
Automatics Core Build Steps
- Clone Automatics Core project from the repository (rdk/tools/automatics/automatics-core) with branch (“rdk-next”)
- In pom.xml, update distributionManagement with artifact repository url.
<distributionManagement>
<repository>
<url></url>
</repository>
</distributionManagement>
- Execute “mvn clean deploy” on project. This will deploy the Automatics Core project to the partner's repository.
Partner XML Configuration
Automatics Core reads partner-applicationContext.xml file residing in Partner Implementation Java Project to create instances of Provider implementation.
The diagram shows how Partner Implementation instances are generated and accessed by Automatics Core
| draw.io Diagram | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
- Partner can inject their Provider implementation classes to Automatics core using Spring Dependency Injection.
- Automatics core expects spring configuration file partner-applicationContext.xml to be provided by available in partner project and resource folder. And, it should be available at classpath during test execution.
- All Java API implementations to be injected should be configured in partner-applicationContext.xml.
- partner-applicationContext.xml file contains predefined bean id with respective implementation class. All beans uses "lazy-init" set to true so that bean instance will be created on demand only. And, for beans that requires separate instance for each device, property "scope" is set to value "prototype".
| View file | ||||
|---|---|---|---|---|
|
| View file | ||||
|---|---|---|---|---|
|
Automatics Rest Implementation
- Partner needs to provide REST based implementation for APIs in device management that is consumed by Automatics orchestration.
- Other device management APIs consumed by Automatics core can be implemented using Java API or REST.
- Automatics core provides rest clients for device management and hardware providers like Power Provider. Partner can provide REST implementation for them based on API specification. Automatics core, by default, will use rest implementation. However, if partners prefers to go with Java API implementation, then in Automatics Properties, update the following properties as shown.
"partner.impl.deviceManager=true” - When set to true, Automatics expects Java based implementation of device management and it should be configured in partner-applicationContext.xml against bean "deviceProvider".
...
Please refer Automatics Partner XML Configuration attached here while developing partner implementation.
Automatics Partner XML Configuration - partner-applicationContext.xml
Partner has to implement Provider Interfaces mentioned below and map the class in partner-applicationContext.xml
Common Providers
Providers applicable to both RDKV and RDKB platforms.
| Bean Name | Automatics Core Provider | Required By Default | API Type | Description |
|---|---|---|---|---|
| testInitializer | com.automatics.providers.TestInitilizationProvider | No | Java API | APIs for Pre and Post Test Initialization |
| deviceAccessValidator | com.automatics.providers.DeviceAccessValidator | No | Java API | APIs for Device Validation. For eg: To verify if device is accessible for taking for execution |
| deviceConnectionProvider | com.automatics.providers.connection.DeviceConnectionProvider | No | Rest & Java API | Both REST and Java API implementation supported. APIs for executing commands within device If Java API is preferred, then implementation class to be updated in xml file. And, property partner.impl.deviceManager=true, to be set in Automatics Properties |
| deviceProvider | com.automatics.providers.rack.DeviceProvider | Yes | Rest & Java API | Both REST and Java API implementation supported. APIs to get device details, lock devices for exclusive access during test and release them after test etc If Java API is preferred, then implementation class to be updated in xml file. And, property partner.impl.deviceConnectionProvider=true, to be set in Automatics Properties |
| deviceConnectionBasedTrace | com.automatics.providers.trace.AbstractTraceProviderImpl | No | Java API | APIs to get trace logs from device. Connection to device will be via DeviceConnectionProvider APIs |
| serialConnectionBasedTrace | com.automatics.providers.trace.SerialTraceProvider | No | Java API | APIs to get trace logs from device via serial console |
| powerProvider | com.automatics.providers.rack.PowerProvider | No | Java API | Both REST and Java API implementation supported. If Java API is preferred, then implementation class to be updated in xml file. And, property partner.impl.powerProvider=true, to be set in Automatics Properties |
| remoteProviderFactory | com.automatics.providers.rack.RemoteProviderFactory | No | Rest & Java API | Factory class that returns instances of com.automatics.providers.rack.RemoteProvider based on remote type. Automatics Core provides rest client handler for RemoteProvider - com.automatics.providers.rack.impl.RemoteProviderRestImpl If partner prefers to use Rest Impl, then RemoteProviderRestImpl can be returned from RemoteProviderFactory. |
| imageUpgradeProviderFactory | com.automatics.providers.imageupgrade.ImageUpgradeProviderFactory | No | Java API | Factory class that returns instances of com.automatics.providers.imageupgrade.ImageUpgradeProvider based on type of image upgrade mechanism |
| codeDownloadProvider | com.automatics.providers.CodeDownloadProvider | No | Java API | Provides APIs to get images for image upgrade |
| crashAnalysisProvider | com.automatics.providers.crashanalysis.CrashAnalysisProvider | No | Java API | Provides APIs identify crash and get crash logs from crash portal |
| serialCommandExecutionProvider | com.automatics.providers.connection.SerialCommandExecutionProvider | No | Java API | Provides APIs to execute command from serial console |
| webpaProvider | com.automatics.providers.webpa.WebpaProvider | No | Java API | API to provide authentication data for rest based webpa communication and api to provide device mac address. |
| snmpDataProvider | com.automatics.providers.snmp.SnmpDataProvider | No | Java API | APIs to provide device mac address and authentication data for snmp communication |
| snmpProviderFactory | com.automatics.providers.snmp.SnmpProviderFactory | No | Java API | Factory class that generates instances of com.automatics.providers.snmp.SnmpProvider based on snmp version. Automatics Core provides default implementation of factory class com.automatics.snmp.impl.DefaultSnmpProviderFactoryImpl that will return com.automatics.snmp.impl.Snmpv2ProviderImpl and com.automatics.snmp.impl.Snmpv3ProviderImpl instances. If Partner wants to provide a custom implementation of SnmpProvider, then they have to provide implementation for factory class as well and map factory class in xml file. |
| tr69Provider | com.automatics.providers.tr69.TR69Provider | No | Java API | API to get TR69 param values |
| issueManagementProvider | com.automatics.providers.issuemanagement.IssueManagementProvider | No | Java API | APIs to get details to be included in auto generated Jira tickets during test failure. |
| buildAppenderProvider | com.automatics.providers.appender.BuildAppenderProvider | No | Java API | BuildAppenderProvider helps to perform device configuration changes or set modes for device before test execution. They are invoked during Pre-Suite Intialization. |
| credentialCryptoProvider | com.automatics.providers.connection.auth.ICrypto | No | Java API | APIs to encrypt and decrypt partner data. Core provides default implementation for ssh connection. To make ssh connection to destination, credentials are required to be configured in file server-config.xml and it can kept in any location in Jenkins VM. The path of the file can be configured via property 'serverConfig.path'. Core will use this file to read credentials for ssh login. If needed, partner can encrypt the credential and keep them securely in server-config.xml and the decryption logic can be added in partner java api. The decryption logic can be linked to Core via the provider ICrypto. Template of server-config.xml - server-config.xml |
RDKV Providers
Providers applicable only to RDKV platform.
| Bean Name | Automatics Core Provider | Required By Default | API Type | Description |
|---|---|---|---|---|
| rdkVideoDeviceProvider | com.automatics.providers.RdkVideoDeviceProvider | Yes | Java API | APIs for AV validation, fetching channel details etc |
| videoProvider | com.automatics.providers.rack.VideoProvider | No | Java API | APIs to capture images from settop video |
| imageCompareProvider | com.automatics.providers.rack.ImageCompareProvider | No | Java API | APIs for image compare. for eg: to verify if given image is displayed on current screen. |
| ocrServiceProvider | com.automatics.providers.ocr.OcrServiceProvider | No | Java API | APIs for OCR reading |
RDKV Providers
Providers applicable only to RDKV platform.
| Bean Name | Automatics Core Provider | Required By Default | API Type | Description |
|---|---|---|---|---|
| rdkVideoDeviceProvider | com.automatics.providers.RdkVideoDeviceProvider | Yes | Java API | APIs for AV validation, fetching channel details etc |
| videoProvider | com.automatics.providers.rack.VideoProvider | No | Java API | APIs to capture images from settop video |
| imageCompareProvider | com.automatics.providers.rack.ImageCompareProvider | No | Java API | APIs for image compare. for eg: to verify if given image is displayed on current screen. |
| ocrServiceProvider | com.automatics.providers.ocr.OcrServiceProvider | No | Java API | APIs for OCR reading |
RDKB Providers
Providers applicable only to RDKB platform.
| Bean Name | Automatics Core Provider | Mandatory | API Type | Description |
|---|---|---|---|---|
| deviceLogUploadProvider | com.automatics.providers.logupload.DeviceLogUploadProvider | No | Java API | APIs to perform device log upload to Partner cloud system |
RDK Interface Providers
WebPA Provider
Automatics core provides default implementation of webPA provider.
Partners can configure the authrization data for communicating with webPA server via the automatics properties.
Package: com.automatics.webpa.impl
class: WebPaProviderImpl
User can configure the authrization to communicate with the webPA server via the property this "WEBPA_AUTH_KEY". So this property can be configured in the automatics too and user can be configure this authentication. Property is "WEBPA_AUTH_KEY".
If partner has provided custom implementation this webPA provider then they can add the implementation in their partner java api project then automatics will get the higher preference to the partner provider implementation.
For custom partner needs to configure this partner-applicationContext.xml.( class="com.rdkm.provider.webpa.WebPaProviderImpl")
| API | Description |
|---|---|
| Map<String, String> getRequestHeaderAuthData(WebPaType methodType) | Authentication headers if any required for WebPa communication. This invokes providing auth token in request header. |
| String getDeviceMacAddress(Dut dut); | The mac address to be used for fetching/updating webpa params |
SNMP Provider
To execute SNMP commands on device, partner needs to implement following APIs in SnmpDataProvider.
Provider - com.automatics.providers.snmp.SnmpDataProvider
Bean Name - snmpDataProvider
APIs in Provider
| API | Description |
|---|---|
| SnmpSecurityDetails getSnmpAuthorization(Dut dut, SnmpParams snmpParams) | Provides the authentication data for SNMP communication. For SNMPv2, provide the community string. For SNMPv3, provide authentication and encryption methods to be sent along with snmp command. |
| SnmpParams updateSnmpParams(Dut dut, SnmpParams snmpParams) | If partner needs to customize snmp params provided by Automatics before execution, it can be done here. |
TR69 Provider
To use TR69 support provided by Automatics, partner needs to implement following API in TR69Provider.
Provider - com.automatics.providers.tr69.TR69Provider
Bean Name - tr69Provider
APIs in Provider
| API | Description |
|---|---|
| List<String> getTr69ParameterValues(Dut dut, String[] parameters) | Provide implementation to get TR 69 param values from ACS server |
Overview
Community Forums
Content Tools
Tasks