2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Implements classes from cmdlinetest.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_testutils
44 #include "cmdlinetest.h"
54 #include "gromacs/commandline/cmdlinehelpcontext.h"
55 #include "gromacs/commandline/cmdlineoptionsmodule.h"
56 #include "gromacs/commandline/cmdlineprogramcontext.h"
57 #include "gromacs/utility/arrayref.h"
58 #include "gromacs/utility/futil.h"
59 #include "gromacs/utility/gmxassert.h"
60 #include "gromacs/utility/strconvert.h"
61 #include "gromacs/utility/stringstream.h"
62 #include "gromacs/utility/stringutil.h"
63 #include "gromacs/utility/textreader.h"
64 #include "gromacs/utility/textwriter.h"
66 #include "testutils/filematchers.h"
67 #include "testutils/refdata.h"
68 #include "testutils/testfilemanager.h"
75 /********************************************************************
79 class CommandLine::Impl
82 Impl(const ArrayRef
<const char *const> &cmdline
);
83 Impl(const ArrayRef
<const std::string
> &cmdline
);
86 std::vector
<char *> args_
;
87 std::vector
<char *> argv_
;
91 CommandLine::Impl::Impl(const ArrayRef
<const char *const> &cmdline
)
93 args_
.reserve(cmdline
.size());
94 argv_
.reserve(cmdline
.size() + 1);
95 argc_
= static_cast<int>(cmdline
.size());
96 for (const auto &arg
: cmdline
)
98 char *argCopy
= strdup(arg
);
99 if (argCopy
== nullptr)
101 throw std::bad_alloc();
103 args_
.push_back(argCopy
);
104 argv_
.push_back(argCopy
);
106 argv_
.push_back(nullptr);
112 //! Helper function so we can delegate from the std::string constructor to the const char * one.
113 std::vector
<const char*> convertFromStringArrayRef(const ArrayRef
<const std::string
> &cmdline
)
115 std::vector
<const char*> v(cmdline
.size());
116 std::transform(cmdline
.begin(), cmdline
.end(), v
.begin(), [](const std::string
&s
){return s
.c_str(); });
122 // This makes a new temporary vector of views of the const char * in
123 // the view passed in. Those are then deep copied in the constructor
125 CommandLine::Impl::Impl(const ArrayRef
<const std::string
> &cmdline
)
126 : Impl(convertFromStringArrayRef(cmdline
)) {}
128 CommandLine::Impl::~Impl()
130 for (size_t i
= 0; i
< args_
.size(); ++i
)
136 /********************************************************************
140 CommandLine::CommandLine()
141 : impl_(new Impl(ArrayRef
<const char *>{}))
145 CommandLine::CommandLine(const ArrayRef
<const char *const> &cmdline
)
146 : impl_(new Impl(cmdline
))
150 CommandLine::CommandLine(const ArrayRef
<const std::string
> &cmdline
)
151 : impl_(new Impl(cmdline
))
155 CommandLine::CommandLine(const CommandLine
&other
)
156 : impl_(new Impl(arrayRefFromArray(other
.argv(), other
.argc())))
160 CommandLine::~CommandLine()
164 void CommandLine::initFromArray(const ArrayRef
<const char *const> &cmdline
)
166 impl_
.reset(new Impl(cmdline
));
169 void CommandLine::append(const char *arg
)
171 GMX_RELEASE_ASSERT(impl_
->argc_
== static_cast<int>(impl_
->args_
.size()),
172 "Command-line has been modified externally");
173 size_t newSize
= impl_
->args_
.size() + 1;
174 impl_
->args_
.reserve(newSize
);
175 impl_
->argv_
.reserve(newSize
+ 1);
176 char *newArg
= strdup(arg
);
177 if (newArg
== nullptr)
179 throw std::bad_alloc();
181 impl_
->args_
.push_back(newArg
);
182 impl_
->argv_
.pop_back(); // Remove the trailing NULL.
183 impl_
->argv_
.push_back(newArg
);
184 impl_
->argv_
.push_back(nullptr);
185 impl_
->argc_
= static_cast<int>(newSize
);
188 void CommandLine::addOption(const char *name
)
193 void CommandLine::addOption(const char *name
, const char *value
)
199 void CommandLine::addOption(const char *name
, const std::string
&value
)
201 addOption(name
, value
.c_str());
204 void CommandLine::addOption(const char *name
, int value
)
207 append(gmx::toString(value
));
210 void CommandLine::addOption(const char *name
, double value
)
213 append(gmx::toString(value
));
216 void CommandLine::merge(const CommandLine
&args
)
220 // Skip first argument if it is the module name.
221 const int firstArg
= (args
.arg(0)[0] == '-' ? 0 : 1);
222 for (int i
= firstArg
; i
< args
.argc(); ++i
)
229 int &CommandLine::argc()
233 char **CommandLine::argv()
235 return &impl_
->argv_
[0];
237 int CommandLine::argc() const
241 const char *const *CommandLine::argv() const
243 return &impl_
->argv_
[0];
245 const char *CommandLine::arg(int i
) const
247 return impl_
->argv_
[i
];
250 std::string
CommandLine::toString() const
252 return CommandLineProgramContext(argc(), argv()).commandLine();
255 bool CommandLine::contains(const char *name
) const
257 for (int i
= 0; i
< impl_
->argc_
; ++i
)
259 if (std::strcmp(arg(i
), name
) == 0)
267 /********************************************************************
268 * CommandLineTestHelper::Impl
271 class CommandLineTestHelper::Impl
274 struct OutputFileInfo
276 OutputFileInfo(const char *option
, const std::string
&path
,
277 FileMatcherPointer matcher
)
278 : option(option
), path(path
), matcher(move(matcher
))
284 FileMatcherPointer matcher
;
287 typedef std::vector
<OutputFileInfo
> OutputFileList
;
289 explicit Impl(TestFileManager
*fileManager
)
290 : fileManager_(*fileManager
)
294 TestFileManager
&fileManager_
;
295 OutputFileList outputFiles_
;
298 /********************************************************************
299 * CommandLineTestHelper
303 int CommandLineTestHelper::runModuleDirect(
304 ICommandLineModule
*module
, CommandLine
*commandLine
)
306 CommandLineModuleSettings settings
;
307 module
->init(&settings
);
308 return module
->run(commandLine
->argc(), commandLine
->argv());
312 int CommandLineTestHelper::runModuleDirect(
313 std::unique_ptr
<ICommandLineOptionsModule
> module
, CommandLine
*commandLine
)
315 // The name and description are not used in the tests, so they can be NULL.
316 const std::unique_ptr
<ICommandLineModule
> wrapperModule(
317 ICommandLineOptionsModule::createModule(nullptr, nullptr, std::move(module
)));
318 return runModuleDirect(wrapperModule
.get(), commandLine
);
322 int CommandLineTestHelper::runModuleFactory(
323 const std::function
<std::unique_ptr
<ICommandLineOptionsModule
>()> &factory
,
324 CommandLine
*commandLine
)
326 return runModuleDirect(factory(), commandLine
);
329 CommandLineTestHelper::CommandLineTestHelper(TestFileManager
*fileManager
)
330 : impl_(new Impl(fileManager
))
334 CommandLineTestHelper::~CommandLineTestHelper()
338 void CommandLineTestHelper::setInputFileContents(
339 CommandLine
*args
, const char *option
, const char *extension
,
340 const std::string
&contents
)
342 GMX_ASSERT(extension
[0] != '.', "Extension should not contain a dot");
343 std::string fullFilename
= impl_
->fileManager_
.getTemporaryFilePath(
344 formatString("%d.%s", args
->argc(), extension
));
345 TextWriter::writeFileFromString(fullFilename
, contents
);
346 args
->addOption(option
, fullFilename
);
349 void CommandLineTestHelper::setInputFileContents(
350 CommandLine
*args
, const char *option
, const char *extension
,
351 const ArrayRef
<const char *const> &contents
)
353 GMX_ASSERT(extension
[0] != '.', "Extension should not contain a dot");
354 std::string fullFilename
= impl_
->fileManager_
.getTemporaryFilePath(
355 formatString("%d.%s", args
->argc(), extension
));
356 TextWriter
file(fullFilename
);
357 ArrayRef
<const char *const>::const_iterator i
;
358 for (i
= contents
.begin(); i
!= contents
.end(); ++i
)
363 args
->addOption(option
, fullFilename
);
366 void CommandLineTestHelper::setOutputFile(
367 CommandLine
*args
, const char *option
, const char *filename
,
368 const ITextBlockMatcherSettings
&matcher
)
370 setOutputFile(args
, option
, filename
, TextFileMatch(matcher
));
373 void CommandLineTestHelper::setOutputFile(
374 CommandLine
*args
, const char *option
, const char *filename
,
375 const IFileMatcherSettings
&matcher
)
377 std::string
suffix(filename
);
378 if (startsWith(filename
, "."))
380 suffix
= formatString("%d.%s", args
->argc(), filename
);
382 std::string fullFilename
= impl_
->fileManager_
.getTemporaryFilePath(suffix
);
383 args
->addOption(option
, fullFilename
);
384 impl_
->outputFiles_
.emplace_back(option
, fullFilename
, matcher
.createFileMatcher());
387 void CommandLineTestHelper::checkOutputFiles(TestReferenceChecker checker
) const
389 if (!impl_
->outputFiles_
.empty())
391 TestReferenceChecker
outputChecker(
392 checker
.checkCompound("OutputFiles", "Files"));
393 for (const auto &outfile
: impl_
->outputFiles_
)
395 TestReferenceChecker
fileChecker(
396 outputChecker
.checkCompound("File", outfile
.option
.c_str()));
397 outfile
.matcher
->checkFile(outfile
.path
, &fileChecker
);
402 /********************************************************************
403 * CommandLineTestBase::Impl
406 class CommandLineTestBase::Impl
409 Impl() : helper_(&tempFiles_
)
411 cmdline_
.append("module");
414 TestReferenceData data_
;
415 TestFileManager tempFiles_
;
416 CommandLineTestHelper helper_
;
417 CommandLine cmdline_
;
420 /********************************************************************
421 * CommandLineTestBase
424 CommandLineTestBase::CommandLineTestBase()
429 CommandLineTestBase::~CommandLineTestBase()
433 void CommandLineTestBase::setInputFile(
434 const char *option
, const char *filename
)
436 impl_
->cmdline_
.addOption(option
, TestFileManager::getInputFilePath(filename
));
439 void CommandLineTestBase::setInputFile(
440 const char *option
, const std::string
&filename
)
442 setInputFile(option
, filename
.c_str());
445 void CommandLineTestBase::setModifiableInputFile(
446 const char *option
, const std::string
&filename
)
448 setModifiableInputFile(option
, filename
.c_str());
451 void CommandLineTestBase::setModifiableInputFile(
452 const char *option
, const char *filename
)
454 std::string originalFileName
= gmx::test::TestFileManager::getInputFilePath(filename
);
455 std::string modifiableFileName
= fileManager().getTemporaryFilePath(filename
);
456 gmx_file_copy(originalFileName
.c_str(), modifiableFileName
.c_str(), true);
457 impl_
->cmdline_
.addOption(option
, modifiableFileName
);
460 void CommandLineTestBase::setInputFileContents(
461 const char *option
, const char *extension
, const std::string
&contents
)
463 impl_
->helper_
.setInputFileContents(&impl_
->cmdline_
, option
, extension
,
467 void CommandLineTestBase::setInputFileContents(
468 const char *option
, const char *extension
,
469 const ArrayRef
<const char *const> &contents
)
471 impl_
->helper_
.setInputFileContents(&impl_
->cmdline_
, option
, extension
,
475 void CommandLineTestBase::setOutputFile(
476 const char *option
, const char *filename
,
477 const ITextBlockMatcherSettings
&matcher
)
479 impl_
->helper_
.setOutputFile(&impl_
->cmdline_
, option
, filename
, matcher
);
482 void CommandLineTestBase::setOutputFile(
483 const char *option
, const char *filename
,
484 const IFileMatcherSettings
&matcher
)
486 impl_
->helper_
.setOutputFile(&impl_
->cmdline_
, option
, filename
, matcher
);
489 void CommandLineTestBase::setInputAndOutputFile(
490 const char *option
, const char *filename
,
491 const ITextBlockMatcherSettings
&matcher
)
493 std::string originalFileName
= gmx::test::TestFileManager::getInputFilePath(filename
);
494 std::string modifiableFileName
= fileManager().getTemporaryFilePath(filename
);
495 gmx_file_copy(originalFileName
.c_str(), modifiableFileName
.c_str(), true);
496 impl_
->helper_
.setOutputFile(&impl_
->cmdline_
, option
, filename
, matcher
);
499 void CommandLineTestBase::setInputAndOutputFile(
500 const char *option
, const char *filename
,
501 const IFileMatcherSettings
&matcher
)
503 std::string originalFileName
= gmx::test::TestFileManager::getInputFilePath(filename
);
504 std::string modifiableFileName
= fileManager().getTemporaryFilePath(filename
);
505 gmx_file_copy(originalFileName
.c_str(), modifiableFileName
.c_str(), true);
506 impl_
->helper_
.setOutputFile(&impl_
->cmdline_
, option
, filename
, matcher
);
509 CommandLine
&CommandLineTestBase::commandLine()
511 return impl_
->cmdline_
;
514 TestFileManager
&CommandLineTestBase::fileManager()
516 return impl_
->tempFiles_
;
519 TestReferenceChecker
CommandLineTestBase::rootChecker()
521 return impl_
->data_
.rootChecker();
524 void CommandLineTestBase::setDefaultTolerance(const FloatingPointTolerance
&tolerance
)
526 impl_
->data_
.rootChecker().setDefaultTolerance(tolerance
);
529 void CommandLineTestBase::testWriteHelp(ICommandLineModule
*module
)
531 StringOutputStream stream
;
532 TextWriter
writer(&stream
);
533 CommandLineHelpContext
context(&writer
, eHelpOutputFormat_Console
, nullptr, "test");
534 context
.setModuleDisplayName(formatString("%s %s", "test", module
->name()));
535 module
->writeHelp(context
);
536 TestReferenceChecker
checker(rootChecker());
537 checker
.checkTextBlock(stream
.toString(), "HelpOutput");
540 void CommandLineTestBase::checkOutputFiles()
542 impl_
->helper_
.checkOutputFiles(rootChecker());