Versions Compared

Key

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

...

draw.io Diagram
bordertrue
diagramNamerpi-interaction
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth1001
revision24


A user can login to RPi device via different ways such making ssh connection or telnet connection and this method is specific to partners.  So there should be an intermediate layer between RPi device and Automatics which helps  to connect with device. This intermediate layer is the RPi Partner Provider Implementation which contains partner specific implementation of different Providers defined by Automatics. 

...

To execute tests on Raspberry Pi device, partner has to ensure below setups are done.

  • Raspberry Pi device loaded with RDKB stack is available
  • Automatics system (Includes Automatics Orchestration, Automatics Properties, Device Manager, Jenkins)
  • Automatics Core and RDKB Utils maven artifacts deployed in self hosted artifactory repository
  • Configure Raspberry Pi device in Device Manager, Automatics Orchestration and Automatics Properties
  • SSH connection to Raspberry Pi device is available from Jenkins VM
  • Configure the test scripts in Automatics Orchestration
  • Maven Deploy generic Raspberry Pi Provider Implementation provided by RDKM or partner specific Raspberry Pi Provider Implementation to self hosted artifactory repository.
  • Configure Raspberry Pi Provider Implementation artifact details in jenkins job.

...

...

/mnt/scripts/pre-test-config.sh -g 'com.automatics.providers' -a 'rpi-provider-impl' -v '0.0.1-SNAPSHOT'

...

4. Configure Device in Automatics

After the setup is ready, partner has to configure the device model and device details in Automatics and its details are available at Device Configuration in Automatics.

...

5. Validate Automatics Setup

After the system is ready, partner can validate the system by executing test script TC-QUICK-DUMMY-ALL-MODELS from Automatics Orchestration. From the execution, partner can verify communication between below components are working fine. After setup validation, partner can configure RDKB test scripts in Orchestration. 

  • Communication between Orchestration and Device Manager.
  • Communication between Orchestration and Jenkins.
  • Communication between Jenkins and Automatics Properties.

...

Please follow Automatics Generic Tests#ConfigureTC-QUICK-DUMMY-ALL-MODELS to configure TC-QUICK-DUMMY-ALL-MODELS in Orchestration.

After setup validation, partner can configure RDKB test scripts in Orchestration.

6. Configure RDKB Test Scripts in Orchestration

To configure RDKB test scripts to Orchestration, please follow the steps below.

...

Note: In Manage Script page, ensure that only single Quick Test script is enabled for each device model. Please follow, Automatics Orchestration User Manual#EnableScript, to enable/disable test script.

7. Configure Device Login Details in Jenkins VM

Some test scripts has to execute commands within device and verify its response. The DeviceConnection Provider implementation in rpi-provider/java-handler uses helps to execute commands within device. It creates SSH connection to device and then executes the commands. So to create SSH connection, ssh login details are to be provided to Automatics. This can be done by configuring ssh login credentials in the format  server-config.xml and then keep it in Jenkins VM. The location where this config file is kept should be configured in Automatics Properties for on parameter 'serverConfig.path'.

From Automatics core version  2.1.0 and device manager version 1.0.2 it is possible to configure SSH Connection login  details in devicemanger by adding sshcredentials in extraproperties  section of  POST /deviceModel/add  API.

...

The priority is given first to get ssh connection details from serverconfig.xml file, if it is not there we can get details from device manager side.

For eg: if server-config.xml is available at /mnt/config in Jenkins VM, then in Automatics Properties parameter will be configured as serverConfig.path=/mnt/config/server-config.xml

8. Trigger Execution

After the test scripts are configured, partner can trigger test execution from Orchestration via Trigger Execution Manually page.

...