#include "gromacs/commandline/cmdlinemodulemanager.h"
-#include <cstdio>
-
#include <gmock/gmock.h>
-#include "gromacs/commandline/cmdlinehelpcontext.h"
-#include "gromacs/commandline/cmdlinemodule.h"
-#include "gromacs/commandline/cmdlineoptionsmodule.h"
-#include "gromacs/commandline/cmdlineprogramcontext.h"
-#include "gromacs/options/basicoptions.h"
-#include "gromacs/options/options.h"
-#include "gromacs/utility/file.h"
-
-#include "gromacs/onlinehelp/tests/mock_helptopic.h"
#include "testutils/cmdlinetest.h"
-#include "testutils/stringtest.h"
#include "testutils/testasserts.h"
-#include "testutils/testfilemanager.h"
+
+#include "cmdlinemodulemanagertest.h"
namespace
{
using gmx::test::CommandLine;
-using gmx::test::MockHelpTopic;
-
-/*! \brief
- * Helper method to disable nice() calls from CommandLineModuleManager.
- *
- * \ingroup module_commandline
- */
-void disableNice(gmx::CommandLineModuleSettings *settings)
-{
- settings->setDefaultNiceLevel(0);
-}
-
-/********************************************************************
- * MockModule
- */
-
-/*! \internal \brief
- * Mock implementation of gmx::CommandLineModuleInterface.
- *
- * \ingroup module_commandline
- */
-class MockModule : public gmx::CommandLineModuleInterface
-{
- public:
- //! Creates a mock module with the given name and description.
- MockModule(const char *name, const char *description);
-
- virtual const char *name() const { return name_; }
- virtual const char *shortDescription() const { return descr_; }
-
- MOCK_METHOD1(init, void(gmx::CommandLineModuleSettings *settings));
- MOCK_METHOD2(run, int(int argc, char *argv[]));
- MOCK_CONST_METHOD1(writeHelp, void(const gmx::CommandLineHelpContext &context));
-
- //! Sets the expected display name for writeHelp() calls.
- void setExpectedDisplayName(const char *expected)
- {
- expectedDisplayName_ = expected;
- }
-
- private:
- //! Checks the context passed to writeHelp().
- void checkHelpContext(const gmx::CommandLineHelpContext &context) const;
+using gmx::test::MockModule;
- const char *name_;
- const char *descr_;
- std::string expectedDisplayName_;
-};
-
-MockModule::MockModule(const char *name, const char *description)
- : name_(name), descr_(description)
-{
- using ::testing::_;
- using ::testing::Invoke;
- ON_CALL(*this, init(_))
- .WillByDefault(Invoke(&disableNice));
- ON_CALL(*this, writeHelp(_))
- .WillByDefault(Invoke(this, &MockModule::checkHelpContext));
-}
-
-void MockModule::checkHelpContext(const gmx::CommandLineHelpContext &context) const
-{
- EXPECT_EQ(expectedDisplayName_, context.moduleDisplayName());
-
- gmx::TextLineWrapperSettings settings;
- std::string moduleName =
- context.writerContext().substituteMarkupAndWrapToString(
- settings, "[THISMODULE]");
- EXPECT_EQ(expectedDisplayName_, moduleName);
-}
-
-/********************************************************************
- * MockOptionsModule
- */
-
-/*! \internal \brief
- * Mock implementation of gmx::CommandLineOptionsModuleInterface.
- *
- * \ingroup module_commandline
- */
-class MockOptionsModule : public gmx::CommandLineOptionsModuleInterface
-{
- public:
- MockOptionsModule();
-
- MOCK_METHOD1(init, void(gmx::CommandLineModuleSettings *settings));
- MOCK_METHOD1(initOptions, void(gmx::Options *options));
- MOCK_METHOD1(optionsFinished, void(gmx::Options *options));
- MOCK_METHOD0(run, int());
-};
-
-MockOptionsModule::MockOptionsModule()
-{
- using ::testing::_;
- using ::testing::Invoke;
- ON_CALL(*this, init(_))
- .WillByDefault(Invoke(&disableNice));
-}
-
-/********************************************************************
- * Test fixture for the tests
- */
-
-class CommandLineModuleManagerTest : public gmx::test::StringTestBase
-{
- public:
- void initManager(const CommandLine &args, const char *realBinaryName);
- MockModule &addModule(const char *name, const char *description);
- MockOptionsModule &addOptionsModule(const char *name, const char *description);
- MockHelpTopic &addHelpTopic(const char *name, const char *title);
-
- gmx::CommandLineModuleManager &manager() { return *manager_; }
-
- void redirectManagerOutput()
- {
- manager_->setOutputRedirector(&initOutputRedirector(&fileManager_));
- }
-
- private:
- boost::scoped_ptr<gmx::CommandLineProgramContext> programContext_;
- boost::scoped_ptr<gmx::CommandLineModuleManager> manager_;
- gmx::test::TestFileManager fileManager_;
-};
-
-void CommandLineModuleManagerTest::initManager(
- const CommandLine &args, const char *realBinaryName)
-{
- manager_.reset();
- programContext_.reset(
- new gmx::CommandLineProgramContext(args.argc(), args.argv()));
- manager_.reset(new gmx::CommandLineModuleManager(realBinaryName,
- programContext_.get()));
- manager_->setQuiet(true);
-}
-
-MockModule &
-CommandLineModuleManagerTest::addModule(const char *name, const char *description)
-{
- MockModule *module = new MockModule(name, description);
- manager().addModule(gmx::CommandLineModulePointer(module));
- return *module;
-}
-
-MockOptionsModule &
-CommandLineModuleManagerTest::addOptionsModule(const char *name, const char *description)
-{
- MockOptionsModule *module = new MockOptionsModule();
- gmx::CommandLineOptionsModuleInterface::registerModule(
- &manager(), name, description, module);
- return *module;
-}
-
-MockHelpTopic &
-CommandLineModuleManagerTest::addHelpTopic(const char *name, const char *title)
-{
- MockHelpTopic *topic = new MockHelpTopic(name, title, "Help text");
- manager().addHelpTopic(gmx::HelpTopicPointer(topic));
- return *topic;
-}
-
-/********************************************************************
- * Actual tests
- */
-
-TEST_F(CommandLineModuleManagerTest, RunsGeneralHelp)
-{
- const char *const cmdline[] = {
- "test"
- };
- CommandLine args(cmdline);
- initManager(args, "test");
- redirectManagerOutput();
- addModule("module", "First module");
- addModule("other", "Second module");
- int rc = 0;
- ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
- ASSERT_EQ(0, rc);
- checkRedirectedOutputFiles();
-}
+//! Test fixture for the tests.
+typedef gmx::test::CommandLineModuleManagerTestBase CommandLineModuleManagerTest;
TEST_F(CommandLineModuleManagerTest, RunsModule)
{
ASSERT_EQ(0, rc);
}
-TEST_F(CommandLineModuleManagerTest, PrintsHelpOnTopic)
-{
- const char *const cmdline[] = {
- "test", "help", "topic"
- };
- CommandLine args(cmdline);
- initManager(args, "test");
- addModule("module", "First module");
- MockHelpTopic &topic = addHelpTopic("topic", "Test topic");
- using ::testing::_;
- EXPECT_CALL(topic, writeHelp(_));
- int rc = 0;
- ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
- ASSERT_EQ(0, rc);
-}
-
TEST_F(CommandLineModuleManagerTest, HandlesConflictingBinaryAndModuleNames)
{
const char *const cmdline[] = {
ASSERT_EQ(0, rc);
}
-/*! \brief
- * Initializes Options for help export tests.
- *
- * \ingroup module_commandline
- */
-void initOptionsBasic(gmx::Options *options)
-{
- const char *const desc[] = {
- "Sample description",
- "for testing [THISMODULE]."
- };
- options->setDescription(desc);
- options->addOption(gmx::IntegerOption("int"));
-}
-
-TEST_F(CommandLineModuleManagerTest, ExportsHelp)
-{
- const char *const cmdline[] = {
- "test", "help", "-export", "rst"
- };
- // TODO: Find a more elegant solution, or get rid of the links.dat altogether.
- gmx::File::writeFileFromString("links.dat", "");
- CommandLine args(cmdline);
- initManager(args, "test");
- redirectManagerOutput();
- MockOptionsModule &mod1 = addOptionsModule("module", "First module");
- MockOptionsModule &mod2 = addOptionsModule("other", "Second module");
- {
- gmx::CommandLineModuleGroup group = manager().addModuleGroup("Group 1");
- group.addModule("module");
- }
- {
- gmx::CommandLineModuleGroup group = manager().addModuleGroup("Group 2");
- group.addModule("other");
- }
- using ::testing::_;
- using ::testing::Invoke;
- EXPECT_CALL(mod1, initOptions(_)).WillOnce(Invoke(&initOptionsBasic));
- EXPECT_CALL(mod2, initOptions(_));
- int rc = 0;
- ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
- ASSERT_EQ(0, rc);
- checkRedirectedOutputFiles();
- std::remove("links.dat");
-}
-
} // namespace
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff