ut.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_UT_UT_H__
#define __MOTR_UT_UT_H__

#include "module/module.h"
#include "lib/types.h"
#include "lib/list.h"     /* m0_list_link, m0_list */
#include "fid/fid.h"

struct m0_ut_module;

# define M0_UT_ASSERT(a) m0_ut_assertimpl((a), #a, __FILE__, __LINE__, __func__)

#if defined M0_UT_TRACE && M0_UT_TRACE > 0
#  define M0_UT_ENTER(FMT, ...) \
        m0_console_printf("> %s: " FMT "\n", __func__, ## __VA_ARGS__)
#  define M0_UT_LOG(FMT, ...) \
        m0_console_printf("* %s: " FMT "\n", __func__, ## __VA_ARGS__)
#  define M0_UT_RETURN(FMT, ...) \
        m0_console_printf("< %s: " FMT "\n", __func__, ## __VA_ARGS__)
#else
#  define M0_UT_ENTER(...)
#  define M0_UT_LOG(...)
#  define M0_UT_RETURN(...)
#endif

struct m0_ut {
        const char *t_name;
        void      (*t_proc)(void);
        const char *t_owner;
        bool        t_enabled;
};

enum { M0_UT_SUITE_TESTS_MAX = 128 };

struct m0_ut_suite {
        struct m0_module           ts_module;
        const struct m0_ut_moddep *ts_deps;
        unsigned                   ts_deps_nr;
        struct m0_list_link        ts_linkage;
        bool                       ts_enabled;
        bool                       ts_masked;
        const char                *ts_name;
        const char                *ts_owners;
        const char                *ts_yaml_config_string;
        int                      (*ts_init)(void);
        int                      (*ts_fini)(void);
        struct m0_ut               ts_tests[M0_UT_SUITE_TESTS_MAX];
        int                        ts_order;
};

int m0_ut_init(struct m0 *instance);
void m0_ut_fini(void);

M0_INTERNAL void m0_ut_add(struct m0_ut_module *m, struct m0_ut_suite *ts,
                           bool enable);

M0_INTERNAL void m0_ut_shuffle(unsigned seed);

M0_INTERNAL void m0_ut_start_from(const char *suite);

M0_INTERNAL int m0_ut_run(void);

M0_INTERNAL bool m0_ut_small_credits(void);

M0_INTERNAL void m0_ut_list(bool with_tests, bool yaml_output);

M0_INTERNAL void m0_ut_list_owners(void);

M0_INTERNAL bool m0_ut_assertimpl(bool c, const char *str_c, const char *file,
                                  int lno, const char *func);

M0_INTERNAL int m0_ut_enable_fault_point(const char *str);

M0_INTERNAL int m0_ut_enable_fault_points_from_file(const char *file_name);

#ifndef __KERNEL__
#include <stdio.h>       /* FILE, fpos_t */

struct m0_ut_redirect {
        FILE  *ur_stream;
        int    ur_oldfd;
        int    ur_fd;
        fpos_t ur_pos;
};

M0_INTERNAL void m0_stream_redirect(FILE * stream, const char *path,
                                    struct m0_ut_redirect *redir);
M0_INTERNAL void m0_stream_restore(const struct m0_ut_redirect *redir);

M0_INTERNAL bool m0_error_mesg_match(FILE * fp, const char *mesg);
#endif

M0_EXTERN struct m0_fid g_process_fid;

#endif /* __MOTR_UT_UT_H__ */