Skip to content

Latest commit

 

History

History
93 lines (76 loc) · 3.71 KB

README.md

File metadata and controls

93 lines (76 loc) · 3.71 KB

Build Status

Automated Test Framework (ATF) scripts

This repository contains ATF scripts and data to run it.

Coverage

Functionality Status Notes
Smoke Test 100% Common mobile APIs check
Mobile API Protocol 95%
HMI API 5%
App Resumption 10%
SDL 4.0 100%
UTF-8 Check 100%
Safety feature active 100%
Audio/Video Streaming 20% Planned
Policies Not Covered Planned
Heartbeat Not Covered Needs new ATF functionality
SecurityService Not Covered Needs new ATF functionality
Start/End Service Not Covered Planned
Transport Not Covered

Manual usage:

  • Setup SDL.

    • Later the SDL sources destination directory is referenced as <sdl_core>
  • Setup ATF.

    • Later the ATF sources destination directory is referenced as <sdl_atf>
    • Later the ATF build destination directory is referenced as <atf_build>
  • Clone sdl_atf_test_scripts

    • Later the atf test scripts destination directory is referenced as <sdl_atf_test_scripts>
    git clone https://github.com/smartdevicelink/sdl_atf_test_scripts <sdl_atf_test_scripts>
  • Create symlinks in the build bin directory to certain directories in <sdl_atf_test_scripts>:

    cd <atf_build>/bin
    ln -s <sdl_atf_test_scripts>/files
    ln -s <sdl_atf_test_scripts>/test_sets
    ln -s <sdl_atf_test_scripts>/test_scripts
    ln -s <sdl_atf_test_scripts>/user_modules
  • In your <sdl_atf>/modules/configuration/base_config.lua

    • Include the path to your local SDL Core binary (ex. <sdl_build>/bin/):
    --- Define path to SDL binary
    -- Example: "/home/user/sdl_build/bin"
    config.pathToSDL = "/home/user/sdl_build/bin"
    • Include the path to your local SDL Core Source directory (ex. <sdl_core>/):
    --- Define path to SDL source
    -- Example: "/home/user/sdl_core"
    config.pathToSDLSource = "<sdl_core>"

    ATF will use the provided path to derive the location of the MOBILE_API.xml and HMI_API.xml files within the directory.

    • Instead of including the path to your local SDL Core Source directory, you can alternatively include the paths to your local directories containing the HMI_API and MOBILE_API files:
    --- Define path to SDL MOBILE interface
    -- Example: "/home/user/sdl_core/tools/rpc_spec"
    config.pathToSDLMobileInterface = "/home/user/sdl_core/tools/rpc_spec"
    --- Define path to SDL HMI interface
    -- Example: "/home/user/sdl_core/src/components/interfaces"
    config.pathToSDLHMIInterface = "/home/user/sdl_core/src/components/interfaces"

    NOTE: If both pathToSDLSource and pathToSDLMobileInterface/pathToSDLHMIInterface are defined in the config file, the paths provided in pathToSDLMobileInterface/pathToSDLHMIInterface will override the paths derived from pathToSDLSource.

  • Run ATF.

Mandatory options:

  • Pass path to test script as first command line parameter
cd <atf_build>/bin
./start.sh ./test_scripts/Smoke/API/021_Speak_PositiveCase_SUCCESS.lua

You can get additional help of usage ATF:

./start.sh --help

Known Issues

  • Some test cases are failed due to known SDL issues. List of failed test cases available in KnownIssues.md
  • For testing different application types (NAVI, MEDIA, etc...) you need to modify your <sdl_atf>/modules/config.lua after prepare step