summaryrefslogtreecommitdiff
path: root/src/components/utils/test/timer_test.cc
blob: ea5c9f0b84acd40b9a14282cd5f18c80c663c185 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/*
 * Copyright (c) 2016, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include "gtest/gtest.h"
#include "utils/timer.h"
#include "utils/mock_timer_task.h"
#include "utils/conditional_variable.h"
#include "utils/lock.h"
#include "utils/macro.h"
#include "utils/timer_task_impl.h"

namespace test {
namespace components {
namespace timer_test {
namespace {

sync_primitives::Lock shot_lock;
sync_primitives::ConditionalVariable shot_condition;

const std::string kTimerName = "TestTimer";

/*
 * Default timeout used during timer testing.
 * Value should be greater than at least 30 ms
 * to avoid timer firing between two sequental Start/Stop calls
 */
const uint32_t kDefaultTimeoutMs = 30u;
const uint32_t kDefaultTimeoutRestartMs = 45u;

class TestTask : public timer::TimerTask {
 public:
  TestTask() : timer_(NULL), calls_count_(0u) {}

  void set_timer(timer::Timer* timer) {
    timer_ = timer;
  }

  virtual void PerformTimer() const {}

  void run() const OVERRIDE {
    sync_primitives::AutoLock auto_lock(shot_lock);
    ++calls_count_;
    shot_condition.NotifyOne();
    PerformTimer();
  }

  size_t calls_count() const {
    return calls_count_;
  }

 protected:
  mutable timer::Timer* timer_;
  mutable size_t calls_count_;
};

class TestTaskWithStart : public TestTask {
 public:
  void PerformTimer() const OVERRIDE {
    if (timer_) {
      timer_->Start(kDefaultTimeoutRestartMs, timer::kPeriodic);
    }
  }
};

class TestTaskWithStop : public TestTask {
 public:
  void PerformTimer() const OVERRIDE {
    if (timer_) {
      timer_->Stop();
    }
  }
};

}  // namespace

// Start - Stop

TEST(TimerTest, Start_Stop_NoLoop_NoCall) {
  MockTimerTask* mock_task = new MockTimerTask();
  EXPECT_CALL(*mock_task, run()).Times(0);

  timer::Timer timer(kTimerName, mock_task);
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  timer.Start(kDefaultTimeoutMs, timer::kSingleShot);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  timer.Stop();
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());
}

TEST(TimerTest, Start_Stop_Loop_NoCall) {
  MockTimerTask* mock_task = new MockTimerTask();
  EXPECT_CALL(*mock_task, run()).Times(0);

  timer::Timer timer(kTimerName, mock_task);
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  timer.Start(kDefaultTimeoutMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  timer.Stop();
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());
}

TEST(TimerTest, Start_Stop_NoLoop_OneCall) {
  sync_primitives::AutoLock auto_lock(shot_lock);
  TestTask* task = new TestTask();

  timer::Timer timer(kTimerName, task);
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  timer.Start(kDefaultTimeoutMs, timer::kSingleShot);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  // Wait for 1 call
  shot_condition.Wait(shot_lock);
  EXPECT_FALSE(timer.is_running());

  timer.Stop();
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  EXPECT_EQ(1u, task->calls_count());
}

TEST(TimerTest, Start_Stop_Loop_3Calls) {
  const size_t loops_count = 3u;

  sync_primitives::AutoLock auto_lock(shot_lock);
  TestTask* task = new TestTask();

  timer::Timer timer(kTimerName, task);
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  timer.Start(kDefaultTimeoutMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  // Wait for 3 calls
  for (size_t i = 0; i < loops_count; ++i) {
    shot_condition.Wait(shot_lock);
    EXPECT_TRUE(timer.is_running());
  }

  timer.Stop();
  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  EXPECT_EQ(loops_count, task->calls_count());
}

// Restart

TEST(TimerTest, Restart_NoLoop_NoCall) {
  MockTimerTask* mock_task = new MockTimerTask();
  EXPECT_CALL(*mock_task, run()).Times(0);

  timer::Timer timer(kTimerName, mock_task);

  timer.Start(kDefaultTimeoutMs, timer::kSingleShot);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  timer.Start(kDefaultTimeoutRestartMs, timer::kSingleShot);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutRestartMs, timer.timeout());
}

TEST(TimerTest, Restart_Loop_NoCall) {
  MockTimerTask* mock_task = new MockTimerTask();
  EXPECT_CALL(*mock_task, run()).Times(0);

  timer::Timer timer(kTimerName, mock_task);

  timer.Start(kDefaultTimeoutMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  timer.Start(kDefaultTimeoutRestartMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutRestartMs, timer.timeout());
}

TEST(TimerTest, Restart_Loop_3Calls) {
  const size_t loops_count = 3u;

  sync_primitives::AutoLock auto_lock(shot_lock);
  TestTask* task = new TestTask();
  timer::Timer timer(kTimerName, task);

  timer.Start(kDefaultTimeoutMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  // Wait for 3 calls
  for (size_t i = 0; i < loops_count; ++i) {
    shot_condition.Wait(shot_lock);
  }
  timer.Start(kDefaultTimeoutRestartMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutRestartMs, timer.timeout());

  EXPECT_EQ(loops_count, task->calls_count());
}

// Restart from call

TEST(TimerTest, Restart_NoLoop_FromCall) {
  sync_primitives::AutoLock auto_lock(shot_lock);
  TestTask* task = new TestTaskWithStart();
  timer::Timer timer(kTimerName, task);
  task->set_timer(&timer);

  timer.Start(kDefaultTimeoutMs, timer::kSingleShot);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  // Wait for 1 calls
  shot_condition.Wait(shot_lock);

  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutRestartMs, timer.timeout());

  EXPECT_EQ(1u, task->calls_count());
}

TEST(TimerTest, Restart_Loop_FromCall) {
  sync_primitives::AutoLock auto_lock(shot_lock);
  TestTask* task = new TestTaskWithStart();
  timer::Timer timer(kTimerName, task);
  task->set_timer(&timer);

  timer.Start(kDefaultTimeoutMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  // Wait for 1 calls
  shot_condition.Wait(shot_lock);

  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutRestartMs, timer.timeout());

  EXPECT_EQ(1u, task->calls_count());
}

// Stop from call

TEST(TimerTest, Stop_Loop_FromCall) {
  sync_primitives::AutoLock auto_lock(shot_lock);
  TestTask* task = new TestTaskWithStop();
  timer::Timer timer(kTimerName, task);
  task->set_timer(&timer);

  timer.Start(kDefaultTimeoutMs, timer::kPeriodic);
  EXPECT_TRUE(timer.is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer.timeout());

  // Wait for 1 calls
  shot_condition.Wait(shot_lock);

  EXPECT_FALSE(timer.is_running());
  EXPECT_EQ(0u, timer.timeout());

  EXPECT_EQ(1u, task->calls_count());
}

// Delete running

TEST(TimerTest, Delete_Running_NoLoop) {
  MockTimerTask* mock_task = new MockTimerTask();
  EXPECT_CALL(*mock_task, run()).Times(0);

  timer::Timer* timer = new timer::Timer(kTimerName, mock_task);
  EXPECT_FALSE(timer->is_running());
  EXPECT_EQ(0u, timer->timeout());

  timer->Start(kDefaultTimeoutMs, timer::kSingleShot);
  EXPECT_TRUE(timer->is_running());
  EXPECT_EQ(kDefaultTimeoutMs, timer->timeout());

  delete timer;
}

}  // namespace timer_test
}  // namespace components
}  // namespace test