blob: 97c7e954f98e32f45f66d989470ba000e578571e [file] [log] [blame]
/*
* 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.
*/
#define LOG_TAG "LibHidlTest"
#include <vintf/parse_string.h>
#include <vintf/parse_xml.h>
#include <vintf/CompatibilityMatrix.h>
#include <vintf/RuntimeInfo.h>
#include <vintf/HalManifest.h>
#include <android-base/logging.h>
#include <android-base/parseint.h>
#include <gtest/gtest.h>
namespace android {
namespace vintf {
extern const XmlConverter<Version> &gVersionConverter;
extern const XmlConverter<MatrixHal> &gMatrixHalConverter;
extern const XmlConverter<KernelConfigTypedValue> &gKernelConfigTypedValueConverter;
extern const XmlConverter<HalImplementation> &gHalImplementationConverter;
extern const XmlConverter<HalManifest> &gHalManifestConverter;
extern const XmlConverter<CompatibilityMatrix> &gCompatibilityMatrixConverter;
struct LibVintfTest : public ::testing::Test {
public:
virtual void SetUp() override {
}
virtual void TearDown() override {
}
bool add(CompatibilityMatrix &cm, MatrixHal &&hal) {
return cm.add(std::move(hal));
}
bool add(CompatibilityMatrix &cm, MatrixKernel &&kernel) {
return cm.add(std::move(kernel));
}
bool add(HalManifest &vm, ManifestHal &&hal) {
return vm.add(std::move(hal));
}
void set(CompatibilityMatrix &cm, Sepolicy &&sepolicy) {
cm.mSepolicy = sepolicy;
}
const ManifestHal *getHal(HalManifest &vm, const std::string &name) {
return vm.getHal(name);
}
ConstMapValueIterable<std::string, ManifestHal> getHals(HalManifest &vm) {
return vm.getHals();
}
bool isEqual(const CompatibilityMatrix &cm1, const CompatibilityMatrix &cm2) {
return cm1.mHals == cm2.mHals && cm1.mKernels == cm2.mKernels;
}
bool isValid(const ManifestHal &mh) {
return mh.isValid();
}
HalManifest testHalManifest() {
HalManifest vm;
vm.add(ManifestHal{
.format = HalFormat::HIDL,
.name = "android.hardware.camera",
.versions = {Version(2, 0)},
.impl = HalImplementation{ImplLevel::SOC, "msm8892"},
.transport = Transport::HWBINDER
});
vm.add(ManifestHal{
.format = HalFormat::HIDL,
.name = "android.hardware.nfc",
.versions = {Version(1, 0)},
.impl = HalImplementation{ImplLevel::GENERIC, "generic"},
.transport = Transport::PASSTHROUGH
});
return vm;
}
RuntimeInfo testRuntimeInfo() {
RuntimeInfo info;
info.mOsName = "Linux";
info.mNodeName = "localhost";
info.mOsRelease = "3.18.31-g936f9a479d0f";
info.mKernelVersion = {3, 18, 31};
info.mOsVersion = "#4 SMP PREEMPT Wed Feb 1 18:10:52 PST 2017";
info.mHardwareId = "aarch64";
info.mKernelSepolicyVersion = 30;
info.mKernelConfigs = {
{"CONFIG_64BIT", "y"},
{"CONFIG_ANDROID_BINDER_DEVICES", "\"binder,hwbinder\""},
{"CONFIG_ARCH_MMAP_RND_BITS", "24"},
{"CONFIG_BUILD_ARM64_APPENDED_DTB_IMAGE_NAMES", "\"\""},
{"CONFIG_ILLEGAL_POINTER_VALUE", "0xdead000000000000"}
};
return info;
}
};
TEST_F(LibVintfTest, Stringify) {
HalManifest vm = testHalManifest();
EXPECT_EQ(dump(vm), "hidl/android.hardware.camera/hwbinder/soc/msm8892/2.0:"
"hidl/android.hardware.nfc/passthrough/generic/generic/1.0");
EXPECT_EQ(to_string(HalFormat::HIDL), "hidl");
EXPECT_EQ(to_string(HalFormat::NATIVE), "native");
VersionRange v(1, 2, 3);
EXPECT_EQ(to_string(v), "1.2-3");
VersionRange v2;
EXPECT_TRUE(parse("1.2-3", &v2));
EXPECT_EQ(v, v2);
}
TEST_F(LibVintfTest, HalManifestConverter) {
HalManifest vm = testHalManifest();
std::string xml = gHalManifestConverter(vm);
EXPECT_EQ(xml,
"<manifest version=\"1.0\">\n"
" <hal format=\"hidl\">\n"
" <name>android.hardware.camera</name>\n"
" <transport>hwbinder</transport>\n"
" <impl level=\"soc\">msm8892</impl>\n"
" <version>2.0</version>\n"
" </hal>\n"
" <hal format=\"hidl\">\n"
" <name>android.hardware.nfc</name>\n"
" <transport>passthrough</transport>\n"
" <impl level=\"generic\">generic</impl>\n"
" <version>1.0</version>\n"
" </hal>\n"
"</manifest>\n");
}
TEST_F(LibVintfTest, VersionConverter) {
Version v(3, 6);
std::string xml = gVersionConverter(v);
EXPECT_EQ(xml, "<version>3.6</version>\n");
Version v2;
EXPECT_TRUE(gVersionConverter(&v2, xml));
EXPECT_EQ(v, v2);
}
TEST_F(LibVintfTest, HalImplementationConverter) {
HalImplementation hl{ImplLevel::SOC, "msm8992"};
std::string xml = gHalImplementationConverter(hl);
EXPECT_EQ(xml, "<impl level=\"soc\">msm8992</impl>\n");
HalImplementation hl2;
EXPECT_TRUE(gHalImplementationConverter(&hl2, xml));
EXPECT_EQ(hl.impl, hl2.impl);
EXPECT_EQ(hl.implLevel, hl2.implLevel);
}
TEST_F(LibVintfTest, MatrixHalConverter) {
MatrixHal mh{HalFormat::NATIVE, "android.hardware.camera",
{{VersionRange(1,2,3), VersionRange(4,5,6)}},
false /* optional */};
std::string xml = gMatrixHalConverter(mh);
EXPECT_EQ(xml,
"<hal format=\"native\" optional=\"false\">\n"
" <name>android.hardware.camera</name>\n"
" <version>1.2-3</version>\n"
" <version>4.5-6</version>\n"
"</hal>\n");
MatrixHal mh2;
EXPECT_TRUE(gMatrixHalConverter(&mh2, xml));
EXPECT_EQ(mh, mh2);
}
TEST_F(LibVintfTest, KernelConfigTypedValueConverter) {
KernelConfigTypedValue converted;
auto testOne = [] (const KernelConfigTypedValue &original,
const std::string &expectXml) {
std::string xml;
KernelConfigTypedValue converted;
xml = gKernelConfigTypedValueConverter(original);
EXPECT_EQ(xml, expectXml);
EXPECT_TRUE(gKernelConfigTypedValueConverter(&converted, xml));
EXPECT_EQ(original, converted);
};
auto testParse = [] (const KernelConfigTypedValue &original,
const std::string &xml) {
KernelConfigTypedValue converted;
EXPECT_TRUE(gKernelConfigTypedValueConverter(&converted, xml));
EXPECT_EQ(original, converted);
};
testOne(KernelConfigTypedValue("stringvalue"),
"<value type=\"string\">stringvalue</value>\n");
testOne(KernelConfigTypedValue(""),
"<value type=\"string\"></value>\n");
testOne(KernelConfigTypedValue(Tristate::YES),
"<value type=\"tristate\">y</value>\n");
testOne(KernelConfigTypedValue(Tristate::NO),
"<value type=\"tristate\">n</value>\n");
testOne(KernelConfigTypedValue(Tristate::MODULE),
"<value type=\"tristate\">m</value>\n");
EXPECT_FALSE(gKernelConfigTypedValueConverter(&converted,
"<value type=\"tristate\">q</value>\n"));
testOne(KernelConfigTypedValue(KernelConfigRangeValue{4, 20}),
"<value type=\"range\">4-20</value>\n");
testOne(KernelConfigTypedValue(KernelConfigRangeValue{0, UINT64_MAX}),
"<value type=\"range\">0-18446744073709551615</value>\n");
testParse(KernelConfigTypedValue(KernelConfigRangeValue{0, UINT64_MAX}),
"<value type=\"range\">0x0-0xffffffffffffffff</value>\n");
EXPECT_FALSE(gKernelConfigTypedValueConverter(&converted,
"<value type=\"int\">-18446744073709551616</value>\n"));
testOne(KernelConfigTypedValue(INT64_MIN),
"<value type=\"int\">-9223372036854775808</value>\n");
testParse(KernelConfigTypedValue(INT64_MIN),
"<value type=\"int\">0x8000000000000000</value>\n");
testParse(KernelConfigTypedValue(INT64_MIN),
"<value type=\"int\">-0X8000000000000000</value>\n");
testParse(KernelConfigTypedValue(INT64_MIN + 1),
"<value type=\"int\">-0X7FFFFFFFFFFFFFFF</value>\n");
testParse(KernelConfigTypedValue(-0x50),
"<value type=\"int\">-0x50</value>\n");
testOne(KernelConfigTypedValue(0),
"<value type=\"int\">0</value>\n");
// Truncation for underflow.
testParse(KernelConfigTypedValue(1),
"<value type=\"int\">-0xffffffffffffffff</value>\n");
testParse(KernelConfigTypedValue(1),
"<value type=\"int\">-18446744073709551615</value>\n");
testOne(KernelConfigTypedValue(INT64_MAX),
"<value type=\"int\">9223372036854775807</value>\n");
testParse(KernelConfigTypedValue(INT64_MAX),
"<value type=\"int\">0x7FFFFFFFFFFFFFFF</value>\n");
// Truncation for underflow.
testParse(KernelConfigTypedValue(INT64_MAX),
"<value type=\"int\">-9223372036854775809</value>\n");
testParse(KernelConfigTypedValue(-1),
"<value type=\"int\">18446744073709551615</value>\n");
testParse(KernelConfigTypedValue(-1),
"<value type=\"int\">0xffffffffffffffff</value>\n");
EXPECT_FALSE(gKernelConfigTypedValueConverter(&converted,
"<value type=\"int\">18446744073709551616</value>\n"));
}
TEST_F(LibVintfTest, CompatibilityMatrixCoverter) {
CompatibilityMatrix cm;
EXPECT_TRUE(add(cm, MatrixHal{HalFormat::NATIVE, "android.hardware.camera",
{{VersionRange(1,2,3), VersionRange(4,5,6)}},
false /* optional */}));
EXPECT_TRUE(add(cm, MatrixHal{HalFormat::NATIVE, "android.hardware.nfc",
{{VersionRange(4,5,6), VersionRange(10,11,12)}},
true /* optional */}));
EXPECT_TRUE(add(cm, MatrixKernel{KernelVersion(3, 18, 22),
{KernelConfig{"CONFIG_FOO", Tristate::YES}, KernelConfig{"CONFIG_BAR", "stringvalue"}}}));
EXPECT_TRUE(add(cm, MatrixKernel{KernelVersion(4, 4, 1),
{KernelConfig{"CONFIG_BAZ", 20}, KernelConfig{"CONFIG_BAR", KernelConfigRangeValue{3, 5} }}}));
set(cm, Sepolicy(30, {1, 3}));
std::string xml = gCompatibilityMatrixConverter(cm);
EXPECT_EQ(xml,
"<compatibility-matrix version=\"1.0\">\n"
" <hal format=\"native\" optional=\"false\">\n"
" <name>android.hardware.camera</name>\n"
" <version>1.2-3</version>\n"
" <version>4.5-6</version>\n"
" </hal>\n"
" <hal format=\"native\" optional=\"true\">\n"
" <name>android.hardware.nfc</name>\n"
" <version>4.5-6</version>\n"
" <version>10.11-12</version>\n"
" </hal>\n"
" <kernel version=\"3.18\" minlts=\"3.18.22\">\n"
" <config>\n"
" <key>CONFIG_FOO</key>\n"
" <value type=\"tristate\">y</value>\n"
" </config>\n"
" <config>\n"
" <key>CONFIG_BAR</key>\n"
" <value type=\"string\">stringvalue</value>\n"
" </config>\n"
" </kernel>\n"
" <kernel version=\"4.4\" minlts=\"4.4.1\">\n"
" <config>\n"
" <key>CONFIG_BAZ</key>\n"
" <value type=\"int\">20</value>\n"
" </config>\n"
" <config>\n"
" <key>CONFIG_BAR</key>\n"
" <value type=\"range\">3-5</value>\n"
" </config>\n"
" </kernel>\n"
" <sepolicy>\n"
" <kernel-sepolicy-version>30</kernel-sepolicy-version>\n"
" <sepolicy-version>1-3</sepolicy-version>\n"
" </sepolicy>\n"
"</compatibility-matrix>\n");
CompatibilityMatrix cm2;
EXPECT_TRUE(gCompatibilityMatrixConverter(&cm2, xml));
EXPECT_TRUE(isEqual(cm, cm2));
}
TEST_F(LibVintfTest, IsValid) {
EXPECT_TRUE(isValid(ManifestHal()));
ManifestHal invalidHal{
.format = HalFormat::HIDL,
.name = "android.hardware.camera",
.versions = {{Version(2, 0), Version(2, 1)}},
.impl = HalImplementation{ImplLevel::SOC, "msm8892"},
.transport = Transport::PASSTHROUGH
};
EXPECT_FALSE(isValid(invalidHal));
HalManifest vm2;
EXPECT_FALSE(add(vm2, std::move(invalidHal)));
}
TEST_F(LibVintfTest, HalManifestGetHal) {
HalManifest vm = testHalManifest();
EXPECT_NE(getHal(vm, "android.hardware.camera"), nullptr);
EXPECT_EQ(getHal(vm, "non-existent"), nullptr);
std::vector<std::string> arr{"android.hardware.camera", "android.hardware.nfc"};
size_t i = 0;
for (const auto &hal : getHals(vm)) {
EXPECT_EQ(hal.name, arr[i++]);
}
}
TEST_F(LibVintfTest, RuntimeInfo) {
RuntimeInfo ki = testRuntimeInfo();
using KernelConfigs = std::vector<KernelConfig>;
const KernelConfigs configs {
KernelConfig{"CONFIG_64BIT", Tristate::YES},
KernelConfig{"CONFIG_ANDROID_BINDER_DEVICES", "binder,hwbinder"},
KernelConfig{"CONFIG_ARCH_MMAP_RND_BITS", 24},
KernelConfig{"CONFIG_BUILD_ARM64_APPENDED_DTB_IMAGE_NAMES", ""},
KernelConfig{"CONFIG_ILLEGAL_POINTER_VALUE", 0xdead000000000000},
KernelConfig{"CONFIG_NOTEXIST", Tristate::NO},
};
auto testMatrix = [&] (MatrixKernel &&kernel) {
CompatibilityMatrix cm;
add(cm, std::move(kernel));
set(cm, {30, {1, 3}});
return cm;
};
std::string error;
{
MatrixKernel kernel(KernelVersion{4, 4, 1}, KernelConfigs(configs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_FALSE(ki.checkCompatibility(cm)) << "Kernel version shouldn't match";
}
{
MatrixKernel kernel(KernelVersion{3, 18, 22}, KernelConfigs(configs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_TRUE(ki.checkCompatibility(cm, &error)) << error;
}
{
MatrixKernel kernel(KernelVersion{3, 18, 22}, KernelConfigs(configs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
set(cm, Sepolicy{22, {1, 3}});
EXPECT_FALSE(ki.checkCompatibility(cm, &error))
<< "kernel-sepolicy-version shouldn't match";
set(cm, Sepolicy{40, {1, 3}});
EXPECT_FALSE(ki.checkCompatibility(cm, &error))
<< "kernel-sepolicy-version shouldn't match";
}
{
KernelConfigs newConfigs(configs);
newConfigs[0] = KernelConfig{"CONFIG_64BIT", Tristate::NO};
MatrixKernel kernel(KernelVersion{3, 18, 22}, std::move(newConfigs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_FALSE(ki.checkCompatibility(cm)) << "Value shouldn't match for tristate";
}
{
KernelConfigs newConfigs(configs);
newConfigs[0] = KernelConfig{"CONFIG_64BIT", 20};
MatrixKernel kernel(KernelVersion{3, 18, 22}, std::move(newConfigs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_FALSE(ki.checkCompatibility(cm)) << "Type shouldn't match";
}
{
KernelConfigs newConfigs(configs);
newConfigs[1] = KernelConfig{"CONFIG_ANDROID_BINDER_DEVICES", "binder"};
MatrixKernel kernel(KernelVersion{3, 18, 22}, std::move(newConfigs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_FALSE(ki.checkCompatibility(cm)) << "Value shouldn't match for string";
}
{
KernelConfigs newConfigs(configs);
newConfigs[1] = KernelConfig{"CONFIG_ANDROID_BINDER_DEVICES", Tristate::YES};
MatrixKernel kernel(KernelVersion{3, 18, 22}, std::move(newConfigs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_FALSE(ki.checkCompatibility(cm)) << "Type shouldn't match";
}
{
KernelConfigs newConfigs(configs);
newConfigs[2] = KernelConfig{"CONFIG_ARCH_MMAP_RND_BITS", 30};
MatrixKernel kernel(KernelVersion{3, 18, 22}, std::move(newConfigs));
CompatibilityMatrix cm = testMatrix(std::move(kernel));
EXPECT_FALSE(ki.checkCompatibility(cm)) << "Value shouldn't match for integer";
}
}
} // namespace vintf
} // namespace android
int main(int argc, char **argv) {
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}