DwmUnitAssert.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2006-2007, 2021
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMUNITASSERT_HH_
#define _DWMUNITASSERT_HH_
 
#include <cstdint>
#include <iostream>
#include <map>
#include <mutex>
#include <string>
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class AssertionCounter
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    AssertionCounter();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t Failed() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t Passed() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void AddFailed();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void AddPassed();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    AssertionCounter & operator += (const AssertionCounter & assertionCounter);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream &
    operator << (std::ostream & os, const AssertionCounter & assertionCounter);
    
  private:
    uint64_t  _passed;
    uint64_t  _failed;
  };
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Assertion
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Assertion(const std::string & filename, const std::string & function,
              int line, const std::string & expression);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Filename();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Function();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Line() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Expression() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator < (const Assertion & assertion) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & 
    operator << (std::ostream & os, const Assertion & assertion);
    
  private:
    std::string   _filename;
    std::string   _function;
    int           _line;
    std::string   _expression;
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class FunctionAssertions
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Failed(const std::string & filename, const std::string & function,
                int lineNumber, const std::string & test);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Passed(const std::string & filename, const std::string & function,
                int lineNumber, const std::string & test);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    AssertionCounter Total() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Print(std::ostream & os, bool onlyFailed = false) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream &
    PrintJson(std::ostream & os, bool onlyFailed = false) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream &
    PrintXML(std::ostream & os, bool onlyFailed = false) const;
 
  private:
    std::string                           _function;
    std::map<Assertion,AssertionCounter>  _assertions;
  };
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class FileAssertions
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Failed(const std::string & filename, const std::string & function,
                int lineNumber, const std::string & test);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Passed(const std::string & filename, const std::string & function,
                int lineNumber, const std::string & test);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    AssertionCounter Total() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Print(std::ostream & os, bool onlyFailed = false) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & PrintJson(std::ostream & os, bool onlyFailed = false) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & PrintXML(std::ostream & os, bool onlyFailed = false) const;
    
  private:
    std::string                               _filename;
    std::map<std::string,FunctionAssertions>  _assertions;
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Assertions
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Failed(const std::string & filename,
                       const std::string & function,
                       int lineNumber, const std::string & test);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static bool Passed(const std::string & filename, 
                       const std::string & function,
                       int lineNumber, const std::string & test);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static AssertionCounter Total();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & Print(std::ostream & os, bool onlyFailed = false);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static int PrintAndReturn();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & PrintJson(std::ostream & os,
                                    bool onlyFailed = false);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static std::ostream & PrintXML(std::ostream & os, bool onlyFailed = false);
 
  private:
    static std::map<std::string,FileAssertions>  _assertions;
    static std::mutex                            _mutex;
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
#define UnitAssert(e) ((e) ?                                             \
  Dwm::Assertions::Passed(__FILE__, __PRETTY_FUNCTION__, __LINE__, #e) : \
  Dwm::Assertions::Failed(__FILE__, __PRETTY_FUNCTION__, __LINE__, #e))
  
}  // namespace Dwm
 
#endif  // _DWMUNITASSERT_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------