RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
...
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.deviceManagerdeviceConnectionProvider=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 |
...
Bean Name | Automatics Core Provider | MandatoryRequired 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 |
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 |
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 |
...
Partners can configure the autherization authrization data for communicating with webPA server via the automatics properties.
...
class: WebPaProviderImpl
User can configure the autherization 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".
...