gearman/libtest/framework.cc

/*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 *
 *  Data Differential YATL (i.e. libtest)  library
 *
 *  Copyright (C) 2012 Data Differential, http://datadifferential.com/
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *
 *      * Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 *
 *      * 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.
 *
 *      * The names of its contributors may not be used to endorse or
 *  promote products derived from this software without specific prior
 *  written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#include "libtest/yatlcon.h"

#include <libtest/common.h>
#include <libtest/collection.h>
#include <libtest/signal.h>
#include <libtest/stream.h>

#include <algorithm>
#include <cerrno>
#include <fnmatch.h>
#include <iostream>
#include <set>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

namespace {
#if defined(DEBUG) && DEBUG
  int open_file_descriptors(std::set<int>& pre_existing_fd, const bool report)
  {
    int max= getdtablesize();

    int counter= 0;

    for (int x= 3; x < max; ++x)
    {
      struct stat stats;

      if (fstat(x, &stats) == 0)
      {
        if (report)
        {
          std::set<int>::iterator it= pre_existing_fd.find(x);
          if (it!= pre_existing_fd.end())
          { }
          else
          {
            std::cerr << "FD: " << x;

            if (S_ISREG(stats.st_mode))
            {
              std::cerr << " regular file ";
            }
            else if (S_ISDIR(stats.st_mode))
            {
              std::cerr << " directory ";
            }
            else if (S_ISSOCK(stats.st_mode))
            {
              std::cerr << " socket ";
            }

            std::cerr << std::endl;
          }
        }
        else
        {
          pre_existing_fd.insert(x);
        }

        ++counter;
      }
    }

    return counter;
  }
#endif // #if defined(DEBUG) && DEBUG
} // namespace

namespace libtest {

Framework::Framework(libtest::SignalThread& signal_,
                     const std::string& name_,
                     const std::string& only_run_arg,
                     const std::string& wildcard_arg) :
  _total(0),
  _success(0),
  _skipped(0),
  _failed(0),
  _create(NULL),
  _destroy(NULL),
  _on_error(NULL),
  _runner(NULL),
  _socket(false),
  _creators_ptr(NULL),
  _signal(signal_),
  _only_run(only_run_arg),
  _wildcard(wildcard_arg),
  _name(name_)
{
  get_world(this);

  {
    std::string file_name;
    if (getenv("WORKSPACE"))
    {
      file_name.append(getenv("WORKSPACE"));
      file_name.append("/");
    }
    file_name.append(name());
    file_name.append(".xml");
    xml_file.open(file_name.c_str(), std::ios::trunc);
    _formatter.push_back(new libtest::Junit(this, xml_file));
  }

  {
    std::string file_name;
    if (getenv("WORKSPACE"))
    {
      file_name.append(getenv("WORKSPACE"));
      file_name.append("/");
    }
    file_name.append(name());
    file_name.append(".tap");
    tap_file.open(file_name.c_str(), std::ios::trunc);
    _formatter.push_back(new libtest::TAP(this, tap_file));
  }
  _formatter.push_back(new libtest::Legacy(this, std::cout));
}

void Framework::collections(collection_st collections_[])
{
  for (collection_st *next= collections_; next and next->name; next++)
  {
    _collection.push_back(new Collection(this, next));
  }
}

Framework::~Framework()
{
  if (_destroy and _destroy(_creators_ptr))
  {
    Error << "Failure in _destroy(), some resources may not have been cleaned up.";
  }

  _servers.shutdown();

  delete _runner;

  std::for_each(_collection.begin(), _collection.end(), DeleteFromVector());
  _collection.clear();

  std::for_each(_formatter.begin(), _formatter.end(), DeleteFromVector());
  _formatter.clear();
}

bool Framework::match(const char* arg)
{
  if (_wildcard.empty() == false and fnmatch(_wildcard.c_str(), arg, 0))
  {
    return true;
  }

  return false;
}

void Framework::exec()
{
  for (Suites::iterator iter= _collection.begin();
       iter != _collection.end() and (_signal.is_shutdown() == false);
       ++iter)
  {
    if (_only_run.empty() == false and
        fnmatch(_only_run.c_str(), (*iter)->name(), 0))
    {
      continue;
    }

    _total++;

#if defined(DEBUG) && DEBUG
    std::set<int> pre_existing_fd;
    int open_fd= 0;
    if (DEBUG)
    {
      open_fd= open_file_descriptors(pre_existing_fd, false);
    }
#endif

    try {
      switch ((*iter)->exec())
      {
      case TEST_FAILURE:
        _failed++;
        break;

      case TEST_SKIPPED:
        _skipped++;
        break;

        // exec() can return SUCCESS, but that doesn't mean that some tests did
        // not fail or get skipped.
      case TEST_SUCCESS:
        _success++;
        break;
      }
    }
    catch (const libtest::fatal& e)
    {
      _failed++;
      stream::cerr(e.file(), e.line(), e.func()) << e.what();
    }
    catch (const libtest::disconnected& e)
    {
      _failed++;
      Error << "Unhandled disconnection occurred:" << e.what();
      throw;
    }
    catch (...)
    {
      _failed++;
      throw;
    }

#if defined(DEBUG) && DEBUG
    if (DEBUG)
    {
      int now_open_fd= open_file_descriptors(pre_existing_fd, true);

      if (open_fd != now_open_fd)
      {
        Error << "Growing number of file descriptors: " << int(now_open_fd - open_fd);
      }
    }
#endif
  }
}

libtest::Runner *Framework::runner()
{
  if (_runner == NULL)
  {
    _runner= new Runner;
  }
  _runner->set_servers(_servers);

  return _runner;
}

test_return_t Framework::create()
{
  test_return_t rc= TEST_SUCCESS;
  if (_create)
  {
    _creators_ptr= _create(_servers, rc);
  }

  return rc;
}

} // namespace libtest