api/gmxapi/cpp/tests/version.cpp

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