audio: Run VTS tests for non-primary modules for HAL V6

am: 686af1cc43

Change-Id: I5ab9eabab63dd19db68e143e337b765db937086f
This commit is contained in:
Mikhail Naganov 2019-11-11 18:29:52 -08:00 committed by android-build-merger
commit 936010d0b3
4 changed files with 254 additions and 154 deletions

View file

@ -260,7 +260,8 @@ interface IDevice {
/** /**
* Returns an array with available microphones in device. * Returns an array with available microphones in device.
* *
* @return retval INVALID_STATE if the call is not successful, * @return retval NOT_SUPPORTED if there are no microphones on this device
* INVALID_STATE if the call is not successful,
* OK otherwise. * OK otherwise.
* *
* @return microphones array with microphones info * @return microphones array with microphones info

View file

@ -18,15 +18,16 @@
TEST_P(AudioHidlTest, OpenPrimaryDeviceUsingGetDevice) { TEST_P(AudioHidlTest, OpenPrimaryDeviceUsingGetDevice) {
doc::test("Calling openDevice(\"primary\") should return the primary device."); doc::test("Calling openDevice(\"primary\") should return the primary device.");
if (getDeviceName() != DeviceManager::kPrimaryDevice) {
GTEST_SKIP() << "No primary device on this factory"; // returns
}
struct WaitExecutor { struct WaitExecutor {
~WaitExecutor() { DeviceManager::waitForInstanceDestruction(); } ~WaitExecutor() { DeviceManager::waitForInstanceDestruction(); }
} waitExecutor; // Make sure we wait for the device destruction on exiting from the test. } waitExecutor; // Make sure we wait for the device destruction on exiting from the test.
Result result; Result result;
sp<IDevice> baseDevice; sp<IDevice> baseDevice;
ASSERT_OK(getDevicesFactory()->openDevice("primary", returnIn(result, baseDevice))); ASSERT_OK(getDevicesFactory()->openDevice("primary", returnIn(result, baseDevice)));
if (result != Result::OK && isPrimaryDeviceOptional()) {
GTEST_SKIP() << "No primary device on this factory"; // returns
}
ASSERT_OK(result); ASSERT_OK(result);
ASSERT_TRUE(baseDevice != nullptr); ASSERT_TRUE(baseDevice != nullptr);
@ -39,10 +40,13 @@ TEST_P(AudioHidlTest, OpenPrimaryDeviceUsingGetDevice) {
/////////////////////////// get(Active)Microphones /////////////////////////// /////////////////////////// get(Active)Microphones ///////////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
TEST_P(AudioPrimaryHidlTest, GetMicrophonesTest) { TEST_P(AudioHidlDeviceTest, GetMicrophonesTest) {
doc::test("Make sure getMicrophones always succeeds"); doc::test("Make sure getMicrophones always succeeds");
hidl_vec<MicrophoneInfo> microphones; hidl_vec<MicrophoneInfo> microphones;
ASSERT_OK(getDevice()->getMicrophones(returnIn(res, microphones))); ASSERT_OK(getDevice()->getMicrophones(returnIn(res, microphones)));
if (res == Result::NOT_SUPPORTED) {
GTEST_SKIP() << "getMicrophones is not supported"; // returns
}
ASSERT_OK(res); ASSERT_OK(res);
if (microphones.size() > 0) { if (microphones.size() > 0) {
// When there is microphone on the phone, try to open an input stream // When there is microphone on the phone, try to open an input stream
@ -120,7 +124,7 @@ TEST_P(AudioPrimaryHidlTest, GetMicrophonesTest) {
} }
} }
TEST_P(AudioPrimaryHidlTest, SetConnectedState) { TEST_P(AudioHidlDeviceTest, SetConnectedState) {
doc::test("Check that the HAL can be notified of device connection and deconnection"); doc::test("Check that the HAL can be notified of device connection and deconnection");
using AD = AudioDevice; using AD = AudioDevice;
for (auto deviceType : {AD::OUT_HDMI, AD::OUT_WIRED_HEADPHONE, AD::IN_USB_HEADSET}) { for (auto deviceType : {AD::OUT_HDMI, AD::OUT_WIRED_HEADPHONE, AD::IN_USB_HEADSET}) {
@ -142,7 +146,7 @@ TEST_P(AudioPrimaryHidlTest, SetConnectedState) {
// Because there is no way of knowing if the devices were connected before // Because there is no way of knowing if the devices were connected before
// calling setConnectedState, there is no way to restore the HAL to its // calling setConnectedState, there is no way to restore the HAL to its
// initial state. To workaround this, destroy the HAL at the end of this test. // initial state. To workaround this, destroy the HAL at the end of this test.
ASSERT_TRUE(DeviceManager::getInstance().resetPrimary(getFactoryName())); ASSERT_TRUE(resetDevice());
} }
static void testGetDevices(IStream* stream, AudioDevice expectedDevice) { static void testGetDevices(IStream* stream, AudioDevice expectedDevice) {

View file

@ -16,3 +16,51 @@
// pull in all the <= 5.0 tests // pull in all the <= 5.0 tests
#include "5.0/AudioPrimaryHidlHalTest.cpp" #include "5.0/AudioPrimaryHidlHalTest.cpp"
const std::vector<DeviceParameter>& getDeviceParametersForFactoryTests() {
static std::vector<DeviceParameter> parameters = [] {
std::vector<DeviceParameter> result;
const auto factories =
::android::hardware::getAllHalInstanceNames(IDevicesFactory::descriptor);
for (const auto& factoryName : factories) {
result.emplace_back(factoryName,
DeviceManager::getInstance().getPrimary(factoryName) != nullptr
? DeviceManager::kPrimaryDevice
: "");
}
return result;
}();
return parameters;
}
const std::vector<DeviceParameter>& getDeviceParametersForPrimaryDeviceTests() {
static std::vector<DeviceParameter> parameters = [] {
std::vector<DeviceParameter> result;
const auto primary = std::find_if(
getDeviceParameters().begin(), getDeviceParameters().end(), [](const auto& elem) {
return std::get<PARAM_DEVICE_NAME>(elem) == DeviceManager::kPrimaryDevice;
});
if (primary != getDeviceParameters().end()) result.push_back(*primary);
return result;
}();
return parameters;
}
const std::vector<DeviceParameter>& getDeviceParameters() {
static std::vector<DeviceParameter> parameters = [] {
std::vector<DeviceParameter> result;
const auto factories =
::android::hardware::getAllHalInstanceNames(IDevicesFactory::descriptor);
const auto devices = getCachedPolicyConfig().getModulesWithDevicesNames();
result.reserve(devices.size());
for (const auto& factoryName : factories) {
for (const auto& deviceName : devices) {
if (DeviceManager::getInstance().get(factoryName, deviceName) != nullptr) {
result.emplace_back(factoryName, deviceName);
}
}
}
return result;
}();
return parameters;
}

View file

@ -24,6 +24,7 @@
#include <limits> #include <limits>
#include <list> #include <list>
#include <map> #include <map>
#include <set>
#include <string> #include <string>
#include <vector> #include <vector>
@ -129,11 +130,31 @@ static AudioHidlTestEnvironment* environment;
#include "DeviceManager.h" #include "DeviceManager.h"
#if MAJOR_VERSION <= 5 #if MAJOR_VERSION <= 5
class HidlTest : public ::testing::VtsHalHidlTargetTestBase { using HidlTestBase = ::testing::VtsHalHidlTargetTestBase;
#elif MAJOR_VERSION >= 6 #elif MAJOR_VERSION >= 6
class HidlTest : public ::testing::Test { using HidlTestBase = ::testing::Test;
#endif #endif
class HidlTest : public HidlTestBase {
public:
virtual ~HidlTest() = default;
protected: protected:
// Factory and device name getters to be overridden in subclasses.
virtual const std::string& getFactoryName() const = 0;
virtual const std::string& getDeviceName() const = 0;
sp<IDevicesFactory> getDevicesFactory() const {
return DevicesFactoryManager::getInstance().get(getFactoryName());
}
sp<IDevice> getDevice() const {
return DeviceManager::getInstance().get(getFactoryName(), getDeviceName());
}
bool resetDevice() const {
return DeviceManager::getInstance().reset(getFactoryName(), getDeviceName());
}
bool areAudioPatchesSupported() { return extract(getDevice()->supportsAudioPatches()); }
// Convenient member to store results // Convenient member to store results
Result res; Result res;
}; };
@ -179,7 +200,25 @@ class PolicyConfig : private PolicyConfigData, public AudioPolicyConfig {
} }
mStatus = android::deserializeAudioPolicyFile(mFilePath.c_str(), this); mStatus = android::deserializeAudioPolicyFile(mFilePath.c_str(), this);
if (mStatus == OK) { if (mStatus == OK) {
mPrimaryModule = getHwModules().getModuleFromName("primary"); mPrimaryModule = getHwModules().getModuleFromName(DeviceManager::kPrimaryDevice);
// Available devices are not 'attached' to modules at this moment.
// Need to go over available devices and find their module.
for (const auto& device : availableOutputDevices) {
for (const auto& module : hwModules) {
if (module->getDeclaredDevices().indexOf(device) >= 0) {
mModulesWithDevicesNames.insert(module->getName());
break;
}
}
}
for (const auto& device : availableInputDevices) {
for (const auto& module : hwModules) {
if (module->getDeclaredDevices().indexOf(device) >= 0) {
mModulesWithDevicesNames.insert(module->getName());
break;
}
}
}
} }
} }
status_t getStatus() const { return mStatus; } status_t getStatus() const { return mStatus; }
@ -193,11 +232,15 @@ class PolicyConfig : private PolicyConfigData, public AudioPolicyConfig {
} }
const std::string& getFilePath() const { return mFilePath; } const std::string& getFilePath() const { return mFilePath; }
sp<const HwModule> getPrimaryModule() const { return mPrimaryModule; } sp<const HwModule> getPrimaryModule() const { return mPrimaryModule; }
const std::set<std::string>& getModulesWithDevicesNames() const {
return mModulesWithDevicesNames;
}
private: private:
status_t mStatus = NO_INIT; status_t mStatus = NO_INIT;
std::string mFilePath; std::string mFilePath;
sp<HwModule> mPrimaryModule = nullptr; sp<HwModule> mPrimaryModule = nullptr;
std::set<std::string> mModulesWithDevicesNames;
}; };
// Cached policy config after parsing for faster test startup // Cached policy config after parsing for faster test startup
@ -210,40 +253,26 @@ const PolicyConfig& getCachedPolicyConfig() {
return *policyConfig; return *policyConfig;
} }
class AudioPolicyConfigTest : public HidlTest { class AudioPolicyConfigTest : public HidlTestBase {
public: public:
void SetUp() override { void SetUp() override {
ASSERT_NO_FATAL_FAILURE(HidlTest::SetUp()); // setup base ASSERT_NO_FATAL_FAILURE(HidlTestBase::SetUp()); // setup base
auto& policyConfig = getCachedPolicyConfig(); auto& policyConfig = getCachedPolicyConfig();
ASSERT_EQ(0, policyConfig.getStatus()) << policyConfig.getError(); ASSERT_EQ(0, policyConfig.getStatus()) << policyConfig.getError();
mPrimaryConfig = policyConfig.getPrimaryModule();
ASSERT_TRUE(mPrimaryConfig) << "Could not find primary module in configuration file: "
<< policyConfig.getFilePath();
} }
protected:
sp<IDevicesFactory> getDevicesFactory(const std::string& factoryName) const {
return DevicesFactoryManager::getInstance().get(factoryName);
}
sp<IPrimaryDevice> getPrimaryDevice(const std::string& factoryName) const {
return DeviceManager::getInstance().getPrimary(factoryName);
}
bool isPrimaryDeviceOptional(const std::string& factoryName) const {
// It's OK not to have "primary" device on non-default audio HAL service.
return factoryName != kDefaultServiceName;
}
sp<const HwModule> mPrimaryConfig = nullptr;
}; };
TEST_F(AudioPolicyConfigTest, LoadAudioPolicyXMLConfiguration) { TEST_F(AudioPolicyConfigTest, LoadAudioPolicyXMLConfiguration) {
doc::test("Test parsing audio_policy_configuration.xml (called in SetUp)"); doc::test("Test parsing audio_policy_configuration.xml (called in SetUp)");
} }
TEST_F(AudioPolicyConfigTest, HasPrimaryModule) {
auto& policyConfig = getCachedPolicyConfig();
ASSERT_TRUE(policyConfig.getPrimaryModule() != nullptr)
<< "Could not find primary module in configuration file: "
<< policyConfig.getFilePath();
}
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
//////////////////// Test parameter types and definitions //////////////////// //////////////////// Test parameter types and definitions ////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
@ -253,13 +282,13 @@ using DeviceParameter = std::tuple<std::string, std::string>;
static inline std::string DeviceParameterToString( static inline std::string DeviceParameterToString(
const ::testing::TestParamInfo<DeviceParameter>& info) { const ::testing::TestParamInfo<DeviceParameter>& info) {
const auto& deviceName = std::get<PARAM_DEVICE_NAME>(info.param);
#if MAJOR_VERSION <= 5 #if MAJOR_VERSION <= 5
return std::get<PARAM_DEVICE_NAME>(info.param); return !deviceName.empty() ? deviceName : std::to_string(info.index);
#elif MAJOR_VERSION >= 6 #elif MAJOR_VERSION >= 6
const auto factoryName = const auto factoryName =
::android::hardware::PrintInstanceNameToString(::testing::TestParamInfo<std::string>{ ::android::hardware::PrintInstanceNameToString(::testing::TestParamInfo<std::string>{
std::get<PARAM_FACTORY_NAME>(info.param), info.index}); std::get<PARAM_FACTORY_NAME>(info.param), info.index});
const auto& deviceName = std::get<PARAM_DEVICE_NAME>(info.param);
return !deviceName.empty() ? factoryName + "_" + deviceName : factoryName; return !deviceName.empty() ? factoryName + "_" + deviceName : factoryName;
#endif #endif
} }
@ -268,41 +297,48 @@ static inline std::string DeviceParameterToString(
// For V2..5 the factory is looked up using the instance name passed // For V2..5 the factory is looked up using the instance name passed
// in the environment, only one factory is returned. This is because the VTS // in the environment, only one factory is returned. This is because the VTS
// framework will call the test for each instance. Only the primary device of // framework will call the test for each instance. Only the primary device of
// the factory specified in the environment is tested. // the default service factory can be tested.
const std::vector<DeviceParameter>& getDeviceParameters() {
// Return a pair of <"default", "primary"> or <[non-default name], "">
// This is used to parametrize device factory tests.
// The device name is used to indicate whether IPrimaryDevice is required.
const std::vector<DeviceParameter>& getDeviceParametersForFactoryTests() {
static std::vector<DeviceParameter> parameters = { static std::vector<DeviceParameter> parameters = {
{environment->getServiceName<IDevicesFactory>(), DeviceManager::kPrimaryDevice}}; {environment->getServiceName<IDevicesFactory>(),
environment->getServiceName<IDevicesFactory>() == kDefaultServiceName
? DeviceManager::kPrimaryDevice
: ""}};
return parameters; return parameters;
} }
// Return a pair of <"default", "primary"> or nothing.
// This is used to parametrize primary device tests.
const std::vector<DeviceParameter>& getDeviceParametersForPrimaryDeviceTests() {
static std::vector<DeviceParameter> parameters =
!std::get<PARAM_DEVICE_NAME>(*getDeviceParametersForFactoryTests().begin()).empty()
? getDeviceParametersForFactoryTests()
: std::vector<DeviceParameter>{};
return parameters;
}
// In V2..5 device tests must only test the primary device.
// No device tests are executed for non-primary devices.
const std::vector<DeviceParameter>& getDeviceParameters() {
return getDeviceParametersForPrimaryDeviceTests();
}
#elif MAJOR_VERSION >= 6 #elif MAJOR_VERSION >= 6
// FIXME: Will be replaced with code that analyzes the audio policy config file. // For V6 and above these functions are implemented in 6.0/AudioPrimaryHidlHalTest.cpp
const std::vector<DeviceParameter>& getDeviceParameters() { const std::vector<DeviceParameter>& getDeviceParametersForFactoryTests();
static std::vector<DeviceParameter> parameters = [] { const std::vector<DeviceParameter>& getDeviceParametersForPrimaryDeviceTests();
const auto instances = const std::vector<DeviceParameter>& getDeviceParameters();
::android::hardware::getAllHalInstanceNames(IDevicesFactory::descriptor);
std::vector<DeviceParameter> result;
result.reserve(instances.size());
for (const auto& instance : instances) {
result.emplace_back(instance, DeviceManager::kPrimaryDevice);
}
return result;
}();
return parameters;
}
#endif #endif
class AudioHidlTestWithDeviceParameter : public AudioPolicyConfigTest, class AudioHidlTestWithDeviceParameter : public HidlTest,
public ::testing::WithParamInterface<DeviceParameter> { public ::testing::WithParamInterface<DeviceParameter> {
protected: protected:
const std::string& getFactoryName() const { return std::get<PARAM_FACTORY_NAME>(GetParam()); } const std::string& getFactoryName() const override {
bool isPrimaryDeviceOptional() const { return std::get<PARAM_FACTORY_NAME>(GetParam());
return AudioPolicyConfigTest::isPrimaryDeviceOptional(getFactoryName());
} }
sp<IDevicesFactory> getDevicesFactory() const { const std::string& getDeviceName() const override {
return AudioPolicyConfigTest::getDevicesFactory(getFactoryName()); return std::get<PARAM_DEVICE_NAME>(GetParam());
}
sp<IPrimaryDevice> getPrimaryDevice() const {
return AudioPolicyConfigTest::getPrimaryDevice(getFactoryName());
} }
}; };
@ -310,7 +346,7 @@ class AudioHidlTestWithDeviceParameter : public AudioPolicyConfigTest,
////////////////////// getService audio_devices_factory ////////////////////// ////////////////////// getService audio_devices_factory //////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
// Test all audio devices // Test audio devices factory
class AudioHidlTest : public AudioHidlTestWithDeviceParameter { class AudioHidlTest : public AudioHidlTestWithDeviceParameter {
public: public:
void SetUp() override { void SetUp() override {
@ -337,53 +373,75 @@ TEST_P(AudioHidlTest, OpenDeviceInvalidParameter) {
ASSERT_TRUE(device == nullptr); ASSERT_TRUE(device == nullptr);
} }
INSTANTIATE_TEST_CASE_P(AudioHidl, AudioHidlTest, ::testing::ValuesIn(getDeviceParameters()), INSTANTIATE_TEST_CASE_P(AudioHidl, AudioHidlTest,
::testing::ValuesIn(getDeviceParametersForFactoryTests()),
&DeviceParameterToString); &DeviceParameterToString);
//////////////////////////////////////////////////////////////////////////////
/////////////////////////////// openDevice ///////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
// Test all audio devices
class AudioHidlDeviceTest : public AudioHidlTest {
public:
void SetUp() override {
ASSERT_NO_FATAL_FAILURE(AudioHidlTest::SetUp()); // setup base
ASSERT_TRUE(getDevice() != nullptr);
}
};
TEST_P(AudioHidlDeviceTest, OpenDevice) {
doc::test("Test openDevice (called during setup)");
}
TEST_P(AudioHidlDeviceTest, Init) {
doc::test("Test that the audio hal initialized correctly");
ASSERT_OK(getDevice()->initCheck());
}
INSTANTIATE_TEST_CASE_P(AudioHidlDevice, AudioHidlDeviceTest,
::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString);
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
/////////////////////////////// openDevice primary /////////////////////////// /////////////////////////////// openDevice primary ///////////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
// Test the primary device // Test the primary device
class AudioPrimaryHidlTest : public AudioHidlTest { class AudioPrimaryHidlTest : public AudioHidlDeviceTest {
public: public:
void SetUp() override { void SetUp() override {
ASSERT_NO_FATAL_FAILURE(AudioHidlTest::SetUp()); // setup base ASSERT_NO_FATAL_FAILURE(AudioHidlDeviceTest::SetUp()); // setup base
if (getDevice() == nullptr && isPrimaryDeviceOptional()) {
GTEST_SKIP() << "No primary device on this factory";
}
ASSERT_TRUE(getDevice() != nullptr); ASSERT_TRUE(getDevice() != nullptr);
} }
protected: protected:
sp<IPrimaryDevice> getDevice() const { return getPrimaryDevice(); } sp<IPrimaryDevice> getDevice() const {
return DeviceManager::getInstance().getPrimary(getFactoryName());
}
}; };
TEST_P(AudioPrimaryHidlTest, OpenPrimaryDevice) { TEST_P(AudioPrimaryHidlTest, OpenPrimaryDevice) {
doc::test("Test the openDevice (called during setup)"); doc::test("Test openPrimaryDevice (called during setup)");
}
TEST_P(AudioPrimaryHidlTest, Init) {
doc::test("Test that the audio primary hal initialized correctly");
ASSERT_OK(getDevice()->initCheck());
} }
INSTANTIATE_TEST_CASE_P(AudioPrimaryHidl, AudioPrimaryHidlTest, INSTANTIATE_TEST_CASE_P(AudioPrimaryHidl, AudioPrimaryHidlTest,
::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString); ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
&DeviceParameterToString);
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
///////////////////// {set,get}{Master,Mic}{Mute,Volume} ///////////////////// ///////////////////// {set,get}{Master,Mic}{Mute,Volume} /////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
template <class Property> template <class Property, class BaseTestClass = AudioHidlDeviceTest>
class AccessorPrimaryHidlTest : public AudioPrimaryHidlTest { class AccessorHidlTest : public BaseTestClass {
protected: protected:
enum Optionality { REQUIRED, OPTIONAL }; enum Optionality { REQUIRED, OPTIONAL };
struct Initial { // Initial property value struct Initial { // Initial property value
Initial(Property value, Optionality check = REQUIRED) : value(value), check(check) {} Initial(Property value, Optionality check = REQUIRED) : value(value), check(check) {}
Property value; Property value;
Optionality check; // If this initial value should be checked Optionality check; // If this initial value should be checked
}; };
using BaseTestClass::res;
/** Test a property getter and setter. /** Test a property getter and setter.
* The getter and/or the setter may return NOT_SUPPORTED if optionality == OPTIONAL. * The getter and/or the setter may return NOT_SUPPORTED if optionality == OPTIONAL.
*/ */
@ -395,7 +453,7 @@ class AccessorPrimaryHidlTest : public AudioPrimaryHidlTest {
optionality == OPTIONAL ? Result::NOT_SUPPORTED : Result::OK}; optionality == OPTIONAL ? Result::NOT_SUPPORTED : Result::OK};
Property initialValue = expectedInitial.value; Property initialValue = expectedInitial.value;
ASSERT_OK((getDevice().get()->*getter)(returnIn(res, initialValue))); ASSERT_OK((BaseTestClass::getDevice().get()->*getter)(returnIn(res, initialValue)));
ASSERT_RESULT(expectedResults, res); ASSERT_RESULT(expectedResults, res);
if (res == Result::OK && expectedInitial.check == REQUIRED) { if (res == Result::OK && expectedInitial.check == REQUIRED) {
EXPECT_EQ(expectedInitial.value, initialValue); EXPECT_EQ(expectedInitial.value, initialValue);
@ -406,7 +464,7 @@ class AccessorPrimaryHidlTest : public AudioPrimaryHidlTest {
for (Property setValue : valuesToTest) { for (Property setValue : valuesToTest) {
SCOPED_TRACE("Test " + propertyName + " getter and setter for " + SCOPED_TRACE("Test " + propertyName + " getter and setter for " +
testing::PrintToString(setValue)); testing::PrintToString(setValue));
auto ret = (getDevice().get()->*setter)(setValue); auto ret = (BaseTestClass::getDevice().get()->*setter)(setValue);
ASSERT_RESULT(expectedResults, ret); ASSERT_RESULT(expectedResults, ret);
if (ret == Result::NOT_SUPPORTED) { if (ret == Result::NOT_SUPPORTED) {
doc::partialTest(propertyName + " setter is not supported"); doc::partialTest(propertyName + " setter is not supported");
@ -414,7 +472,7 @@ class AccessorPrimaryHidlTest : public AudioPrimaryHidlTest {
} }
Property getValue; Property getValue;
// Make sure the getter returns the same value just set // Make sure the getter returns the same value just set
ASSERT_OK((getDevice().get()->*getter)(returnIn(res, getValue))); ASSERT_OK((BaseTestClass::getDevice().get()->*getter)(returnIn(res, getValue)));
ASSERT_RESULT(expectedResults, res); ASSERT_RESULT(expectedResults, res);
if (res == Result::NOT_SUPPORTED) { if (res == Result::NOT_SUPPORTED) {
doc::partialTest(propertyName + " getter is not supported"); doc::partialTest(propertyName + " getter is not supported");
@ -426,34 +484,40 @@ class AccessorPrimaryHidlTest : public AudioPrimaryHidlTest {
for (Property invalidValue : invalidValues) { for (Property invalidValue : invalidValues) {
SCOPED_TRACE("Try to set " + propertyName + " with the invalid value " + SCOPED_TRACE("Try to set " + propertyName + " with the invalid value " +
testing::PrintToString(invalidValue)); testing::PrintToString(invalidValue));
EXPECT_RESULT(invalidArgsOrNotSupported, (getDevice().get()->*setter)(invalidValue)); EXPECT_RESULT(invalidArgsOrNotSupported,
(BaseTestClass::getDevice().get()->*setter)(invalidValue));
} }
// Restore initial value // Restore initial value
EXPECT_RESULT(expectedResults, (getDevice().get()->*setter)(initialValue)); EXPECT_RESULT(expectedResults, (BaseTestClass::getDevice().get()->*setter)(initialValue));
} }
}; };
using BoolAccessorPrimaryHidlTest = AccessorPrimaryHidlTest<bool>; using BoolAccessorHidlTest = AccessorHidlTest<bool>;
using BoolAccessorPrimaryHidlTest = AccessorHidlTest<bool, AudioPrimaryHidlTest>;
TEST_P(BoolAccessorPrimaryHidlTest, MicMuteTest) { TEST_P(BoolAccessorHidlTest, MicMuteTest) {
doc::test("Check that the mic can be muted and unmuted"); doc::test("Check that the mic can be muted and unmuted");
testAccessors("mic mute", Initial{false}, {true}, &IDevice::setMicMute, &IDevice::getMicMute); testAccessors<OPTIONAL>("mic mute", Initial{false}, {true}, &IDevice::setMicMute,
&IDevice::getMicMute);
// TODO: check that the mic is really muted (all sample are 0) // TODO: check that the mic is really muted (all sample are 0)
} }
TEST_P(BoolAccessorPrimaryHidlTest, MasterMuteTest) { TEST_P(BoolAccessorHidlTest, MasterMuteTest) {
doc::test("If master mute is supported, try to mute and unmute the master output"); doc::test("If master mute is supported, try to mute and unmute the master output");
testAccessors<OPTIONAL>("master mute", Initial{false}, {true}, &IDevice::setMasterMute, testAccessors<OPTIONAL>("master mute", Initial{false}, {true}, &IDevice::setMasterMute,
&IDevice::getMasterMute); &IDevice::getMasterMute);
// TODO: check that the master volume is really muted // TODO: check that the master volume is really muted
} }
INSTANTIATE_TEST_CASE_P(BoolAccessorPrimaryHidl, BoolAccessorPrimaryHidlTest, INSTANTIATE_TEST_CASE_P(BoolAccessorHidl, BoolAccessorHidlTest,
::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString); ::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString);
INSTANTIATE_TEST_CASE_P(BoolAccessorPrimaryHidl, BoolAccessorPrimaryHidlTest,
::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
&DeviceParameterToString);
using FloatAccessorPrimaryHidlTest = AccessorPrimaryHidlTest<float>; using FloatAccessorHidlTest = AccessorHidlTest<float>;
TEST_P(FloatAccessorPrimaryHidlTest, MasterVolumeTest) { TEST_P(FloatAccessorHidlTest, MasterVolumeTest) {
doc::test("Test the master volume if supported"); doc::test("Test the master volume if supported");
testAccessors<OPTIONAL>( testAccessors<OPTIONAL>(
"master volume", Initial{1}, {0, 0.5}, &IDevice::setMasterVolume, &IDevice::getMasterVolume, "master volume", Initial{1}, {0, 0.5}, &IDevice::setMasterVolume, &IDevice::getMasterVolume,
@ -461,28 +525,29 @@ TEST_P(FloatAccessorPrimaryHidlTest, MasterVolumeTest) {
// TODO: check that the master volume is really changed // TODO: check that the master volume is really changed
} }
INSTANTIATE_TEST_CASE_P(FloatAccessorPrimaryHidl, FloatAccessorPrimaryHidlTest, INSTANTIATE_TEST_CASE_P(FloatAccessorHidl, FloatAccessorHidlTest,
::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString); ::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString);
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
//////////////////////////////// AudioPatches //////////////////////////////// //////////////////////////////// AudioPatches ////////////////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
class AudioPatchPrimaryHidlTest : public AudioPrimaryHidlTest { class AudioPatchHidlTest : public AudioHidlDeviceTest {
protected: public:
bool areAudioPatchesSupported() { return extract(getDevice()->supportsAudioPatches()); } void SetUp() override {
ASSERT_NO_FATAL_FAILURE(AudioHidlDeviceTest::SetUp()); // setup base
if (!areAudioPatchesSupported()) {
GTEST_SKIP() << "Audio patches are not supported";
}
}
}; };
TEST_P(AudioPatchPrimaryHidlTest, AudioPatches) { TEST_P(AudioPatchHidlTest, AudioPatches) {
doc::test("Test if audio patches are supported"); doc::test("Test if audio patches are supported");
if (!areAudioPatchesSupported()) {
doc::partialTest("Audio patches are not supported");
return;
}
// TODO: test audio patches // TODO: test audio patches
} }
INSTANTIATE_TEST_CASE_P(AudioPatchPrimaryHidl, AudioPatchPrimaryHidlTest, INSTANTIATE_TEST_CASE_P(AudioPatchHidl, AudioPatchHidlTest,
::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString); ::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString);
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
@ -591,24 +656,21 @@ static string DeviceConfigParameterToString(
} }
class AudioHidlTestWithDeviceConfigParameter class AudioHidlTestWithDeviceConfigParameter
: public AudioPolicyConfigTest, : public HidlTest,
public ::testing::WithParamInterface<DeviceConfigParameter> { public ::testing::WithParamInterface<DeviceConfigParameter> {
protected: protected:
const std::string& getFactoryName() const { void SetUp() override {
ASSERT_NO_FATAL_FAILURE(HidlTest::SetUp()); // setup base
ASSERT_TRUE(getDevicesFactory() != nullptr);
ASSERT_TRUE(getDevice() != nullptr);
}
const std::string& getFactoryName() const override {
return std::get<PARAM_FACTORY_NAME>(std::get<PARAM_DEVICE>(GetParam())); return std::get<PARAM_FACTORY_NAME>(std::get<PARAM_DEVICE>(GetParam()));
} }
bool isPrimaryDeviceOptional() const { const std::string& getDeviceName() const override {
return AudioPolicyConfigTest::isPrimaryDeviceOptional(getFactoryName()); return std::get<PARAM_DEVICE_NAME>(std::get<PARAM_DEVICE>(GetParam()));
}
sp<IDevicesFactory> getDevicesFactory() const {
return AudioPolicyConfigTest::getDevicesFactory(getFactoryName());
}
sp<IPrimaryDevice> getPrimaryDevice() const {
return AudioPolicyConfigTest::getPrimaryDevice(getFactoryName());
} }
const AudioConfig& getConfig() const { return std::get<PARAM_CONFIG>(GetParam()); } const AudioConfig& getConfig() const { return std::get<PARAM_CONFIG>(GetParam()); }
// FIXME: Split out tests that don't require primary device
sp<IPrimaryDevice> getDevice() const { return getPrimaryDevice(); }
}; };
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
@ -620,16 +682,6 @@ class AudioHidlTestWithDeviceConfigParameter
// how to get this value ? is it a property ??? // how to get this value ? is it a property ???
class AudioCaptureConfigPrimaryTest : public AudioHidlTestWithDeviceConfigParameter { class AudioCaptureConfigPrimaryTest : public AudioHidlTestWithDeviceConfigParameter {
public:
void SetUp() override {
ASSERT_NO_FATAL_FAILURE(AudioHidlTestWithDeviceConfigParameter::SetUp()); // setup base
ASSERT_TRUE(getDevicesFactory() != nullptr);
if (getDevice() == nullptr && isPrimaryDeviceOptional()) {
GTEST_SKIP() << "No primary device on this factory";
}
ASSERT_TRUE(getDevice() != nullptr);
}
protected: protected:
void inputBufferSizeTest(const AudioConfig& audioConfig, bool supportRequired) { void inputBufferSizeTest(const AudioConfig& audioConfig, bool supportRequired) {
uint64_t bufferSize; uint64_t bufferSize;
@ -661,8 +713,9 @@ TEST_P(RequiredInputBufferSizeTest, RequiredInputBufferSizeTest) {
} }
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
RequiredInputBufferSize, RequiredInputBufferSizeTest, RequiredInputBufferSize, RequiredInputBufferSizeTest,
// FIXME: uses primaryHasMic
::testing::Combine( ::testing::Combine(
::testing::ValuesIn(getDeviceParameters()), ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
::testing::ValuesIn(ConfigHelper::getRequiredSupportCaptureAudioConfig())), ::testing::ValuesIn(ConfigHelper::getRequiredSupportCaptureAudioConfig())),
&DeviceConfigParameterToString); &DeviceConfigParameterToString);
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
@ -682,8 +735,9 @@ TEST_P(OptionalInputBufferSizeTest, OptionalInputBufferSizeTest) {
} }
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
RecommendedCaptureAudioConfigSupport, OptionalInputBufferSizeTest, RecommendedCaptureAudioConfigSupport, OptionalInputBufferSizeTest,
// FIXME: uses primaryHasMic
::testing::Combine( ::testing::Combine(
::testing::ValuesIn(getDeviceParameters()), ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
::testing::ValuesIn(ConfigHelper::getRecommendedSupportCaptureAudioConfig())), ::testing::ValuesIn(ConfigHelper::getRecommendedSupportCaptureAudioConfig())),
&DeviceConfigParameterToString); &DeviceConfigParameterToString);
@ -691,7 +745,7 @@ INSTANTIATE_TEST_CASE_P(
/////////////////////////////// setScreenState /////////////////////////////// /////////////////////////////// setScreenState ///////////////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
TEST_P(AudioPrimaryHidlTest, setScreenState) { TEST_P(AudioHidlDeviceTest, setScreenState) {
doc::test("Check that the hal can receive the screen state"); doc::test("Check that the hal can receive the screen state");
for (bool turnedOn : {false, true, true, false, false}) { for (bool turnedOn : {false, true, true, false, false}) {
ASSERT_RESULT(okOrNotSupported, getDevice()->setScreenState(turnedOn)); ASSERT_RESULT(okOrNotSupported, getDevice()->setScreenState(turnedOn));
@ -702,15 +756,16 @@ TEST_P(AudioPrimaryHidlTest, setScreenState) {
//////////////////////////// {get,set}Parameters ///////////////////////////// //////////////////////////// {get,set}Parameters /////////////////////////////
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
TEST_P(AudioPrimaryHidlTest, getParameters) { TEST_P(AudioHidlDeviceTest, getParameters) {
doc::test("Check that the hal can set and get parameters"); doc::test("Check that the hal can set and get parameters");
hidl_vec<ParameterValue> context; hidl_vec<ParameterValue> context;
hidl_vec<hidl_string> keys; hidl_vec<hidl_string> keys;
hidl_vec<ParameterValue> values; hidl_vec<ParameterValue> values;
ASSERT_OK(Parameters::get(getDevice(), keys, returnIn(res, values))); ASSERT_OK(Parameters::get(getDevice(), keys, returnIn(res, values)));
ASSERT_OK(Parameters::set(getDevice(), values)); ASSERT_RESULT(okOrNotSupported, res);
ASSERT_RESULT(okOrNotSupported, Parameters::set(getDevice(), values));
values.resize(0); values.resize(0);
ASSERT_OK(Parameters::set(getDevice(), values)); ASSERT_RESULT(okOrNotSupported, Parameters::set(getDevice(), values));
} }
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
@ -751,12 +806,12 @@ static void testDebugDump(DebugDump debugDump) {
EXPECT_EQ(0, close(fds[1])) << errno; EXPECT_EQ(0, close(fds[1])) << errno;
} }
TEST_P(AudioPrimaryHidlTest, DebugDump) { TEST_P(AudioHidlDeviceTest, DebugDump) {
doc::test("Check that the hal can dump its state without error"); doc::test("Check that the hal can dump its state without error");
testDebugDump([this](const auto& handle) { return dump(getDevice(), handle); }); testDebugDump([this](const auto& handle) { return dump(getDevice(), handle); });
} }
TEST_P(AudioPrimaryHidlTest, DebugDumpInvalidArguments) { TEST_P(AudioHidlDeviceTest, DebugDumpInvalidArguments) {
doc::test("Check that the hal dump doesn't crash on invalid arguments"); doc::test("Check that the hal dump doesn't crash on invalid arguments");
ASSERT_OK(dump(getDevice(), hidl_handle())); ASSERT_OK(dump(getDevice(), hidl_handle()));
} }
@ -768,15 +823,6 @@ TEST_P(AudioPrimaryHidlTest, DebugDumpInvalidArguments) {
template <class Stream> template <class Stream>
class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter { class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
protected: protected:
void SetUp() override {
ASSERT_NO_FATAL_FAILURE(AudioHidlTestWithDeviceConfigParameter::SetUp()); // setup base
ASSERT_TRUE(getDevicesFactory() != nullptr);
if (getDevice() == nullptr && isPrimaryDeviceOptional()) {
GTEST_SKIP() << "No primary device on this factory";
}
ASSERT_TRUE(getDevice() != nullptr);
}
template <class Open> template <class Open>
void testOpen(Open openStream, const AudioConfig& config) { void testOpen(Open openStream, const AudioConfig& config) {
// FIXME: Open a stream without an IOHandle // FIXME: Open a stream without an IOHandle
@ -828,14 +874,12 @@ class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
usleep(100 * 1000); usleep(100 * 1000);
} }
bool areAudioPatchesSupported() { return extract(getDevice()->supportsAudioPatches()); }
private: private:
void TearDown() override { void TearDown() override {
if (open) { if (open) {
ASSERT_OK(closeStream()); ASSERT_OK(closeStream());
} }
AudioPolicyConfigTest::TearDown(); AudioHidlTestWithDeviceConfigParameter::TearDown();
} }
protected: protected:
@ -850,7 +894,6 @@ class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
class OutputStreamTest : public OpenStreamTest<IStreamOut> { class OutputStreamTest : public OpenStreamTest<IStreamOut> {
void SetUp() override { void SetUp() override {
ASSERT_NO_FATAL_FAILURE(OpenStreamTest::SetUp()); // setup base ASSERT_NO_FATAL_FAILURE(OpenStreamTest::SetUp()); // setup base
if (IsSkipped()) return; // do not attempt to use 'device'
address.device = AudioDevice::OUT_DEFAULT; address.device = AudioDevice::OUT_DEFAULT;
const AudioConfig& config = getConfig(); const AudioConfig& config = getConfig();
// TODO: test all flag combination // TODO: test all flag combination
@ -881,10 +924,11 @@ TEST_P(OutputStreamTest, OpenOutputStreamTest) {
"recommended config"); "recommended config");
// Open done in SetUp // Open done in SetUp
} }
// FIXME: Add instantiations for non-primary devices with configs harvested from the APM config file
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
RequiredOutputStreamConfigSupport, OutputStreamTest, RequiredOutputStreamConfigSupport, OutputStreamTest,
::testing::Combine( ::testing::Combine(
::testing::ValuesIn(getDeviceParameters()), ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
::testing::ValuesIn(ConfigHelper::getRequiredSupportPlaybackAudioConfig())), ::testing::ValuesIn(ConfigHelper::getRequiredSupportPlaybackAudioConfig())),
&DeviceConfigParameterToString); &DeviceConfigParameterToString);
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
@ -896,7 +940,7 @@ INSTANTIATE_TEST_CASE_P(
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
RecommendedOutputStreamConfigSupport, OutputStreamTest, RecommendedOutputStreamConfigSupport, OutputStreamTest,
::testing::Combine( ::testing::Combine(
::testing::ValuesIn(getDeviceParameters()), ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
::testing::ValuesIn(ConfigHelper::getRecommendedSupportPlaybackAudioConfig())), ::testing::ValuesIn(ConfigHelper::getRecommendedSupportPlaybackAudioConfig())),
&DeviceConfigParameterToString); &DeviceConfigParameterToString);
@ -905,7 +949,6 @@ INSTANTIATE_TEST_CASE_P(
class InputStreamTest : public OpenStreamTest<IStreamIn> { class InputStreamTest : public OpenStreamTest<IStreamIn> {
void SetUp() override { void SetUp() override {
ASSERT_NO_FATAL_FAILURE(OpenStreamTest::SetUp()); // setup base ASSERT_NO_FATAL_FAILURE(OpenStreamTest::SetUp()); // setup base
if (IsSkipped()) return; // do not attempt to use 'device'
address.device = AudioDevice::IN_DEFAULT; address.device = AudioDevice::IN_DEFAULT;
const AudioConfig& config = getConfig(); const AudioConfig& config = getConfig();
// TODO: test all supported flags and source // TODO: test all supported flags and source
@ -934,8 +977,9 @@ TEST_P(InputStreamTest, OpenInputStreamTest) {
} }
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
RequiredInputStreamConfigSupport, InputStreamTest, RequiredInputStreamConfigSupport, InputStreamTest,
// FIXME: uses primaryHasMic
::testing::Combine( ::testing::Combine(
::testing::ValuesIn(getDeviceParameters()), ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
::testing::ValuesIn(ConfigHelper::getRequiredSupportCaptureAudioConfig())), ::testing::ValuesIn(ConfigHelper::getRequiredSupportCaptureAudioConfig())),
&DeviceConfigParameterToString); &DeviceConfigParameterToString);
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
@ -946,8 +990,9 @@ INSTANTIATE_TEST_CASE_P(
INSTANTIATE_TEST_CASE_P( INSTANTIATE_TEST_CASE_P(
RecommendedInputStreamConfigSupport, InputStreamTest, RecommendedInputStreamConfigSupport, InputStreamTest,
// FIXME: uses primaryHasMic
::testing::Combine( ::testing::Combine(
::testing::ValuesIn(getDeviceParameters()), ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
::testing::ValuesIn(ConfigHelper::getRecommendedSupportCaptureAudioConfig())), ::testing::ValuesIn(ConfigHelper::getRecommendedSupportCaptureAudioConfig())),
&DeviceConfigParameterToString); &DeviceConfigParameterToString);
@ -1481,7 +1526,8 @@ TEST_P(BoolAccessorPrimaryHidlTest, setGetBtScoWidebandEnabled) {
&IPrimaryDevice::getBtScoWidebandEnabled); &IPrimaryDevice::getBtScoWidebandEnabled);
} }
using TtyModeAccessorPrimaryHidlTest = AccessorPrimaryHidlTest<IPrimaryDevice::TtyMode>; using TtyModeAccessorPrimaryHidlTest =
AccessorHidlTest<IPrimaryDevice::TtyMode, AudioPrimaryHidlTest>;
TEST_P(TtyModeAccessorPrimaryHidlTest, setGetTtyMode) { TEST_P(TtyModeAccessorPrimaryHidlTest, setGetTtyMode) {
doc::test("Query and set the TTY mode state"); doc::test("Query and set the TTY mode state");
testAccessors<OPTIONAL>( testAccessors<OPTIONAL>(
@ -1490,7 +1536,8 @@ TEST_P(TtyModeAccessorPrimaryHidlTest, setGetTtyMode) {
&IPrimaryDevice::setTtyMode, &IPrimaryDevice::getTtyMode); &IPrimaryDevice::setTtyMode, &IPrimaryDevice::getTtyMode);
} }
INSTANTIATE_TEST_CASE_P(TtyModeAccessorPrimaryHidl, TtyModeAccessorPrimaryHidlTest, INSTANTIATE_TEST_CASE_P(TtyModeAccessorPrimaryHidl, TtyModeAccessorPrimaryHidlTest,
::testing::ValuesIn(getDeviceParameters()), &DeviceParameterToString); ::testing::ValuesIn(getDeviceParametersForPrimaryDeviceTests()),
&DeviceParameterToString);
TEST_P(BoolAccessorPrimaryHidlTest, setGetHac) { TEST_P(BoolAccessorPrimaryHidlTest, setGetHac) {
doc::test("Query and set the HAC state"); doc::test("Query and set the HAC state");