lumiera_/tests/gui/test/test-nexus.cpp

/*
  test::Nexus  -  implementation base for test user interface backbone

  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.

* *****************************************************/


/** @file test/test-nexus.cpp
 ** Implementation of a fake UI backbone for testing.
 ** This compilation unit provides the actual setup for running a faked
 ** user interface from unit tests. Test code is assumed to access those
 ** features through the [front-end](\ref gui::test::TestNexus), while the
 ** actual implementation instances are placed [as singletons](depend.hpp)
 ** 
 ** @todo initial draft and WIP-WIP-WIP as of 11/2015
 ** 
 ** @see abstract-tangible-test.cpp
 ** 
 */


#include "lib/error.hpp"
#include "test/test-nexus.hpp"
#include "lib/test/event-log.hpp"
#include "gui/ctrl/nexus.hpp"
#include "lib/diff/gen-node.hpp"
#include "lib/idi/entry-id.hpp"
#include "lib/idi/genfunc.hpp"
#include "lib/depend.hpp"
#include "lib/format-string.hpp"
//#include "lib/util.hpp"

#include <iostream>
#include <string>
//#include <map>

//using std::map;
using std::cerr;
using std::endl;
using std::string;

using lib::test::EventLog;
using lib::diff::GenNode;
using gui::ctrl::BusTerm;
using util::_Fmt;
//using util::contains;
//using util::isnil;

namespace gui {
namespace test{
  
  namespace { // internal details
    
    using lib::Variant;
    using lib::diff::Rec;
    using lib::diff::DataValues;
    
    using BusHub = gui::ctrl::Nexus;
    
    
    /** helper to figure out if a command message
     *  is a binding or invocation message.
     * @remarks from a design standpoint, this is ugly,
     *          since we're basically switching on type.
     *          Well -- we do it just for diagnostics here,
     *          so _look away please..._
     */
    inline bool
    isCommandBinding (GenNode const& msg)
    {
      class CommandBindingDetector
        : public Variant<DataValues>::Predicate
        {
          bool handle  (Rec const&) override { return true; }
        }
        detector;
      
      return msg.data.accept (detector);
    }
    
    inline string
    invocationStage (GenNode const& msg)
    {
      return isCommandBinding(msg)? string("binding for")
                                  : string("invoke");
    }
    
    inline string
    renderBindingArgs (GenNode const& msg)
    {
      return isCommandBinding(msg)? "| " + string(msg.data.get<Rec>())
                                  : "";
    }
    
    
    /**
     * @internal fake interface backbone and unit test rig
     * for simulated command and presentation state handling.
     * This implementation embodies the routing functionality
     * as found in the [real nexus](\ref gui::ctrl::Nexus), and additionally
     * also implements the handler functions of the [gui::ctrl::CoreService].
     * The latter allows us to intercept command invocations and presentation
     * state messages
     */
    class TestNexus
      : public BusHub
      {
        EventLog log_{this};
        
        
        virtual void
        act (GenNode const& command)
          {
            log_.call(this, "act", command);
            BusHub::act (command);
            log_.event("TestNexus", _Fmt("%s command \"%s\"%s")
                                        % invocationStage(command)
                                        % command.idi.getSym()
                                        % renderBindingArgs(command));
          }
        
        virtual void
        note (ID subject, GenNode const& mark)  override
          {
            log_.call(this, "note", subject, mark);
            BusHub::note (subject, mark);
            log_.event("TestNexus", _Fmt("processed note from %s |%s") % subject % mark);
          }
        
        virtual void
        mark (ID subject, GenNode const& mark)  override
          {
            log_.call(this, "mark", subject, mark);
            BusHub::mark (subject, mark);
            log_.event("TestNexus", _Fmt("delivered mark to %s |%s") % subject % mark);
          }
        
        virtual operator string()  const
          {
            return getID().getSym()+"."+lib::idi::instanceTypeID(this);
          }
        
        virtual BusTerm&
        routeAdd (ID identity, Tangible& newNode)  override
          {
            log_.call(this, "routeAdd", identity, newNode);
            BusHub::routeAdd (identity, newNode);
            log_.event("TestNexus", _Fmt("added route to %s |%s| table-size=%2d")
                                        % identity
                                        % lib::idi::instanceTypeID(&newNode)
                                        % BusHub::size());
            return *this;
          }
        
        virtual void
        routeDetach (ID node)  noexcept override
          {
            log_.call(this, "routeDetach", node);
            BusHub::routeDetach (node);
            log_.event("TestNexus", _Fmt("removed route to %s | table-size=%2d") % node % BusHub::size());
          }
        
        
      public:
        TestNexus()
          : BusHub(*this, lib::idi::EntryID<TestNexus>("mock-UI"))
          { }
        
        // standard copy operations
        
        
        EventLog&
        getLog()
          {
            return log_;
          }
      };

    /** singleton instance of the [TestNexus]
     *  used for rigging unit tests */
    lib::Depend<TestNexus> testNexus;
    
    
    
    /**
     * @internal a defunct interface backbone.
     * All UI-Bus operations are implemented NOP, but warning on STDRR
     * and logging the invocation to the internal log of [TestNexus].
     * This allows to set up deceased entities within a test rigged UI.
     */
    class ZombieNexus
      : public BusTerm
      {
        
        EventLog&
        log()
          {
            return testNexus().getLog();
          }
        
        
        
        /* ==== defunct re-implementation of the BusTerm interface ==== */
        
        virtual void
        act (GenNode const& command)
          {
            log().call(this, "act", command);
            log().error ("sent command invocation to ZombieNexus");
            cerr << "Command " << string(command) << " -> ZombieNexus" <<endl;
          }
        
        virtual void
        note (ID subject, GenNode const& mark)  override
          {
            log().call(this, "note", subject, mark);
            log().error ("sent note message to ZombieNexus");
            cerr << "note message "<< string(mark)
                 << " FROM:" << string(subject)
                 << " -> ZombieNexus" <<endl;
          }
        
        virtual void
        mark (ID subject, GenNode const& mark)  override
          {
            log().call(this, "mark", subject, mark);
            log().error ("request to deliver mark message via ZombieNexus");
            cerr << "mark message -> ZombieNexus" <<endl;
          }
        
        virtual operator string()  const
          {
            return getID().getSym()+"."+lib::idi::instanceTypeID(this);
          }
        
        virtual BusTerm&
        routeAdd (ID identity, Tangible& newNode)  override
          {
            log().call(this, "routeAdd", identity, newNode);
            log().error ("attempt to connect against ZombieNexus");
            cerr << "connect("<<string(identity)<<" -> ZombieNexus" <<endl;
            return *this;
          }
        
        virtual void
        routeDetach (ID node)  noexcept override
          {
            log().call(this, "routeDetach", node);
            log().error ("disconnect from ZombieNexus");
            cerr << "disconnect("<<string(node)<<" -> ZombieNexus" <<endl;
          }
        
        
      public:
        /** fabricate a "dead terminal", marked as deceased, viciously connected to itself.
         * @note intentionally to be sliced right after generation.
         *       All operations on this object are defunct.
         */
        ZombieNexus(string formerID, BusTerm& homeland)
          : BusTerm(lib::idi::EntryID<ZombieNexus>("defunct-"+formerID), homeland)
          { }
        
        explicit
        ZombieNexus()
          : ZombieNexus{"zombieland", *this}
          { }
        
       ~ZombieNexus()
          {
            cerr << this->getID().getSym() << ": Zombies never die" << endl;
          }
      };
    
    
    
    lib::Depend<ZombieNexus> zombieNexus;
    
  } // internal details
  
  
  
  
  /**
   * @return reference to a node of the test UI bus,
   *         which allows to hook up new nodes for test
   */
  ctrl::BusTerm&
  Nexus::testUI()
  {
    return testNexus();
  }
  
  lib::test::EventLog const&
  Nexus::getLog()
  {
    return testNexus().getLog();
  }
  
  lib::test::EventLog const&
  Nexus::startNewLog()
  {
    return testNexus().getLog().clear();
  }
  
  
  
  /**
   * @return a defunct BusTerm with up-link to [ZombieNexus]
   * @remarks useful to create zombie mock UI-Elements for testing.
   */
  void
  Nexus::zombificate (BusTerm& doomed)
  {
    string lateName = doomed.getID().getSym();
    doomed.~BusTerm();
    testNexus().getLog().destroy (lateName);
    
    static_assert (sizeof(BusTerm) >= sizeof(ZombieNexus), "Zombie overflow");
    new(&doomed) ZombieNexus{lateName, zombieNexus()};
    testNexus().getLog().event(lateName + " successfully zombificated.");
  }

}} // namespace gui::test