ovstest: Fix a typo in a comment.

[mirror_ovs.git] / tests / ovstest.h

/*
 * Copyright (c) 2014 Nicira, Inc.
 *
 * 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.
 */

#ifndef OVSTEST_H
#define OVSTEST_H

#include "compiler.h"

/* Overview
 * ========
 *
 * OVS tests directory contains many small test programs. One down side
 * of building them as individual programs is that they all have to be
 * linked whenever a library function is modified.
 *
 * ovstest is an attempt to improve the overall build time by linking
 * all test programs into a single program, ovs-test. Regardless of
 * the number of test programs, linking will be done only once to produce
 * ovstest.
 *
 * With ovstest, each test programs now becomes a sub program of ovstest.
 * For example, 'mytest' program, can now be invoked as 'ovstest mytest'.
 *
 * 'ovstest --help' will list all test programs can be invoked.
 *
 * The 'Usage' section below documents how to add a new sub program
 * to ovstest using OVSTEST_REIGSTER macros.
 */

typedef void (*ovstest_func)(int argc, char *argv[]);
void ovstest_register(const char *test_name, ovstest_func f);

/* Usage
 * =====
 *
 * For each sub test program, its 'main' program should be named as
 * '<test_name>_main()'.
 *
 * The 'main' programs should be registered with ovstest as a sub program.
 *    OVSTEST_REGISTER(name, function)
 *
 * 'name' will be name of the test program. It is expected as argv[1] when
 * invoking with ovstest.
 *
 * 'function' is the 'main' program mentioned above.
 *
 * Example:
 * ----------
 *
 * Suppose the test program is called my-test.c
 * ...
 *
 * static void
 * my_test_main(int argc, char *argv[])
 * {
 *   ....
 * }
 *
 * OVSTEST_REGISTER("my-test", my_test_main);
 */
#define OVSTEST_REGISTER(name, function) \
    OVS_CONSTRUCTOR(register_##function) { \
        ovstest_register(name, function); \
    }

#endif