test-nexus.hpp

Go to the documentation of this file.

/*
  TEST-NEXUS.hpp  -  fake user interface backbone for test support

  Copyright (C)         Lumiera.org
    2015,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef STAGE_TEST_TEST_NEXUS_H
#define STAGE_TEST_TEST_NEXUS_H


#include "lib/error.hpp"
#include "lib/nocopy.hpp"
#include "stage/ctrl/bus-term.hpp"
#include "stage/model/tangible.hpp"
#include "stage/ctrl/state-manager.hpp"
#include "test/placeholder-command.hpp"
#include "lib/test/event-log.hpp"
#include "lib/diff/gen-node.hpp"

#include <functional>
#include <string>


namespace stage {
namespace test{
  
  
  class Nexus
    : util::NonCopyable
    {
      
    public:
      static ctrl::BusTerm& testUI();
      
      static void zombificate(ctrl::BusTerm&);
      
      static lib::test::EventLog const& getLog();
      static lib::test::EventLog const& startNewLog();
      
      static size_t size();
      
      
      /* == allow to set custom handlers for commands and state changes == */
      
      using CommandHandler   = std::function<void(lib::diff::GenNode const&)>;
      using StateMarkHandler = std::function<void(lib::idi::BareEntryID const&, lib::diff::GenNode const&)>;
      
      static void setCommandHandler (CommandHandler  =CommandHandler());
      static void setStateMarkHandler (StateMarkHandler  =StateMarkHandler());
      
      
      static ctrl::StateManager& useMockStateManager();
      static ctrl::StateManager& getMockStateManager();
      
      
      template<typename...ARGS>
      static Symbol prepareMockCmd();
      
      static bool wasInvoked (Symbol);
      
      template<typename...ARGS>
      static bool wasBound (Symbol, ARGS const& ...args);
      
      template<typename...ARGS>
      static bool wasInvoked (Symbol, ARGS const& ...args);
      
    private:
      static void prepareDiagnosticCommandHandler();
    };
  
  
  
  template<typename...ARGS>
  inline Symbol
  Nexus::prepareMockCmd()
  {
    prepareDiagnosticCommandHandler();
    return PlaceholderCommand<ARGS...>::fabricateNewInstance(getLog())
                                       .getID();
  }
  
  
  template<typename...ARGS>
  inline bool
  Nexus::wasBound (Symbol cmd, ARGS const& ...args)
  {
    using lib::diff::DataCap;
    
    return getLog()
            .verifyMatch("TestNexus.+HANDLING Command-Message for .+" +cmd)
            .beforeCall("bind-command").on("TestNexus")
                                       .arg(string(DataCap(args))...);
  }
  
  template<typename...ARGS>
  inline bool
  Nexus::wasInvoked (Symbol cmd, ARGS const& ...args)
  {
    return getLog()
            .verifyMatch("TestNexus.+HANDLING Command-Message for .+" +cmd)
            .beforeCall("exec-command").on("TestNexus").arg(cmd)
            .beforeCall("exec").on("MockHandlingPattern")
            .beforeCall("operate").arg(util::toString(args)...)
            .beforeEvent("TestNexus", "SUCCESS handling "+cmd);
  }
  
  inline bool
  Nexus::wasInvoked (Symbol cmd)
  {
    return getLog()
            .verifyMatch("TestNexus.+HANDLING Command-Message for .+" +cmd)
            .beforeCall("exec-command").on("TestNexus").arg(cmd)
            .beforeCall("operate")
            .beforeEvent("TestNexus", "SUCCESS handling "+cmd);
  }
  
  
  
}} // namespace stage::test
#endif /*STAGE_TEST_TEST_NEXUS_H*/