Setup

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
    • Log4j configuration is mandatory 
    • Copy “log4j.properties” (inside Automatics/src/main/resources) to any specific location,

    • Add the following param to JAVA_OPTS inside apache-tomcat/bin/catalina.sh file 

      -DloggerUI.properties.file = {path to log properties file} 

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

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.

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

• • 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'. 

• • 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

            Admin user has to configure source repositories of test projects in Automatics Orchestration. 

 User can update source repo details via DB. UI support is not available now.

Source Repo Configuration for RDKB

Following are the source repository details to be configured for RDKB. Please execute following SQL Queries.

Configure generic core tests 

insert into source_code_details (NAME, CATEGORY_TYPE, SOURCE_REPO, SOURCE_BRANCH, DELETED_DATE, UPDATED_BY, UPDATED_DATE) values ('RDKB_CORE_TESTS', 'RDKB', 'generic-automation-tests', 'rdk-next', NULL,  'admin', now());

Configure RDKB tests 

insert into source_code_details (NAME, CATEGORY_TYPE, SOURCE_REPO, SOURCE_BRANCH, DELETED_DATE, UPDATED_BY, UPDATED_DATE) values ('RDKB_TESTS', 'RDKB', 'rdkb-tests', 'rdk-next', NULL,  'admin', now());

Source Repo Configuration for RDKV

Following are the source repository details to be configured for RDKV. Please execute following SQL Queries.

Configure generic core tests 

insert into source_code_details (NAME, CATEGORY_TYPE, SOURCE_REPO, SOURCE_BRANCH, DELETED_DATE, UPDATED_BY, UPDATED_DATE) values ('RDKV_CORE_TESTS', 'RDKV', 'generic-automation-tests', 'rdk-next', NULL,  'admin', now());

 Job Settings

From Automatics UI,User can navigate to the page Settings ->  Job Settings.

And verify (AUTO_QUICK_TEST_JOB, AUTO_QUICK_TEST_JOB_CI, AUTO_1HOUR_TEST_JOB, AUTO_4HOUR_TEST_JOB,AUTO_2DAYS_TEST_JOB,AUTO_COMPONENT_TEST_JOB,) jobs are created in the UI.

If job is not created please follow this Url Automatics Orchestration User Manual - Preferred Program - RDK Central Wiki

 If the jos not configured you can follow the UI.

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.

Job templates are created . If it is not not created you can follow Automatics Orchestration User Manual - Preferred Program - RDK Central Wiki

Email Notification

• From Automatics UI, navigate to Settings ->  System Configuration.

Automatics Orchestration has the support to update test execution details and other updates to users via automated email notification.

To enable this feature, admin user has to configure following fields in System Configuration page:

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 user email id
  • 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.