xref: /aosp_15_r20/test/vts/vndk_utils/vndk/vndk_utils.py (revision 9a74111979c139a065a9a7e4d45972320c5732c7)

#
# Copyright (C) 2017 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

import logging

from vts.utils.python.android import api


def IsVndkRuntimeEnforced(dut):
    """Returns whether VNDK run-time enforcement is enabled on the device.

    VNDK run-time enforcement is optional in O-MR1 (API 27); mandatory after P.
    If VNDK run-time enforcement is disabled, the system property named
    ro.vndk.lite must be set to true. The usage of this function is to decide
    whether to skip VNDK test cases.

    Args:
        dut: The AndroidDevice under test.

    Returns:
        A boolean, whether VNDK runtime should be enabled.
    """
    api_level = dut.getLaunchApiLevel(strict=False)
    if not api_level:
        logging.error("Cannot get first API level. "
                      "Assume VNDK runtime to be enforced.")
        return True
    if api_level <= api.PLATFORM_API_LEVEL_O_MR1:
        return not dut.vndk_lite
    # For P-launching devices, VNDK run-time enforcement is mandatory.
    return True


def IsVndkRequired(dut):
    """Returns whether the device's vendor partition requires VNDK.

    VNDK libraries are moved from system to vendor partition in V version. If
    a device does not require VNDK, it does not define ro.vndk.version.

    Args:
        dut: The AndroidDevice under test.

    Returns:
        A boolean, whether VNDK is required.
    """
    return bool(dut.GetVndkVersion())


def IsVndkInstalledInVendor(dut):
    """Returns whether the device's VNDK should be installed in vendor.

    VNDK libraries are moved from system to vendor partition in V version.
    VNDK 35 should be installed in vendor partiton.

    Args:
        dut: The AndroidDevice under test.

    Returns:
        A boolean, whether VNDK should be installed in vendor partition.
    """
    try:
        return int(dut.GetVndkVersion()) > 34
    except ValueError:
        return False


def FormatVndkPath(pattern, bitness, version=""):
    """Formats a VNDK path.

    Args:
        pattern: The path pattern containing {LIB} and {VER}.
        bitness: A string or an integer, 32 or 64.
        version: A string, the VNDK version.

    Returns:
        A string, the formatted path.
    """
    return pattern.format(LIB=("lib64" if str(bitness) == "64" else "lib"),
                          VER=version)


def GetVndkDirectory(bitness, version):
    """Returns the path to VNDK directory on device.

    Args:
        bitness: A string or an integer, 32 or 64.
        version: A string, the VNDK version.

    Returns:
        A string, the path to VNDK directory.
    """
    return FormatVndkPath("/apex/com.android.vndk.v{VER}/{LIB}",
                          bitness, version)


def GetVndkExtDirectories(bitness):
    """Returns the paths to VNDK extension directories on device.

    Args:
        bitness: A string or an integer, 32 or 64.

    Returns:
        A list of strings, the paths to VNDK extension directories.
    """
    return [FormatVndkPath("/odm/{LIB}/vndk", bitness),
            FormatVndkPath("/vendor/{LIB}/vndk", bitness)]


def GetVndkSpExtDirectories(bitness):
    """Returns the paths to VNDK-SP extension directories on device.

    Args:
        bitness: A string or an integer, 32 or 64.

    Returns:
        A list of strings, the paths to VNDK-SP extension directories.
    """
    return [FormatVndkPath("/odm/{LIB}/vndk-sp", bitness),
            FormatVndkPath("/vendor/{LIB}/vndk-sp", bitness)]