test_base.h

/* Base tests utilities
 * Copyright (C) 2025 Aaron M. Ucko
 * Copyright (C) 2025 Frediano Ziglio
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef _tdsguard_afBM6E9n8CuIFSBHNNblq5_
#define _tdsguard_afBM6E9n8CuIFSBHNNblq5_

/*
 * Base header for FreeTDS unit tests, even those just covering helpers
 * from the utils and replacements trees.  Should be included first
 * (possibly via a common.h) to be certain of preceding <assert.h>.
 */

/* Ensure assert is always active. */
#if defined(assert) && defined(NDEBUG)
#  error "Include test_base.h (or common.h) earlier"
#endif

#undef NDEBUG

#include <config.h>

#include <freetds/bool.h>
#include <freetds/macros.h>

/*
 * Tests should define test_main in lieu of main so that they can be
 * configured to suppress automation-unfriendly crash dialog boxes on
 * Windows.  To that end, they can use the TEST_MAIN macro, which cleanly
 * avoids warnings for the tests that ignore their arguments (but still
 * provides the details under conventional names for the remainder).
 */
int test_main(int argc, char **argv);

#define TEST_MAIN() int test_main(int argc TDS_UNUSED, char **argv TDS_UNUSED)

typedef struct
{
    char server[512];
    char database[512];
    char user[512];
    char password[512];
    char driver[1024];  /* ODBC-only */
    char charset[512];  /* TDS only */
    int maxlength;
    bool fverbose;
    bool initialized;
    bool tried_env;
} COMMON_PWD;

extern COMMON_PWD common_pwd;

#define DEFAULT_PWD_PATH "../../../PWD"

/*
 * Both return the path used (favoring $TDSPWDFILE in the absence of
 * tried_env) on success or NULL on failure (silently in the case of
 * try_read_login_info), and defer to any existing settings from
 * e.g. the command line.
 */
const char *read_login_info_base(COMMON_PWD * common_pwd, const char *default_path);
const char *try_read_login_info_base(COMMON_PWD * common_pwd, const char *default_path);

#endif /* _tdsguard_afBM6E9n8CuIFSBHNNblq5_ */