summaryrefslogtreecommitdiff
path: root/src/components/utils/test/timer_test.cc
blob: dadec5393f2e86008eb8ea909cc6f170b3302af6 (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
/*
 * 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 test_lock;
sync_primitives::ConditionalVariable lock_monitor;
const uint32_t default_timeout = 30u;
const std::string timer_name_ = "test_timer";

class TestTask : public timer::TimerTask {
 public:
  TestTask() : calls_count_(0u) {}
  void run() const OVERRIDE {
    sync_primitives::AutoLock auto_lock(test_lock);
    ++calls_count_;
    lock_monitor.NotifyOne();
  }
  uint GetCallsCount() const {
    return calls_count_;
  }
  ~TestTask() {}
 private:
  mutable uint calls_count_;
};

class FakeClassWithTimer {
 public:
  FakeClassWithTimer()
      : calls_count_(0u)
      , internal_timer_("test_timer",
                        new timer::TimerTaskImpl<FakeClassWithTimer>(
                            this, &FakeClassWithTimer::OnTimer)) {
    internal_timer_.Start(default_timeout, true);
  }
  void OnTimer() {
    sync_primitives::AutoLock auto_lock_(test_lock);
    internal_timer_.Stop();
    ++calls_count_;
    lock_monitor.NotifyOne();
  }
  bool IsTimerRunning() const {
    return internal_timer_.IsRunning();
  }
  uint GetCallsCount() const {
    return calls_count_;
  }

 private:
  uint calls_count_;
  timer::Timer internal_timer_;
};
}  // namespace


class TimerTest : public testing::Test {
 protected:
  void SetUp() OVERRIDE {
    timeout_ = default_timeout;
    repeatable_ = false;
    // Will be destroyed in Timer Destructor
    test_task_ = new MockTimerTask();
  }
  bool repeatable_;
  MockTimerTask* test_task_;
  uint32_t timeout_;
};

TEST_F(TimerTest, Start_ZeroTimeout_CorrectTimeout) {
  // Preconditions
  timer::Timer test_timer(timer_name_, test_task_);
  // Actions
  test_timer.Start(0u, repeatable_);
  // Expects
  EXPECT_EQ(1u, test_timer.GetTimeout());

  test_timer.Stop();
}

TEST_F(TimerTest, Start_NoLoop_OneCall) {
  // Preconditions
  test_lock.Acquire();
  TestTask* task = new TestTask();
  timer::Timer test_timer(timer_name_, task);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  ASSERT_TRUE(test_timer.IsRunning());
  // Wait for call
  lock_monitor.Wait(test_lock);
  test_lock.Release();
  EXPECT_FALSE(test_timer.IsRunning());
  EXPECT_EQ(1u, task->GetCallsCount());
}

TEST_F(TimerTest, Start_Loop_3Calls) {
  // Preconditions
  uint loops_count = 3u;
  repeatable_ = true;
  test_lock.Acquire();
  TestTask* task = new TestTask();
  timer::Timer test_timer(timer_name_, task);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  for (int i = loops_count; i; --i) {
    lock_monitor.Wait(test_lock);
  }
  test_lock.Release();
  test_timer.Stop();

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

TEST_F(TimerTest, Start_Runned_RunnedWithNewTimeout) {
  // Preconditions
  timer::Timer test_timer(timer_name_, test_task_);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  // Expects
  ASSERT_EQ(timeout_, test_timer.GetTimeout());
  ASSERT_TRUE(test_timer.IsRunning());
  // Actions
  timeout_ = 1000u;
  test_timer.Start(timeout_, repeatable_);
  // Expects
  ASSERT_EQ(timeout_, test_timer.GetTimeout());
  ASSERT_TRUE(test_timer.IsRunning());
}

TEST_F(TimerTest, Start_NotRunned_RunnedWithNewTimeout) {
  // Preconditions
  timer::Timer test_timer(timer_name_, test_task_);
  // Expects
  ASSERT_EQ(0u, test_timer.GetTimeout());
  ASSERT_FALSE(test_timer.IsRunning());
  // Actions
  timeout_ = 1000u;
  test_timer.Start(timeout_, repeatable_);
  // Expects
  ASSERT_EQ(timeout_, test_timer.GetTimeout());
  ASSERT_TRUE(test_timer.IsRunning());
}


TEST_F(TimerTest, Stop_FirstLoop_NoCall) {
  // Preconditions
  timer::Timer test_timer(timer_name_, test_task_);
  // Expects
  EXPECT_CALL(*test_task_, run()).Times(0);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  test_timer.Stop();
}

TEST_F(TimerTest, Stop_SecondLoop_OneCall) {
  // Preconditions
  test_lock.Acquire();
  TestTask* task = new TestTask();
  timer::Timer test_timer(timer_name_, task);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  ASSERT_TRUE(test_timer.IsRunning());
  // Wait for Starting second loop
  lock_monitor.Wait(test_lock);
  test_timer.Stop();
  test_lock.Release();
  // Expects
  EXPECT_EQ(1u, task->GetCallsCount());
}

TEST_F(TimerTest, IsRunning_Started_True) {
  // Preconditions
  timer::Timer test_timer(timer_name_, test_task_);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  // Expects
  EXPECT_TRUE(test_timer.IsRunning());
}

TEST_F(TimerTest, IsRunning_Stoped_False) {
  // Preconditions
  timer::Timer test_timer(timer_name_, test_task_);
  // Actions
  test_timer.Start(timeout_, repeatable_);
  ASSERT_TRUE(test_timer.IsRunning());
  test_timer.Stop();
  // Expects
  EXPECT_FALSE(test_timer.IsRunning());
}

TEST_F(TimerTest, IsRunning_Suspended_FalseAndOneCall) {
  // Preconditions
  test_lock.Acquire();
  FakeClassWithTimer fake_class;
  // Expects
  ASSERT_EQ(0u, fake_class.GetCallsCount());
  ASSERT_TRUE(fake_class.IsTimerRunning());
  // Wait for end of loop
  lock_monitor.Wait(test_lock);
  test_lock.Release();
  // Expects
  ASSERT_EQ(1u, fake_class.GetCallsCount());
  ASSERT_FALSE(fake_class.IsTimerRunning());
}

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