Following are the new pages added for scriptless execution support in Orchestration

...

API Explorer

...

Automatics Login

User can login into Automatics through any one of these two authentication modes - Self-Authentication or LDAP Authentication.

Link to Automatics Login page URL :

<Automatics Login URL>

Image Removed

API Explorer

Link to the page: <<APi Explorer URL>>

     For API's Explorer we can verify via Environment Type & API Category & Keywords.

     Select appropriate environment (for E.g. select RDKV for video devices, RDKB for broadband devices and RDKC for cameras). For API's Category we can verify the category of the API's

     using keywords, we can search for API (Ex: channel tune), it will expose all channel related API's.

Image Removed

API's can be verified via 

• BTC: Test cases created in Build Test Case page.
• TCG: Test cases created in Test Case Generator page.

DEVICE MANAGER  

• Device Model Configuration
  • 1. Configure device model in Device Manager.
  • 2. Configure device model in Automatics Orchestration.
  • 3. Device model in Automatics Properties 
• Device Configuration
  • 1. Configure device details in Device Manager
  • 2. Configure Connected Client device details in Device Manager
  • 3. Configure device group in Automatics Orchestration.
• Device Extra Properties Configuration

To execute tests on devices, partner has to configure device models and the device details in Automatics. 

Device Model Configuration

To execute tests on a new device model in Automatics, partner has to configure device model details in Device Manager, Automatics Orchestration and Automatics Properties.

The detailed steps of configuring device models in each component is shared below.

1. Configure device model in Device Manager.

Devices to be used in the Automatics System should be configured in Device Manager. These devices are provided to Automatics Orchestration during test execution. Follow the below steps to add device details to the device manager database.

To Invoke the API defined for Device Manager application using Swagger UI tool which is integrated with Device Manager application.

Steps to invoke an API on Swagger UI tool is available at Device Manager API Documentation#SwaggerUIUsage.

• Navigate to {protocol}://{host:port}/DeviceManager/swagger-ui.html.
• Navigate to Device Model API and invoke POST /deviceModel/add API to add new device model to the Application by providing "deviceModelName" parameters. Refer Device Manager API Documentation#DeviceModelRequest to get more details on the input parameters.
• POST /deviceModel/add API will return response as "SUCCESS" on successfully adding the device model to the device manager database.
• Refer Device Manager API documentation- Device Model page to get more details on the parameters provided and type of responses received for POST /deviceModel/add API.

2. Configure device model in Automatics Orchestration.

Automatics identifies a device model from its build name. For this, admin user has to configure device model and it's corresponding build name. It requires only to map the device model and initial starting sub string of build name. The starting few letters(image prefix) in the build name should be unique to a device model and this should be added in 'Image Name Prefix' text.

Steps to configure device model in Automatics Orchestration is available at Automatics Orchestration Configure Device Model.

3. Device model in Automatics Properties 

Partner has to configure model details in device_config.json deployed with Automatics Properties. The file can be found at VM where Automatics Properties is deployed at location {Apache_Tomcat_Home_Directory}/webapps/automatics/device_config.json.  Edit this file and add models details as shown below.

• For Raspberry Pi device with RDKB stack, update device_config.json as

...

{  
    "name":"Raspberry Pi-RDKB",
    "automaticsModelName": "Rpi-RDKB",
    "rackModelNames":["Rpi-RDKB"],
    "groups":[""],
    "category":"RDKB",
    "inventoryModelName":"Rpi-RDKB",
    "accessibleMechanism":"SSH",
    "accessbilityCheck": false,
    "waitTimeAfterHardReboot": 300000  
}

     For API's Explorer we can verify via Environment Type & API Category & Keywords.

     Select appropriate environment (for E.g. select RDKV for video devices, RDKB for broadband devices and RDKC for cameras). For API's Category we can verify the category of the API's

     using keywords, we can search for API (Ex: channel tune), it will expose all channel related API's.

Image Added

API's can be verified via 

• BTC: Test cases created in Build Test Case page.
• TCG: Test cases created in Test Case Generator page.

Device Configuration

1. Configure device details in Device Manager

Devices to be used in the Automatics System should be configured in DeviceManager. These devices are provided to Automatics Orchestration during test execution. Follow the below steps to add device details to the device manager database.

To Invoke API defined for Device Manager application using Swagger UI tool which is integrated with Device Manager application.

Steps to invoke an API on Swagger UI tool is available at Device Manager API Documentation#SwaggerUIUsage.

• Navigate to {protocol}://{host:port}/DeviceManager/swagger-ui.html.
• Navigate to Device API and try to execute POST /device/add  API to adds new device to the Device Manager database by providing valid input parameters for deviceDetailsRequest as defined in Device Manager API Documentation#DeviceDetailsRequest.
• POST /deviceModel/add API will return response as "SUCCESS" on successfully adding the device details to the device manager database.G
• Refer Device Manager API Documentation#Device page to get more details on the parameters provided and type of responses received for POST /device/add API.
• SSH login details can be configured through POST/device/add  API .It's possible to add ssh connection details in extraproperties section of this API.
• The SSH connection details configured of particular IPAddress can be obtained by POST/device/sshDetailsByIpAddress API .
• Refer Device Manager API Documentation#Device page to get more details on the parameters provided and type of responses received for POST /device/sshDetailsByIpAddress API.

2. Configure Connected Client device details in Device Manager

The steps for configuring connected clients is same as configuring standalone device as mentioned in section 1. Configure device details in Device Manager, except that it requires additional data like device login details etc to be included while adding the device.

1. While adding connected client devices, ensure that all devices under the same setup are mapped with same account id. During connected client test execution, devices are fetched based on account id and this can be used to identify each connected client setup.
2. For connected clients, the additional data should be configured in extraProperties section while adding the client device.

For eg: For wifi clients, the extra properties should have following fields.

Wifi Clients

...

Property Required

...

Description

...

Image Removed

3. Configure device group in Automatics Orchestration.

For Automatics to use devices from partner's inventory, device groups have to be configured. The device group name in inventory should be added here so that user can execute tests on devices within these groups only. Admin user can map device groups to users so that only those users mapped to device group can execute tests on device.

• Steps to Configure device group in Automatics Orchestration is available at Automatics Orchestration Configure DeviceGroup.
• Steps to map device groups to user Automatics Orchestration User Manual#ManageUserGroupAccess

Device Extra Properties Configuration

The steps for configuring connected clients is same as configuring standalone device except that it requires additional data like device login details etc.. to be included while adding the device.

• For connected clients, the additional data should be configured in extra properties section while adding the client device.

 Extra properties can be configured in 2 ways as shown below.

• Using Swagger UI
  • The additional data related to device like serial port, login credentials  etc... can be configured in extra properties section of the device.
  • Please use the swagger API /device/update  to update extra properties.

Image Removed

• • Update extraProperties filed with device extra properties as shown below.

Eg: “username”:”root”

     Image Removed

• Using Device Manager UI
  • Following page will provide the steps to add or edit  extra properties  for a device using Device Manager UI tool.

...

Build Test Utility

Link to Build Test Utility : <<Build Test Utility>>

...