src/gromacs/fileio/tests/filemd5.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 /*! \internal \file
  36  * \brief
  37  * Tests for routines for computing MD5 sums on files.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_fileio
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <cstdio>
  45
  46 #include <algorithm>
  47 #include <numeric>
  48 #include <string>
  49 #include <vector>
  50
  51 #include <gmock/gmock.h>
  52 #include <gtest/gtest.h>
  53
  54 #include "gromacs/fileio/gmxfio.h"
  55 #include "gromacs/utility/arrayref.h"
  56
  57 #include "testutils/refdata.h"
  58 #include "testutils/testfilemanager.h"
  59
  60 namespace gmx
  61 {
  62 namespace test
  63 {
  64 namespace
  65 {
  66
  67 class FileMD5Test : public ::testing::Test
  68 {
  69 public:
  70     void prepareFile(int lengthInBytes)
  71     {
  72         // Fill some memory with some arbitrary bits.
  73         std::vector<char> data(lengthInBytes);
  74         std::iota(data.begin(), data.end(), 1);
  75         // Binary mode ensures it works the same on all OS
  76         FILE* fp = fopen(filename_.c_str(), "wb");
  77         fwrite(data.data(), sizeof(char), data.size(), fp);
  78         fclose(fp);
  79     }
  80     ~FileMD5Test() override
  81     {
  82         if (file_)
  83         {
  84             gmx_fio_close(file_);
  85         }
  86     }
  87     TestFileManager fileManager_;
  88     // Make sure the file extension is one that gmx_fio_open will
  89     // recognize to open as binary.
  90     std::string filename_ = fileManager_.getTemporaryFilePath("data.edr");
  91     t_fileio*   file_     = nullptr;
  92 };
  93
  94 TEST_F(FileMD5Test, CanComputeMD5)
  95 {
  96     prepareFile(1000);
  97     file_ = gmx_fio_open(filename_.c_str(), "r+");
  98
  99     std::array<unsigned char, 16> digest = { 0 };
 100     // Chosen to be less than the full file length
 101     gmx_off_t offset             = 64;
 102     gmx_off_t expectedLength     = 64;
 103     gmx_off_t lengthActuallyRead = gmx_fio_get_file_md5(file_, offset, &digest);
 104
 105     EXPECT_EQ(expectedLength, lengthActuallyRead);
 106     // Did we compute an actual reproducible checksum?
 107     auto total = std::accumulate(digest.begin(), digest.end(), 0);
 108     EXPECT_EQ(2111, total);
 109 }
 110
 111 TEST_F(FileMD5Test, ReturnsErrorIfFileModeIsWrong)
 112 {
 113     prepareFile(1000);
 114     file_ = gmx_fio_open(filename_.c_str(), "r");
 115
 116     std::array<unsigned char, 16> digest;
 117     gmx_off_t                     offset             = 100;
 118     gmx_off_t                     lengthActuallyRead = gmx_fio_get_file_md5(file_, offset, &digest);
 119     EXPECT_EQ(-1, lengthActuallyRead);
 120 }
 121
 122 } // namespace
 123 } // namespace test
 124 } // namespace gmx