/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright (c) 2013,2014,2015,2016,2018 by the GROMACS development team.
 * Copyright (c) 2019,2020, by the GROMACS development team, led by
 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
 * and including many others, as listed in the AUTHORS file in the
 * top-level source directory and at http://www.gromacs.org.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at http://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out http://www.gromacs.org.
 */
#ifndef GMX_MDRUN_TESTS_MULTISIMTEST_H
#define GMX_MDRUN_TESTS_MULTISIMTEST_H

/*! \internal \file
 * \brief
 * Declares test fixture for the mdrun multi-simulation functionality
 *
 * \author Mark Abraham <mark.j.abraham@gmail.com>
 * \ingroup module_mdrun_integration_tests
 */

#include <memory>
#include <string>

#include <gtest/gtest.h>

#include "testutils/cmdlinetest.h"

#include "moduletest.h"

namespace gmx
{
namespace test
{

//! Convenience typedef
typedef std::unique_ptr<CommandLine> CommandLinePointer;

/*! \internal
 * \brief Test fixture for multi-sim functionality.
 *
 * This is intended to be re-used also for tests of functionality that
 * are derived from multi-sim, e.g. REMD.
 *
 * \ingroup module_mdrun_integration_tests
 */
class MultiSimTest : public MdrunTestFixtureBase, public ::testing::WithParamInterface<const char*>
{
public:
    MultiSimTest();

    /*! \brief Organize the .mdp file for this rank
     *
     * For testing multi-simulation, this .mdp file is more
     * complicated than it needs to be, but it does little harm,
     * and doing it this way allows this function to be re-used
     * for testing replica-exchange.
     *
     * \param runner          The simulation runner that uses the
     *                        mdp file that is organized.
     * \param controlVariable Allows parameterization to work with
     * T, P or (later) lambda as the control variable, by passing a
     * string with "mdp-param = value" such that different paths
     * in init_replica_exchange() are followed.
     * \param numSteps        Number of MD steps to perform.
     */
    void organizeMdpFile(SimulationRunner* runner, const char* controlVariable, int numSteps = 2);
    //! Test that a basic simulation works
    void runExitsNormallyTest();
    //! Test that mdrun -maxh and restart works
    void runMaxhTest();
    //! Number of MPI ranks
    int size_;
    //! MPI rank of this process
    int rank_;
    //! Object for building the mdrun command line
    CommandLinePointer mdrunCaller_;
    //! Manages temporary files during the test.
    TestFileManager fileManager_;
};

} // namespace test
} // namespace gmx

#endif
