File: UnitTests.h

package info (click to toggle)
libserial 1.0.0%2Bgit20250903-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,220 kB
  • sloc: cpp: 6,140; makefile: 278; python: 163; sh: 29
file content (187 lines) | stat: -rw-r--r-- 6,555 bytes parent folder | download | duplicates (4)
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
/******************************************************************************
 * @file UnitTests.h                                                          *
 * @copyright (C) 2004-2018 LibSerial Development Team. All rights reserved.  *
 * crayzeewulf@gmail.com                                                      *
 *                                                                            *
 * Redistribution and use in source and binary forms, with or without         *
 * modification, are permitted provided that the following conditions         *
 * are met:                                                                   *
 *                                                                            *
 * 1. Redistributions of source code must retain the above copyright          *
 *    notice, this list of conditions and the following disclaimer.           *
 * 2. 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.                                                           *
 * 3. Neither the name PX4 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 OWNER 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.                                                *
 *****************************************************************************/

#pragma once

#include "libserial/SerialPort.h"
#include "libserial/SerialPortConstants.h"
#include "libserial/SerialStream.h"

#include <gtest/gtest.h>
#include <mutex>
#include <stdlib.h>
#include <sys/ioctl.h>

/**
 * @namespace Libserial
 */
namespace LibSerial
{
    /**
     * @var Default Serial Port 1.
     */
    constexpr const char* const SERIAL_PORT_1 = "/dev/ttyUSB0" ;

    /**
     * @var Default Serial Port 2.
     */
    constexpr const char* const SERIAL_PORT_2 = "/dev/ttyUSB1" ;

    /**
     * @var The number of iterations to perform on each unit test.
     */
    constexpr int TEST_ITERATIONS = 10 ;


    class UnitTests : public ::testing::Test
    {
    public:

        /**
         * @brief Default Constructor.
         */
        explicit UnitTests() ;

        /**
         * @brief Default Destructor.
         */
        virtual ~UnitTests() ;

        /**
         * @brief Gets the time since epoch in milliseconds.
         * @return Returns the time since epoch in milliseconds
         */
        size_t getTimeInMilliSeconds() ;
        
        /**
         * @brief Gets the time since epoch in microseconds.
         * @return Returns the time since epoch in microseconds
         */
        size_t getTimeInMicroSeconds() ;

    protected:

        /**
         * @brief Tests for correct functionality for writing data from a serial stream object and reading that data from a serial port object..
         */
        void testSerialStreamToSerialPortReadWrite() ;

        /**
         * @var Failure rate of serial communications being tracked in the threaded tests.
         */
        size_t failureRate = 0 ;

        /**
         * @var Loop count variable.
         */
        size_t loopCount = 0 ;

        /**
         * @var Timeout to be used for test methods, (ms).
         */
        size_t timeOutMilliseconds = 250 ;

        /**
         * @var Time to allow the hardware read buffer to fill or empty (us).
         */
        unsigned int readBufferDelay = 20000 ;

        /**
         * @struct Standard baud rates.
         */
        std::vector<LibSerial::BaudRate> baudRates {} ;

        /**
         * @struct Standard character sizes.
         */
        std::vector<LibSerial::CharacterSize> characterSizes {} ;

        /**
         * @struct Standard flow control types.
         */
        std::vector<LibSerial::FlowControl> flowControlTypes {} ;

        /**
         * @struct Standard flow parity types.
         */
        std::vector<LibSerial::Parity> parityTypes {} ;

        /**
         * @struct Standard number of stop bits.
         */
        std::vector<LibSerial::StopBits> stopBits {} ;

        /**
         * @param Serial Stream instance 1 for unit testing applications.
         */
        LibSerial::SerialStream serialStream1 {} ;

        /**
         * @param Serial Stream instance 2 for unit testing applications.
         */
        LibSerial::SerialStream serialStream2 {} ;

        /**
         * @param Serial Port instance 1 for unit testing applications.
         */
        LibSerial::SerialPort serialPort1 {} ;

        /**
         * @param Serial Port instance 2 for unit testing applications.
         */
        LibSerial::SerialPort serialPort2 {} ;

        /**
         * @param String to store received data.
         */
        std::string readString1 {} ;

        /**
         * @param String to store received data.
         */
        std::string readString2 {} ;

        /**
         * @param String to store data to be written to the serial port.
         */
        std::string writeString1 {"Quidquid latine dictum sit, altum sonatur. (Whatever is said in Latin sounds profound.)"} ;

        /**
         * @param String to store data to be written to the serial port.
         */
        std::string writeString2 {"The secret of the man who is universally interesting is that he is universally interested. - William Dean Howells"} ;

    private:

    } ;
}