AUnit  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
MetaAssertion.h
1 /*
2 MIT License
3 
4 Copyright (c) 2018 Brian T. Park
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 
25 // Significant portions of the design and implementation of this file came from
26 // https://github.com/mmurdoch/arduinounit/blob/master/src/ArduinoUnit.h
27 
28 #ifndef AUNIT_META_ASSERTION_H
29 #define AUNIT_META_ASSERTION_H
30 
31 #include "Printer.h"
32 #include "Assertion.h"
33 
34 class __FlashStringHelper;
35 
36 namespace aunit {
37 
42 class MetaAssertion: public Assertion {
43  protected:
44  // Human-readable strings for various meta-asssertion messages.
45  // They need to be protected, not private, because they are used by
46  // subclasses through the test() and testing() macros.
47  static const char kMessageDone[];
48  static const char kMessageNotDone[];
49  static const char kMessagePassed[];
50  static const char kMessageNotPassed[];
51  static const char kMessageFailed[];
52  static const char kMessageNotFailed[];
53  static const char kMessageSkipped[];
54  static const char kMessageNotSkipped[];
55  static const char kMessageExpired[];
56  static const char kMessageNotExpired[];
57 
60 
65  bool assertionTestStatus(const char* file, uint16_t line,
66  const char* testName, const __FlashStringHelper* statusMessage,
67  bool ok);
68 
70  bool isOutputEnabledForStatus(uint8_t status) const;
71 
73  void setStatusNow(const char* file, uint16_t line, uint8_t status,
74  const __FlashStringHelper* statusString);
75 
76  private:
77  // Disable copy-constructor and assignment operator
78  MetaAssertion(const MetaAssertion&) = delete;
79  MetaAssertion& operator=(const MetaAssertion&) = delete;
80 
81 };
82 
83 }
84 
85 #endif
An Assertion class is a subclass of Test and provides various overloaded assertion() functions.
Definition: Assertion.h:55
Class that extends the Assertion class to support the checkTestXxx() and assertTestXxx() macros that ...
Definition: MetaAssertion.h:42
bool assertionTestStatus(const char *file, uint16_t line, const char *testName, const __FlashStringHelper *statusMessage, bool ok)
Set the status of the current test using the 'ok' status from another test, and print the assertion m...
void setStatusNow(const char *file, uint16_t line, uint8_t status, const __FlashStringHelper *statusString)
Set the status of the current test to 'status' and print a message.
MetaAssertion()
Empty constructor.
Definition: MetaAssertion.h:59
bool isOutputEnabledForStatus(uint8_t status) const
Return true if setting of status should print a message.