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 "vibrator_hidl_hal_test"
18
19 #include <android-base/logging.h>
20 #include <android/hardware/vibrator/1.0/types.h>
21 #include <android/hardware/vibrator/1.3/IVibrator.h>
22 #include <gtest/gtest.h>
23 #include <hidl/GtestPrinter.h>
24 #include <hidl/ServiceManagement.h>
25 #include <unistd.h>
26
27 using ::android::sp;
28 using ::android::hardware::hidl_enum_range;
29 using ::android::hardware::Return;
30 using ::android::hardware::Void;
31 using ::android::hardware::vibrator::V1_0::EffectStrength;
32 using ::android::hardware::vibrator::V1_0::Status;
33 using ::android::hardware::vibrator::V1_3::Effect;
34 using ::android::hardware::vibrator::V1_3::IVibrator;
35
36 #define EXPECT_OK(ret) ASSERT_TRUE((ret).isOk())
37
38 // The main test class for VIBRATOR HIDL HAL 1.3.
39 class VibratorHidlTest_1_3 : public ::testing::TestWithParam<std::string> {
40 public:
SetUp()41 virtual void SetUp() override {
42 vibrator = IVibrator::getService(GetParam());
43 ASSERT_NE(vibrator, nullptr);
44 }
45
TearDown()46 virtual void TearDown() override {}
47
48 sp<IVibrator> vibrator;
49 };
50
TEST_P(VibratorHidlTest_1_3,ChangeVibrationalExternalControl)51 TEST_P(VibratorHidlTest_1_3, ChangeVibrationalExternalControl) {
52 if (vibrator->supportsExternalControl()) {
53 EXPECT_EQ(Status::OK, vibrator->setExternalControl(true));
54 sleep(1);
55 EXPECT_EQ(Status::OK, vibrator->setExternalControl(false));
56 sleep(1);
57 }
58 }
59
TEST_P(VibratorHidlTest_1_3,SetExternalControlReturnUnsupportedOperationIfNotSupported)60 TEST_P(VibratorHidlTest_1_3, SetExternalControlReturnUnsupportedOperationIfNotSupported) {
61 if (!vibrator->supportsExternalControl()) {
62 EXPECT_EQ(Status::UNSUPPORTED_OPERATION, vibrator->setExternalControl(true));
63 }
64 }
65
validatePerformEffectUnsupportedOperation(Status status,uint32_t lengthMs)66 static void validatePerformEffectUnsupportedOperation(Status status, uint32_t lengthMs) {
67 ASSERT_EQ(Status::UNSUPPORTED_OPERATION, status);
68 ASSERT_EQ(static_cast<uint32_t>(0), lengthMs)
69 << "Effects that return UNSUPPORTED_OPERATION must have a duration of zero";
70 }
71
validatePerformEffect(Status status,uint32_t lengthMs)72 static void validatePerformEffect(Status status, uint32_t lengthMs) {
73 ASSERT_TRUE(status == Status::OK || status == Status::UNSUPPORTED_OPERATION);
74 if (status == Status::OK) {
75 ASSERT_LT(static_cast<uint32_t>(0), lengthMs)
76 << "Effects that return OK must return a positive duration";
77 } else {
78 validatePerformEffectUnsupportedOperation(status, lengthMs);
79 }
80 }
81
82 /*
83 * Test to make sure effects within the valid range return are either supported and return OK with
84 * a valid duration, or are unsupported and return UNSUPPORTED_OPERATION with a duration of 0.
85 */
TEST_P(VibratorHidlTest_1_3,PerformEffect_1_3)86 TEST_P(VibratorHidlTest_1_3, PerformEffect_1_3) {
87 for (const auto& effect : hidl_enum_range<Effect>()) {
88 for (const auto& strength : hidl_enum_range<EffectStrength>()) {
89 EXPECT_OK(vibrator->perform_1_3(effect, strength, validatePerformEffect));
90 }
91 }
92 }
93
94 /*
95 * Test to make sure effect values above the valid range are rejected.
96 */
TEST_P(VibratorHidlTest_1_3,PerformEffect_1_3_BadEffects_AboveValidRange)97 TEST_P(VibratorHidlTest_1_3, PerformEffect_1_3_BadEffects_AboveValidRange) {
98 Effect effect = *std::prev(hidl_enum_range<Effect>().end());
99 Effect badEffect = static_cast<Effect>(static_cast<int32_t>(effect) + 1);
100 EXPECT_OK(vibrator->perform_1_3(badEffect, EffectStrength::LIGHT,
101 validatePerformEffectUnsupportedOperation));
102 }
103
104 /*
105 * Test to make sure effect values below the valid range are rejected.
106 */
TEST_P(VibratorHidlTest_1_3,PerformEffect_1_3_BadEffects_BelowValidRange)107 TEST_P(VibratorHidlTest_1_3, PerformEffect_1_3_BadEffects_BelowValidRange) {
108 Effect effect = *hidl_enum_range<Effect>().begin();
109 Effect badEffect = static_cast<Effect>(static_cast<int32_t>(effect) - 1);
110 EXPECT_OK(vibrator->perform_1_3(badEffect, EffectStrength::LIGHT,
111 validatePerformEffectUnsupportedOperation));
112 }
113
114 /*
115 * Test to make sure strength values above the valid range are rejected.
116 */
TEST_P(VibratorHidlTest_1_3,PerformEffect_1_3_BadStrength_AboveValidRange)117 TEST_P(VibratorHidlTest_1_3, PerformEffect_1_3_BadStrength_AboveValidRange) {
118 EffectStrength strength = *std::prev(hidl_enum_range<EffectStrength>().end());
119 EffectStrength badStrength = static_cast<EffectStrength>(static_cast<int32_t>(strength) + 1);
120 EXPECT_OK(vibrator->perform_1_3(Effect::THUD, badStrength,
121 validatePerformEffectUnsupportedOperation));
122 }
123
124 /*
125 * Test to make sure strength values below the valid range are rejected.
126 */
TEST_P(VibratorHidlTest_1_3,PerformEffect_1_3_BadStrength_BelowValidRange)127 TEST_P(VibratorHidlTest_1_3, PerformEffect_1_3_BadStrength_BelowValidRange) {
128 EffectStrength strength = *hidl_enum_range<EffectStrength>().begin();
129 EffectStrength badStrength = static_cast<EffectStrength>(static_cast<int32_t>(strength) - 1);
130 EXPECT_OK(vibrator->perform_1_3(Effect::THUD, badStrength,
131 validatePerformEffectUnsupportedOperation));
132 }
133
134 GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(VibratorHidlTest_1_3);
135 INSTANTIATE_TEST_SUITE_P(
136 PerInstance, VibratorHidlTest_1_3,
137 testing::ValuesIn(android::hardware::getAllHalInstanceNames(IVibrator::descriptor)),
138 android::hardware::PrintInstanceNameToString);
139