Skip to content

dsHdmiIn HAL L3 Python Test Procedure

Acronyms, Terms and Abbreviations

  • HAL - Hardware Abstraction Layer
  • L3 - Level 3 Testing
  • OEM - Original Equipment Manufacture
  • SoC - System on a Chip
  • HDMI - High-Definition Multimedia Interface
  • SDR - Standard Dynamic Range
  • EDID - Extended Display Identification Data
  • ALLM - Auto Low Latency Mode
  • AVI - Audio Video Interleave
  • SPD - Source Product Descriptor

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: ut/host/tests/configs/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 Downloads the streams required for test cases
ssh_hal_test Executes the HAL binary for the test case 
rackConfig:
  - dut:
      ip: "XXX.XXX.XXX.XXX"  # IP Address of the device
      description: "tv device under test"
      platform: "tv"
      consoles:
        - default:
            type: "ssh"
            port: 10022
            username: "root"
            ip: "XXX.XXX.XXX" # IP address of the device
            password: ' '
        - ssh_hal_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: ut/host/tests/configs/deviceConfig.yml

For more details refer RAFT and example_device_config.yml

Update below fileds in the device configuration file: - Set the folder path for target_directory where HAL binaries will be copied onto the device. - Specify the device profile path in test/profile - Ensure the platform should match with the DUT platform in Rack Configuration

deviceConfig:
  cpe1:
    platform: "linux"    # Must match the platform in example_rack_config.yml
    model: "uk"
    soc_vendor: "intel"
    target_directory: "/tmp"  # Path where HAL binaries are copied in device
    prompt: "" # Prompt string on console
    test:
      profile: "../../../../profiles/sink/Sink_HDMIIN.yaml"
      player:
        tool: "gstreamer"
        prerequisites:
          - export xxxx    # Pre-commands required to play the stream

Test Setup Configuration File

Example Test Setup configuration File: ut/host/tests/L3_TestCases/dsHdmiIn/dsHdmiIn_L3_testSetup.yml

If need to enable any commands post test case execution update postcmd.

dsHdmiIn:
  description: "dsHdmiIn Device Settings test setup"
  assets:
    device:
      test1_ConnectionCallback_Verify:
        streams:[]
      test2_SignalChangeCallback_Verify:
        streams:[]
      test14_SetAndGetEDID2ALLMSupport:
        streams:[]

Test Configuration

Example Test Setup configuration File: ut/host/tests/dsClasses/dsHdmiIn_testConfig.yml

Update the execute command according to the device path where HAL binaries are copied.

dsHdmiIn:
  description: "dsHdmiIn Device Settings testing profile"
  test:
    artifacts:
            - "../../../bin/"
    execute: "run.sh"
    type: UT-C  # Cunit tests (UT-C)

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 Cases

dsHdmiIn_test1_ConnectionCallback_Verify.py

Platform Support - test01

  • Sink

User Input Required - test01

Yes: User interaction is necessary to connect and Disconnect the Hdmi In device.(This will be automated later).

Acceptance Criteria - test01

Connect the external device and check if dut recognize the event. Disconnect the external device and check if dut recognize the event.

Expected Results - test01

The test registers the event and check for the event callback.

Success Criteria

  • Device should recognize the connect/Disconnect event.

Test Steps - test01

  • Initiate the Test:

  • Select and execute the Python file: dsHdmiIn_test1_ConnectionCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will Request User to connect Source device to Hdmi In port:

  • Question: "Plug the HDMI cable {port} and Press Enter: (Y/N)"

  • Press Y if Device is connected/disconnect (this will mark the step as PASS).

  • Press N if user could not connect/disconnect the device (this will mark the step as FAIL).

  • Device Status Confirmation:

  • Test will check if the device status event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, connecting/disconnecting device on each one and collecting user feedback accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

dsHdmiIn_test2_SignalChangeCallback_Verify.py

Platform Supported - test02

  • Sink

User Input Required - test02

  • Yes: User interaction is necessary to connect the Hdmi In device.(This will be automated later).

Acceptance Criteria - test02

  • Verify the Signal status.

Expected Results - test02

  • The test registers the event and check for signal status event callback.

Test Steps - test02

  • Initiate the Test:

  • Select and execute the Python file: dsHdmiIn_test2_SignalChangeCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Signal Status Confirmation:

  • Test will check if the signal status event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, collects signal status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test3_PortStatusCallback_Verify.py

Platform Supported - test03

  • Sink

User Input Required - test03

  • Yes: User interaction is necessary to connect the Hdmi In device.(This will be automated later).

Acceptance Criteria - test03

  • Verify the Port status.

Expected Results - test03

  • The test registers the event and check for port status event callback.

Test Steps - test03

  • Initiate the Test:

  • Select and execute the Python file: dsHdmiIn_test3_PortStatusCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Port Status Confirmation:

  • Test will check if the port status event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, collects port status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test4_VideoModeChangeCallback_Verify.py

Platform Supported - test04

  • Sink

User Input Required - test04

  • Yes: User interaction is necessary to connect the Hdmi In device and to change the resolution on connected device(like Fire Tv Stick, Xbox, Hdmi Analyzer).(This will be automated later).

Acceptance Criteria - test04

  • Verify the video mode status.

Expected Results - test04

  • The test registers the event and check for Video mode status event callback.

Test Steps - test04

  • Select the test file:

  • Run the Python script dsHdmiIn_test4_VideoModeChangeCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Device resolution change prompt:

    The test will prompt the user to change the resolution on the source device connected to the HDMI In port:

  • Question: "Change the Resolution on device connected to port_type and then press Enter: (Y/N)"

  • Press Y if user able to change resolution (this will mark the step as PASS).

  • Press N if user unable to change the resolution (this will mark the step as FAIL).

  • Video mode Status Confirmation:

  • Test will check if the video mode status event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, collects video mode status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test5_AllmChangeCallback_Verify.py

Platform Supported - test05

  • Sink

User Input Required - test05

  • Yes: User interaction is necessary to connect the Hdmi In device and to enable/disable ALLM on connected device (like Fire Tv Stick, Xbox, Hdmi Analyzer).(This will be automated later).

Acceptance Criteria - test05

  • Verify the ALLM status.

Expected Results - test05

  • The test registers the event and check for ALLM change event callback

Test Steps - test05

  • Select the test file:

  • Run the Python script dsHdmiIn_test5_AllmChangeCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Device ALLM change prompt:

    The test will prompt the user to enable or disable ALLM:

  • Question: "Change ALLM mode on Hdmi In device connected to port to enable ALLM if its in OFF and press Enter: (Y/N)"

  • Press Y if user able to enable the ALLM feature (this will mark the step as PASS).

  • Press N if user unable to enable ALLM feature (this will mark the step as FAIL).

  • Question: "Change ALLM mode on Hdmi In device connected to port to disable ALLM and press Enter: (Y/N)"

  • Press Y if user able to disable the ALLM feature (this will mark the step as PASS).

  • Press N if user unable to disable ALLM feature (this will mark the step as FAIL).

  • ALLM enable/disable Status Confirmation:

  • Test will check if the ALLM change event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, collects ALLM status status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test6_AVlatencyCallback_Verify.py

Platform Supported - test06

  • Sink

User Input Required - test06

  • Yes: User interaction is necessary to connect the Hdmi In device on ports (like Xbox) and play the games.(This will be automated later).

Acceptance Criteria - test06

  • Verify the audio video latency.

Expected Results - test06

  • The test registers the event and check for audio video latency event callback.

Test Steps - test06

  • Select the test file:

  • Run the Python script dsHdmiIn_test6_AVlatencyCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Audio Video latency Confirmation:

  • Test will check if the audio video latency event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, collects audio video latency status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

dsHdmiIn_test7_AVIChangeCallback_Verify.py

Platform Supported - test07

  • Sink

User Input Required - test07

  • Yes: User interaction is necessary to connect the Hdmi In device and to change the AVI content on connected device (lik e Hdmi Analyzer) and change the content type like Cinema , Game , Sport.(This will be automated later).

Acceptance Criteria - test07

  • Verify the AVI content type being played on device.

Expected Results - test07

  • The test registers the event and check for AVI content change event callback

Test Steps - test07

  • Select the test file:

  • Run the Python script dsHdmiIn_test7_AVIChangeCallback_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Device AVI content change prompt:

    The test will prompt the user to change AVI content on the source device:

  • Question: "Change the AVI Content on device connected to port and press Enter: (Y/N)"

  • Press Y if user able to change AVI content (this will mark the step as PASS).

  • Press N if user unable to change the AVI content (this will mark the step as FAIL).

  • AVI content Change Confirmation:

  • Test will check if the AVI content change event has reached the device.

  • If event is detected, the step will marked as PASS

  • If event not detected, the step will marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, collects AVI content change status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test8_SelectPortAndVerifyPortStatus.py

Platform Supported - test08

  • Sink

User Input Required - test08

  • Yes: User interaction is necessary to connect the Hdmi In device to port.(This will be automated later)

Acceptance Criteria - test08

  • Verify the respective port is selected.

Expected Results - test08

  • The test selects the respective port and verify the same.

Test Steps - test08

  • Select the test file:

  • Run the Python script dsHdmiIn_test8_SelectPortAndVerifyPortStatus.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Port select Confirmation:

  • Test will check the status of the port selected.

  • If port selected and supplied port argument are same then mark the step as PASS

  • If port selected and supplied port argument are not same then mark the step as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, verify port status accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test9_ScaleVideoAndVerify.py

Platform Supported - test09

  • Sink

User Input Required - test09

  • Yes: User interaction is necessary to connect the Hdmi In device and to verify the video scaling on connected device.(This will be automated later).

Acceptance Criteria - test09

  • Verify the video scaled on selected port.

Expected Results - test09

  • The test selects the respective port and scales video.

Test Steps - test09

  • Select the test file:

  • Run the Python script dsHdmiIn_test9_ScaleVideoAndVerify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Video scaling Confirmation: The test will Request User to check video scaled on particular port or not:

  • Question: "Check if video is scaled on port port_type. Press Y/N:"

  • Press Y if video scaling on the specified port is successful (this will mark the step as PASS).

  • Press N if video scaled on the sepcified port not successful (this will mark the step as FAIL).

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, verify video scaling accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test10_ZoomModeAndVerify.py

Platform Supported - test10

  • Source

User Input Required - test10

  • Yes: User interaction is necessary to connect the Hdmi In device and to verify the video scaling on connected device.(This will be automated later).

Acceptance Criteria - test10

  • Verify the zoom mode on selected port.

Expected Results - test10

  • The test selects the respective port and sets zoom mode.

Test Steps - test10

  • Select the test file:

  • Run the Python script dsHdmiIn_test10_ZoomModeAndVerify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • Zoom Mode set Confirmation: The test will Request User to check particular zoom mode is set on particular port or not:

  • Question: "Verify Zoom Mode selected on port {port_type} and press Enter: Y/N"

  • Press Y if zoom mode ablet to set on particular port happen (this will mark the step as PASS).

  • Press N if unable to set zoom mode on particular port not happen (this will mark the step as FAIL).

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, verify zoom mode set accordingly.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test11_GetEDIDInfo_Verify.py

Platform Supported - test11

  • Sink

User Input Required - test11

  • NO

Acceptance Criteria - test11

  • Get and verify EDID info.

Expected Results - test11

  • The test get EDID info and verifies the info.

Test Steps - test11

  • Run the Python script dsHdmiIn_test11_GetEDIDInfo_Verify.py
  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Edid Info Confirmation:

  • Test will get the EDID info and verifies the same.

  • If EDID info is received, it will be compared with the YAML EDID info bytes. If they match, the step will be marked as PASS

  • If EDID info is received, it will be compared with the YAML EDID info bytes. If they does not match, the step will be marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, gets EDID and verifies.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test12_GetSpdInfo_Verify.py

Platform Supported - test12

  • Sink

User Input Required - test12

  • Yes: User interaction is necessary to connect the Hdmi In device to port like Hdmi Quantum Data Analyzer.(This will be automated later).

Acceptance Criteria - test12

  • Gets SPD Info and verifies the same.

Expected Results - test12

This test evaluates the SPD Info received from connected device.

Test Steps - test12

  • Run the Python script dsHdmiIn_test12_GetSpdInfo_Verify.py

  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • Device Connect prompt:

    The test will prompt the User to connect a Source device:

  • Question: "connect device to porttype and press Enter (Y/N)"

  • Press Y if Device is connected (this will mark the step as PASS).

  • Press N if user could not connect the device (this will mark the step as FAIL).

  • SPD Info Confirmation:

  • Test will get the SPD info and verifies the same.

  • If SPD info is received, it will be compared with the YAML SPD info bytes. If they match, the step will be marked as PASS

  • If SPD info is received, it will be compared with the YAML SPD info bytes. If they does not match, the step will be marked as FAIL

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, gets spdinfo and verifies the same.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test13_SetAndGetEDIDVersion.py

Platform Supported - test13

  • Sink

User Input Required - test13

  • NO

Acceptance Criteria - test13

  • Verify EDID version by retrieving.

Expected Results - test13

This test set EDID version and verifies the same by retrieving the EDID version.

Test Steps - test13

  • Run the Python script dsHdmiIn_test13_SetAndGetEDIDVersion.py
  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • EDID version Verification:

  • Test will sets and get the EDID version.

  • If the set and retrieved EDID versions are the same, the test will mark the step as PASS.

  • If the set and retrieved EDID versions do not match, the test will mark the step as FAIL.

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, sets EDID version and verifies by retrieving EDID version.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

  • Completion and Result:

Once all necessary user actions are completed, the test will evaluate the results and display whether the test Passed or Failed.

dsHdmiIn_test14_SetAndGetEDID2ALLMSupport.py

Platform Supported - test14

  • Sink

User Input Required - test14

  • NO

Acceptance Criteria - test14

  • Verify ALLM by retrieving.

Expected Results - test14

This test set ALLM and verifies the same by retrieving the ALLM.

Test Steps - test14

  • Run the Python script dsHdmiIn_test14_SetAndGetEDID2ALLMSupport.py
  • The test will automatically download all required artifacts and streams, copying them to the designated target directory before commencing execution.

  • ALLM version Verification:

  • Test will sets and get the ALLM.

  • If the set and retrieved ALLM support statuses match, the test will mark the step as PASS.

  • If the set and retrieved ALLM support statuses do not match, the test will mark the step as FAIL.

  • Repeat for All Ports:

The test will iterate through all available Hdmi IN ports, sets ALLM and verifies by retrieving ALLM.

  • Test Conclusion:

Upon receiving user responses for all ports, the test will conclude and present a final result: PASS or FAIL based on the user inputs throughout the test execution.

dsHdmiIn_L3_Runall_Sink.py

This python file runs all the tests supported by sink devices

```bash python dsHdmiIn_L3_Runall_Sink.py --config /PATH/ut/host/tests/configs/example_rack_config.yml --deviceConfig /PATH/ut/host/tests/configs/deviceConfig.yml