|
| 1 | +// Copyright 2020 Open Source Robotics Foundation, Inc. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +#ifndef MOCKING_UTILS_H_ |
| 16 | +#define MOCKING_UTILS_H_ |
| 17 | + |
| 18 | +#include <cstring> |
| 19 | + |
| 20 | +#include "rcutils/macros.h" |
| 21 | +#include "rcutils/get_env.h" |
| 22 | + |
| 23 | +#include "mimick.h" |
| 24 | + |
| 25 | +template<typename T> |
| 26 | +class state_chain { |
| 27 | + public: |
| 28 | + state_chain() { |
| 29 | + prev_state_ = this_state; |
| 30 | + this_state = &state_; |
| 31 | + } |
| 32 | + ~state_chain() { |
| 33 | + this_state = prev_state_; |
| 34 | + } |
| 35 | + |
| 36 | + static T * this_state; |
| 37 | + protected: |
| 38 | + T * prev_state_; |
| 39 | + T state_; |
| 40 | +}; |
| 41 | + |
| 42 | +template <typename T> |
| 43 | +T * state_chain<T>::this_state{nullptr}; |
| 44 | + |
| 45 | +#if !defined(_WIN32) |
| 46 | +#if defined(__MACH__) |
| 47 | + |
| 48 | +#include <mach/clock.h> |
| 49 | +#include <mach/mach.h> |
| 50 | + |
| 51 | +class stopped_clock_mock : private state_chain<mach_timespec_t> { |
| 52 | +public: |
| 53 | + stopped_clock_mock() { |
| 54 | + m_ = mmk_mock(RCUTILS_STRINGIFY(clock_get_time) "@lib:rcutils", clock_get_time_mock_t); |
| 55 | + mmk_when(clock_get_time(mmk_any(clock_serv_t), mmk_any(mach_timespec_t *)), |
| 56 | + .then_call = reinterpret_cast<mmk_fn>(return_timespec)); |
| 57 | + } |
| 58 | + |
| 59 | + ~stopped_clock_mock() { |
| 60 | + mmk_reset(m); |
| 61 | + } |
| 62 | + |
| 63 | + mach_timespec_t & time() { |
| 64 | + return state_; |
| 65 | + } |
| 66 | + |
| 67 | + bool called(int times = 1) const { |
| 68 | + return mmk_verify( |
| 69 | + clock_get_time( |
| 70 | + mmk_any(clock_serv_t), |
| 71 | + mmk_any(mach_timespec_t *)), |
| 72 | + .times = times); |
| 73 | + } |
| 74 | +private: |
| 75 | + mmk_mock_define(clock_get_time_mock_t, kern_return_t, clock_serv_t, mach_timespec_t *); |
| 76 | + |
| 77 | + static kern_return_t this_implementation(clock_serv_t, mach_timespec_t * ts) { |
| 78 | + *ts = *this_implementation; |
| 79 | + return 0; |
| 80 | + } |
| 81 | + |
| 82 | + clock_get_time_mock_t m_; |
| 83 | +}; |
| 84 | + |
| 85 | +#else // defined(__MACH__) |
| 86 | + |
| 87 | +#include <time.h> |
| 88 | + |
| 89 | +class stopped_clock_mock : private state_chain<struct timespec> { |
| 90 | +public: |
| 91 | + stopped_clock_mock() { |
| 92 | + m_ = mmk_mock(RCUTILS_STRINGIFY(clock_gettime) "@lib:rcutils", clock_gettime_mock_t); |
| 93 | + mmk_when(clock_gettime(mmk_any(clockid_t), mmk_any(struct timespec *)), |
| 94 | + .then_call = reinterpret_cast<mmk_fn>(this_implementation)); |
| 95 | + } |
| 96 | + |
| 97 | + ~stopped_clock_mock() { |
| 98 | + mmk_reset(m_); |
| 99 | + } |
| 100 | + |
| 101 | + struct timespec & time() { |
| 102 | + return state_; |
| 103 | + } |
| 104 | + |
| 105 | + bool called(int times = 1) const { |
| 106 | + return mmk_verify( |
| 107 | + clock_gettime( |
| 108 | + mmk_any(clockid_t), |
| 109 | + mmk_any(struct timespec *)), |
| 110 | + .times = times); |
| 111 | + } |
| 112 | +private: |
| 113 | + mmk_mock_define(clock_gettime_mock_t, int, clockid_t, struct timespec *); |
| 114 | + |
| 115 | + static int this_implementation(clockid_t, struct timespec * ts) { |
| 116 | + *ts = *this_state; |
| 117 | + return 0; |
| 118 | + } |
| 119 | + |
| 120 | + clock_gettime_mock_t m_; |
| 121 | +}; |
| 122 | + |
| 123 | +#endif // defined(__MACH__) |
| 124 | + |
| 125 | +class vsnprintf_fails_formatting_mock : private state_chain<size_t> { |
| 126 | + public: |
| 127 | + vsnprintf_fails_formatting_mock() { |
| 128 | + m_ = mmk_mock(RCUTILS_STRINGIFY(vsnprintf) "@lib:rcutils", vsnprintf_mock_t); |
| 129 | + mmk_when(vsnprintf(mmk_any(char *), |
| 130 | + mmk_any(size_t), |
| 131 | + mmk_any(const char *), |
| 132 | + mmk_any(va_list)), |
| 133 | + .then_call = reinterpret_cast<mmk_fn>(this_implementation)); |
| 134 | + state_ = 1u; |
| 135 | + } |
| 136 | + |
| 137 | + void requires_size(size_t n) { |
| 138 | + state_ = n; |
| 139 | + } |
| 140 | + |
| 141 | + ~vsnprintf_fails_formatting_mock() { |
| 142 | + mmk_reset(m_); |
| 143 | + } |
| 144 | + |
| 145 | + private: |
| 146 | + mmk_mock_define(vsnprintf_mock_t, int, char *, size_t, const char *, va_list); |
| 147 | + |
| 148 | + static int this_implementation(char * buffer, size_t buffer_size, const char *, va_list) { |
| 149 | + if (NULL == buffer || buffer_size < *this_state) { |
| 150 | + return *this_state; |
| 151 | + } |
| 152 | + errno = EINVAL; |
| 153 | + return -1; |
| 154 | + } |
| 155 | + |
| 156 | + vsnprintf_mock_t m_; |
| 157 | +}; |
| 158 | + |
| 159 | +#include <sys/types.h> |
| 160 | +#include <dirent.h> |
| 161 | + |
| 162 | +class failing_file_api_mock { |
| 163 | + public: |
| 164 | + failing_file_api_mock() { |
| 165 | + m_ = mmk_mock(RCUTILS_STRINGIFY(opendir) "@lib:rcutils", opendir_mock_t); |
| 166 | + mmk_when(opendir(mmk_any(const char *)), |
| 167 | + .then_call = reinterpret_cast<mmk_fn>(this_implementation)); |
| 168 | + } |
| 169 | + |
| 170 | + ~failing_file_api_mock() { |
| 171 | + mmk_reset(m_); |
| 172 | + } |
| 173 | + private: |
| 174 | + mmk_mock_define(opendir_mock_t, DIR *, const char *); |
| 175 | + |
| 176 | + static DIR * this_implementation(const char *) { |
| 177 | + errno = ENFILE; |
| 178 | + return NULL; |
| 179 | + } |
| 180 | + |
| 181 | + opendir_mock_t m_; |
| 182 | +}; |
| 183 | + |
| 184 | +#else // !defined(_WIN32) |
| 185 | + |
| 186 | +class vsnprintf_fails_formatting_mock : private state_chain<size_t> { |
| 187 | + public: |
| 188 | + vsnprintf_fails_formatting_mock() { |
| 189 | + m_ = mmk_mock(RCUTILS_STRINGIFY(_vsnprintf_s) "@lib:rcutils", _vsnprintf_s_mock_t); |
| 190 | + mmk_when(_vsnprintf_s(mmk_any(char *), |
| 191 | + mmk_any(size_t), |
| 192 | + mmk_any(size_t), |
| 193 | + mmk_any(const char *), |
| 194 | + mmk_any(va_list)), |
| 195 | + .then_call = reinterpret_cast<mmk_fn>(this_implementation)); |
| 196 | + state_ = 1u; |
| 197 | + } |
| 198 | + |
| 199 | + void requires_size(size_t n) { |
| 200 | + state_ = n; |
| 201 | + } |
| 202 | + |
| 203 | + ~vsnprintf_fails_formatting_mock() { |
| 204 | + mmk_reset(m_); |
| 205 | + } |
| 206 | + private: |
| 207 | + mmk_mock_define(_vsnprintf_s_mock_t, int, char *, size_t, size_t, const char *, va_list); |
| 208 | + |
| 209 | + static |
| 210 | + int this_implementation(char * buffer, size_t buffer_size, size_t, const char *, va_list) { |
| 211 | + if (NULL == buffer || buffer_size < *this_state) { |
| 212 | + return *this_state; |
| 213 | + } |
| 214 | + errno = EINVAL; |
| 215 | + return -1; |
| 216 | + } |
| 217 | + |
| 218 | + _vsnprintf_s_mock_t m_; |
| 219 | +}; |
| 220 | + |
| 221 | +#endif // !defined(_WIN32) |
| 222 | + |
| 223 | +class rcutils_get_env_mock : private state_chain<std::set<std::string>> { |
| 224 | + public: |
| 225 | + rcutils_get_env_mock() { |
| 226 | + m_ = mmk_mock("rcutils_get_env@lib:rcutils", rcutils_get_env_mock_t); |
| 227 | + mmk_when(rcutils_get_env(mmk_any(const char *), mmk_any(const char **)), |
| 228 | + .then_call = reinterpret_cast<mmk_fn>(this_implementation)); |
| 229 | + } |
| 230 | + |
| 231 | + void fails_to_get(std::string name) { |
| 232 | + state_.insert(std::move(name)); |
| 233 | + } |
| 234 | + |
| 235 | + ~rcutils_get_env_mock() { |
| 236 | + mmk_reset(m_); |
| 237 | + } |
| 238 | + private: |
| 239 | + mmk_mock_define(rcutils_get_env_mock_t, const char *, const char *, const char **); |
| 240 | + |
| 241 | + static const char * this_implementation(const char * name, const char ** value) |
| 242 | + { |
| 243 | + if (this_state->count(name) > 0) { |
| 244 | + return "ERROR"; |
| 245 | + } |
| 246 | + *value = ""; |
| 247 | + return NULL; |
| 248 | + } |
| 249 | + |
| 250 | + rcutils_get_env_mock_t m_; |
| 251 | +}; |
| 252 | + |
| 253 | +#endif // MOCKING_UTILS_H_ |
0 commit comments