examples-as-tests-test-suite.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Lawrence Livermore National Laboratory
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Peter D. Barnes, Jr. <pdbarnes@llnl.gov>
 */
 
#include "ns3/example-as-test.h"
#include "ns3/system-path.h"
 
using namespace ns3;
 
/**
 * @file
 * @ingroup examples-as-tests
 * Examples-as-tests test suite
 */
 
/**
 * @ingroup core-tests
 * @ingroup testing
 * @defgroup examples-as-tests Examples as tests test suite
 *
 * Runs several examples as tests in order to test ExampleAsTestSuite and ExampleAsTestCase.
 */
namespace ns3
{
 
namespace tests
{
 
/**
 * @ingroup examples-as-tests
 * Run command line example as a test case
 */
class CommandLineExampleTestCase : public ExampleAsTestCase
{
  public:
    /**
     * Default constructor
     */
    CommandLineExampleTestCase();
 
    /**
     * Destructor
     */
    ~CommandLineExampleTestCase() override;
 
    /**
     * Override this function to filter the version string from
     * the command-line-example output.
     * Since the version changes each time a commit is made it shouldn't
     * be tested as part of the command-line-example output.
     *
     * @returns The string of post-processing commands.
     */
    std::string GetPostProcessingCommand() const override;
};
 
CommandLineExampleTestCase::CommandLineExampleTestCase()
    : ExampleAsTestCase("core-example-command-line",
                        "command-line-example",
                        NS_TEST_SOURCEDIR,
                        "--intArg=2 --boolArg --strArg=deadbeef --anti=t "
                        "--cbArg=beefstew --charbuf=stewmeat 3 4 extraOne extraTwo")
{
}
 
CommandLineExampleTestCase::~CommandLineExampleTestCase()
{
}
 
std::string
CommandLineExampleTestCase::GetPostProcessingCommand() const
{
    // Delete the line that starts with Program Version:
    return std::string(R"__(| sed -e "/^Program Version:.*$/d")__");
}
 
/**
 * @ingroup examples-as-tests
 * Run examples as tests, checking stdout for regressions.
 */
class ExamplesAsTestsTestSuite : public TestSuite
{
  public:
    ExamplesAsTestsTestSuite();
};
 
ExamplesAsTestsTestSuite::ExamplesAsTestsTestSuite()
    : TestSuite("examples-as-tests-test-suite", Type::UNIT)
{
    AddTestCase(
        new ExampleAsTestCase("core-example-simulator", "sample-simulator", NS_TEST_SOURCEDIR));
 
    AddTestCase(new ExampleAsTestCase("core-example-sample-random-variable",
                                      "sample-random-variable",
                                      NS_TEST_SOURCEDIR));
 
    AddTestCase(new CommandLineExampleTestCase());
}
 
/**
 * @ingroup examples-as-tests
 * ExampleAsTestsTestSuite instance variable.
 * Tests multiple examples in a single TestSuite using AddTestCase to add the examples to the suite.
 */
static ExamplesAsTestsTestSuite g_examplesAsTestsTestSuite;
 
/**
 * @ingroup examples-as-tests
 * ExampleTestSuite instance variables.
 *
 * Tests ExampleTestSuite which runs a single example as test suite as specified in constructor
 * arguments.
 */
 
static ExampleAsTestSuite g_exampleCommandLineTest("core-example-simulator",
                                                   "sample-simulator",
                                                   NS_TEST_SOURCEDIR);
 
} // namespace tests
 
} // namespace ns3