Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 87b63f43 authored by Henri Chataing's avatar Henri Chataing
Browse files

pandora: Implement avatar test for legacy LE advertising 

Test multiple configurations of advertising data length
and advertising event type and validate that the dut
correctly reports all of them.

Test: avatar run --include-filter='LeAdvertisingTest'
Change-Id: I6882b4f4817d220a46a6c581189a359714b8caed
parent d90bc4f9

android/pandora/server/src/com/android/pandora/Host.kt

+7 −6
Original line number Diff line number Diff line
@@ -582,17 +582,18 @@ class Host( 
                  else -> DiscoverabilityMode.NOT_DISCOVERABLE

                }

              dataTypesBuilder.setLeDiscoverabilityMode(mode)

              var manufacturerData = ByteBuffer.allocate(32)

              val manufacteurSpecificDatas = scanRecord.getManufacturerSpecificData()

              for (i in 0..manufacteurSpecificDatas.size() - 1) {

                val id = manufacteurSpecificDatas.keyAt(i)

              var manufacturerData = ByteBuffer.allocate(512)

              val manufacturerSpecificDatas = scanRecord.getManufacturerSpecificData()

              for (i in 0..manufacturerSpecificDatas.size() - 1) {

                val id = manufacturerSpecificDatas.keyAt(i)

                manufacturerData

                  .put(id.toByte())

                  .put(id.shr(8).toByte())

                  .put(manufacteurSpecificDatas.get(id))

                  .put(manufacturerSpecificDatas.get(id))

              }

              dataTypesBuilder.setManufacturerSpecificData(

                ByteString.copyFrom(manufacturerData.array())

                ByteString.copyFrom(manufacturerData.array(), 0,

                  manufacturerData.position())

              )

              val primaryPhy =

                when (result.getPrimaryPhy()) {

android/pandora/test/le_advertising_test.py

0 → 100644
+125 −0
Original line number Diff line number Diff line 
# Copyright 2022 Google LLC

#

# 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

#

#     https://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 asyncio

import enum

import logging

import random



from avatar import PandoraDevice, PandoraDevices, asynchronous, parameterized

from mobly import base_test, test_runner

from mobly.asserts import assert_equal  # type: ignore

from mobly.asserts import assert_false  # type: ignore

from mobly.asserts import assert_in  # type: ignore

from mobly.asserts import assert_is_none  # type: ignore

from mobly.asserts import assert_is_not_none  # type: ignore

from mobly.asserts import assert_true  # type: ignore

from mobly.asserts import fail  # type: ignore

from pandora.host_pb2 import PUBLIC, DataTypes

from typing import Optional





class AdvertisingEventProperties(enum.IntEnum):

    ADV_IND = 0x13

    ADV_DIRECT_IND = 0x15

    ADV_SCAN_IND = 0x12

    ADV_NONCONN_IND = 0x10



    CONNECTABLE = 0x01

    SCANNABLE = 0x02

    DIRECTED = 0x04

    LEGACY = 0x10

    ANONYMOUS = 0x20



    def __repr__(self) -> str:

        return str(self.value)





class LeAdvertisingTest(base_test.BaseTestClass):  # type: ignore[misc]

    """Suite of tests designed to validate that Android correctly reports

    all kinds of advertising events to the user application."""



    devices: Optional[PandoraDevices] = None

    dut: PandoraDevice

    ref: PandoraDevice



    def setup_class(self) -> None:

        self.devices = PandoraDevices(self)

        dut, ref, *_ = self.devices

        self.dut, self.ref = dut, ref



    def teardown_class(self) -> None:

        if self.devices:

            self.devices.stop_all()



    @asynchronous

    async def setup_test(self) -> None:

        await asyncio.gather(self.dut.reset(), self.ref.reset())



    @parameterized(

        (AdvertisingEventProperties.ADV_IND, 0),

        (AdvertisingEventProperties.ADV_IND, 31),

        (AdvertisingEventProperties.ADV_DIRECT_IND, 0),

        (AdvertisingEventProperties.ADV_SCAN_IND, 0),

        (AdvertisingEventProperties.ADV_SCAN_IND, 31),

        (AdvertisingEventProperties.ADV_NONCONN_IND, 0),

        (AdvertisingEventProperties.ADV_NONCONN_IND, 31),

    )  # type: ignore[misc]

    def test_legacy_advertising_parameters(

        self, advertising_event_properties: AdvertisingEventProperties, advertising_data_length: int

    ) -> None:

        # Advertise from the Ref device with the specified legacy advertising

        # event properties. Use the manufacturer specific data to pad the advertising data to the

        # desired length. The scan response data must always be provided when

        # scannable but it is defaulted.

        connectable = (advertising_event_properties & AdvertisingEventProperties.CONNECTABLE) != 0

        scannable = (advertising_event_properties & AdvertisingEventProperties.SCANNABLE) != 0

        directed = (advertising_event_properties & AdvertisingEventProperties.DIRECTED) != 0



        manufacturer_specific_data_length = max(0, advertising_data_length - 5)  # Flags (3) + LV (2)

        manufacturer_specific_data = bytes([random.randint(1, 255) for _ in range(manufacturer_specific_data_length)])

        advertising_data = (

            DataTypes(manufacturer_specific_data=manufacturer_specific_data) if advertising_data_length > 0 else None

        )



        scan_response_data = DataTypes() if scannable else None

        target = self.dut.address if directed else None



        advertiser = self.ref.host.Advertise(

            legacy=True,

            connectable=connectable,

            data=advertising_data,  # type: ignore[arg-type]

            scan_response_data=scan_response_data,  # type: ignore[arg-type]

            public=target,

            own_address_type=PUBLIC,

        )

        scanner = self.dut.host.Scan(legacy=False, passive=False)



        report = next((x for x in scanner if x.public == self.ref.address))



        scanner.cancel()

        advertiser.cancel()



        assert_true(report.legacy, msg='expected legacy advertising report')

        assert_equal(report.connectable, connectable)

        # TODO: scannable is not set by the android server

        # assert_equal(report.scannable, scannable)

        # TODO: direct_address is not set by the android server

        assert_equal(report.data.manufacturer_specific_data, manufacturer_specific_data)

        assert_false(report.truncated, msg='expected non-truncated advertising report')





if __name__ == '__main__':

    logging.basicConfig(level=logging.DEBUG)

    test_runner.main()  # type: ignore

android/pandora/test/main.py

+10 −2
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ import argparse 
import asha_test

import example

import gatt_test

import le_advertising_test

import logging

import os

import sys
@@ -14,7 +15,12 @@ from collections import OrderedDict 
from mobly import base_test, config_parser, signals, suite_runner, test_runner

from typing import Any, List, Optional, Type



_TEST_CLASSES_LIST = [example.ExampleTest, asha_test.ASHATest, gatt_test.GattTest]

_TEST_CLASSES_LIST = [

    example.ExampleTest,

    asha_test.ASHATest,

    gatt_test.GattTest,

    le_advertising_test.LeAdvertisingTest,

]





def _parse_cli_args(argv: List[str]) -> argparse.Namespace:
@@ -79,7 +85,9 @@ def run(test_classes: List[Any], argv: List[str]) -> None: 
    ok = True

    try:

        # Load test config file.

        test_configs: List[config_parser.TestRunConfig] = config_parser.load_test_config_file(args.config, args.test_bed)  # type: ignore

        test_configs: List[config_parser.TestRunConfig] = config_parser.load_test_config_file(

            args.config, args.test_bed

        )  # type: ignore



        console_level = logging.DEBUG if args.verbose else logging.INFO

        for config in test_configs: