RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
User can login into Automatics through any one of these two authentication modes - Self-Authentication or LDAP Authentication.
Link to Automatics Login page URL :
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.
API's can be verified via
DEVICE MANAGER
To execute tests on devices, partner has to configure device models and the device details in Automatics.
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.
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.
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.
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.
|
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.
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.
For eg: For wifi clients, the extra properties should have following fields.
Wifi Clients
Property Required | Description |
---|---|
username | User name to login to client device |
password | Password to login to client device |
connectionType | Expected values: "Wi-Fi" or "Ethernet" |
wifiCapability | Wifi Capability eg: Dual Band |
wifiMacAddress | Wifi Mac Address |
ethernetMacAddress | Ethernet mac address, which is same as value configured in field ecm mac address/estb mac address |
deviceIp | Ip address of the device, which is same as value configured in field estb ip address/ecm ip address |
devicePort | Tests can connect to client using deviceIp and devicePort |
osType | OS running in client. Eg: Linux, Windows |
nodePort | Port used for selenium connection |
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.
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.
Extra properties can be configured in 2 ways as shown below.
Eg: “username”:”root”
Device Manager UI User Manual#EditDeviceExtraProperties
Link to Build Test Utility : <<Build Test Utility>
Build utility in automatics is creating the frequently used steps as utility. The same utility can be injected in to any other testcases.
For example, if 4 steps are used in common for multiple testcases then user can club those four steps into a build utility and then user can insert that utility into any other test cases.
The advantages of build utility are reuse and it decreases the effort for user to create the same steps again and again.
Build utility can be created in the same way as build test case.
User can create build utility by clicking Build Utility tab under settings a shown below,
Settings --> Build Utility
First user should create the repeated steps as utility as shown above.
Then user can add that utility as a step while creating the test case as shown below,
If user want to include the utility in test case below steps should be followed,
Build Test Case
Link to Build Test case : <<Build Test case>>
The build test case tab will be as shown below:
For Build test case the Test case Id should be unique and different, and Test Description should be correct way based on the Testcase ID. In Environment Type Field Select appropriate environment (for Eg. select RDKV for Video devices, RDKB for broadband devices and RDKC for Cameras and EXTENDER for Extender devices). Test type and Test Priority should be in the Unique way. Run on models needs to be mentioned like what are all the devices that are applicable for the Test case ID. For each test case id, we need to mention the models that needs to execute. User can verify once whether all the details are valid and then click on the Next button.
Then user will be navigated to Build your own Test case... page as shown below.
For Build our Own Test case
we need to add three steps ;
By clicking Add Step button, the User will get a drop-down as shown below.
All the options that are present in the drop-down are explained below,
Step name
Step No will be in non-editable one. Description should be clear based on the test step. User can select the Command Type based on each step. Based on the API's the methods will be applicable for each step.By clicking the settings icon in the Input filed, User will be navigated → Input Configuration page.
For command user needs to add the command inside the command field. User can select how the output of the command executed should be validated. Select all the device models to which the command will be applicable. The expected output of the command should be given in this field. If the selected execution mode of the test case is Connected Client, then user can select Device-Config and Clients. After entering all the details of the input command, we need to click → Add button. User can verify once whether all the details are valid and then click on the Submit button.Now command and Test step added successfully. If user wants to edit, user can click on button. If user want to change the declaration part, click on edit delete button. Once all the details are added click on the submit button.
By clicking external-link icon, User will get Additional Values window as shown below.
Iterational option will create a iteration step as shown below.
Step number will be non-editable text box. User should enter the detailed description about the test step. For Test Type should mention LOOP (or)
EXIT-LOOP. After click the settings icon in the Action filed, It will be automatically navigate to the Add Iteration or Duration page as shown below.
We need to provide either Iteration Count or Duration in Seconds and click -> Save button. Now the Command / Test step added successfully.
same as Iterational . In Test Type it contains IF, ELSE-IF and ELSE.
By clicking the settings icon in the Action filed, user will be navigated to Add Condition page as shown below.
User should select the Operator type. The drop-down list consists of AND & OR options. For Invert Result don't select the NOT check box to invert condition. Actual value of the condition should be given in this field. User can select how the output of the command executed should be validated. Expected value of the condition should be given in this filed. After entering all the details of the input condition, click on the plus icon. Verify once whether all the details are valid and added successfully click on the Save button. Command/test step details added successfully.
User can see all the available steps created in Test Step Generator page. By using Filter, we can find the added test step (Saved in a test step generator page).In all the available steps, we can select the required test step. After selecting the test steps, click '>'. Then user can see the required steps in Selected Steps column. After click on the Add Steps button. Now the steps will be added in our Build your own Test case... page. After creating/adding all the test steps, click Save button to save the changes and it will be added in Available test cases table.
EDIT,CLONE& DELETE Test case
For Editing the Testcase
For Editing the test case details, then click the pencil icon in Action column in Available test cases table. Then user can edit the entered details then click on Save button to save the changes or by clicking the Next button user can add/remove/edit test steps details and click Save button to save the changes.
For Cloning the Testcase
To clone or get a copy of a test case, then click the copy/clone icon in Action column in Available test cases table. Then user should provide a unique test case id, and user can edit the existing details and can add/remove/edit the test step details. By clicking the Save button the cloned test case will be added in Available test cases table, and it will not change the existing test case.
For Delete Test Case
By clicking the delete icon in Action column in Available test cases table, user can delete the test case.
Link For Test Constants :<<Test Constants>>
Test constant here in automatics means the command or log file or any string that gets used more frequently is called as a test constant
We can declare the test constant once and can use the same in multiple places.
The main advantage of the test constant is it avoids the stabilization effort or test case developer can change the value at one place rather than spending effort on searching all the testcases that uses the string.
Also, whenever user changes any value of the test constant, it impacts all the testcases that are using that test constant.
So, while editing test constant one should be very careful as its impact might be huge
Test constant can be created through test constants page under settings tab. Settings → Test Constants
User should click on Add Constant button and add the constant name and constant value as shown below.
Constants name must be unique.
To add test constant in test case we need to use {{as the trigger. When user enters {{then all the test constants are listed under as shown below.
Test constants always starts with TC$ and user can select the test constant as per the requirement
Link for Manage Test Trigger :<Manage Test Trigger>
For Both RDKV & RDKB same job trigger page
For Select Service name default it will be Functional Verification if user wants he can select CI verification based on the requirement.Build name should be the same one that is available inside the box details. Endpoint should be either Desk box or Rack device. Partner Test is not the mandatory one.If we want we can select the box and add COMCAST. Test types needs to be selected based on the hours and days execution time. Environment type should be either RDKV,RDKB,RDKC.Is Quick Test required it will selected as a default one . We can disable that if we are not using QT .
Once all the details added successfully User will be navigate to the Following page.
In Automation ID user needs to select the Automation ID . Once the ID selected it will available inside Short-listed Automation Ids. Click on Next button. It will be navigated to the Trigger Execution manually.
For Mac address select check box 00-xx-xx-xx-xx-xx and for good devices click on -> . . It will list the good devices. We can have Schedule trigger option also available, and the time needs to be mentioned. Device Group we can select based on the Automation ID. Build Appender and Notification mail will be mandatory. Source Repo needs to be mentioned based on the repo's available in the repository.Once all the details mentioned user Should click on the Trigger Job button. Once done Trigger will start successfully and via Job manager Tab.
E.gBy clicking this icon
we can see the child Jobs name . After that click on thsi icon .Then Jenkins Execution logs will be available . We can verify pass and failures of all the steps.