berryUITestCase.h

Go to the documentation of this file.

/*===================================================================

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef BERRYUITESTCASE_H_
#define BERRYUITESTCASE_H_

#include <berryTestCase.h>

#include <berryIWindowListener.h>
#include <berryIWorkbench.h>
#include <berryIWorkbenchPage.h>

#include <org_blueberry_uitest_Export.h>

#include <list>

namespace berry
{

class BERRY_UITEST_EXPORT UITestCase: public TestCase
{

public:

  static IAdaptable* GetPageInput();

  UITestCase(const QString& testName);

  virtual void DoSetUp();

  virtual void DoTearDown();

  void failexc(const QString& message, const std::exception& e,
               long lineNumber = -1,
               const QString& fileName = "unknown");

  IWorkbenchWindow::Pointer OpenTestWindow();

  IWorkbenchWindow::Pointer OpenTestWindow(const QString& perspectiveId);

  void CloseAllTestWindows();

  IWorkbenchPage::Pointer OpenTestPage(const IWorkbenchWindow::Pointer& win);

  QList<IWorkbenchPage::Pointer> OpenTestPage(
      const IWorkbenchWindow::Pointer& win, int pageTotal);

  void CloseAllPages(const IWorkbenchWindow::Pointer& window);

protected:

  void Trace(const QString& msg);

  void setUp();

  void tearDown();

  static void ProcessEvents();

  void ManageWindows(bool manage);

  IWorkbench* GetWorkbench();

  class TestWindowListener: public IWindowListener
  {

  private:
    bool enabled;
    QList<IWorkbenchWindow::Pointer>& testWindows;

  public:

    TestWindowListener(QList<IWorkbenchWindow::Pointer>& testWindows);

    void SetEnabled(bool enabled);

    void WindowActivated(const IWorkbenchWindow::Pointer& window);

    void WindowDeactivated(const IWorkbenchWindow::Pointer& window);

    void WindowClosed(const IWorkbenchWindow::Pointer& window);

    void WindowOpened(const IWorkbenchWindow::Pointer& window);
  };

  IWorkbench* fWorkbench;

private:

  QList<IWorkbenchWindow::Pointer> testWindows;

  QScopedPointer<TestWindowListener> windowListener;

  static void Indent(std::ostream& output, unsigned int indent);

  //static void Write(IStatus status, unsigned int indent);

  void AddWindowListener();

  void RemoveWindowListener();

  void WaitOnShell(Shell::Pointer shell);

};

#define failuimsg(msg, exc) \
  (this->failexc(msg, exc, __LINE__, __FILE__))

}

#endif /* BERRYUITESTCASE_H_ */