tests/logging.h

Go to the documentation of this file.

#ifndef LOGGING_H
#define LOGGING_H
 
#include <stdbool.h>
 
int test_logging_disable(bool disable_stdout, bool disable_stderr);
 
int test_logging_restore(void);
 
bool test_logging_is_disabled(void);
 
// ============================================================================
// Convenience Macros for Test Suites
// ============================================================================
 
#define TEST_LOGGING_SETUP_AND_TEARDOWN()                                                                              \
  void setup_quiet_test_logging(void) {                                                                                \
    test_logging_disable(true, true);                                                                                  \
  }                                                                                                                    \
  void restore_test_logging(void) {                                                                                    \
    test_logging_restore();                                                                                            \
  }
 
#define TEST_LOGGING_SETUP_AND_TEARDOWN_WITH_LOG_LEVELS(setup_level, restore_level, disable_stdout, disable_stderr)    \
  void setup_quiet_test_logging(void) {                                                                                \
    log_set_level(setup_level);                                                                                        \
    test_logging_disable(disable_stdout, disable_stderr);                                                              \
  }                                                                                                                    \
  void restore_test_logging(void) {                                                                                    \
    log_set_level(restore_level);                                                                                      \
    test_logging_restore();                                                                                            \
  }
 
#define TEST_LOGGING_SETUP_AND_TEARDOWN_WITH_LOG_LEVEL()                                                               \
  TEST_LOGGING_SETUP_AND_TEARDOWN_WITH_LOG_LEVELS(LOG_FATAL, LOG_DEBUG, true, true)
 
#define TEST_SUITE_WITH_QUIET_LOGGING_AND_LOG_LEVELS(suite_name, setup_level, restore_level, disable_stdout,           \
                                                     disable_stderr, ...)                                              \
  void setup_quiet_test_logging_##suite_name(void) {                                                                   \
    log_set_level(setup_level);                                                                                        \
    test_logging_disable(disable_stdout, disable_stderr);                                                              \
  }                                                                                                                    \
  void restore_test_logging_##suite_name(void) {                                                                       \
    log_set_level(restore_level);                                                                                      \
    test_logging_restore();                                                                                            \
  }                                                                                                                    \
  TestSuite(suite_name, .init = setup_quiet_test_logging_##suite_name, .fini = restore_test_logging_##suite_name,      \
            ##__VA_ARGS__);
 
#define TEST_SUITE_WITH_QUIET_LOGGING(suite_name, ...)                                                                 \
  void setup_quiet_test_logging_##suite_name(void) {                                                                   \
    test_logging_disable(true, true);                                                                                  \
  }                                                                                                                    \
  void restore_test_logging_##suite_name(void) {                                                                       \
    test_logging_restore();                                                                                            \
  }                                                                                                                    \
  TestSuite(suite_name, .init = setup_quiet_test_logging_##suite_name, .fini = restore_test_logging_##suite_name,      \
            ##__VA_ARGS__);
 
#define TEST_SUITE_WITH_QUIET_LOGGING_AND_LOG_LEVEL(suite_name, ...)                                                   \
  void setup_quiet_test_logging_##suite_name(void) {                                                                   \
    log_set_level(LOG_FATAL);                                                                                          \
    test_logging_disable(true, true);                                                                                  \
  }                                                                                                                    \
  void restore_test_logging_##suite_name(void) {                                                                       \
    log_set_level(LOG_DEBUG);                                                                                          \
    test_logging_restore();                                                                                            \
  }                                                                                                                    \
  TestSuite(suite_name, .init = setup_quiet_test_logging_##suite_name, .fini = restore_test_logging_##suite_name,      \
            ##__VA_ARGS__);
 
#define TEST_LOGGING_TEMPORARILY_DISABLE()                                                                             \
  bool _logging_was_disabled = test_logging_is_disabled();                                                             \
  if (!_logging_was_disabled) {                                                                                        \
    test_logging_disable(true, true);                                                                                  \
  }                                                                                                                    \
  /* Note: Restoration happens automatically when test ends */
 
#define TEST_LOGGING_TEMPORARILY_DISABLE_STDOUT()                                                                      \
  bool _logging_was_disabled = test_logging_is_disabled();                                                             \
  if (!_logging_was_disabled) {                                                                                        \
    test_logging_disable(true, false);                                                                                 \
  }
 
#define TEST_LOGGING_TEMPORARILY_DISABLE_STDERR()                                                                      \
  bool _logging_was_disabled = test_logging_is_disabled();                                                             \
  if (!_logging_was_disabled) {                                                                                        \
    test_logging_disable(false, true);                                                                                 \
  }
 
#define TEST_SUITE_WITH_DEBUG_LOGGING(suite_name, ...)                                                                 \
  TEST_SUITE_WITH_QUIET_LOGGING_AND_LOG_LEVELS(suite_name, LOG_DEBUG, LOG_DEBUG, false, false, ##__VA_ARGS__)
 
#define TEST_SUITE_WITH_VERBOSE_LOGGING(suite_name, ...) TEST_SUITE_WITH_DEBUG_LOGGING(suite_name, ##__VA_ARGS__)
 
#endif // LOGGING_H