xref: /aosp_15_r20/frameworks/native/services/inputflinger/tests/InterfaceMocks.h (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1 /*
2  * Copyright 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 #pragma once
18 
19 #include <cstdint>
20 #include <list>
21 #include <memory>
22 #include <optional>
23 #include <string>
24 #include <unordered_map>
25 #include <utility>
26 #include <vector>
27 
28 #include <EventHub.h>
29 #include <InputDevice.h>
30 #include <InputReaderBase.h>
31 #include <InputReaderContext.h>
32 #include <NotifyArgs.h>
33 #include <PointerChoreographerPolicyInterface.h>
34 #include <StylusState.h>
35 #include <VibrationElement.h>
36 #include <android-base/logging.h>
37 #include <android-base/result.h>
38 #include <gmock/gmock.h>
39 #include <input/InputDevice.h>
40 #include <input/KeyCharacterMap.h>
41 #include <input/KeyLayoutMap.h>
42 #include <input/KeyboardClassifier.h>
43 #include <input/PropertyMap.h>
44 #include <input/TouchVideoFrame.h>
45 #include <input/VirtualKeyMap.h>
46 #include <utils/Errors.h>
47 #include <utils/Timers.h>
48 
49 namespace android {
50 
51 class MockInputReaderContext : public InputReaderContext {
52 public:
53     MOCK_METHOD(void, updateGlobalMetaState, (), (override));
54     MOCK_METHOD(int32_t, getGlobalMetaState, (), (override));
55 
56     MOCK_METHOD(void, disableVirtualKeysUntil, (nsecs_t time), (override));
57     MOCK_METHOD(bool, shouldDropVirtualKey, (nsecs_t now, int32_t keyCode, int32_t scanCode),
58                 (override));
59 
60     MOCK_METHOD(void, requestTimeoutAtTime, (nsecs_t when), (override));
bumpGeneration()61     int32_t bumpGeneration() override { return ++mGeneration; }
62 
63     MOCK_METHOD(void, getExternalStylusDevices, (std::vector<InputDeviceInfo>& outDevices),
64                 (override));
65     MOCK_METHOD(std::list<NotifyArgs>, dispatchExternalStylusState, (const StylusState& outState),
66                 (override));
67 
68     MOCK_METHOD(InputReaderPolicyInterface*, getPolicy, (), (override));
69     MOCK_METHOD(EventHubInterface*, getEventHub, (), (override));
70 
getNextId()71     int32_t getNextId() override { return 1; };
72 
73     MOCK_METHOD(void, updateLedMetaState, (int32_t metaState), (override));
74     MOCK_METHOD(int32_t, getLedMetaState, (), (override));
75 
76     MOCK_METHOD(void, setPreventingTouchpadTaps, (bool prevent), (override));
77     MOCK_METHOD(bool, isPreventingTouchpadTaps, (), (override));
78 
79     MOCK_METHOD(void, setLastKeyDownTimestamp, (nsecs_t when));
80     MOCK_METHOD(nsecs_t, getLastKeyDownTimestamp, ());
81 
getKeyboardClassifier()82     KeyboardClassifier& getKeyboardClassifier() override { return *mClassifier; };
83 
84 private:
85     int32_t mGeneration = 0;
86     std::unique_ptr<KeyboardClassifier> mClassifier = std::make_unique<KeyboardClassifier>();
87 };
88 
89 class MockEventHubInterface : public EventHubInterface {
90 public:
91     MOCK_METHOD(ftl::Flags<InputDeviceClass>, getDeviceClasses, (int32_t deviceId), (const));
92     MOCK_METHOD(InputDeviceIdentifier, getDeviceIdentifier, (int32_t deviceId), (const));
93     MOCK_METHOD(int32_t, getDeviceControllerNumber, (int32_t deviceId), (const));
94     MOCK_METHOD(std::optional<PropertyMap>, getConfiguration, (int32_t deviceId), (const));
95     MOCK_METHOD(std::optional<RawAbsoluteAxisInfo>, getAbsoluteAxisInfo,
96                 (int32_t deviceId, int axis), (const));
97     MOCK_METHOD(bool, hasRelativeAxis, (int32_t deviceId, int axis), (const));
98     MOCK_METHOD(bool, hasInputProperty, (int32_t deviceId, int property), (const));
99     MOCK_METHOD(bool, hasMscEvent, (int32_t deviceId, int mscEvent), (const));
100     MOCK_METHOD(void, setKeyRemapping,
101                 (int32_t deviceId, (const std::map<int32_t, int32_t>& keyRemapping)), (const));
102     MOCK_METHOD(status_t, mapKey,
103                 (int32_t deviceId, int scanCode, int usageCode, int32_t metaState,
104                  int32_t* outKeycode, int32_t* outMetaState, uint32_t* outFlags),
105                 (const));
106     MOCK_METHOD(status_t, mapAxis, (int32_t deviceId, int scanCode, AxisInfo* outAxisInfo),
107                 (const));
108     MOCK_METHOD(void, setExcludedDevices, (const std::vector<std::string>& devices));
109     MOCK_METHOD(std::vector<RawEvent>, getEvents, (int timeoutMillis));
110     MOCK_METHOD(std::vector<TouchVideoFrame>, getVideoFrames, (int32_t deviceId));
111     MOCK_METHOD((base::Result<std::pair<InputDeviceSensorType, int32_t>>), mapSensor,
112                 (int32_t deviceId, int32_t absCode), (const, override));
113     MOCK_METHOD(std::vector<int32_t>, getRawBatteryIds, (int32_t deviceId), (const, override));
114     MOCK_METHOD(std::optional<RawBatteryInfo>, getRawBatteryInfo,
115                 (int32_t deviceId, int32_t BatteryId), (const, override));
116     MOCK_METHOD(std::vector<int32_t>, getRawLightIds, (int32_t deviceId), (const, override));
117     MOCK_METHOD(std::optional<RawLightInfo>, getRawLightInfo, (int32_t deviceId, int32_t lightId),
118                 (const, override));
119     MOCK_METHOD(std::optional<int32_t>, getLightBrightness, (int32_t deviceId, int32_t lightId),
120                 (const, override));
121     MOCK_METHOD(void, setLightBrightness, (int32_t deviceId, int32_t lightId, int32_t brightness),
122                 (override));
123     MOCK_METHOD((std::optional<std::unordered_map<LightColor, int32_t>>), getLightIntensities,
124                 (int32_t deviceId, int32_t lightId), (const, override));
125     MOCK_METHOD(void, setLightIntensities,
126                 (int32_t deviceId, int32_t lightId,
127                  (std::unordered_map<LightColor, int32_t>)intensities),
128                 (override));
129 
130     MOCK_METHOD(std::optional<RawLayoutInfo>, getRawLayoutInfo, (int32_t deviceId),
131                 (const, override));
132     MOCK_METHOD(int32_t, getScanCodeState, (int32_t deviceId, int32_t scanCode), (const, override));
133     MOCK_METHOD(int32_t, getKeyCodeState, (int32_t deviceId, int32_t keyCode), (const, override));
134     MOCK_METHOD(int32_t, getSwitchState, (int32_t deviceId, int32_t sw), (const, override));
135 
136     MOCK_METHOD(std::optional<int32_t>, getAbsoluteAxisValue, (int32_t deviceId, int32_t axis),
137                 (const, override));
138     MOCK_METHOD(base::Result<std::vector<int32_t>>, getMtSlotValues,
139                 (int32_t deviceId, int32_t axis, size_t slotCount), (const, override));
140 
141     MOCK_METHOD(int32_t, getKeyCodeForKeyLocation, (int32_t deviceId, int32_t locationKeyCode),
142                 (const, override));
143     MOCK_METHOD(bool, markSupportedKeyCodes,
144                 (int32_t deviceId, const std::vector<int32_t>& keyCodes, uint8_t* outFlags),
145                 (const, override));
146 
147     MOCK_METHOD(bool, hasScanCode, (int32_t deviceId, int32_t scanCode), (const, override));
148 
149     MOCK_METHOD(bool, hasKeyCode, (int32_t deviceId, int32_t keyCode), (const, override));
150 
151     MOCK_METHOD(bool, hasLed, (int32_t deviceId, int32_t led), (const, override));
152 
153     MOCK_METHOD(void, setLedState, (int32_t deviceId, int32_t led, bool on), (override));
154 
155     MOCK_METHOD(void, getVirtualKeyDefinitions,
156                 (int32_t deviceId, std::vector<VirtualKeyDefinition>& outVirtualKeys),
157                 (const, override));
158 
159     MOCK_METHOD(const std::shared_ptr<KeyCharacterMap>, getKeyCharacterMap, (int32_t deviceId),
160                 (const, override));
161 
162     MOCK_METHOD(bool, setKeyboardLayoutOverlay,
163                 (int32_t deviceId, std::shared_ptr<KeyCharacterMap> map), (override));
164 
165     MOCK_METHOD(void, vibrate, (int32_t deviceId, const VibrationElement& effect), (override));
166     MOCK_METHOD(void, cancelVibrate, (int32_t deviceId), (override));
167 
168     MOCK_METHOD(std::vector<int32_t>, getVibratorIds, (int32_t deviceId), (const, override));
169     MOCK_METHOD(std::optional<int32_t>, getBatteryCapacity, (int32_t deviceId, int32_t batteryId),
170                 (const, override));
171 
172     MOCK_METHOD(std::optional<int32_t>, getBatteryStatus, (int32_t deviceId, int32_t batteryId),
173                 (const, override));
174     MOCK_METHOD(void, requestReopenDevices, (), (override));
175     MOCK_METHOD(void, wake, (), (override));
176 
177     MOCK_METHOD(void, dump, (std::string& dump), (const, override));
178     MOCK_METHOD(void, monitor, (), (const, override));
179     MOCK_METHOD(bool, isDeviceEnabled, (int32_t deviceId), (const, override));
180     MOCK_METHOD(status_t, enableDevice, (int32_t deviceId), (override));
181     MOCK_METHOD(status_t, disableDevice, (int32_t deviceId), (override));
182     MOCK_METHOD(void, sysfsNodeChanged, (const std::string& sysfsNodePath), (override));
183     MOCK_METHOD(bool, setKernelWakeEnabled, (int32_t deviceId, bool enabled), (override));
184 };
185 
186 class MockPointerChoreographerPolicyInterface : public PointerChoreographerPolicyInterface {
187 public:
188     MOCK_METHOD(std::shared_ptr<PointerControllerInterface>, createPointerController,
189                 (PointerControllerInterface::ControllerType), (override));
190     MOCK_METHOD(void, notifyPointerDisplayIdChanged,
191                 (ui::LogicalDisplayId displayId, const vec2& position), (override));
192     MOCK_METHOD(bool, isInputMethodConnectionActive, (), (override));
193     MOCK_METHOD(void, notifyMouseCursorFadedOnTyping, (), (override));
194 };
195 
196 class MockInputDevice : public InputDevice {
197 public:
MockInputDevice(InputReaderContext * context,int32_t id,int32_t generation,const InputDeviceIdentifier & identifier)198     MockInputDevice(InputReaderContext* context, int32_t id, int32_t generation,
199                     const InputDeviceIdentifier& identifier)
200           : InputDevice(context, id, generation, identifier) {}
201 
202     MOCK_METHOD(uint32_t, getSources, (), (const, override));
203     MOCK_METHOD(std::optional<DisplayViewport>, getAssociatedViewport, (), (const));
204     MOCK_METHOD(KeyboardType, getKeyboardType, (), (const, override));
205     MOCK_METHOD(bool, isEnabled, (), ());
206     MOCK_METHOD(bool, isExternal, (), (override));
207 
208     MOCK_METHOD(void, dump, (std::string& dump, const std::string& eventHubDevStr), ());
209     MOCK_METHOD(void, addEmptyEventHubDevice, (int32_t eventHubId), ());
210     MOCK_METHOD(std::list<NotifyArgs>, addEventHubDevice,
211                 (nsecs_t when, int32_t eventHubId, const InputReaderConfiguration& readerConfig),
212                 ());
213     MOCK_METHOD(void, removeEventHubDevice, (int32_t eventHubId), ());
214     MOCK_METHOD(std::list<NotifyArgs>, configure,
215                 (nsecs_t when, const InputReaderConfiguration& readerConfig,
216                  ConfigurationChanges changes),
217                 ());
218     MOCK_METHOD(std::list<NotifyArgs>, reset, (nsecs_t when), ());
219     MOCK_METHOD(std::list<NotifyArgs>, process, (const RawEvent* rawEvents, size_t count), ());
220     MOCK_METHOD(std::list<NotifyArgs>, timeoutExpired, (nsecs_t when), ());
221     MOCK_METHOD(std::list<NotifyArgs>, updateExternalStylusState, (const StylusState& state), ());
222 
223     MOCK_METHOD(InputDeviceInfo, getDeviceInfo, (), ());
224     MOCK_METHOD(int32_t, getKeyCodeState, (uint32_t sourceMask, int32_t keyCode), ());
225     MOCK_METHOD(int32_t, getScanCodeState, (uint32_t sourceMask, int32_t scanCode), ());
226     MOCK_METHOD(int32_t, getSwitchState, (uint32_t sourceMask, int32_t switchCode), ());
227     MOCK_METHOD(int32_t, getKeyCodeForKeyLocation, (int32_t locationKeyCode), (const));
228     MOCK_METHOD(bool, markSupportedKeyCodes,
229                 (uint32_t sourceMask, const std::vector<int32_t>& keyCodes, uint8_t* outFlags), ());
230     MOCK_METHOD(std::list<NotifyArgs>, vibrate,
231                 (const VibrationSequence& sequence, ssize_t repeat, int32_t token), ());
232     MOCK_METHOD(std::list<NotifyArgs>, cancelVibrate, (int32_t token), ());
233     MOCK_METHOD(bool, isVibrating, (), ());
234     MOCK_METHOD(std::vector<int32_t>, getVibratorIds, (), ());
235     MOCK_METHOD(std::list<NotifyArgs>, cancelTouch, (nsecs_t when, nsecs_t readTime), ());
236     MOCK_METHOD(bool, enableSensor,
237                 (InputDeviceSensorType sensorType, std::chrono::microseconds samplingPeriod,
238                  std::chrono::microseconds maxBatchReportLatency),
239                 ());
240 
241     MOCK_METHOD(void, disableSensor, (InputDeviceSensorType sensorType), ());
242     MOCK_METHOD(void, flushSensor, (InputDeviceSensorType sensorType), ());
243 
244     MOCK_METHOD(std::optional<int32_t>, getBatteryEventHubId, (), (const));
245 
246     MOCK_METHOD(bool, setLightColor, (int32_t lightId, int32_t color), ());
247     MOCK_METHOD(bool, setLightPlayerId, (int32_t lightId, int32_t playerId), ());
248     MOCK_METHOD(std::optional<int32_t>, getLightColor, (int32_t lightId), ());
249     MOCK_METHOD(std::optional<int32_t>, getLightPlayerId, (int32_t lightId), ());
250 
251     MOCK_METHOD(int32_t, getMetaState, (), ());
252     MOCK_METHOD(void, setKeyboardType, (KeyboardType keyboardType), ());
253 
254     MOCK_METHOD(const PropertyMap&, getConfiguration, (), (const, override));
255 
256     MOCK_METHOD(NotifyDeviceResetArgs, notifyReset, (nsecs_t when), ());
257 
258     MOCK_METHOD(std::optional<ui::LogicalDisplayId>, getAssociatedDisplayId, (), ());
259 
260     MOCK_METHOD(void, updateLedState, (bool reset), ());
261 
262     MOCK_METHOD(size_t, getMapperCount, (), ());
263 
getGeneration()264     virtual int32_t getGeneration() const override { return mGeneration; }
bumpGeneration()265     virtual void bumpGeneration() override { mGeneration++; }
266 
267 private:
268     int32_t mGeneration = 0;
269 };
270 } // namespace android
271