DeepSleep HAL L3 Python Test Procedure

Acronyms, Terms and Abbreviations

HAL - Hardware Abstraction Layer
L3 - Level 3 Testing
DUT - Device Under Test
RAFT - Rapid Automation Framework for Testing
YAML - YAML Ain't Markup Language
HDMI - High-Definition Multimedia Interface
CEC - Consumer Electronics Control
LAN - Local Area Network
SSID - Service Set Identifier
IP - Internet Protocal

Setting Up Test Environment

To execute HAL L3 Python test cases, need a Python environment. Follow these steps mentioned in HPK Public Documentation

Update Configuration Files

Rack Configuration File

Example Rack configuration File: example_rack_config.yml

For more details refer RAFT and example_rack_config.yml

In this file, update the configuration to define the console sessions for the DUT and the outbound settings:

Console Session	Description
default	This session is used for basic operations, such as verifying the device status and retrieving the MAC address
ssh_hal_deepsleep_test	Executes the `HAL` binary for the deepsleep test case
ssh_hal_power_test	Executes the `HAL` binary for the power test case

rackConfig:
  - dut:
      ip: "XXX.XXX.XXX.XXX"  # IP Address of the device
      description: "stb device under test"
      platform: "stb"
      consoles:
        - default:
            type: "ssh"
            port: 10022
            username: "root"
            ip: "XXX.XXX.XXX" # IP address of the device
            password: ' '
        - ssh_hal_deepsleep_test:
            type: "ssh"
            port: 10022
            username: "root"
            ip: "XXX.XXX.XXX" # IP address of the device
            password: ' '
        - ssh_hal_power_test:
            type: "ssh"
            port: 10022
            username: "root"
            ip: "XXX.XXX.XXX" # IP address of the device
            password: ' '
      outbound:
        download_url: "tftp://tftp-server.com/rack1/slot1/"    # Download location for the CPE device
        upload_url: "sftp://server-address/home/workspace/tftp/rack1/slot1/" # Upload location
        upload_url_base_dir: "sftp://server-address/home/workspace/tftp/rack1/slot1"
        httpProxy:   # Local proxy if required
        workspaceDirectory: './logs/workspace'   # Local working directory

Device Configuration File

Example Device configuration File: deviceConfig.yml

For more details refer RAFT and example_device_config.yml

Update the target directory where HAL binaries will be copied into the device. Also, map the profile to the source/sink settings YAML file path.

Ensure the platform should match with the DUT platform in Rack Configuration

deviceConfig:
  cpe1:
    platform: "stb"    # Must match the platform in example_rack_config.yml
    model: "uk"
    target_directory: "/tmp"  # Path where HAL binaries are copied in device
    test:
      profile: "../../../profiles/deepsleepmanagerExtendedEnumsNotSupported.yaml"

Test Setup Configuration File

Example Test Setup configuration File the deepsleep side: deepsleep_L3_testSetup.yml

Example Test Setup configuration File the power manager side: power_L3_testSetup.yml

Streams required for each test case was provided in this file. Testing Deep sleep functionality doesn't require any streams.

deepsleep:  # Prefix must always exist
  description: "deepsleep Manager test setup"
  assets:
    device:
      test1_TestWakeupSources:
        streams:

power:  # Prefix must always exist
  description: "power Manager test setup"
  assets:
    device:
      test1_TestWakeupSources:
        streams:

Test Configuration

Example Test configuration File for deepsleep manager: deepsleep_testConfig.yml Example Test Setup configuration File for power manager: power_testConfig.yml

The test copies the binary files from the path specified in the artifacts entry of the yml file. Ensure that the HAL test binaries for the deep sleep manager and power manager are available in the specified folder.

Execute command to run the HAL binary was provided in this file.

deepsleep:
    description: "deepsleep Manager testing profile / menu system for UT"
    test:
        artifacts:
        #List of artifacts folders, test class copies the content of folder to the target device workspace
          - "../../../bin/deepsleepmanager/"
        # exectute command, this will appended with the target device workspace path
        execute: "run.sh" #Execute command

power:
    description: "power Manager testing profile / menu system for UT"
    test:
        artifacts:
        #List of artifacts folders, test class copies the content of folder to the target device workspace
          - "../../../bin/powermanager/"
        # exectute command, this will appended with the target device workspace path
        execute: "run.sh" #Execute command

Run Test Cases

Once the environment is set up, you can execute the test cases with the following command

python <TestCaseName.py> --config </PATH>/ut/host/tests/configs/example_rack_config.yml --deviceConfig </PATH>/ut/host/tests/configs/deviceConfig.yml

Test Setup Connections

Make sure the device under test DUT is connected to wifi, LAN and a CEC supported device for waking up from deepsleep before starting the test case.

Example WIFI Configuration

If the DUT supports WPA, follow these steps to configure the WIFI:

Generate the WPA Configuration File:

Use the router's SSID and password to create a configuration file:

wpa_passphrase <"Router SSID"> <"Passsword" > /data/wpa-supplicant.conf

Start the wpa_supplicant daemon: Run the following command to start the wpa_supplicant service:

wpa_supplicant -dd -B -i wlan0 -c /data/wpa-supplicant.conf

If still not getting IP for wlan0 bridge interface try:

ifconfig wlan0 down
ifconfig wlan0 up

Test Cases

test1_TriggerDeepsleep.py

Platform Support - test01

Sink/Source

User Input Required - test01

Yes: User interaction is required to manually trigger wake-up events from deep sleep for specific wake-up sources. (This will be automated later).

Acceptance Criteria - test01

All supported wake-up sources must be validated and properly trigger the system to wake up from deep sleep

Expected Results - test01

All tested wake-up sources must successfully trigger the system to exit deep sleep without errors or failures. Upon waking, the recorded wake-up reason must accurately correspond to the triggered event.

Test Steps - test01

Initiate the Test:
Select and execute the Python file: test1_TriggerDeepsleep.py
The test will automatically download all required artifacts, copying them to the designated target directory before commencing execution.
Trigger deepsleep prompt:

The test will set the wake-up source and trigger a deepsleep.

The above will loop through all supported wake up sources that applicable for the specific device based on the yaml file.
Once in deepsleep the device will need to be manually awoken for some sources like IR, CEC and Power_Key.
- During the IR test, use an IR remote to trigger the wake-up by pressing the power key or home key. If the device successfully wakes up from deep sleep using this method, the test evaluates whether the wake-up process was successful.
- During the Power_Key test, press the power key of the dut to wake-up. If the device successfully wakes up from deep sleep using this method, the test evaluates whether the wake-up process was successful.
- During the CEC test, initiate the wake-up process by connecting an HDMI cable to the device and sending a wake-up CEC command (e.g., Image_View_On) from the connected device to the DUT. If the device transitions successfully from deep sleep to an active state using this method, the test assesses the success of the wake-up operation.
The following tests should be done automaticaly.
- When the device enters LAN test, test automatically triggers the wake up and validates whether the device successfully wakes up.
- When the device enters wifi test, test automatically triggers the wake up and validates whether the device successfully wakes up.
- When the device enters Timer test, dut wakes up after 60 seconds and test validates whether the device successfully wakes up.