src/programs/mdrun/tests/mdmodulenotification.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 MdModuleNotification
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \ingroup module_mdrun_integration_tests
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <gmock/gmock.h>
  45
  46 #include "gromacs/mdrunutility/mdmodulenotification.h"
  47
  48 namespace gmx
  49 {
  50
  51 namespace
  52 {
  53
  54 struct EventA{};
  55 struct EventB{};
  56
  57 class EventACallee final
  58 {
  59     public:
  60         void callback(EventA /*a*/)
  61         {
  62             notifiedEventA_ = true;
  63         };
  64
  65         bool notifiedEventA() { return notifiedEventA_; }
  66
  67     private:
  68         bool notifiedEventA_ = false;
  69 };
  70
  71 class EventBCallee final
  72 {
  73     public:
  74         void callback(EventB * /* bPointer */)
  75         {
  76             notifiedEventB_ = true;
  77         };
  78
  79         bool notifiedEventB() { return notifiedEventB_; }
  80
  81     private:
  82         bool notifiedEventB_ = false;
  83 };
  84
  85 class EventAandBCallee final
  86 {
  87     public:
  88         void notify(EventB * /* bPointer */)
  89         {
  90             notifiedEventB_ = true;
  91         };
  92
  93         void callback(EventA /* a */)
  94         {
  95             notifiedEventA_ = true;
  96         };
  97
  98         bool notifiedEventB() { return notifiedEventB_; }
  99         bool notifiedEventA() { return notifiedEventA_; }
 100
 101     private:
 102         bool notifiedEventB_ = false;
 103         bool notifiedEventA_ = false;
 104 };
 105
 106 TEST(MDModuleNotificationTest, addConsumer)
 107 {
 108     registerMdModuleNotification<EventA>::type notifications;
 109     EventACallee eventACallee;
 110
 111     EXPECT_FALSE(eventACallee.notifiedEventA());
 112
 113     notifications.subscribe([&eventACallee](EventA eventA) { eventACallee.callback(eventA); });
 114     notifications.notify(EventA {});
 115
 116     EXPECT_TRUE(eventACallee.notifiedEventA());
 117 }
 118
 119 TEST(MDModuleNotificationTest, addConsumerWithPointerParameter)
 120 {
 121     registerMdModuleNotification<EventB *>::type notifications;
 122     EventBCallee eventBCallee;
 123
 124     EXPECT_FALSE(eventBCallee.notifiedEventB());
 125
 126     notifications.subscribe([&eventBCallee](EventB * eventB) { eventBCallee.callback(eventB); });
 127     EventB * eventBPointer = nullptr;
 128     notifications.notify(eventBPointer);
 129
 130     EXPECT_TRUE(eventBCallee.notifiedEventB());
 131 }
 132
 133 TEST(MDModuleNotificationTest, addTwoDifferentConsumers)
 134 {
 135     registerMdModuleNotification<EventA, EventB *>::type notifications;
 136     EventBCallee eventBCallee;
 137     EventACallee eventACallee;
 138
 139     EXPECT_FALSE(eventACallee.notifiedEventA());
 140     EXPECT_FALSE(eventBCallee.notifiedEventB());
 141
 142     notifications.subscribe([&eventBCallee](EventB *eventB) { eventBCallee.callback(eventB); });
 143     notifications.subscribe([&eventACallee](EventA eventA) { eventACallee.callback(eventA); });
 144
 145     EventB * eventBPointer = nullptr;
 146     notifications.notify(eventBPointer);
 147
 148     EXPECT_FALSE(eventACallee.notifiedEventA());
 149     EXPECT_TRUE(eventBCallee.notifiedEventB());
 150
 151     notifications.notify(EventA {});
 152
 153     EXPECT_TRUE(eventACallee.notifiedEventA());
 154     EXPECT_TRUE(eventBCallee.notifiedEventB());
 155 }
 156
 157 TEST(MDModuleNotificationTest, consumerOfTwoResources)
 158 {
 159     registerMdModuleNotification<EventA, EventB *>::type notifications;
 160
 161     EventAandBCallee     callee;
 162
 163     EXPECT_FALSE(callee.notifiedEventB());
 164     EXPECT_FALSE(callee.notifiedEventA());
 165
 166     // requires a template parameter here, because call is ambiguous otherwise
 167     notifications.subscribe([&callee](EventA msg) { callee.callback(msg); });
 168     notifications.subscribe([&callee](EventB *msg) { callee.notify(msg); });
 169
 170     EventB * eventBp = nullptr;
 171
 172     notifications.notify(eventBp);
 173
 174     EXPECT_FALSE(callee.notifiedEventA());
 175     EXPECT_TRUE(callee.notifiedEventB());
 176
 177     notifications.notify(EventA {});
 178
 179     EXPECT_TRUE(callee.notifiedEventA());
 180     EXPECT_TRUE(callee.notifiedEventB());
 181 }
 182
 183
 184 } // namespace
 185
 186 } // namespace gmx