Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Bean NameAutomatics Core Provider

Required

By Default

API TypeDescription
testInitializercom.automatics.providers.TestInitilizationProviderNoJava APIAPIs for Pre and Post Test Initialization
deviceAccessValidatorcom.automatics.providers.DeviceAccessValidatorNoJava API

APIs for Device Validation. For eg: To verify

if device is accessible for taking for execution

deviceConnectionProvidercom.automatics.providers.connection.DeviceConnectionProviderNoRest & 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

deviceProvidercom.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

deviceConnectionBasedTracecom.automatics.providers.trace.AbstractTraceProviderImplNoJava APIAPIs to get trace logs from device. Connection to device will be via  DeviceConnectionProvider APIs
serialConnectionBasedTracecom.automatics.providers.trace.SerialTraceProviderNoJava APIAPIs to get trace logs from device via serial console
powerProvidercom.automatics.providers.rack.PowerProviderNoJava 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

remoteProviderFactorycom.automatics.providers.rack.RemoteProviderFactoryNoRest & 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.

imageUpgradeProviderFactorycom.automatics.providers.imageupgrade.ImageUpgradeProviderFactory

No

Java APIFactory class that returns instances of com.automatics.providers.imageupgrade.ImageUpgradeProvider based on type of image upgrade mechanism
codeDownloadProvidercom.automatics.providers.CodeDownloadProviderNoJava APIProvides APIs to get images for image upgrade
crashAnalysisProvidercom.automatics.providers.crashanalysis.CrashAnalysisProviderNoJava APIProvides APIs identify crash and get crash logs from crash portal
serialCommandExecutionProvidercom.automatics.providers.connection.SerialCommandExecutionProviderNoJava API

Provides APIs to execute command from serial console

webpaProvidercom.automatics.providers.webpa.WebpaProviderNoJava API

API to provide authentication data for rest based webpa

communication and api to provide device mac address.

snmpDataProvidercom.automatics.providers.snmp.SnmpDataProviderNoJava APIAPIs to provide device mac address and authentication data for snmp communication
snmpProviderFactorycom.automatics.providers.snmp.SnmpProviderFactoryNoJava 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.

tr69Providercom.automatics.providers.tr69.TR69ProviderNoJava APIAPI to get TR69 param values
issueManagementProvidercom.automatics.providers.issuemanagement.IssueManagementProviderNoJava APIAPIs to get details to be included in auto generated Jira tickets during test failure.
buildAppenderProvidercom.automatics.providers.appender.BuildAppenderProviderNoJava APIBuildAppenderProvider helps to perform device configuration changes or set modes for device before test execution. They are invoked during Pre-Suite Intialization.
credentialCryptoProvidercom.automatics.providers.connection.auth.ICryptoNoJava 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

...

Mandatory
Bean NameAutomatics Core Provider

Required

By Default

API TypeDescription
rdkVideoDeviceProvidercom.automatics.providers.RdkVideoDeviceProviderYesJava APIAPIs for AV validation, fetching channel details etc
videoProvidercom.automatics.providers.rack.VideoProviderNoJava APIAPIs to capture images from settop video
imageCompareProvidercom.automatics.providers.rack.ImageCompareProviderNoJava API

APIs for image compare. for eg: to verify if given image is 

displayed on current screen.

ocrServiceProvidercom.automatics.providers.ocr.OcrServiceProviderNoJava APIAPIs for OCR reading

RDKV Providers

Providers applicable only to RDKV platform.

Bean NameAutomatics Core Provider

Required

By Default

API TypeDescription
rdkVideoDeviceProvidercom.automatics.providers.RdkVideoDeviceProviderYesJava APIAPIs for AV validation, fetching channel details etc
videoProvidercom.automatics.providers.rack.VideoProviderNoJava APIAPIs to capture images from settop video
imageCompareProvidercom.automatics.providers.rack.ImageCompareProviderNoJava API

APIs for image compare. for eg: to verify if given image is 

displayed on current screen.

ocrServiceProvidercom.automatics.providers.ocr.OcrServiceProviderNoJava APIAPIs for OCR reading

RDKB Providers

Providers applicable only to RDKB platform.

Bean NameAutomatics Core ProviderMandatoryAPI TypeDescription
deviceLogUploadProvidercom.automatics.providers.logupload.DeviceLogUploadProviderNoJava APIAPIs to perform device log upload to Partner cloud system

RDK Interface Providers

WebPA Provider

...