test_main.cpp revision aa661fc957c8d3acbc0abd409f5e4a16a65ce3b1 
1/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define LOG_TAG "LibHidlTest"
18
19#include <android-base/logging.h>
20#include <condition_variable>
21#include <gmock/gmock.h>
22#include <gtest/gtest.h>
23#include <hidl/HidlSupport.h>
24#include <hidl/Status.h>
25#include <hidl/TaskRunner.h>
26#include <vector>
27
28#define EXPECT_ARRAYEQ(__a1__, __a2__, __size__) EXPECT_TRUE(isArrayEqual(__a1__, __a2__, __size__))
29#define EXPECT_2DARRAYEQ(__a1__, __a2__, __size1__, __size2__) \
30        EXPECT_TRUE(is2dArrayEqual(__a1__, __a2__, __size1__, __size2__))
31
32template<typename T, typename S>
33static inline bool isArrayEqual(const T arr1, const S arr2, size_t size) {
34    for(size_t i = 0; i < size; i++)
35        if(arr1[i] != arr2[i])
36            return false;
37    return true;
38}
39
40template<typename T, typename S>
41static inline bool is2dArrayEqual(const T arr1, const S arr2, size_t size1, size_t size2) {
42    for(size_t i = 0; i < size1; i++)
43        for (size_t j = 0; j < size2; j++)
44            if(arr1[i][j] != arr2[i][j])
45                return false;
46    return true;
47}
48
49class LibHidlTest : public ::testing::Test {
50public:
51    virtual void SetUp() override {
52    }
53    virtual void TearDown() override {
54    }
55};
56
57TEST_F(LibHidlTest, StringTest) {
58    using android::hardware::hidl_string;
59    hidl_string s; // empty constructor
60    EXPECT_STREQ(s.c_str(), "");
61    hidl_string s1 = "s1"; // copy = from cstr
62    EXPECT_STREQ(s1.c_str(), "s1");
63    hidl_string s2("s2"); // copy constructor from cstr
64    EXPECT_STREQ(s2.c_str(), "s2");
65    hidl_string s2a(nullptr); // copy constructor from null cstr
66    EXPECT_STREQ("", s2a.c_str());
67    s2a = nullptr; // = from nullptr cstr
68    EXPECT_STREQ(s2a.c_str(), "");
69    hidl_string s3 = hidl_string("s3"); // move =
70    EXPECT_STREQ(s3.c_str(), "s3");
71    hidl_string s4 = hidl_string("12345", 3); // copy constructor from cstr w/ length
72    EXPECT_STREQ(s4.c_str(), "123");
73    hidl_string s5(hidl_string(hidl_string("s5"))); // move constructor
74    EXPECT_STREQ(s5.c_str(), "s5");
75    hidl_string s6(std::string("s6")); // copy constructor from std::string
76    EXPECT_STREQ(s6.c_str(), "s6");
77    hidl_string s7 = std::string("s7"); // copy = from std::string
78    EXPECT_STREQ(s7.c_str(), "s7");
79    hidl_string s8(s7); // copy constructor // NOLINT, test the copy constructor
80    EXPECT_STREQ(s8.c_str(), "s7");
81    hidl_string s9 = s8; // copy =  // NOLINT, test the copy operator
82    EXPECT_STREQ(s9.c_str(), "s7");
83    char myCString[20] = "myCString";
84    s.setToExternal(&myCString[0], strlen(myCString));
85    EXPECT_STREQ(s.c_str(), "myCString");
86    myCString[2] = 'D';
87    EXPECT_STREQ(s.c_str(), "myDString");
88    s.clear(); // should not affect myCString
89    EXPECT_STREQ(myCString, "myDString");
90
91    // casts
92    s = "great";
93    std::string myString = s;
94    const char *anotherCString = s.c_str();
95    EXPECT_EQ(myString, "great");
96    EXPECT_STREQ(anotherCString, "great");
97
98    const hidl_string t = "not so great";
99    std::string myTString = t;
100    const char * anotherTCString = t.c_str();
101    EXPECT_EQ(myTString, "not so great");
102    EXPECT_STREQ(anotherTCString, "not so great");
103
104    // Assignment from hidl_string to std::string
105    std::string tgt;
106    hidl_string src("some stuff");
107    tgt = src;
108    EXPECT_STREQ(tgt.c_str(), "some stuff");
109
110    // Stream output operator
111    hidl_string msg("hidl_string works with operator<<");
112    std::cout << msg;
113
114    // Comparisons
115    const char * cstr1 = "abc";
116    std::string string1(cstr1);
117    hidl_string hs1(cstr1);
118    const char * cstrE = "abc";
119    std::string stringE(cstrE);
120    hidl_string hsE(cstrE);
121    const char * cstrNE = "ABC";
122    std::string stringNE(cstrNE);
123    hidl_string hsNE(cstrNE);
124    const char * cstr2 = "def";
125    std::string string2(cstr2);
126    hidl_string hs2(cstr2);
127
128    EXPECT_TRUE(hs1  == hsE);
129    EXPECT_FALSE(hs1 == hsNE);
130    EXPECT_TRUE(hs1  == cstrE);
131    EXPECT_FALSE(hs1 == cstrNE);
132    EXPECT_TRUE(hs1  == stringE);
133    EXPECT_FALSE(hs1 == stringNE);
134    EXPECT_FALSE(hs1 != hsE);
135    EXPECT_TRUE(hs1  != hsNE);
136    EXPECT_FALSE(hs1 != cstrE);
137    EXPECT_TRUE(hs1  != cstrNE);
138    EXPECT_FALSE(hs1 != stringE);
139    EXPECT_TRUE(hs1  != stringNE);
140
141    EXPECT_TRUE(hs1 < hs2);
142    EXPECT_FALSE(hs2 < hs1);
143    EXPECT_TRUE(hs2 > hs1);
144    EXPECT_FALSE(hs1 > hs2);
145    EXPECT_TRUE(hs1 <= hs1);
146    EXPECT_TRUE(hs1 <= hs2);
147    EXPECT_FALSE(hs2 <= hs1);
148    EXPECT_TRUE(hs1 >= hs1);
149    EXPECT_TRUE(hs2 >= hs1);
150    EXPECT_FALSE(hs2 <= hs1);
151}
152
153TEST_F(LibHidlTest, MemoryTest) {
154    using android::hardware::hidl_memory;
155
156    hidl_memory mem1 = hidl_memory(); // default constructor
157    hidl_memory mem2 = mem1; // copy constructor (nullptr), NOLINT
158
159    EXPECT_EQ(nullptr, mem2.handle());
160
161    native_handle_t* testHandle = native_handle_create(0 /* numInts */, 0 /* numFds */);
162
163    hidl_memory mem3 = hidl_memory("foo", testHandle, 42 /* size */); // owns testHandle
164    hidl_memory mem4 = mem3; // copy constructor (regular handle), NOLINT
165
166    EXPECT_EQ(mem3.name(), mem4.name());
167    EXPECT_EQ(mem3.size(), mem4.size());
168    EXPECT_NE(nullptr, mem4.handle());
169    EXPECT_NE(mem3.handle(), mem4.handle()); // check handle cloned
170
171    hidl_memory mem5 = hidl_memory("foo", nullptr, 0); // hidl memory works with nullptr handle
172    hidl_memory mem6 = mem5; // NOLINT, test copying
173    EXPECT_EQ(nullptr, mem5.handle());
174    EXPECT_EQ(nullptr, mem6.handle());
175}
176
177TEST_F(LibHidlTest, VecInitTest) {
178    using android::hardware::hidl_vec;
179    using std::vector;
180    int32_t array[] = {5, 6, 7};
181    vector<int32_t> v(array, array + 3);
182
183    hidl_vec<int32_t> hv0(3);  // size
184    EXPECT_EQ(hv0.size(), 3ul);  // cannot say anything about its contents
185
186    hidl_vec<int32_t> hv1 = v; // copy =
187    EXPECT_ARRAYEQ(hv1, array, 3);
188    EXPECT_ARRAYEQ(hv1, v, 3);
189    hidl_vec<int32_t> hv2(v); // copy constructor
190    EXPECT_ARRAYEQ(hv2, v, 3);
191
192    vector<int32_t> v2 = hv1; // cast
193    EXPECT_ARRAYEQ(v2, v, 3);
194
195    hidl_vec<int32_t> v3 = {5, 6, 7}; // initializer_list
196    EXPECT_EQ(v3.size(), 3ul);
197    EXPECT_ARRAYEQ(v3, array, v3.size());
198}
199
200TEST_F(LibHidlTest, VecIterTest) {
201    int32_t array[] = {5, 6, 7};
202    android::hardware::hidl_vec<int32_t> hv1 = std::vector<int32_t>(array, array + 3);
203
204    auto iter = hv1.begin();    // iterator begin()
205    EXPECT_EQ(*iter++, 5);
206    EXPECT_EQ(*iter, 6);
207    EXPECT_EQ(*++iter, 7);
208    EXPECT_EQ(*iter--, 7);
209    EXPECT_EQ(*iter, 6);
210    EXPECT_EQ(*--iter, 5);
211
212    iter += 2;
213    EXPECT_EQ(*iter, 7);
214    iter -= 2;
215    EXPECT_EQ(*iter, 5);
216
217    iter++;
218    EXPECT_EQ(*(iter + 1), 7);
219    EXPECT_EQ(*(1 + iter), 7);
220    EXPECT_EQ(*(iter - 1), 5);
221    EXPECT_EQ(*iter, 6);
222
223    auto five = iter - 1;
224    auto seven = iter + 1;
225    EXPECT_EQ(seven - five, 2);
226    EXPECT_EQ(five - seven, -2);
227
228    EXPECT_LT(five, seven);
229    EXPECT_LE(five, seven);
230    EXPECT_GT(seven, five);
231    EXPECT_GE(seven, five);
232
233    EXPECT_EQ(seven[0], 7);
234    EXPECT_EQ(five[1], 6);
235}
236
237TEST_F(LibHidlTest, VecIterForTest) {
238    using android::hardware::hidl_vec;
239    int32_t array[] = {5, 6, 7};
240    hidl_vec<int32_t> hv1 = std::vector<int32_t>(array, array + 3);
241
242    int32_t sum = 0;            // range based for loop interoperability
243    for (auto &&i: hv1) {
244        sum += i;
245    }
246    EXPECT_EQ(sum, 5+6+7);
247
248    for (auto iter = hv1.begin(); iter < hv1.end(); ++iter) {
249        *iter += 10;
250    }
251    const hidl_vec<int32_t> &v4 = hv1;
252    sum = 0;
253    for (const auto &i : v4) {
254        sum += i;
255    }
256    EXPECT_EQ(sum, 15+16+17);
257}
258
259TEST_F(LibHidlTest, VecEqTest) {
260    android::hardware::hidl_vec<int32_t> hv1{5, 6, 7};
261    android::hardware::hidl_vec<int32_t> hv2{5, 6, 7};
262    android::hardware::hidl_vec<int32_t> hv3{5, 6, 8};
263
264    // use the == and != operator intentionally here
265    EXPECT_TRUE(hv1 == hv2);
266    EXPECT_TRUE(hv1 != hv3);
267}
268
269TEST_F(LibHidlTest, VecRangeCtorTest) {
270    struct ConvertibleType {
271        int val;
272
273        explicit ConvertibleType(int val) : val(val) {}
274        explicit operator int() const { return val; }
275        bool operator==(const int& other) const { return val == other; }
276    };
277
278    std::vector<ConvertibleType> input{
279        ConvertibleType(1), ConvertibleType(2), ConvertibleType(3),
280    };
281
282    android::hardware::hidl_vec<int> hv(input.begin(), input.end());
283
284    EXPECT_EQ(input.size(), hv.size());
285    int sum = 0;
286    for (unsigned i = 0; i < input.size(); i++) {
287        EXPECT_EQ(input[i], hv[i]);
288        sum += hv[i];
289    }
290    EXPECT_EQ(sum, 1 + 2 + 3);
291}
292
293TEST_F(LibHidlTest, ArrayTest) {
294    using android::hardware::hidl_array;
295    int32_t array[] = {5, 6, 7};
296
297    hidl_array<int32_t, 3> ha(array);
298    EXPECT_ARRAYEQ(ha, array, 3);
299}
300
301TEST_F(LibHidlTest, TaskRunnerTest) {
302    using android::hardware::details::TaskRunner;
303    using namespace std::chrono_literals;
304
305    std::condition_variable cv;
306    std::mutex m;
307
308    TaskRunner tr;
309    tr.start(1 /* limit */);
310    bool flag = false;
311    tr.push([&] {
312        flag = true;
313        cv.notify_all();
314    });
315
316    std::unique_lock<std::mutex> lock(m);
317
318    // 1s so this doesn't deadlock. This isn't a performance test.
319    EXPECT_TRUE(cv.wait_for(lock, 1s, [&]{return flag;}));
320    EXPECT_TRUE(flag);
321}
322
323TEST_F(LibHidlTest, StringCmpTest) {
324    using android::hardware::hidl_string;
325    const char * s = "good";
326    hidl_string hs(s);
327    EXPECT_NE(hs.c_str(), s);
328
329    EXPECT_TRUE(hs == s); // operator ==
330    EXPECT_TRUE(s == hs);
331
332    EXPECT_FALSE(hs != s); // operator ==
333    EXPECT_FALSE(s != hs);
334}
335
336template <typename T>
337void great(android::hardware::hidl_vec<T>) {}
338
339TEST_F(LibHidlTest, VecCopyTest) {
340    android::hardware::hidl_vec<int32_t> v;
341    great(v);
342}
343
344TEST_F(LibHidlTest, StdArrayTest) {
345    using android::hardware::hidl_array;
346    hidl_array<int32_t, 5> array{(int32_t[5]){1, 2, 3, 4, 5}};
347    std::array<int32_t, 5> stdArray = array;
348    EXPECT_ARRAYEQ(array.data(), stdArray.data(), 5);
349    hidl_array<int32_t, 5> array2 = stdArray;
350    EXPECT_ARRAYEQ(array.data(), array2.data(), 5);
351}
352
353TEST_F(LibHidlTest, MultiDimStdArrayTest) {
354    using android::hardware::hidl_array;
355    hidl_array<int32_t, 2, 3> array;
356    for (size_t i = 0; i < 2; i++) {
357        for (size_t j = 0; j < 3; j++) {
358            array[i][j] = i + j + i * j;
359        }
360    }
361    std::array<std::array<int32_t, 3>, 2> stdArray = array;
362    EXPECT_2DARRAYEQ(array, stdArray, 2, 3);
363    hidl_array<int32_t, 2, 3> array2 = stdArray;
364    EXPECT_2DARRAYEQ(array, array2, 2, 3);
365}
366
367TEST_F(LibHidlTest, HidlVersionTest) {
368    using android::hardware::hidl_version;
369    hidl_version v1_0{1, 0};
370    EXPECT_EQ(1, v1_0.get_major());
371    EXPECT_EQ(0, v1_0.get_minor());
372    hidl_version v2_0{2, 0};
373    hidl_version v2_1{2, 1};
374    hidl_version v2_2{2, 2};
375    hidl_version v3_0{3, 0};
376    hidl_version v3_0b{3,0};
377
378    EXPECT_TRUE(v1_0 < v2_0);
379    EXPECT_TRUE(v2_0 < v2_1);
380    EXPECT_TRUE(v2_1 < v3_0);
381    EXPECT_TRUE(v2_0 > v1_0);
382    EXPECT_TRUE(v2_1 > v2_0);
383    EXPECT_TRUE(v3_0 > v2_1);
384    EXPECT_TRUE(v3_0 == v3_0b);
385    EXPECT_TRUE(v3_0 <= v3_0b);
386    EXPECT_TRUE(v2_2 <= v3_0);
387    EXPECT_TRUE(v3_0 >= v3_0b);
388    EXPECT_TRUE(v3_0 >= v2_2);
389}
390
391TEST_F(LibHidlTest, ReturnMoveTest) {
392    using namespace ::android;
393    using ::android::hardware::Return;
394    using ::android::hardware::Status;
395    Return<void> ret{Status::fromStatusT(DEAD_OBJECT)};
396    ret.isOk();
397    ret = {Status::fromStatusT(DEAD_OBJECT)};
398    ret.isOk();
399}
400
401TEST_F(LibHidlTest, ReturnTest) {
402    using ::android::DEAD_OBJECT;
403    using ::android::hardware::Return;
404    using ::android::hardware::Status;
405    using ::android::hardware::hidl_string;
406
407    EXPECT_FALSE(Return<void>(Status::fromStatusT(DEAD_OBJECT)).isOk());
408    EXPECT_TRUE(Return<void>(Status::ok()).isOk());
409
410    hidl_string one = "1";
411    hidl_string two = "2";
412    Return<hidl_string> ret = Return<hidl_string>(Status::fromStatusT(DEAD_OBJECT));
413
414    EXPECT_EQ(one, Return<hidl_string>(one).withDefault(two));
415    EXPECT_EQ(two, ret.withDefault(two));
416
417    hidl_string&& moved = ret.withDefault(std::move(two));
418    EXPECT_EQ("2", moved);
419
420    const hidl_string three = "3";
421    EXPECT_EQ(three, ret.withDefault(three));
422}
423
424std::string toString(const ::android::hardware::Status &s) {
425    using ::android::hardware::operator<<;
426    std::ostringstream oss;
427    oss << s;
428    return oss.str();
429}
430
431TEST_F(LibHidlTest, StatusStringTest) {
432    using namespace ::android;
433    using ::android::hardware::Status;
434    using ::testing::HasSubstr;
435
436    EXPECT_EQ(toString(Status::ok()), "No error");
437
438    EXPECT_THAT(toString(Status::fromStatusT(DEAD_OBJECT)), HasSubstr("DEAD_OBJECT"));
439
440    EXPECT_THAT(toString(Status::fromStatusT(-EBUSY)), HasSubstr("busy"));
441
442    EXPECT_THAT(toString(Status::fromExceptionCode(Status::EX_NULL_POINTER)),
443            HasSubstr("EX_NULL_POINTER"));
444
445}
446
447int main(int argc, char **argv) {
448    ::testing::InitGoogleTest(&argc, argv);
449    return RUN_ALL_TESTS();
450}
451