1 /*
2  * Copyright (C) 2023 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 #include <aidl/Gtest.h>
18 #include <aidl/Vintf.h>
19 #include <aidl/android/frameworks/vibrator/BnVibratorControlService.h>
20 #include <aidl/android/frameworks/vibrator/BnVibratorController.h>
21 #include <aidl/android/frameworks/vibrator/IVibratorControlService.h>
22 #include <aidl/android/frameworks/vibrator/IVibratorController.h>
23 #include <aidl/android/frameworks/vibrator/ScaleParam.h>
24 #include <android-base/logging.h>
25 #include <android/binder_auto_utils.h>
26 #include <android/binder_manager.h>
27 #include <android/binder_process.h>
28 #include <utils/Condition.h>
29 #include <utils/Mutex.h>
30 
31 namespace android {
32 
33 using ::aidl::android::frameworks::vibrator::BnVibratorController;
34 using ::aidl::android::frameworks::vibrator::BnVibratorControlService;
35 using ::aidl::android::frameworks::vibrator::IVibratorController;
36 using ::aidl::android::frameworks::vibrator::IVibratorControlService;
37 using ::aidl::android::frameworks::vibrator::ScaleParam;
38 using ::aidl::android::frameworks::vibrator::VibrationParam;
39 using ::android::getAidlHalInstanceNames;
40 using ::android::PrintInstanceNameToString;
41 using ndk::SpAIBinder;
42 using ::testing::Eq;
43 using ::testing::InitGoogleTest;
44 using ::testing::TestWithParam;
45 using ::testing::ValuesIn;
46 
generateVibrationParam(int in_typesMask,float scale)47 VibrationParam generateVibrationParam(int in_typesMask, float scale) {
48     ScaleParam scaleParam = ScaleParam();
49     scaleParam.typesMask = in_typesMask;
50     scaleParam.scale = scale;
51     return VibrationParam(scaleParam);
52 }
53 
generateVibrationParams(int in_typesMask,float scale)54 std::vector<VibrationParam> generateVibrationParams(int in_typesMask, float scale) {
55     return {generateVibrationParam(in_typesMask, scale)};
56 }
57 
58 class VibratorController : public BnVibratorController {
59    public:
60     ~VibratorController() override = default;
61 
requestVibrationParams(int in_typesMask,int64_t in_deadlineElapsedRealtimeMillis,const::ndk::SpAIBinder & in_requestToken)62     ndk::ScopedAStatus requestVibrationParams(int in_typesMask,
63                                               int64_t in_deadlineElapsedRealtimeMillis,
64                                               const ::ndk::SpAIBinder& in_requestToken) override {
65         if (in_requestToken == nullptr) {
66             LOG(INFO) << "Vibrator controller failed to process a request for vibration params";
67             return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_ILLEGAL_ARGUMENT));
68         }
69 
70         LOG(INFO) << "Vibrator controller received a request for vibration params for type: "
71                   << in_typesMask << ", with a timeout of: " << in_deadlineElapsedRealtimeMillis;
72 
73         std::shared_ptr<IVibratorControlService> service =
74             IVibratorControlService::fromBinder(in_requestToken);
75 
76         EXPECT_TRUE(service
77                         ->onRequestVibrationParamsComplete(
78                             in_requestToken, generateVibrationParams(in_typesMask, /* scale= */ 1))
79                         .isOk());
80 
81         return ndk::ScopedAStatus::ok();
82     }
83 };
84 
85 class VibratorControlServiceTest : public ::testing::TestWithParam<std::string> {
86    public:
SetUp()87     void SetUp() override {
88         SpAIBinder binder(AServiceManager_waitForService(GetParam().c_str()));
89         service = IVibratorControlService::fromBinder(binder);
90         ASSERT_NE(service, nullptr);
91     }
92 
93     std::shared_ptr<IVibratorControlService> service;
94 };
95 
TEST_P(VibratorControlServiceTest,RegisterAndUnregisterVibratorControllerTest)96 TEST_P(VibratorControlServiceTest, RegisterAndUnregisterVibratorControllerTest) {
97     std::shared_ptr<IVibratorController> vibratorController =
98         ::ndk::SharedRefBase::make<VibratorController>();
99 
100     EXPECT_TRUE(service->registerVibratorController(vibratorController).isOk());
101 
102     EXPECT_TRUE(service->unregisterVibratorController(vibratorController).isOk());
103 }
104 
TEST_P(VibratorControlServiceTest,RegisterAndUnregisterMultipleVibratorControllersTest)105 TEST_P(VibratorControlServiceTest, RegisterAndUnregisterMultipleVibratorControllersTest) {
106     std::shared_ptr<IVibratorController> firstController =
107         ::ndk::SharedRefBase::make<VibratorController>();
108     std::shared_ptr<IVibratorController> secondController =
109         ::ndk::SharedRefBase::make<VibratorController>();
110 
111     EXPECT_TRUE(service->registerVibratorController(firstController).isOk());
112     EXPECT_TRUE(service->registerVibratorController(secondController).isOk());
113 
114     EXPECT_TRUE(service->unregisterVibratorController(firstController).isOk());
115     EXPECT_TRUE(service->unregisterVibratorController(secondController).isOk());
116 }
117 
TEST_P(VibratorControlServiceTest,SetAndClearVibrationParamsTest)118 TEST_P(VibratorControlServiceTest, SetAndClearVibrationParamsTest) {
119     std::shared_ptr<IVibratorController> vibratorController =
120         ::ndk::SharedRefBase::make<VibratorController>();
121 
122     EXPECT_TRUE(service->registerVibratorController(vibratorController).isOk());
123 
124     // Set empty params
125     EXPECT_TRUE(service->setVibrationParams({}, vibratorController->getDefaultImpl()).isOk());
126 
127     // Set single param
128     EXPECT_TRUE(
129         service
130             ->setVibrationParams({generateVibrationParam(ScaleParam::TYPE_ALARM, /* scale= */ 1)},
131                                  vibratorController->getDefaultImpl())
132             .isOk());
133 
134     // Set multiple params
135     EXPECT_TRUE(service
136                     ->setVibrationParams(
137                         {generateVibrationParam(ScaleParam::TYPE_ALARM, /* scale= */ 1),
138                          generateVibrationParam(ScaleParam::TYPE_RINGTONE, /* scale= */ 1)},
139                         vibratorController->getDefaultImpl())
140                     .isOk());
141 
142     // Clear params
143     EXPECT_TRUE(
144         service->clearVibrationParams(ScaleParam::TYPE_ALARM, vibratorController->getDefaultImpl())
145             .isOk());
146 
147     EXPECT_TRUE(service->unregisterVibratorController(vibratorController).isOk());
148 }
149 
TEST_P(VibratorControlServiceTest,UnregisteredControllerSetAndClearVibrationParamsTest)150 TEST_P(VibratorControlServiceTest, UnregisteredControllerSetAndClearVibrationParamsTest) {
151     std::shared_ptr<IVibratorController> vibratorController =
152         ::ndk::SharedRefBase::make<VibratorController>();
153 
154     EXPECT_TRUE(
155         service
156             ->setVibrationParams(generateVibrationParams(ScaleParam::TYPE_MEDIA, /* scale= */ 1),
157                                  vibratorController->getDefaultImpl())
158             .isOk());
159 
160     EXPECT_TRUE(
161         service->clearVibrationParams(ScaleParam::TYPE_MEDIA, vibratorController->getDefaultImpl())
162             .isOk());
163 }
164 
TEST_P(VibratorControlServiceTest,UnexpectedRequestTokenOnRequestVibrationParamsCompleteTest)165 TEST_P(VibratorControlServiceTest, UnexpectedRequestTokenOnRequestVibrationParamsCompleteTest) {
166     std::shared_ptr<IVibratorController> vibratorController =
167         ::ndk::SharedRefBase::make<VibratorController>();
168 
169     auto unexpectedRequestToken = service->asBinder();
170 
171     // Empty params
172     EXPECT_TRUE(service->onRequestVibrationParamsComplete(unexpectedRequestToken, {}).isOk());
173 
174     // Single param
175     EXPECT_TRUE(service
176                     ->onRequestVibrationParamsComplete(
177                         unexpectedRequestToken,
178                         generateVibrationParams(ScaleParam::TYPE_ALARM, /* scale= */ 1))
179                     .isOk());
180 
181     // Multiple params
182     EXPECT_TRUE(service
183                     ->onRequestVibrationParamsComplete(
184                         unexpectedRequestToken,
185                         {generateVibrationParam(ScaleParam::TYPE_ALARM, /* scale= */ 1),
186                          generateVibrationParam(ScaleParam::TYPE_RINGTONE, /* scale= */ 1)})
187                     .isOk());
188 
189     EXPECT_TRUE(service->unregisterVibratorController(vibratorController).isOk());
190 }
191 
192 GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(VibratorControlServiceTest);
193 
194 INSTANTIATE_TEST_SUITE_P(
195     PerInstance, VibratorControlServiceTest,
196     testing::ValuesIn(getAidlHalInstanceNames(IVibratorControlService::descriptor)),
197     PrintInstanceNameToString);
198 
main(int argc,char ** argv)199 int main(int argc, char** argv) {
200     InitGoogleTest(&argc, argv);
201     ABinderProcess_setThreadPoolMaxThreadCount(/* numThreads= */ 1);
202     ABinderProcess_startThreadPool();
203     return RUN_ALL_TESTS();
204 }
205 }  // namespace android
206