src/gromacs/utility/tests/mdmodulesnotifier.cpp

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