summaryrefslogtreecommitdiff
path: root/services/vibratorservice/test/VibratorManagerHalWrapperAidlTest.cpp
blob: 1593cb18ec2b979d64f66f984914e870e7c5c5b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
/*
 * Copyright (C) 2020 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 "VibratorManagerHalWrapperAidlTest"

#include <gmock/gmock.h>
#include <gtest/gtest.h>

#include <utils/Log.h>

#include <vibratorservice/VibratorManagerHalWrapper.h>

#include "test_utils.h"

using android::binder::Status;

using android::hardware::vibrator::Braking;
using android::hardware::vibrator::CompositeEffect;
using android::hardware::vibrator::CompositePrimitive;
using android::hardware::vibrator::Effect;
using android::hardware::vibrator::EffectStrength;
using android::hardware::vibrator::IVibrator;
using android::hardware::vibrator::IVibratorCallback;
using android::hardware::vibrator::IVibratorManager;
using android::hardware::vibrator::PrimitivePwle;

using namespace android;
using namespace testing;

static const auto OFF_FN = [](vibrator::HalWrapper* hal) { return hal->off(); };

class MockBinder : public BBinder {
public:
    MOCK_METHOD(status_t, linkToDeath,
                (const sp<DeathRecipient>& recipient, void* cookie, uint32_t flags), (override));
    MOCK_METHOD(status_t, unlinkToDeath,
                (const wp<DeathRecipient>& recipient, void* cookie, uint32_t flags,
                 wp<DeathRecipient>* outRecipient),
                (override));
    MOCK_METHOD(status_t, pingBinder, (), (override));
};

class MockIVibrator : public IVibrator {
public:
    MOCK_METHOD(Status, getCapabilities, (int32_t * ret), (override));
    MOCK_METHOD(Status, off, (), (override));
    MOCK_METHOD(Status, on, (int32_t timeout, const sp<IVibratorCallback>& cb), (override));
    MOCK_METHOD(Status, perform,
                (Effect e, EffectStrength s, const sp<IVibratorCallback>& cb, int32_t* ret),
                (override));
    MOCK_METHOD(Status, getSupportedEffects, (std::vector<Effect> * ret), (override));
    MOCK_METHOD(Status, setAmplitude, (float amplitude), (override));
    MOCK_METHOD(Status, setExternalControl, (bool enabled), (override));
    MOCK_METHOD(Status, getCompositionDelayMax, (int32_t * ret), (override));
    MOCK_METHOD(Status, getCompositionSizeMax, (int32_t * ret), (override));
    MOCK_METHOD(Status, getSupportedPrimitives, (std::vector<CompositePrimitive> * ret),
                (override));
    MOCK_METHOD(Status, getPrimitiveDuration, (CompositePrimitive p, int32_t* ret), (override));
    MOCK_METHOD(Status, compose,
                (const std::vector<CompositeEffect>& e, const sp<IVibratorCallback>& cb),
                (override));
    MOCK_METHOD(Status, composePwle,
                (const std::vector<PrimitivePwle>& e, const sp<IVibratorCallback>& cb), (override));
    MOCK_METHOD(Status, getSupportedAlwaysOnEffects, (std::vector<Effect> * ret), (override));
    MOCK_METHOD(Status, alwaysOnEnable, (int32_t id, Effect e, EffectStrength s), (override));
    MOCK_METHOD(Status, alwaysOnDisable, (int32_t id), (override));
    MOCK_METHOD(Status, getQFactor, (float * ret), (override));
    MOCK_METHOD(Status, getResonantFrequency, (float * ret), (override));
    MOCK_METHOD(Status, getFrequencyResolution, (float* ret), (override));
    MOCK_METHOD(Status, getFrequencyMinimum, (float* ret), (override));
    MOCK_METHOD(Status, getBandwidthAmplitudeMap, (std::vector<float> * ret), (override));
    MOCK_METHOD(Status, getPwlePrimitiveDurationMax, (int32_t * ret), (override));
    MOCK_METHOD(Status, getPwleCompositionSizeMax, (int32_t * ret), (override));
    MOCK_METHOD(Status, getSupportedBraking, (std::vector<Braking> * ret), (override));
    MOCK_METHOD(int32_t, getInterfaceVersion, (), (override));
    MOCK_METHOD(std::string, getInterfaceHash, (), (override));
    MOCK_METHOD(IBinder*, onAsBinder, (), (override));
};

class MockIVibratorManager : public IVibratorManager {
public:
    MOCK_METHOD(Status, getCapabilities, (int32_t * ret), (override));
    MOCK_METHOD(Status, getVibratorIds, (std::vector<int32_t> * ret), (override));
    MOCK_METHOD(Status, getVibrator, (int32_t id, sp<IVibrator>* ret), (override));
    MOCK_METHOD(Status, prepareSynced, (const std::vector<int32_t>& ids), (override));
    MOCK_METHOD(Status, triggerSynced, (const sp<IVibratorCallback>& cb), (override));
    MOCK_METHOD(Status, cancelSynced, (), (override));
    MOCK_METHOD(int32_t, getInterfaceVersion, (), (override));
    MOCK_METHOD(std::string, getInterfaceHash, (), (override));
    MOCK_METHOD(IBinder*, onAsBinder, (), (override));
};

// -------------------------------------------------------------------------------------------------

class VibratorManagerHalWrapperAidlTest : public Test {
public:
    void SetUp() override {
        mMockBinder = new StrictMock<MockBinder>();
        mMockVibrator = new StrictMock<MockIVibrator>();
        mMockHal = new StrictMock<MockIVibratorManager>();
        mMockScheduler = std::make_shared<StrictMock<vibrator::MockCallbackScheduler>>();
        mWrapper = std::make_unique<vibrator::AidlManagerHalWrapper>(mMockScheduler, mMockHal);
        ASSERT_NE(mWrapper, nullptr);
    }

protected:
    std::shared_ptr<StrictMock<vibrator::MockCallbackScheduler>> mMockScheduler = nullptr;
    std::unique_ptr<vibrator::ManagerHalWrapper> mWrapper = nullptr;
    sp<StrictMock<MockIVibratorManager>> mMockHal = nullptr;
    sp<StrictMock<MockIVibrator>> mMockVibrator = nullptr;
    sp<StrictMock<MockBinder>> mMockBinder = nullptr;
};

// -------------------------------------------------------------------------------------------------

static const std::vector<int32_t> kVibratorIds = {1, 2};
static constexpr int kVibratorId = 1;

ACTION(TriggerCallback) {
    if (arg0 != nullptr) {
        arg0->onComplete();
    }
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestPing) {
    EXPECT_CALL(*mMockHal.get(), onAsBinder())
            .Times(Exactly(2))
            .WillRepeatedly(Return(mMockBinder.get()));
    EXPECT_CALL(*mMockBinder.get(), pingBinder())
            .Times(Exactly(2))
            .WillOnce(Return(android::OK))
            .WillRepeatedly(Return(android::DEAD_OBJECT));

    ASSERT_TRUE(mWrapper->ping().isOk());
    ASSERT_TRUE(mWrapper->ping().isFailed());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetCapabilitiesDoesNotCacheFailedResult) {
    EXPECT_CALL(*mMockHal.get(), getCapabilities(_))
            .Times(Exactly(3))
            .WillOnce(
                    Return(Status::fromExceptionCode(Status::Exception::EX_UNSUPPORTED_OPERATION)))
            .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
            .WillRepeatedly(DoAll(SetArgPointee<0>(IVibratorManager::CAP_SYNC), Return(Status())));

    ASSERT_TRUE(mWrapper->getCapabilities().isUnsupported());
    ASSERT_TRUE(mWrapper->getCapabilities().isFailed());

    auto result = mWrapper->getCapabilities();
    ASSERT_TRUE(result.isOk());
    ASSERT_EQ(vibrator::ManagerCapabilities::SYNC, result.value());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetCapabilitiesCachesResult) {
    EXPECT_CALL(*mMockHal.get(), getCapabilities(_))
            .Times(Exactly(1))
            .WillRepeatedly(DoAll(SetArgPointee<0>(IVibratorManager::CAP_SYNC), Return(Status())));

    std::vector<std::thread> threads;
    for (int i = 0; i < 10; i++) {
        threads.push_back(std::thread([&]() {
            auto result = mWrapper->getCapabilities();
            ASSERT_TRUE(result.isOk());
            ASSERT_EQ(vibrator::ManagerCapabilities::SYNC, result.value());
        }));
    }
    std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });

    auto result = mWrapper->getCapabilities();
    ASSERT_TRUE(result.isOk());
    ASSERT_EQ(vibrator::ManagerCapabilities::SYNC, result.value());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetVibratorIdsDoesNotCacheFailedResult) {
    EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
            .Times(Exactly(3))
            .WillOnce(
                    Return(Status::fromExceptionCode(Status::Exception::EX_UNSUPPORTED_OPERATION)))
            .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
            .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

    ASSERT_TRUE(mWrapper->getVibratorIds().isUnsupported());
    ASSERT_TRUE(mWrapper->getVibratorIds().isFailed());

    auto result = mWrapper->getVibratorIds();
    ASSERT_TRUE(result.isOk());
    ASSERT_EQ(kVibratorIds, result.value());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetVibratorIdsCachesResult) {
    EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
            .Times(Exactly(1))
            .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

    std::vector<std::thread> threads;
    for (int i = 0; i < 10; i++) {
        threads.push_back(std::thread([&]() {
            auto result = mWrapper->getVibratorIds();
            ASSERT_TRUE(result.isOk());
            ASSERT_EQ(kVibratorIds, result.value());
        }));
    }
    std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });

    auto result = mWrapper->getVibratorIds();
    ASSERT_TRUE(result.isOk());
    ASSERT_EQ(kVibratorIds, result.value());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetVibratorWithValidIdReturnsController) {
    {
        InSequence seq;
        EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
                .Times(Exactly(1))
                .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

        EXPECT_CALL(*mMockHal.get(), getVibrator(Eq(kVibratorId), _))
                .Times(Exactly(1))
                .WillRepeatedly(DoAll(SetArgPointee<1>(mMockVibrator), Return(Status())));
    }

    auto result = mWrapper->getVibrator(kVibratorId);
    ASSERT_TRUE(result.isOk());
    ASSERT_NE(nullptr, result.value().get());
    ASSERT_TRUE(result.value().get()->init());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetVibratorWithInvalidIdFails) {
    EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
            .Times(Exactly(1))
            .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

    ASSERT_TRUE(mWrapper->getVibrator(0).isFailed());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestGetVibratorRecoversVibratorPointer) {
    EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
            .Times(Exactly(1))
            .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

    EXPECT_CALL(*mMockHal.get(), getVibrator(Eq(kVibratorId), _))
            .Times(Exactly(3))
            .WillOnce(DoAll(SetArgPointee<1>(nullptr),
                            Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY))))
            .WillRepeatedly(DoAll(SetArgPointee<1>(mMockVibrator), Return(Status())));

    EXPECT_CALL(*mMockVibrator.get(), off())
            .Times(Exactly(3))
            .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
            .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
            .WillRepeatedly(Return(Status()));

    // Get vibrator controller is successful even if first getVibrator.
    auto result = mWrapper->getVibrator(kVibratorId);
    ASSERT_TRUE(result.isOk());
    ASSERT_NE(nullptr, result.value().get());

    auto vibrator = result.value();
    // First getVibrator call fails.
    ASSERT_FALSE(vibrator->init());
    // First and second off() calls fail, reload IVibrator with getVibrator.
    ASSERT_TRUE(vibrator->doWithRetry<void>(OFF_FN, "off").isFailed());
    // Third call to off() worked after IVibrator reloaded.
    ASSERT_TRUE(vibrator->doWithRetry<void>(OFF_FN, "off").isOk());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestPrepareSynced) {
    EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
            .Times(Exactly(1))
            .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

    EXPECT_CALL(*mMockHal.get(), getVibrator(_, _))
            .Times(Exactly(2))
            .WillRepeatedly(DoAll(SetArgPointee<1>(mMockVibrator), Return(Status())));

    EXPECT_CALL(*mMockHal.get(), prepareSynced(Eq(kVibratorIds)))
            .Times(Exactly(3))
            .WillOnce(
                    Return(Status::fromExceptionCode(Status::Exception::EX_UNSUPPORTED_OPERATION)))
            .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
            .WillRepeatedly(Return(Status()));

    ASSERT_TRUE(mWrapper->getVibratorIds().isOk());
    ASSERT_TRUE(mWrapper->prepareSynced(kVibratorIds).isUnsupported());
    ASSERT_TRUE(mWrapper->prepareSynced(kVibratorIds).isFailed());
    ASSERT_TRUE(mWrapper->prepareSynced(kVibratorIds).isOk());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestTriggerSyncedWithCallbackSupport) {
    {
        InSequence seq;
        EXPECT_CALL(*mMockHal.get(), getCapabilities(_))
                .Times(Exactly(1))
                .WillRepeatedly(DoAll(SetArgPointee<0>(IVibratorManager::CAP_TRIGGER_CALLBACK),
                                      Return(Status())));
        EXPECT_CALL(*mMockHal.get(), triggerSynced(_))
                .Times(Exactly(3))
                .WillOnce(Return(Status::fromStatusT(UNKNOWN_TRANSACTION)))
                .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
                .WillRepeatedly(DoAll(TriggerCallback(), Return(Status())));
    }

    std::unique_ptr<int32_t> callbackCounter = std::make_unique<int32_t>();
    auto callback = vibrator::TestFactory::createCountingCallback(callbackCounter.get());

    ASSERT_TRUE(mWrapper->triggerSynced(callback).isUnsupported());
    ASSERT_TRUE(mWrapper->triggerSynced(callback).isFailed());
    ASSERT_TRUE(mWrapper->triggerSynced(callback).isOk());
    ASSERT_EQ(1, *callbackCounter.get());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestTriggerSyncedWithoutCallbackSupport) {
    {
        InSequence seq;
        EXPECT_CALL(*mMockHal.get(), getCapabilities(_))
                .Times(Exactly(1))
                .WillRepeatedly(
                        DoAll(SetArgPointee<0>(IVibratorManager::CAP_SYNC), Return(Status())));
        EXPECT_CALL(*mMockHal.get(), triggerSynced(Eq(nullptr)))
                .Times(Exactly(1))
                .WillRepeatedly(Return(Status()));
    }

    std::unique_ptr<int32_t> callbackCounter = std::make_unique<int32_t>();
    auto callback = vibrator::TestFactory::createCountingCallback(callbackCounter.get());

    ASSERT_TRUE(mWrapper->triggerSynced(callback).isOk());
    ASSERT_EQ(0, *callbackCounter.get());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestCancelSynced) {
    EXPECT_CALL(*mMockHal.get(), cancelSynced())
            .Times(Exactly(3))
            .WillOnce(Return(Status::fromStatusT(UNKNOWN_TRANSACTION)))
            .WillOnce(Return(Status::fromExceptionCode(Status::Exception::EX_SECURITY)))
            .WillRepeatedly(Return(Status()));

    ASSERT_TRUE(mWrapper->cancelSynced().isUnsupported());
    ASSERT_TRUE(mWrapper->cancelSynced().isFailed());
    ASSERT_TRUE(mWrapper->cancelSynced().isOk());
}

TEST_F(VibratorManagerHalWrapperAidlTest, TestCancelSyncedReloadsAllControllers) {
    EXPECT_CALL(*mMockHal.get(), getVibratorIds(_))
            .Times(Exactly(1))
            .WillRepeatedly(DoAll(SetArgPointee<0>(kVibratorIds), Return(Status())));

    EXPECT_CALL(*mMockHal.get(), getVibrator(_, _))
            .Times(Exactly(2))
            .WillRepeatedly(DoAll(SetArgPointee<1>(mMockVibrator), Return(Status())));

    EXPECT_CALL(*mMockHal.get(), cancelSynced()).Times(Exactly(1)).WillRepeatedly(Return(Status()));

    ASSERT_TRUE(mWrapper->getVibratorIds().isOk());
    ASSERT_TRUE(mWrapper->cancelSynced().isOk());
}