mu/lib/utils/mu-test-utils.hh

/*
** Copyright (C) 2008-2023 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** This program is free software; you can redistribute it and/or modify it
** under the terms of the GNU General Public License as published by the
** Free Software Foundation; either version 3, or (at your option) any
** later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software Foundation,
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**
*/

#ifndef MU_TEST_UTILS_HH__
#define MU_TEST_UTILS_HH__

#include <initializer_list>
#include <string>
#include <utils/mu-utils.hh>
#include <utils/mu-result.hh>

namespace Mu {

/**
 * mu wrapper for g_test_init. Sets environment variable MU_TEST to 1.
 *
 * @param argc
 * @param argv
 */
void mu_test_init(int *argc, char ***argv);


/**
 * Are we running in a MU_HACKER environment?
 *
 * @return true or false
 */
bool mu_test_mu_hacker();

/**
 * set the timezone
 *
 * @param tz timezone
 *
 * @return the old timezone
 */
const char* set_tz(const char* tz);

/**
 * switch the locale to en_US.utf8, return TRUE if it succeeds
 *
 * @return true if the switch succeeds, false otherwise
 */
bool set_en_us_utf8_locale();


/**
 * For unit tests, assert two std::string's are equal.
 *
 * @param s1 string1
 * @param s2 string2
 */
#define assert_equal(s1__,s2__) do {					\
		std::string s1s__(s1__), s2s__(s2__);			\
		g_assert_cmpstr(s1s__.c_str(), ==, s2s__.c_str());	\
	} while(0)


#define assert_equal_seq(seq1__, seq2__) do {				\
		g_assert_cmpuint(seq1__.size(), ==, seq2__.size());	\
		size_t n__{};						\
		for (auto&& item__: seq1__) {				\
			g_assert_true(item__ == seq2__.at(n__));	\
			++n__;						\
		}							\
		} while(0)

#define assert_equal_seq_str(seq1__, seq2__) do {			\
		g_assert_cmpuint(seq1__.size(), ==, seq2__.size());	\
		size_t n__{};						\
		for (auto&& item__: seq1__) {				\
			assert_equal(item__, seq2__.at(n__));		\
			++n__;						\
		}							\
		} while(0)

#define assert_valid_command(RCO) do {					\
	assert_valid_result(RCO);					\
	if ((RCO)->exit_code != 0 && !(RCO)->standard_err.empty())	\
		mu_printerrln("{}:{}: {}",				\
			      __FILE__, __LINE__, (RCO)->standard_err);	\
	g_assert_cmpuint((RCO)->exit_code, ==, 0);			\
} while (0)

/**
 * For unit-tests, allow warnings in the current function.
 *
 */
void allow_warnings();


/**
 * For unit-tests, a RAII tempdir.
 *
 */
struct TempDir {
	/**
	 * Construct a temporary directory
	 */
	TempDir(bool autodelete=true);

	/**
	 * DTOR; removes the temporary directory
	 *
	 *
	 * @return
	 */
	~TempDir();

	/**
	 * Path to the temporary directory
	 *
	 * @return the path.
	 */
	const std::string& path() const { return path_; }
private:
	std::string path_;
	const bool autodelete_;
};

static inline auto format_as(const TempDir& td) {
	return td.path();
}


/**
 * Temporary (RAII) timezone
 */
struct TempTz {
	TempTz(const char* tz) {
		if (timezone_available(tz))
			old_tz_ = set_tz(tz);
		else
			old_tz_ = {};
		mu_debug("timezone '{}' {}available", tz, old_tz_ ? "": "not ");
	}
	~TempTz() {
		if (old_tz_) {
			mu_debug("reset timezone to '{}'", old_tz_);
			set_tz(old_tz_);
		}
	}
	bool available() const { return !!old_tz_; }
private:
	const char *old_tz_{};
};

} // namepace Mu


#endif /* MU_TEST_UTILS_HH__ */