1 /*
2 * This file is part of the GROMACS molecular simulation package.
3 *
4 * Copyright (c) 2018,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
36 #include <climits>
37
38 #include <gtest/gtest.h>
39
40 #include "gmxapi/version.h"
41 #include "testingconfiguration.h"
42
43 namespace gmxapi
44 {
45
46 namespace testing
47 {
48
49 namespace
50 {
51
52 using gmxapi::Version;
53
54 /* Copy header version info with intentionally sloppy type-ing to try to catch
55 * worst-case scenarios and unexpected behavior. Otherwise the isAtLeast function
56 * uses major(), minor(), and patch() so testing them might be superfluous.
57 */
58 //! \cond
59 const int current_major = gmxapi::c_majorVersion;
60 const int current_minor = gmxapi::c_minorVersion;
61 const int current_patch = gmxapi::c_patchVersion;
62 //! \endcond
63
64 /*!
65 * \brief Check basic Version interface functionality.
66 */
TEST_F(GmxApiTest,SaneVersionComparisons)67 TEST_F(GmxApiTest, SaneVersionComparisons)
68 {
69 EXPECT_TRUE(Version::isAtLeast(0, 0, 0));
70 EXPECT_FALSE(Version::isAtLeast(SHRT_MAX, SHRT_MAX, SHRT_MAX));
71 EXPECT_TRUE(Version::isAtLeast(current_major, current_minor, current_patch));
72 EXPECT_FALSE(Version::isAtLeast(current_major + 1, current_minor, current_patch));
73 EXPECT_FALSE(Version::isAtLeast(current_major, current_minor + 1, current_patch));
74 EXPECT_FALSE(Version::isAtLeast(current_major, current_minor, current_patch + 1));
75 }
76
77 /*!
78 * \brief Check whether gmxapi correctly advertises or refutes feature availability.
79 *
80 * Check for correct responses from the Version API for features or
81 * functionality not (yet) guaranteed by the current API version.
82 * If a feature is available, it is expected to conform to the API specification
83 * for the library Version::release(). As we discover features that break
84 * forward-compatibility of the API, we will have to provide developer documentation
85 * or sample code for build-time CMake feature checks.
86 *
87 * This is the test for pre-0.1 features leading up to that specification.
88 *
89 * \internal
90 * Designed but unimplemented features should be tested with ``EXPECT_FALSE``
91 * until they are implemented, then toggled to ``EXPECT_TRUE`` as implemented as
92 * extensions of the current API spec. (There aren't any yet.)
93 */
TEST_F(GmxApiTest,VersionNamed0_1_Features)94 TEST_F(GmxApiTest, VersionNamed0_1_Features)
95 {
96 EXPECT_FALSE(Version::hasFeature(""));
97 EXPECT_FALSE(Version::hasFeature("nonexistent feature"));
98 }
99
100 } // end anonymous namespace
101
102 } // namespace testing
103
104 } // namespace gmxapi
105