Software Requirement
- JDK 1.8
- MySql 5.6
- Tomcat 7.0.92
- Maven 3
- SMTP server (optional, if email feature in Automatics to be enabled)
MySQL Configuration
- Create database with name ‘automatics’.
- Execute the script 'Automatics_DB.sql' that is available with Orchestration source at 'automatics\resources\'. Now the Automatics tables are created with basic configuration data.
- Execute the script 'Automatics_MySqlProcedures.sql' that is available with Orchestration source at 'automatics\resources\'. This is a stored procedure invoked by orchestration to update test pass/fail count in DB.
WAR Generation
- Pull the latest Automatics Orchestration tool project from the repository (rdk/tools/automatics) with branch “rdk-next”.
- After taking the pull, do “mvn clean install” then war file will be generated and will be present inside Automatics/release/Automatics-v0.1/ folder inside the project.
- Rename war to Automatics.war.
War Deployment
- Copy the Automatics.war file to the apache-tomcat/webapps folder.
- Copy the restartTMR.sh file which is inside Automatics/config to apache-tomcat/bin folder.
- Copy “hibernate.cfg.xml”(inside Automatics/config folder) and “log4j.properties”(inside Automatics) files to any specific location,
- Update “hibernate.cfg.xml” with database user name and password. And the password updating in "hibernate.cfg.xml” should be Base64 encoded. And, the DB name should be 'automatics'.
- Add the following params to JAVA_OPTS inside apache-tomcat/bin/catalina.sh file
-DAutomatics -DhibernateUI.config.file = {path to hibernate config file}
- Log4j Configuration
- Orchestration <= v3.0
- Orchestration >= v3.1
- Log4j configuration is optional.
- log4j.properties has been replaced with log4j2-test.xml and is available at Automatics/src/main/resources/. By default, log4j2-test.xml logging configuration will be taken and no explicit configuration is required. However, if custom logging is preferred then it can be configured with JVM property
- Add the following param to JAVA_OPTS inside apache-tomcat/bin/catalina.sh file
-Dlog4j.configurationFile={path_to_custom_log4j2-test.xml}
- Create empty files childUI.jmd and mainUI.jmd in apache-tomcat/bin/. This is required by orchestration for job scheduling.
- Navigate to apache-tomcat/bin directory and start the server by executing command.
./startup.sh
- To verify the server logs, navigate to logs directory (apache-tomcat/logs) under tomcat.
- catalina.out - server start up logs
- automatics_{time_stamp} - Automatics logs
- traces/trace_automatics_{time_stamp} - Automatics trace logs
- Automatics Orchestration can be launched from “{protocol}://{host:port}/Automatics/login.htm
- To stop the server type ./shutdown.sh.
Configuration
- Launch Automatics Orchestration.
- For the first time, login with username as "admin" without password using Self Authentication.
- After a successful login, we need to setup the following configuration. Some of the configurations are visible only to admin user. Also, it is recommended to keep configuration related access to be retained only with admin. (eg Access to page 'System Configuration' ).
System Configuration
- From Automatics UI, go to Settings -> System Configuration page.
The system configuration page has following parameters and partner has to configure values for their environment. The description of each parameter is provided below which helps to configure them.
System Config Param | Description |
DEFAULT_SYNDICATION_PARTNER | Default syndication partner. Eg: Company name |
SYNDICATION_PARTNERS | Syndication partner names in comma separated format. Eg: Company name |
DEVICE_INVENTORY_BASE_URL | Base URL which is having the rest implementation of device management |
EXECUTION_ENVIRONMENT_TYPES | Execution environment types in comma separated format. Supported values are RDKV, RDKB |
JUN | Jenkins Username |
JUP | Jenkins Password |
LDAP | LDAP Configuration values |
Test_Types | Test Types supported by Automatics, QUICK, QUICK_CI, 1HOUR, 4HOUR, 2DAYS, FAST_QUICK, FAST_QUICK_CI |
EXECUTION_PRIORITY | Test cases will be executed based on the priority. Default provided values in comma separated format for execution priority are P0,P1,P2,P3 |
JOB_NAME_PREFIX | Prefix of the Jenkins job name. Depending on the test environment partner can configure multiple jenkins jobs for test execution and they all should have name that is configured here with an index. Default provided value is “GENERIC_RDKM_JOB”. eg: GENERIC_RDKM_JOB1, GENERIC_RDKM_JOB2 ...GENERIC_RDKM_JOBN |
RDK_PORTAL_AUTH | Authentication token to access the RDK portal. Currently, this is not used by Orchestration for communication |
MINIMUM_FAIL_PERCENTAGE_TO_RETRY_TEST | After test execution, orchestration will calculate the percentage of failed test steps in a test script. If the failure percentage is beyond the limit configured here, then test will be automatically selected for re-trigger. Default value is 20 |
USER_DEFAULT_MODULES | Values of the default modules that can be accessed by the guest user. Default provided values separated by hyphen -3-5-6-8-9-13- |
MASTER | Comma separated string keywords to identify a build name as master |
SPRINT | Comma separated string keywords to identify a build name as sprint |
STABLE | Comma separated string keywords to identify a build name as stable |
CI_BUILD | Comma separated string keywords to identify a build name as CI build |
TM_TYPE | Automatics deployment environment. Valid values DEV or PROD |
HEAD_ENDS | Head ends to which devices are connected. Values added in comma separated format |
SERVICE_CI_VERIFICATION_VALUE | Value for service CI_VERFICATION. Supported value CI_VERIFICATION. |
SERVICE_FUNCTIONAL_VERIFICATION_VALUE | Value for service FUNCTIONAL_VERIFICATION. Supported value FUNCTIONAL _VERIFICATION. |
REASON_TYPES | Reasons for adding/updating/deleting scripts via 'Manage Script' page. Values added in comma separated format |
MAX_DAILY_ACCEPTABLE_GRT_BUILD_FROM_PORTAL | Ideally automatics process one time only the same CI build for a device. If process/execution to be done multiple time on same CI build for same device this property can be configured. |
RDK_PORTAL_BASE_URL | RDK Portal base url |
ISSUE_MANAGEMENT_URL | Issue/Defect Management service base url |
![](/download/attachments/149883174/image2021-4-28_19-41-10.png?version=1&modificationDate=1619697809000&api=v2)
![](/download/attachments/149883174/image2021-4-28_19-41-50.png?version=1&modificationDate=1619697809000&api=v2)
![](/download/attachments/149883174/image2021-4-28_19-42-6.png?version=1&modificationDate=1619697809000&api=v2)
![](/download/attachments/149883174/image2021-4-28_19-42-19.png?version=1&modificationDate=1619697809000&api=v2)
Device Models
- From Automatics UI, navigate to Settings -> Manage Scripts -> Run on Models
User needs to configure all device models that is going to execute from Automatics.
Automatics identifies a device model from its build name. For this, admin user has to configure device model and its 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 build name should be unique to a device model and this should be added in 'Image Name Prefix' text.
![](/download/attachments/149883174/image2021-4-30_12-54-51.png?version=1&modificationDate=1619767594000&api=v2)
- Click on Add Device Name
- Enter the Device Name.
- Enter the Image Prefix Name. The build name prefix which will be unique to identify a device model. Automatics identify a device model from the build name.
- Select the device category.
- Check-in isClientDevice, if the device is a RDKV client device.
Device Group
- From Automatics UI, navigate to Settings -> Device Groups
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.
![](/download/attachments/149883174/image2021-4-30_12-47-32.png?version=1&modificationDate=1619767162000&api=v2)
- Go to Settings -> Device Groups
- Click on Add New Device Group Name
- Enter the Device Group Name. Devices should be present in this Group Name.
Resource Details
- From Automatics UI, navigate to Settings -> Resource Details
User can configure Jenkins details in resource details. The test execution happens at jenkins. The jenkins job name should be configured in 'System Configuration' page for param 'JOB_NAME_PREFIX'.
![](/download/attachments/149883174/image2021-4-30_14-38-18.png?version=1&modificationDate=1619773800000&api=v2)
- Click on Add Resource Details.
- Enter the Jenkins resource base URL
- Select the Category type from the dropdown (Select if jenkins is configured for RDKV or RDKB execution).
- Maximum Parallel Jobs :- It represents the number of jobs configured in Jenkins for Automatics. It also requires, the configured jenkins jobs should have pre-defined name which is configurable from system property 'JOB_NAME_PREFIX'. For, eg: If "JOB_NAME_PREFIX" is set to AUTO_JOB, then in jenkins, jobs dedicated for Automatics execution should have names AUTO_JOB1, AUTO_JOB2, AUTO_JOB3 etc. Here, the Maximum Parallel Jobs configured is 10. So at a time Automatics can perform 10 job executions and remaining jobs will be in Queued state in Automatics waiting for free jenkins job.
Source Code Repository
User can configure source repository of test project in Automatics. Test project repository path and branch are passed to jenkins during execution. Jenkins will clone the repository and execute the tests. It requires user to add details from database.
- Update the Source Code Repository Details, by executing sql command on 'source_code_details' table in database.
- Ex: insert into source_code_details (NAME, CATEGORY_TYPE, SOURCE_REPO, SOURCE_BRANCH, DELETED_DATE, UPDATED_BY, UPDATED_DATE) values ('{generic category name}','{category type}',{repo details of the project been deployed}','{branch name of the project where it is pulled}','NULL', 'admin', now());
- The 'NAME' field will contain the source name. This is for ease of identifying repo details from UI. The source name should be starting with 'RDKV_' or 'RDKB_' prefix.
- Valid values for CATEGORY_TYPE fields are RDKV or RDKB.
Job Settings
- From Automatics UI, navigate to Settings -> Job Settings
For each test type in Automatics, job will be created during test execution. The jobs are created based on job templates. For each test type, a job template need to be created.
![](/download/attachments/149883174/image2021-11-24_14-44-42.png?version=1&modificationDate=1637745283000&api=v2)
- Click on Add New Job
- Enter Job Name: Enter the Job Name with the prefix of AUTO followed by TEST_TYPE and JOB, all are separated by “_”.
Eg: AUTO_1HOUR_JOB. Quick Test is configured as parent of all other jobs. Child jobs are executed in the order of priority set for the job.
![](/download/attachments/149883174/image2021-11-24_14-46-10.png?version=1&modificationDate=1637745372000&api=v2)
- Please update the default value for each field here.
- For CI integration, if results of test execution to be updated to CI portal, then set 'updateRdkPortal' to true here.
- Click on Save.
For the below test types configured in Automatics, user has to create a Job template from Job Settings page. The Job names and test types names should be configured as below.
Test Type | Template Job Name |
---|
QUICK, FAST_QUICK | AUTO_QUICK_TEST_JOB |
QUICK_CI, FAST_QUICK_CI | AUTO_QUICK_TEST_JOB_CI |
1HOUR | AUTO_1HOUR_TEST_JOB |
4HOUR | AUTO_4HOUR_TEST_JOB |
2DAYS | AUTO_2DAYS_TEST_JOB |
Tests not mapped to any group | AUTO_COMPONENT_TEST_JOB |
Admin Only Features
Following features should be given permission only to Admin.
Upgrade Automatics
Admin can upgrade the Automatics by going to Settings -> Upgrade Automatics
Automatics provides support for automated deployment.
- Click on Browse button, now select the Automatics.war file in releases/automatics-v{pom_version} folder and click on Open.
- Click on Upgrade button to upgrade the Automatics.
User Management
- From Automatics UI, navigate to Settings -> User Management
Admin can manage all the users of the Automatics.
Admin can Add/Delete the user details and groups. Also, manages the user group module access.
- Click on Add New User
- Enter Preferred User Id: “guest”
- Enter the user name: “guest”
- Enter email: guest@automatics.com
- Select user group: GUEST
- Click on Add New User Group
- Enter User Group name: GUEST_1
- Click on Delete User Group
- Select the User Group, you want to delete and click on Delete
- Click on User Group Module Access
- Select the User Group and click on Fetch Access Rights.
- Select the access right checkbox of the Module Name, you want to provide access.
- Click on Save.