1 /* 2 * This file is part of the GROMACS molecular simulation package. 3 * 4 * Copyright (c) 2017,2018,2019,2020, 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. 8 * 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. 13 * 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. 18 * 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. 23 * 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. 31 * 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. 34 */ 35 #ifndef GMX_TESTUTILS_TEST_HARDWARE_ENVIRONMENT_H 36 #define GMX_TESTUTILS_TEST_HARDWARE_ENVIRONMENT_H 37 38 /*! \internal \file 39 * \brief 40 * Describes test environment class which performs hardware enumeration for unit tests. 41 * 42 * \author Aleksei Iupinov <a.yupinov@gmail.com> 43 * \author Artem Zhmurov <zhmurov@gmail.com> 44 * 45 * \ingroup module_testutils 46 */ 47 48 #include <map> 49 #include <memory> 50 #include <vector> 51 52 #include <gtest/gtest.h> 53 54 #include "gromacs/utility/gmxassert.h" 55 56 #include "testutils/test_device.h" 57 58 struct gmx_hw_info_t; 59 60 namespace gmx 61 { 62 namespace test 63 { 64 65 /*! \internal \brief 66 * This class performs one-time test initialization (enumerating the hardware) 67 */ 68 class TestHardwareEnvironment : public ::testing::Environment 69 { 70 private: 71 //! General hardware info 72 std::unique_ptr<gmx_hw_info_t> hardwareInfo_; 73 //! Storage of hardware contexts 74 std::vector<std::unique_ptr<TestDevice>> testDeviceList_; 75 76 public: 77 TestHardwareEnvironment(); 78 //! This is called by GTest framework once to query the hardware 79 void SetUp() override; 80 //! This is called by GTest framework once release the hardware 81 void TearDown() override; 82 //! Get available hardware contexts. getTestDeviceList()83 const std::vector<std::unique_ptr<TestDevice>>& getTestDeviceList() const 84 { 85 return testDeviceList_; 86 } 87 //! Whether the available hardware has any compatible devices hasCompatibleDevices()88 bool hasCompatibleDevices() const { return !testDeviceList_.empty(); } 89 //! Get available hardware information. hwinfo()90 const gmx_hw_info_t* hwinfo() const { return hardwareInfo_.get(); } 91 }; 92 93 //! Get the test environment 94 const TestHardwareEnvironment* getTestHardwareEnvironment(); 95 96 /*! \brief This constructs the test environment during setup of the 97 * unit test so that they can use the hardware context. */ 98 void callAddGlobalTestEnvironment(); 99 100 } // namespace test 101 } // namespace gmx 102 #endif // GMX_TESTUTILS_TEST_HARDWARE_ENVIRONMENT_H 103