RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Command to add Jpype dependency
pip install jpype1
For creating a Test case in python the below criteria should be followed
For identifying a particular Test case is python a new field will be introduced in managed scripts. This new field will be used to mark particular test case as Python or not. The below are the stepwise information on how a particular test case will executed
alter table script_details add TEST_SCRIPT_TYPE varchar(25) default 'JAVA'; alter table script_details add IS_PYTEST_TC boolean default false; insert into available_job_params (PARAMETER_NAME,UPDATED_BY) values ('Test_Script_Type','admin'); insert into available_job_params (PARAMETER_NAME,UPDATED_BY) values ('is_pytest_testCase','admin');
For unlocking/enabling the access of Automatics Java API's to python scripts, JPype framework is used. For accessing the Java API's from python test scripts, a new set of Python scripts which contains all the basic API's should be developed which will make use of the JPype framework to instantiate and invoke the Java classes and method in Automatics Core and Test Utils. For example, A python script similar to AutomaticsTapApi class can be created to get the Automatics properties configuration and other API's of Automatics core. This python script will in-turn call the AutomaticsTapApi Java class present in the Automatics core project using JPype to enable all the required functions.
# Boiler plate stuff to start the module import json import os import jpype import jpype.imports from jpype.types import * import logging logger = logging.getLogger() # Launch the JVM def launchJVM(automaticsPropsUrl,pathToExecJar): if jpype.isJVMStarted(): logger.info('JVM is already running. Do not init twice!') else: logger.info('Inside else') logger.info(jpype.getDefaultJVMPath()) javaClassPath = "-Djava.class.path="+pathToExecJar propsJavaOpts = "-Dautomatics.properties.file="+automaticsPropsUrl jpype.startJVM(jpype.getDefaultJVMPath(), "-ea", javaClassPath, propsJavaOpts) # tapApi = AutomaticsTapApi.getInstance() # import the Java modules from com.automatics.tap import AutomaticsTapApi from com.automatics.executor import PythonScriptExecutor from com.automatics.utils import BeanUtils def createDeviceObj(deviceJson): pyexecutor = PythonScriptExecutor() deviceObj = pyexecutor.convertJsonToDevice(deviceJson) return deviceObj def executeCommandUsingSsh(dut, command): pyexecutor = PythonScriptExecutor() return pyexecutor.executeCommandUsingSsh(dut, command) def getInstance(): jpype.JClass("com.automatics.core.SupportedModelHandler").main([]) BeanUtils.startContext() return AutomaticsTapApi.getInstance()
Sample code for an Automatics Test Case Written in Python and which use Utils and Core APIs for different operations
import logging from jpype.types import * from com.automatics.rdkb.utils import BroadBandCommonUtils from automaticsPythonLib.annotation.PythonScriptAnnotation import TestCaseId from automaticsPythonLib.automatics import AutomaticsTapApi logger = logging.getLogger() @TestCaseId('TC-RDKB-PYTHON-TEST-001') def checkImageVersionInDevice(dut): testCaseId = "TC-RDKB-PYTHON-TEST-001"; tapEnv = AutomaticsTapApi.getInstance() stepNum = "S1"; errorMessage = "command execution in device failed"; status = JBoolean(False); logger.info("#######################################################################################"); logger.info("STARTING TEST CASE: TC-RDKB-PYTHON-TEST-001"); logger.info("TEST DESCRIPTION: Validation of device version"); logger.info("TEST STEPS : "); logger.info("1. Run a Command in the device VIA SSH to parse the version.txt file"); logger.info("#######################################################################################"); try: logger.info("**********************************************************************************"); logger.info("**********************************************************************************"); logger.info( "STEP 1: DESCRIPTION : Check and Validate the version of the device "); logger.info( "STEP 1: ACTION : \"Run a command in the device to view the current RDK version in device\""); logger.info( "STEP 1: EXPECTED : The current version in the device should be received as response"); logger.info("**********************************************************************************"); response = tapEnv.executeCommandUsingSsh(dut, JString("cat /version.txt")); logger.info(response) except Exception as e: logger.info(str(e)) finally: logger.info("################### STARTING POST-CONFIGURATIONS ###################"); logger.info("POST-CONDITION STEPS"); logger.info("POST-CONDITION : DESCRIPTION : Remove dummy file"); logger.info("POST-CONDITION : ACTION : Remove the dummy file permanently (rm -rf /nvram/dummytest.sh)"); logger.info("POST-CONDITION : EXPECTED : Created dummy file should be removed"); status = BroadBandCommonUtils.removeFileAndVerifyStatus(tapEnv, dut, JString("/nvram/dummytest.sh")); if status: logger.info("POST-CONDITION : ACTUAL : Post condition executed successfully"); else: logger.info("POST-CONDITION : ACTUAL : Post condition failed"); logger.info("POST-CONFIGURATIONS : FINAL STATUS - " + str(status)); tapEnv.updateExecutionStatus(dut, testCaseId, stepNum, JBoolean(status), errorMessage, JBoolean(False)); logger.info("################### COMPLETED POST-CONFIGURATIONS ###################");
from unittest import result import pytest import logging from jpype.types import * from automaticsPythonLib.annotation.PythonScriptAnnotation import TestCaseId from automaticsPythonLib.automatics import AutomaticsTapApi logger = logging.getLogger() @TestCaseId('TC-RDKB-PYTHON-PY-TEST-001') def test_command_execution_in_device(): dut = pytest.Config.dut tapEnv = pytest.Config.tapEnv testCaseId = "TC-RDKB-PYTHON-PY-TEST-001"; stepNum = "S1"; errorMessage = "command execution in device failed"; status = JBoolean(False); expected_result = "" print(dut) response = tapEnv.executeCommandUsingSsh(dut, JString("pwd")); if not response: status = JBoolean(False); else: status = JBoolean(True); tapEnv.updateExecutionStatus(dut, testCaseId, stepNum, JBoolean(status), errorMessage, JBoolean(False)); assert result == response, f"Expected {expected_result}, but got {response}"