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

Commit 24a21c1b authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge changes from topic "engine_vts" 

* changes:
  audiopolicy: engine: Add VTS for engine configurable configuration
  audio: Add VTS for configurable engine
  audio: update XSD for dynamic engine loading support config
parents 7b37dc5d a8cac48d

audio/6.0/config/api/current.txt

+8 −0
Original line number Diff line number Diff line
@@ -214,6 +214,12 @@ package audio.policy.configuration.V6_0 { 
    method public void set_default(boolean);

  }



  public enum EngineSuffix {

    method public String getRawName();

    enum_constant public static final audio.policy.configuration.V6_0.EngineSuffix _default;

    enum_constant public static final audio.policy.configuration.V6_0.EngineSuffix configurable;

  }



  public enum GainMode {

    method public String getRawName();

    enum_constant public static final audio.policy.configuration.V6_0.GainMode AUDIO_GAIN_MODE_CHANNELS;
@@ -252,7 +258,9 @@ package audio.policy.configuration.V6_0 { 


  public class GlobalConfiguration {

    ctor public GlobalConfiguration();

    method public audio.policy.configuration.V6_0.EngineSuffix getEngine_library();

    method public boolean getSpeaker_drc_enabled();

    method public void setEngine_library(audio.policy.configuration.V6_0.EngineSuffix);

    method public void setSpeaker_drc_enabled(boolean);

  }

audio/6.0/config/audio_policy_configuration.xsd

+7 −0
Original line number Diff line number Diff line
@@ -66,6 +66,7 @@ 
    </xs:element>

    <xs:complexType name="globalConfiguration">

        <xs:attribute name="speaker_drc_enabled" type="xs:boolean" use="required"/>

        <xs:attribute name="engine_library" type="engineSuffix" use="optional"/>

    </xs:complexType>

    <xs:complexType name="modules">

        <xs:annotation>
@@ -623,4 +624,10 @@ 
            </xs:element>

        </xs:sequence>

    </xs:complexType>

    <xs:simpleType name="engineSuffix">

        <xs:restriction base="xs:string">

            <xs:enumeration value="default"/>

            <xs:enumeration value="configurable"/>

        </xs:restriction>

    </xs:simpleType>

</xs:schema>

audio/policy/1.0/vts/OWNERS

0 → 100644
+2 −0
Original line number Diff line number Diff line 
elaurent@google.com

mnaganov@google.com

audio/policy/1.0/vts/functional/Android.bp

0 → 100644
+59 −0
Original line number Diff line number Diff line 
cc_test {

    name: "VtsHalAudioPolicyV1_0TargetTest",

    defaults: ["vts_target_tests_defaults"],

    srcs: [

        "ValidateEngineConfiguration.cpp",

    ],

    static_libs: [

        "libxml2",

        "liblog",

        "libmedia_helper",

        "libaudiopolicyengine_config",

        "libaudiopolicycomponents",

        "libaudiopolicyengineconfigurable_pfwwrapper",

        "android.hardware.audio.common.test.utility",

        "libparameter",

        "libpfw_utility",

        "libremote-processor",

        "libutils",

        "libcutils",

        "libhidlbase",

        "liblog",

        "libbase",

    ],

    shared_libs: [

        "libaudiofoundation",

    ],

    // Use test_config for vts-core suite.

    // TODO(b/146104851): Add auto-gen rules and remove it.

    test_config: "VtsHalAudioPolicyV1_0TargetTest.xml",

    cflags: [

        "-DXSD_DIR=\"/data/local/tmp\"",

        "-DXSD_PFW_DIR=\"/data/local/tmp/Schemas\"",

        "-Wall",

        "-Werror",

        "-Wno-unused-function",

        "-O0",

        "-g",

    ],

    data: [

        ":audio_policy_engine_conf_V1_0",

        ":audio_policy_engine_configurable_configuration_V1_0",

        ":audio_policy_engine_configurable_configuration_ComponentLibrary_V1_0",

        ":audio_policy_engine_configurable_configuration_ComponentTypeSet_V1_0",

        ":audio_policy_engine_configurable_configuration_ConfigurableDomain_V1_0",

        ":audio_policy_engine_configurable_configuration_ConfigurableDomains_V1_0",

        ":audio_policy_engine_configurable_configuration_FileIncluder_V1_0",

        ":audio_policy_engine_configurable_configuration_Parameter_V1_0",

        ":audio_policy_engine_configurable_configuration_ParameterFrameworkConfiguration_V1_0",

        ":audio_policy_engine_configurable_configuration_ParameterSettings_V1_0",

        ":audio_policy_engine_configurable_configuration_Subsystem_V1_0",

        ":audio_policy_engine_configurable_configuration_SystemClass_V1_0",

        ":audio_policy_engine_configurable_configuration_W3cXmlAttributes_V1_0",

    ],

    gtest: true,

    test_suites: [

        "general-tests",

        "vts-core",

    ],

}

audio/policy/1.0/vts/functional/ValidateEngineConfiguration.cpp

0 → 100644
+113 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 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.

 */



#include <EngineConfig.h>

#include <ParameterManagerWrapper.h>



#include <gtest/gtest.h>



#include <unistd.h>

#include <string>

#include "utility/ValidateXml.h"



static const std::vector<const char*> locations = {"/odm/etc", "/vendor/etc", "/system/etc"};

static const std::string config = "audio_policy_engine_configuration.xml";

static const std::string schema =

        std::string(XSD_DIR) + "/audio_policy_engine_configuration_V1_0.xsd";



static const std::string configurableSchemas =

        std::string(XSD_DIR) + "/audio_policy_engine_configurable_configuration_V1_0.xsd";

static const std::string configurableConfig =

        "parameter-framework/ParameterFrameworkConfigurationPolicy.xml";



/**

 * @brief TEST to ensure the audio policy engine configuration file is validating schemas.

 * Note: this configuration file is not mandatory, an hardcoded fallback is provided, so

 * it does not fail if not found.

 */

TEST(ValidateConfiguration, audioPolicyEngineConfiguration) {

    RecordProperty("description",

                   "Verify that the audio policy engine configuration file "

                   "is valid according to the schemas");

    EXPECT_VALID_XML_MULTIPLE_LOCATIONS(config.c_str(), locations, schema.c_str());

}



/**

 * @brief deviceUsesConfigurableEngine checks if the configuration file for

 * the engine presents on the device AND

 * for the configurable engine (aka Parameter-Framework top configuration file) presents.

 */

static bool deviceUsesConfigurableEngine() {

    return android::hardware::audio::common::test::utility::validateXmlMultipleLocations<true>(

                   "", "", "", config.c_str(), locations, schema.c_str()) &&

           android::hardware::audio::common::test::utility::validateXmlMultipleLocations<true>(

                   "", "", "", configurableConfig.c_str(), locations, configurableSchemas.c_str());

}



TEST(ValidateConfiguration, audioPolicyEngineConfigurable) {

    if (!deviceUsesConfigurableEngine()) {

        GTEST_SKIP() << "Device using legacy engine without parameter-framework, n-op.";

    }

    RecordProperty("description",

                   "Verify that the audio policy engine PFW configuration files "

                   "are valid according to the schemas");



    auto testAudioPolicyEnginePfw = [&](bool validateSchema, const std::string& schemasUri) {

        auto result = android::engineConfig::parse();



        ASSERT_NE(nullptr, result.parsedConfig)

                << "failed to parse audio policy engine configuration";



        ASSERT_EQ(result.nbSkippedElement, 0) << "skipped %zu elements " << result.nbSkippedElement;



        std::unique_ptr<android::audio_policy::ParameterManagerWrapper> policyParameterMgr(

                new android::audio_policy::ParameterManagerWrapper(validateSchema, schemasUri));

        ASSERT_NE(nullptr, policyParameterMgr) << "failed to create Audio Policy Engine PFW";



        // Load the criterion types and criteria

        for (auto& criterion : result.parsedConfig->criteria) {

            android::engineConfig::CriterionType criterionType;

            for (auto& configCriterionType : result.parsedConfig->criterionTypes) {

                if (configCriterionType.name == criterion.typeName) {

                    criterionType = configCriterionType;

                    break;

                }

            }

            ASSERT_FALSE(criterionType.name.empty())

                    << "Invalid criterion type for " << criterion.name.c_str();

            policyParameterMgr->addCriterion(criterion.name, criterionType.isInclusive,

                                             criterionType.valuePairs,

                                             criterion.defaultLiteralValue);

        }

        ASSERT_EQ(0, result.nbSkippedElement) << "failed to parse Audio Policy Engine PFW criteria";



        // If the PFW cannot validate, it will not start

        std::string error;

        auto status = policyParameterMgr->start(error);

        ASSERT_EQ(status, android::NO_ERROR)

                << "failed to " << (validateSchema ? "validate" : "start")

                << " Audio Policy Engine PFW: " << error;



        ASSERT_TRUE(policyParameterMgr->isStarted());

    };



    // First round for sanity to ensure we can launch the Audio Policy Engine PFW without

    // schema validation successfully, otherwise it is not forth going on running validation...

    testAudioPolicyEnginePfw(false, {});



    // If second round fails, it means parameter-framework cannot validate schema

    testAudioPolicyEnginePfw(true, {XSD_PFW_DIR});

}