src/gromacs/commandline/tests/cmdlinemodulemanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Tests gmx::CommandLineModuleManager.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_commandline
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "gromacs/commandline/cmdlinemodulemanager.h"
  46
  47 #include <gmock/gmock.h>
  48
  49 #include "testutils/cmdlinetest.h"
  50 #include "testutils/testasserts.h"
  51
  52 #include "cmdlinemodulemanagertest.h"
  53
  54 namespace
  55 {
  56
  57 using gmx::test::CommandLine;
  58 using gmx::test::MockModule;
  59
  60 //! Test fixture for the tests.
  61 typedef gmx::test::CommandLineModuleManagerTestBase CommandLineModuleManagerTest;
  62
  63 TEST_F(CommandLineModuleManagerTest, RunsModule)
  64 {
  65     const char* const cmdline[] = { "test", "module", "-flag", "yes" };
  66     CommandLine       args(cmdline);
  67     initManager(args, "test");
  68     MockModule& mod1 = addModule("module", "First module");
  69     addModule("other", "Second module");
  70     using ::testing::_;
  71     using ::testing::Args;
  72     using ::testing::ElementsAreArray;
  73     EXPECT_CALL(mod1, init(_));
  74     EXPECT_CALL(mod1, run(_, _)).With(Args<1, 0>(ElementsAreArray(args.argv() + 1, args.argc() - 1)));
  75     int rc = 0;
  76     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
  77     ASSERT_EQ(0, rc);
  78 }
  79
  80 TEST_F(CommandLineModuleManagerTest, RunsModuleHelp)
  81 {
  82     const char* const cmdline[] = { "test", "help", "module" };
  83     CommandLine       args(cmdline);
  84     initManager(args, "test");
  85     MockModule& mod1 = addModule("module", "First module");
  86     addModule("other", "Second module");
  87     using ::testing::_;
  88     EXPECT_CALL(mod1, writeHelp(_));
  89     mod1.setExpectedDisplayName("test module");
  90     int rc = 0;
  91     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
  92     ASSERT_EQ(0, rc);
  93 }
  94
  95 TEST_F(CommandLineModuleManagerTest, RunsModuleHelpAfterQuiet)
  96 {
  97     const char* const cmdline[] = { "test", "-quiet", "help", "module" };
  98     CommandLine       args(cmdline);
  99     initManager(args, "test");
 100     MockModule& mod1 = addModule("module", "First module");
 101     addModule("other", "Second module");
 102     using ::testing::_;
 103     EXPECT_CALL(mod1, writeHelp(_));
 104     mod1.setExpectedDisplayName("test module");
 105     int rc = 0;
 106     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
 107     ASSERT_EQ(0, rc);
 108 }
 109
 110 TEST_F(CommandLineModuleManagerTest, RunsModuleHelpWithDashH)
 111 {
 112     const char* const cmdline[] = { "test", "module", "-h" };
 113     CommandLine       args(cmdline);
 114     initManager(args, "test");
 115     MockModule& mod1 = addModule("module", "First module");
 116     addModule("other", "Second module");
 117     using ::testing::_;
 118     EXPECT_CALL(mod1, writeHelp(_));
 119     mod1.setExpectedDisplayName("test module");
 120     int rc = 0;
 121     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
 122     ASSERT_EQ(0, rc);
 123 }
 124
 125 TEST_F(CommandLineModuleManagerTest, RunsModuleHelpWithDashHWithSingleModule)
 126 {
 127     const char* const cmdline[] = { "g_module", "-h" };
 128     CommandLine       args(cmdline);
 129     initManager(args, "g_module");
 130     MockModule mod(nullptr, nullptr);
 131     manager().setSingleModule(&mod);
 132     using ::testing::_;
 133     EXPECT_CALL(mod, writeHelp(_));
 134     mod.setExpectedDisplayName("g_module");
 135     int rc = 0;
 136     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
 137     ASSERT_EQ(0, rc);
 138 }
 139
 140 TEST_F(CommandLineModuleManagerTest, HandlesConflictingBinaryAndModuleNames)
 141 {
 142     const char* const cmdline[] = { "test", "test", "-flag", "yes" };
 143     CommandLine       args(cmdline);
 144     initManager(args, "test");
 145     MockModule& mod1 = addModule("test", "Test module");
 146     addModule("other", "Second module");
 147     using ::testing::_;
 148     using ::testing::Args;
 149     using ::testing::ElementsAreArray;
 150     EXPECT_CALL(mod1, init(_));
 151     EXPECT_CALL(mod1, run(_, _)).With(Args<1, 0>(ElementsAreArray(args.argv() + 1, args.argc() - 1)));
 152     int rc = 0;
 153     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
 154     ASSERT_EQ(0, rc);
 155 }
 156
 157 } // namespace