summaryrefslogtreecommitdiffstats
path: root/test/timertest.cpp
blob: 9d05e550988480f5451d90211d129b3a5fec98cc (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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
/**
 * Copyright © 2017 IBM Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#include <iostream>
#include <chrono>
#include <gtest/gtest.h>
#include "event.hpp"
#include "timer.hpp"

/**
 * Testcases for the Timer class
 */

using namespace phosphor::fan::util;
using namespace std::chrono;


/**
 * Class to ensure sd_events are correctly
 * setup and destroyed.
 */
class TimerTest : public ::testing::Test
{
    public:
        // systemd event handler
        phosphor::fan::event::EventPtr events;

        // Need this so that events can be initialized.
        int rc;

        // Gets called as part of each TEST_F construction
        TimerTest()
        {
            sd_event* event = nullptr;
            auto rc = sd_event_default(&event);
            EXPECT_GE(rc, 0);

            events.reset(event);
        }
};

/**
 * Helper class to hande tracking timer expirations
 * via callback functions.
 */
class CallbackTester
{
    public:

        CallbackTester() {}

        size_t getCount()
        {
            return _count;
        }

        void callbackFunction()
        {
            _count++;
            _gotCallback = true;
        }

        bool gotCallback()
        {
            return _gotCallback;
        }

    private:
        bool _gotCallback = false;
        size_t _count = 0;
};


/**
 * Helper class that more closely mimics real usage,
 * which is another class containing a timer and using
 * one of its member functions as the callback.
 */
class CallbackTesterWithTimer : public CallbackTester
{
    public:
        CallbackTesterWithTimer(phosphor::fan::event::EventPtr& events) :
            _timer(events,
                   std::bind(&CallbackTesterWithTimer::callbackFunction,
                             this))
        {
        }

        void callbackFunction()
        {
            //restart the timer once from the callback
            if (!_restarted)
            {
                _restarted = true;
                auto time = duration_cast<microseconds>(seconds(1));
                _timer.start(time, Timer::TimerType::oneshot);
            }

            CallbackTester::callbackFunction();
        }

        Timer& getTimer()
        {
            return _timer;
        }

        inline bool restarted() const
        {
            return _restarted;
        }

    private:

        Timer _timer;
        bool _restarted = false;
};


/**
 * Test that a callback will occur after 2 seconds.
 */
TEST_F(TimerTest, timerExpiresAfter2seconds)
{
    CallbackTester tester;

    Timer timer(events,
                std::bind(&CallbackTester::callbackFunction, &tester));


    auto time = duration_cast<microseconds>(seconds(2));

    EXPECT_EQ(false, timer.running());

    timer.start(time, Timer::TimerType::oneshot);
    EXPECT_EQ(false, tester.gotCallback());
    EXPECT_EQ(true, timer.running());

    int count = 0;
    auto sleepTime = duration_cast<microseconds>(seconds(1));

    //Wait for 2 1s timeouts
    while (count < 2)
    {
        // Returns 0 on timeout and positive number on dispatch
        if (sd_event_run(events.get(), sleepTime.count()) == 0)
        {
            count++;
        }
    }

    EXPECT_EQ(true, tester.gotCallback());
    EXPECT_EQ(1, tester.getCount());
    EXPECT_EQ(false, timer.running());
}

/**
 * Test that a timer can be restarted.
 */
TEST_F(TimerTest, timerRestart)
{
    CallbackTester tester;

    Timer timer(events,
                std::bind(&CallbackTester::callbackFunction, &tester));


    auto time = duration_cast<microseconds>(seconds(2));
    timer.start(time, Timer::TimerType::oneshot);

    //wait for a second
    auto sleepTime = duration_cast<microseconds>(seconds(1));
    auto rc = sd_event_run(events.get(), sleepTime.count());

    //expect the timeout, not the dispatch
    //and the timer should still be running
    EXPECT_EQ(0, rc);
    EXPECT_EQ(true, timer.running());

    //Restart it
    timer.start(time, Timer::TimerType::oneshot);

    //Wait just 1s, make sure not done
    rc = sd_event_run(events.get(), sleepTime.count());
    EXPECT_EQ(0, rc);
    EXPECT_EQ(true, timer.running());
    EXPECT_EQ(false, tester.gotCallback());

    //Wait 1 more second, this time expecting a dispatch
    int count = 0;
    while (count < 1)
    {
        // Returns 0 on timeout and positive number on dispatch
        if (sd_event_run(events.get(), sleepTime.count()) == 0)
        {
            count++;
        }
    }

    EXPECT_EQ(true, tester.gotCallback());
    EXPECT_EQ(1, tester.getCount());
    EXPECT_EQ(false, timer.running());
}


/**
 * Test that a timer can be stopped.
 */
TEST_F(TimerTest, timerStop)
{
    CallbackTester tester;

    Timer timer(events,
                std::bind(&CallbackTester::callbackFunction, &tester));


    auto time = duration_cast<microseconds>(seconds(2));
    timer.start(time, Timer::TimerType::oneshot);

    auto sleepTime = duration_cast<microseconds>(seconds(1));

    //wait 1s
    auto rc = sd_event_run(events.get(), sleepTime.count());

    //expect the timeout, not the dispatch
    EXPECT_EQ(rc, 0);
    EXPECT_EQ(true, timer.running());

    timer.stop();

    EXPECT_EQ(false, timer.running());
    EXPECT_EQ(false, tester.gotCallback());

    //Wait another 2s, make sure no callbacks happened
    sleepTime = duration_cast<microseconds>(seconds(2));
    rc = sd_event_run(events.get(), sleepTime.count());

    EXPECT_EQ(rc, 0);
    EXPECT_EQ(false, timer.running());
    EXPECT_EQ(false, tester.gotCallback());
}


/**
 * Test that the timer can be restarted from within
 * a callback function.
 */
TEST_F(TimerTest, timerRestartFromCallback)
{
    CallbackTesterWithTimer tester(events);

    auto& timer = tester.getTimer();

    auto time = duration_cast<microseconds>(seconds(2));
    timer.start(time, Timer::TimerType::oneshot);

    //after running for 2 seconds, the timer will get restarted
    //for another 1s

    int count = 0;
    auto sleepTime = duration_cast<microseconds>(seconds(1));
    while (count < 3)
    {
        // Returns 0 on timeout and positive number on dispatch
        if (sd_event_run(events.get(), sleepTime.count()) == 0)
        {
            count++;
        }
    }

    EXPECT_EQ(false, timer.running());
    EXPECT_EQ(true, tester.gotCallback());
    EXPECT_EQ(2, tester.getCount()); //2 callbacks
    EXPECT_EQ(true, tester.restarted());
}

/**
 * This shows what happens when the timer expires but
 * sd_event_run never got called.
 */
TEST_F(TimerTest, timerNoEventRun)
{
    CallbackTester tester;

    Timer timer(events,
                std::bind(&CallbackTester::callbackFunction, &tester));


    auto time = duration_cast<microseconds>(milliseconds(500));

    timer.start(time, Timer::TimerType::oneshot);

    sleep(1);

    //The timer should have expired, but with no event processing
    //it will still think it's running.

    EXPECT_EQ(true, timer.running());
    EXPECT_EQ(false, tester.gotCallback());

    //Now process an event
    auto sleepTime = duration_cast<microseconds>(milliseconds(5));
    auto rc = sd_event_run(events.get(), sleepTime.count());

    EXPECT_GT(rc, 0);
    EXPECT_EQ(false, timer.running());
    EXPECT_EQ(true, tester.gotCallback());
}


/**
 * Tests that a timer in repeating mode will keep calling
 * the callback.
 */
TEST_F(TimerTest, RepeatingTimer)
{
    CallbackTester tester;

    Timer timer(events,
                std::bind(&CallbackTester::callbackFunction, &tester));

    auto time = duration_cast<microseconds>(seconds(1));
    timer.start(time, Timer::TimerType::repeating);

    int count = 0;
    auto sleepTime = duration_cast<microseconds>(milliseconds(500));

    while (count < 5)
    {
        if (sd_event_run(events.get(), sleepTime.count()) == 0)
        {
            count++;
        }
    }

    EXPECT_EQ(true, timer.running());
    EXPECT_EQ(true, tester.gotCallback());
    EXPECT_EQ(4, tester.getCount());

    timer.stop();

    EXPECT_EQ(false, timer.running());
}
OpenPOWER on IntegriCloud