Add some unit tests

qgis · Jul 11, 2017 · 86bc8af · 86bc8af
1 parent 3843b5e
commit 86bc8af
Show file tree

Hide file tree

Showing 5 changed files with 180 additions and 6 deletions.
diff --git a/python/gui/layout/qgslayoutviewrubberband.sip b/python/gui/layout/qgslayoutviewrubberband.sip
@@ -30,7 +30,7 @@ class QgsLayoutViewRubberBand
 %End
   public:
 
-    QgsLayoutViewRubberBand( QgsLayoutView *view );
+    QgsLayoutViewRubberBand( QgsLayoutView *view = 0 );
 %Docstring
  Constructor for QgsLayoutViewRubberBand.
 %End
@@ -101,7 +101,7 @@ class QgsLayoutViewRectangularRubberBand : QgsLayoutViewRubberBand
 %End
   public:
 
-    QgsLayoutViewRectangularRubberBand( QgsLayoutView *view );
+    QgsLayoutViewRectangularRubberBand( QgsLayoutView *view = 0 );
 %Docstring
  Constructor for QgsLayoutViewRectangularRubberBand.
 %End
@@ -131,7 +131,7 @@ class QgsLayoutViewEllipticalRubberBand : QgsLayoutViewRubberBand
 %End
   public:
 
-    QgsLayoutViewEllipticalRubberBand( QgsLayoutView *view );
+    QgsLayoutViewEllipticalRubberBand( QgsLayoutView *view = 0 );
 %Docstring
  Constructor for QgsLayoutViewEllipticalRubberBand.
 %End

diff --git a/src/core/layout/qgslayoutitemregistry.h b/src/core/layout/qgslayoutitemregistry.h
@@ -180,6 +180,8 @@ class CORE_EXPORT QgsLayoutItemMetadata : public QgsLayoutItemAbstractMetadata
     QIcon icon() const override { return mIcon.isNull() ? QgsLayoutItemAbstractMetadata::icon() : mIcon; }
     QgsLayoutItem *createItem( QgsLayout *layout, const QVariantMap &properties ) override { return mCreateFunc ? mCreateFunc( layout, properties ) : nullptr; }
     QWidget *createItemWidget() override { return mWidgetFunc ? mWidgetFunc() : nullptr; }
+    QgsLayoutViewRubberBand *createRubberBand( QgsLayoutView *view ) override { return mRubberBandFunc ? mRubberBandFunc( view ) : nullptr; }
+
     void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving ) override
     {
       if ( mPathResolverFunc )

diff --git a/src/gui/layout/qgslayoutview.h b/src/gui/layout/qgslayoutview.h
@@ -113,6 +113,8 @@ class GUI_EXPORT QgsLayoutView: public QGraphicsView
 
     QPointer< QgsLayoutViewTool > mTool;
 
+    friend class TestQgsLayoutView;
+
 };
 
 #endif // QGSLAYOUTVIEW_H
diff --git a/src/gui/layout/qgslayoutviewrubberband.h b/src/gui/layout/qgslayoutviewrubberband.h
@@ -49,7 +49,7 @@ class GUI_EXPORT QgsLayoutViewRubberBand
     /**
      * Constructor for QgsLayoutViewRubberBand.
      */
-    QgsLayoutViewRubberBand( QgsLayoutView *view );
+    QgsLayoutViewRubberBand( QgsLayoutView *view = nullptr );
 
     virtual ~QgsLayoutViewRubberBand() = default;
 
@@ -117,7 +117,7 @@ class GUI_EXPORT QgsLayoutViewRectangularRubberBand : public QgsLayoutViewRubber
     /**
      * Constructor for QgsLayoutViewRectangularRubberBand.
      */
-    QgsLayoutViewRectangularRubberBand( QgsLayoutView *view );
+    QgsLayoutViewRectangularRubberBand( QgsLayoutView *view = nullptr );
     QgsLayoutViewRectangularRubberBand *create( QgsLayoutView *view ) const override SIP_FACTORY;
 
     ~QgsLayoutViewRectangularRubberBand();
@@ -148,7 +148,7 @@ class GUI_EXPORT QgsLayoutViewEllipticalRubberBand : public QgsLayoutViewRubberB
     /**
      * Constructor for QgsLayoutViewEllipticalRubberBand.
      */
-    QgsLayoutViewEllipticalRubberBand( QgsLayoutView *view );
+    QgsLayoutViewEllipticalRubberBand( QgsLayoutView *view = nullptr );
     QgsLayoutViewEllipticalRubberBand *create( QgsLayoutView *view ) const override SIP_FACTORY;
 
     ~QgsLayoutViewEllipticalRubberBand();

diff --git a/tests/src/gui/testqgslayoutview.cpp b/tests/src/gui/testqgslayoutview.cpp
@@ -17,6 +17,11 @@
 #include "qgslayout.h"
 #include "qgslayoutview.h"
 #include "qgslayoutviewtool.h"
+#include "qgslayoutviewmouseevent.h"
+#include "qgslayoutitem.h"
+#include "qgslayoutviewrubberband.h"
+#include "qgslayoutitemregistryguiutils.h"
+#include "qgstestutils.h"
 #include <QtTest/QSignalSpy>
 
 class TestQgsLayoutView: public QObject
@@ -29,6 +34,8 @@ class TestQgsLayoutView: public QObject
     void cleanup(); // will be called after every testfunction.
     void basic();
     void tool();
+    void events();
+    void registryUtils();
 
   private:
 
@@ -101,5 +108,168 @@ void TestQgsLayoutView::tool()
   delete view;
 }
 
+class LoggingTool : public QgsLayoutViewTool
+{
+  public:
+
+    LoggingTool( QgsLayoutView *view )
+      : QgsLayoutViewTool( view, "logging" )
+    {}
+
+    bool receivedMoveEvent = false;
+    void layoutMoveEvent( QgsLayoutViewMouseEvent *event ) override
+    {
+      receivedMoveEvent = true;
+      QCOMPARE( event->layoutPoint().x(), 8.0 );
+      QCOMPARE( event->layoutPoint().y(), 6.0 );
+    }
+
+    bool receivedDoubleClickEvent = false;
+    void layoutDoubleClickEvent( QgsLayoutViewMouseEvent *event ) override
+    {
+      receivedDoubleClickEvent = true;
+      QCOMPARE( event->layoutPoint().x(), 8.0 );
+      QCOMPARE( event->layoutPoint().y(), 6.0 );
+    }
+
+    bool receivedPressEvent = false;
+    void layoutPressEvent( QgsLayoutViewMouseEvent *event ) override
+    {
+      receivedPressEvent  = true;
+      QCOMPARE( event->layoutPoint().x(), 8.0 );
+      QCOMPARE( event->layoutPoint().y(), 6.0 );
+    }
+
+    bool receivedReleaseEvent = false;
+    void layoutReleaseEvent( QgsLayoutViewMouseEvent *event ) override
+    {
+      receivedReleaseEvent  = true;
+      QCOMPARE( event->layoutPoint().x(), 8.0 );
+      QCOMPARE( event->layoutPoint().y(), 6.0 );
+    }
+
+    bool receivedWheelEvent = false;
+    void wheelEvent( QWheelEvent * ) override
+    {
+      receivedWheelEvent = true;
+    }
+
+    bool receivedKeyPressEvent = false;
+    void keyPressEvent( QKeyEvent * ) override
+    {
+      receivedKeyPressEvent  = true;
+    }
+
+    bool receivedKeyReleaseEvent = false;
+    void keyReleaseEvent( QKeyEvent * ) override
+    {
+      receivedKeyReleaseEvent = true;
+    }
+};
+
+void TestQgsLayoutView::events()
+{
+  QgsLayoutView *view = new QgsLayoutView();
+  QgsLayout *layout = new QgsLayout();
+  view->setCurrentLayout( layout );
+  layout->setSceneRect( 0, 0, 1000, 1000 );
+  view->setHorizontalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
+  view->setVerticalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
+  view->setFrameStyle( 0 );
+  view->resize( 100, 100 );
+  view->setFixedSize( 100, 100 );
+  QCOMPARE( view->width(), 100 );
+  QCOMPARE( view->height(), 100 );
+
+  QTransform transform;
+  transform.scale( 10, 10 );
+  view->setTransform( transform );
+
+  LoggingTool *tool = new LoggingTool( view );
+  view->setTool( tool );
+
+  QPointF point( 80, 60 );
+  QMouseEvent press( QEvent::MouseButtonPress, point,
+                     Qt::LeftButton, Qt::LeftButton, Qt::NoModifier );
+  QMouseEvent move( QEvent::MouseMove, point,
+                    Qt::LeftButton, Qt::LeftButton, Qt::NoModifier );
+  QMouseEvent releases( QEvent::MouseButtonRelease, point,
+                        Qt::LeftButton, Qt::LeftButton, Qt::NoModifier );
+  QMouseEvent dblClick( QEvent::MouseButtonDblClick, point,
+                        Qt::LeftButton, Qt::LeftButton, Qt::NoModifier );
+  QWheelEvent wheelEvent( point, 10,
+                          Qt::LeftButton, Qt::NoModifier );
+  QKeyEvent keyPress( QEvent::KeyPress, 10, Qt::NoModifier );
+  QKeyEvent keyRelease( QEvent::KeyRelease, 10, Qt::NoModifier );
+
+  view->mouseMoveEvent( &move );
+  QVERIFY( tool->receivedMoveEvent );
+  view->mousePressEvent( &press );
+  QVERIFY( tool->receivedPressEvent );
+  view->mouseReleaseEvent( &releases );
+  QVERIFY( tool->receivedReleaseEvent );
+  view->mouseDoubleClickEvent( &dblClick );
+  QVERIFY( tool->receivedDoubleClickEvent );
+  view->wheelEvent( &wheelEvent );
+  QVERIFY( tool->receivedWheelEvent );
+  view->keyPressEvent( &keyPress );
+  QVERIFY( tool->receivedKeyPressEvent );
+  view->keyReleaseEvent( &keyRelease );
+  QVERIFY( tool->receivedKeyReleaseEvent );
+}
+
+//simple item for testing, since some methods in QgsLayoutItem are pure virtual
+class TestItem : public QgsLayoutItem
+{
+  public:
+
+    TestItem( QgsLayout *layout ) : QgsLayoutItem( layout ) {}
+    ~TestItem() {}
+
+    //implement pure virtual methods
+    int type() const override { return QgsLayoutItemRegistry::LayoutItem + 101; }
+    void draw( QPainter *, const QStyleOptionGraphicsItem *, QWidget * ) override
+    {    }
+};
+
+QgsLayout *mLayout = nullptr;
+QString mReport;
+
+bool renderCheck( QString testName, QImage &image, int mismatchCount );
+
+void TestQgsLayoutView::registryUtils()
+{
+  // add a dummy item to registry
+  auto create = []( QgsLayout * layout, const QVariantMap & )->QgsLayoutItem*
+  {
+    return new TestItem( layout );
+  };
+
+  auto createRubberBand = []( QgsLayoutView * view )->QgsLayoutViewRubberBand *
+  {
+    return new QgsLayoutViewRectangularRubberBand( view );
+  };
+
+  QgsLayoutItemMetadata *metadata = new QgsLayoutItemMetadata( 2, QStringLiteral( "my type" ), QIcon(), create );
+  metadata->setRubberBandCreationFunction( createRubberBand );
+  QVERIFY( QgsApplication::layoutItemRegistry()->addLayoutItemType( metadata ) );
+
+  QgsLayoutView *view = new QgsLayoutView();
+  //should use metadata's method
+  QgsLayoutViewRubberBand *band = QgsApplication::layoutItemRegistry()->createItemRubberBand( 2, view );
+  QVERIFY( band );
+  QVERIFY( dynamic_cast< QgsLayoutViewRectangularRubberBand * >( band ) );
+  QCOMPARE( band->view(), view );
+  delete band;
+
+  //manually register a prototype
+  QgsLayoutItemRegistryGuiUtils::setItemRubberBandPrototype( 2, new QgsLayoutViewEllipticalRubberBand() );
+  band = QgsApplication::layoutItemRegistry()->createItemRubberBand( 2, view );
+  QVERIFY( band );
+  QVERIFY( dynamic_cast< QgsLayoutViewEllipticalRubberBand * >( band ) );
+  QCOMPARE( band->view(), view );
+
+}
+
 QGSTEST_MAIN( TestQgsLayoutView )
 #include "testqgslayoutview.moc"