1 /*
2  * Copyright (C) 2020 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 "VibratorManagerHalControllerTest"
18 
19 #include <cutils/atomic.h>
20 #include <gmock/gmock.h>
21 #include <gtest/gtest.h>
22 
23 #include <utils/Log.h>
24 
25 #include <vibratorservice/VibratorManagerHalController.h>
26 
27 #include "test_utils.h"
28 
29 using android::vibrator::HalController;
30 
31 using namespace android;
32 using namespace testing;
33 
34 static constexpr int MAX_ATTEMPTS = 2;
35 static const std::vector<int32_t> VIBRATOR_IDS = {1, 2};
36 static constexpr int VIBRATOR_ID = 1;
37 
38 class MockManagerHalWrapper : public vibrator::ManagerHalWrapper {
39 public:
40     MOCK_METHOD(void, tryReconnect, (), (override));
41     MOCK_METHOD(vibrator::HalResult<void>, ping, (), (override));
42     MOCK_METHOD(vibrator::HalResult<vibrator::ManagerCapabilities>, getCapabilities, (),
43                 (override));
44     MOCK_METHOD(vibrator::HalResult<std::vector<int32_t>>, getVibratorIds, (), (override));
45     MOCK_METHOD(vibrator::HalResult<std::shared_ptr<HalController>>, getVibrator, (int32_t id),
46                 (override));
47     MOCK_METHOD(vibrator::HalResult<void>, prepareSynced, (const std::vector<int32_t>& ids),
48                 (override));
49     MOCK_METHOD(vibrator::HalResult<void>, triggerSynced,
50                 (const std::function<void()>& completionCallback), (override));
51     MOCK_METHOD(vibrator::HalResult<void>, cancelSynced, (), (override));
52 };
53 
54 class VibratorManagerHalControllerTest : public Test {
55 public:
SetUp()56     void SetUp() override {
57         mConnectCounter = 0;
58         auto callbackScheduler = std::make_shared<vibrator::CallbackScheduler>();
59         mMockHal = std::make_shared<StrictMock<MockManagerHalWrapper>>();
60         auto connector = [this](std::shared_ptr<vibrator::CallbackScheduler>) {
61             android_atomic_inc(&mConnectCounter);
62             return mMockHal;
63         };
64         mController = std::make_unique<vibrator::ManagerHalController>(std::move(callbackScheduler),
65                                                                        connector);
66         ASSERT_NE(mController, nullptr);
67     }
68 
69 protected:
70     int32_t mConnectCounter;
71     std::shared_ptr<MockManagerHalWrapper> mMockHal;
72     std::unique_ptr<vibrator::ManagerHalController> mController;
73 
setHalExpectations(int32_t cardinality,vibrator::HalResult<void> voidResult,vibrator::HalResult<vibrator::ManagerCapabilities> capabilitiesResult,vibrator::HalResult<std::vector<int32_t>> idsResult,vibrator::HalResult<std::shared_ptr<HalController>> vibratorResult)74     void setHalExpectations(int32_t cardinality, vibrator::HalResult<void> voidResult,
75                             vibrator::HalResult<vibrator::ManagerCapabilities> capabilitiesResult,
76                             vibrator::HalResult<std::vector<int32_t>> idsResult,
77                             vibrator::HalResult<std::shared_ptr<HalController>> vibratorResult) {
78         EXPECT_CALL(*mMockHal.get(), ping())
79                 .Times(Exactly(cardinality))
80                 .WillRepeatedly(Return(voidResult));
81         EXPECT_CALL(*mMockHal.get(), getCapabilities())
82                 .Times(Exactly(cardinality))
83                 .WillRepeatedly(Return(capabilitiesResult));
84         EXPECT_CALL(*mMockHal.get(), getVibratorIds())
85                 .Times(Exactly(cardinality))
86                 .WillRepeatedly(Return(idsResult));
87         EXPECT_CALL(*mMockHal.get(), getVibrator(_))
88                 .Times(Exactly(cardinality))
89                 .WillRepeatedly(Return(vibratorResult));
90         EXPECT_CALL(*mMockHal.get(), prepareSynced(_))
91                 .Times(Exactly(cardinality))
92                 .WillRepeatedly(Return(voidResult));
93         EXPECT_CALL(*mMockHal.get(), triggerSynced(_))
94                 .Times(Exactly(cardinality))
95                 .WillRepeatedly(Return(voidResult));
96         EXPECT_CALL(*mMockHal.get(), cancelSynced())
97                 .Times(Exactly(cardinality))
98                 .WillRepeatedly(Return(voidResult));
99 
100         if (cardinality > 1) {
101             // One reconnection for each retry.
102             EXPECT_CALL(*mMockHal.get(), tryReconnect()).Times(Exactly(7 * (cardinality - 1)));
103         } else {
104             EXPECT_CALL(*mMockHal.get(), tryReconnect()).Times(Exactly(0));
105         }
106     }
107 };
108 
TEST_F(VibratorManagerHalControllerTest,TestInit)109 TEST_F(VibratorManagerHalControllerTest, TestInit) {
110     mController->init();
111     ASSERT_EQ(1, mConnectCounter);
112 
113     // Noop when wrapper was already initialized.
114     mController->init();
115     ASSERT_EQ(1, mConnectCounter);
116 }
117 
TEST_F(VibratorManagerHalControllerTest,TestApiCallsAreForwardedToHal)118 TEST_F(VibratorManagerHalControllerTest, TestApiCallsAreForwardedToHal) {
119     setHalExpectations(/* cardinality= */ 1, vibrator::HalResult<void>::ok(),
120                        vibrator::HalResult<vibrator::ManagerCapabilities>::ok(
121                                vibrator::ManagerCapabilities::SYNC),
122                        vibrator::HalResult<std::vector<int32_t>>::ok(VIBRATOR_IDS),
123                        vibrator::HalResult<std::shared_ptr<HalController>>::ok(nullptr));
124 
125     ASSERT_TRUE(mController->ping().isOk());
126 
127     auto getCapabilitiesResult = mController->getCapabilities();
128     ASSERT_TRUE(getCapabilitiesResult.isOk());
129     ASSERT_EQ(vibrator::ManagerCapabilities::SYNC, getCapabilitiesResult.value());
130 
131     auto getVibratorIdsResult = mController->getVibratorIds();
132     ASSERT_TRUE(getVibratorIdsResult.isOk());
133     ASSERT_EQ(VIBRATOR_IDS, getVibratorIdsResult.value());
134 
135     auto getVibratorResult = mController->getVibrator(VIBRATOR_ID);
136     ASSERT_TRUE(getVibratorResult.isOk());
137     ASSERT_EQ(nullptr, getVibratorResult.value());
138 
139     ASSERT_TRUE(mController->prepareSynced(VIBRATOR_IDS).isOk());
140     ASSERT_TRUE(mController->triggerSynced([]() {}).isOk());
141     ASSERT_TRUE(mController->cancelSynced().isOk());
142 
143     ASSERT_EQ(1, mConnectCounter);
144 }
145 
TEST_F(VibratorManagerHalControllerTest,TestUnsupportedApiResultDoesNotResetHalConnection)146 TEST_F(VibratorManagerHalControllerTest, TestUnsupportedApiResultDoesNotResetHalConnection) {
147     setHalExpectations(/* cardinality= */ 1, vibrator::HalResult<void>::unsupported(),
148                        vibrator::HalResult<vibrator::ManagerCapabilities>::unsupported(),
149                        vibrator::HalResult<std::vector<int32_t>>::unsupported(),
150                        vibrator::HalResult<std::shared_ptr<HalController>>::unsupported());
151 
152     ASSERT_TRUE(mController->ping().isUnsupported());
153     ASSERT_TRUE(mController->getCapabilities().isUnsupported());
154     ASSERT_TRUE(mController->getVibratorIds().isUnsupported());
155     ASSERT_TRUE(mController->getVibrator(VIBRATOR_ID).isUnsupported());
156     ASSERT_TRUE(mController->prepareSynced(VIBRATOR_IDS).isUnsupported());
157     ASSERT_TRUE(mController->triggerSynced([]() {}).isUnsupported());
158     ASSERT_TRUE(mController->cancelSynced().isUnsupported());
159 
160     ASSERT_EQ(1, mConnectCounter);
161 }
162 
TEST_F(VibratorManagerHalControllerTest,TestOperationFailedApiResultDoesNotResetHalConnection)163 TEST_F(VibratorManagerHalControllerTest, TestOperationFailedApiResultDoesNotResetHalConnection) {
164     setHalExpectations(/* cardinality= */ 1, vibrator::HalResult<void>::failed("msg"),
165                        vibrator::HalResult<vibrator::ManagerCapabilities>::failed("msg"),
166                        vibrator::HalResult<std::vector<int32_t>>::failed("msg"),
167                        vibrator::HalResult<std::shared_ptr<HalController>>::failed("msg"));
168 
169     ASSERT_TRUE(mController->ping().isFailed());
170     ASSERT_TRUE(mController->getCapabilities().isFailed());
171     ASSERT_TRUE(mController->getVibratorIds().isFailed());
172     ASSERT_TRUE(mController->getVibrator(VIBRATOR_ID).isFailed());
173     ASSERT_TRUE(mController->prepareSynced(VIBRATOR_IDS).isFailed());
174     ASSERT_TRUE(mController->triggerSynced([]() {}).isFailed());
175     ASSERT_TRUE(mController->cancelSynced().isFailed());
176 
177     ASSERT_EQ(1, mConnectCounter);
178 }
179 
TEST_F(VibratorManagerHalControllerTest,TestTransactionFailedApiResultResetsHalConnection)180 TEST_F(VibratorManagerHalControllerTest, TestTransactionFailedApiResultResetsHalConnection) {
181     setHalExpectations(MAX_ATTEMPTS, vibrator::HalResult<void>::transactionFailed("m"),
182                        vibrator::HalResult<vibrator::ManagerCapabilities>::transactionFailed("m"),
183                        vibrator::HalResult<std::vector<int32_t>>::transactionFailed("m"),
184                        vibrator::HalResult<std::shared_ptr<HalController>>::transactionFailed("m"));
185 
186     ASSERT_TRUE(mController->ping().isFailed());
187     ASSERT_TRUE(mController->getCapabilities().isFailed());
188     ASSERT_TRUE(mController->getVibratorIds().isFailed());
189     ASSERT_TRUE(mController->getVibrator(VIBRATOR_ID).isFailed());
190     ASSERT_TRUE(mController->prepareSynced(VIBRATOR_IDS).isFailed());
191     ASSERT_TRUE(mController->triggerSynced([]() {}).isFailed());
192     ASSERT_TRUE(mController->cancelSynced().isFailed());
193 
194     ASSERT_EQ(1, mConnectCounter);
195 }
196 
TEST_F(VibratorManagerHalControllerTest,TestFailedApiResultReturnsSuccessAfterRetries)197 TEST_F(VibratorManagerHalControllerTest, TestFailedApiResultReturnsSuccessAfterRetries) {
198     {
199         InSequence seq;
200         EXPECT_CALL(*mMockHal.get(), ping())
201                 .Times(Exactly(1))
202                 .WillRepeatedly(Return(vibrator::HalResult<void>::transactionFailed("message")));
203         EXPECT_CALL(*mMockHal.get(), tryReconnect()).Times(Exactly(1));
204         EXPECT_CALL(*mMockHal.get(), ping())
205                 .Times(Exactly(1))
206                 .WillRepeatedly(Return(vibrator::HalResult<void>::ok()));
207     }
208 
209     ASSERT_TRUE(mController->ping().isOk());
210     ASSERT_EQ(1, mConnectCounter);
211 }
212 
TEST_F(VibratorManagerHalControllerTest,TestMultiThreadConnectsOnlyOnce)213 TEST_F(VibratorManagerHalControllerTest, TestMultiThreadConnectsOnlyOnce) {
214     ASSERT_EQ(0, mConnectCounter);
215 
216     EXPECT_CALL(*mMockHal.get(), ping())
217             .Times(Exactly(10))
218             .WillRepeatedly(Return(vibrator::HalResult<void>::ok()));
219 
220     std::vector<std::thread> threads;
221     for (int i = 0; i < 10; i++) {
222         threads.push_back(std::thread([&]() { ASSERT_TRUE(mController->ping().isOk()); }));
223     }
224     std::for_each(threads.begin(), threads.end(), [](std::thread& t) { t.join(); });
225 
226     // Connector was called only by the first thread to use the api.
227     ASSERT_EQ(1, mConnectCounter);
228 }
229