Setup

If you already have an existing setup of Automatics you can follow the steps in this page for upgrading the software's Automatics Technology Stack - Upgrade 

Software Requirement

• JDK

  1.8

  17

Please note that even though the recommended version of Orchestration is JDK17, it is reverse compatible with JDK11 also. So code also be compiled with JDK11. Follow Steps below to install Java 17 on CentOS/Follow Steps below to install Java 1.8 on CentOS/linux.

• • Update before installing any new program

Image Removed

• • Install Java 1.8

Image Removed

• • Verify Java is Installed

Image Removed

Sample output:

Image Removed

sudo yum -y update

• • Install Java 17

sudo yum install java-17-openjdk

• • Verify Java is Installed

java -version

Sample output:

Image Added

• MariaDB 10.11

  MySql 5.6

Follow below steps to install and configure MySQL MariaDB on CentOS/linux

• • Go to the Download MySQL Yum Repository page (https://dev.mysql.com/downloads/repo/yum/) in the MySQL Developer Zone.

  • Select and download the release package for your platform.

  • Install the downloaded release package with the following command, replacing platform-and-version-specific-package-name with the name of the downloaded RPM package.

$> rpm -ivh  platform-and-version-specific-package-name.rpm

Example Output:

Image Removed

• • By using yum command, now we will install MySQL Server 5.6 . All dependencies will be installed itself.

Image Removed

• • To start MySQL Service, run command "systemctl start mysqld".

  • To stop MySQL Service, run command "systemctl stop mysqld".

  • To restart MySQL Service, run command "systemctl restart mysqld".

  • To get status of MySQL Service, run command "systemctl status mysqld".

  • Run "mysql_secure_installation"  to perform to reset the root user password.

Image Removed

• Tomcat 7.0.XX

Follow below Steps to setup Tomcat server  on CentOs/linux.

• • Download Apache Tomcat archive file from Apache Tomcat Download Webpage. You can use below wget command to download it.

Image Removed

• • After competed download extract archive file in /tmp directory and move to the proper location as per your need.

Example:

Image Removed

• • Navigate to the tomcat file path and run ./bin/startup.sh cmd to start the tomcat server.

Sample Output:

Image Removed

• Maven 3

Follow below steps to setup maven on Centos/linux.

• • Download Apache maven archive from Apache Maven 3 Download webpage. 

  • Extract distribution archive in any directory.

Image Removed

• • Add maven bin folder path using cmd "export PATH=<MAVEN_FOLDER_PATH>:$PATH.

Example:

Image Removed

• • Verfiy Maven is installed by giving "mvn -v" cmd.

Image Removed

• 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_RDKB' that is available with Orchestration source at 'automatics\resources\'. Now the Automatics tables are updated with basic Automatics_RDKB 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-v<version>/ 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} 

...

• • All the packages need to be up-to-date. Use the following command to update your packages.

    Code Block
    language bash
    sudo yum update

    Create a new repo file for the latest version.

    Code Block
    language bash
    vi /etc/yum.repos.d/MariaDB.repo

    Copy and paste the following contents into the /etc/yum.repos.d/mariadb.repo file.

    Code Block
    [mariadb] name = MariaDB baseurl = http://yum.mariadb.org/10.11/centos7-amd64 gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB gpgcheck=1

    To exit and save the Vim file, type :wq and press Enter.

  • Install the Latest Version of MariaDB

Install 10.11 of MariaDB and the most common packages, using the command below.

sudo yum install MariaDB-server galera-4 MariaDB-client MariaDB-shared MariaDB-backup MariaDB-common

• • Start MariaDB

    Start the MariaDB service with this command.

    Code Block
    language bash
    sudo systemctl start mariadb

    To set MariaDB to start automatically when the VM boots up, use the following command.

    Code Block
    language bash
    sudo systemctl enable mariadb

    Check the current status of MariaDB using this command.

    Code Block
    language bash
    sudo systemctl status mariadb

    Check the currently installed MariaDB version with this command.

    Code Block
    language bash
    sudo mysql -u root -p -V

• Tomcat 9.0.XX

Follow below Steps to setup Tomcat server  on CentOs/linux.

• • Download Tomcat 9 from the Apache Tomcat Archive

wget -c https://downloads.apache.org/tomcat/tomcat-9/v9.0.85/bin/apache-tomcat-9.0.85.tar.gz

• • Extract the Tomcat archive to the directory in which you want to deploy the Automatics Tools

    Code Block
    language bash
    sudo tar -xvf apache-tomcat-9.0.85.tar.gz -C /opt/automatics/

  • Navigate to the tomcat file path and run ./bin/startup.sh cmd to start the tomcat server.

Sample Output:

Image Added

• Maven 3

Follow below steps to setup maven on Centos/linux.

• • Download latest Apache maven archive from Apache Maven 3 Download webpage. 

  • Extract distribution archive in any directory.

Image Added

• • Add maven bin folder path using cmd "export PATH=<MAVEN_FOLDER_PATH>:$PATH.

Example:

Image Added

• • Verfiy Maven is installed by giving "mvn -v" cmd.

Image Added

• 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_RDKB' that is available with Orchestration source at 'automatics\resources\'. Now the Automatics tables are updated with basic Automatics_RDKB 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-v<version>/ 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

...

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

...

• to JAVA_OPTS inside apache-tomcat/bin/catalina.sh file   

-DAutomatics -

...

DhibernateUI.config.

...

file = {path

...

•  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

...

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 name1, Company name2

...

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

...

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

...

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.

 Image Added

Image Added

Image Added

Image Added

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.

Image Added

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

Image Added

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

Image Added

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

 Image Removed

Image Removed

Image Removed

Image Removed

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.

Image Removed

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

Image Removed

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

Image Removed

• • 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 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 jobs 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
User can create a new test type, map the test cases to the newly created test type and execute the test cases. To create a new test type add the test type using system configuration tab
under 'Test_Types' configuration name. If a new test type is created, then a new job as to be created based on test type name. The job name should be in the format of 'AUTO_'+'Test type name'+'_TEST_JOB'.
For example If a test type is created as 'REGRESSION', then the job name should be 'AUTO_REGRESSION_TEST_JOB'. Do not create new test types by using the use the test type name that are already present
in 'Test_Types' and 'TEST_TYPE_MAP' config values from the system_config table.Job templates are created . If it is not not created you can follow Automatics Orchestration User Manual - Preferred Program - RDK Central Wiki

...