Page History

...

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.

...

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

Example:

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

Image Modified

• SMTP server (optional, if email feature in Automatics to be enabled)

...

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

...

 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.

...

Please follow Automatics 3.0 - Scriptless Automation#SystemConfigurationinAutomaticsOrchestration for configurations related to scriptless automation in System Configuration Page.

Please follow Smart Review Management#AddConfigsinSystemConfigurationPage for configurations related to Review Management feature in System Configuration Page.

Please follow Smart Debugger#AddConfigsinSystemConfigurationPage for configurations related to Smart Debugger feature in System Configuration Page.

Please follow CDRouter Configurations in Automatics#AddConfigsinSystemConfigurationPage for configurations related to CDRouter integration in System Configuration Page.

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

...

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

...

Source Repo Configuration for RDKB

Following are the source repository details to be configured for RDKB. Please execute following SQL Queries.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 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-automationrdkb-tests', 'rdk-next', NULL,  'admin', now());'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 Configure RDKB tests 

insert into source_code_details (NAME, CATEGORY_TYPE, SOURCE_REPO, SOURCE_BRANCH, DELETED_DATE, UPDATED_BY, UPDATED_DATE) values ('RDKBRDKV_CORE_TESTS', 'RDKBRDKV', 'rdkbgeneric-automation-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 Configure RDKV 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-automationrdkv-tests', 'rdk-next', NULL,  'admin', now());

...

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.

...