[layouts] Improve north arrow export time validity check to also test

nyalldawson · nirvn · commit ad4a38d1c0e8 · 2019-06-14T08:02:34.000+07:00
for north arrows by checking their default id string
diff --git a/src/app/layout/qgslayoutvaliditychecks.cpp b/src/app/layout/qgslayoutvaliditychecks.cpp
@@ -105,8 +105,10 @@ bool QgsLayoutNorthArrowValidityCheck::prepareCheck( const QgsValidityCheckConte
   layoutContext->layout->layoutItems( pictureItems );
   for ( QgsLayoutItemPicture *picture : qgis::as_const( pictureItems ) )
   {
-    // look for pictures which use the default north arrow svg, but aren't actually linked to maps
-    if ( !picture->linkedMap() && picture->picturePath() == QStringLiteral( ":/images/north_arrows/layout_default_north_arrow.svg" ) )
+    // look for pictures which use the default north arrow svg, but aren't actually linked to maps.
+    // alternatively identify them by looking for the default "North Arrow" string in their id
+    if ( !picture->linkedMap() && ( picture->picturePath() == QStringLiteral( ":/images/north_arrows/layout_default_north_arrow.svg" )
+                                    || picture->id().contains( QObject::tr( "North Arrow" ), Qt::CaseInsensitive ) ) )
     {
       QgsValidityCheckResult res;
       res.type = QgsValidityCheckResult::Warning;
diff --git a/tests/src/app/testqgsapplayoutvaliditychecks.cpp b/tests/src/app/testqgsapplayoutvaliditychecks.cpp
@@ -134,6 +134,24 @@ void TestQgsLayoutValidityChecks::testNorthArrowValidity()
   QVERIFY( check2.prepareCheck( &context, &f ) );
   res = check2.runCheck( &context, &f );
   QCOMPARE( res.size(), 0 );
+
+  // test with ID check
+  picture->setPicturePath( QStringLiteral( "a" ) );
+  picture->setId( QStringLiteral( "north arrow 2" ) );
+  picture->setLinkedMap( nullptr );
+
+  QgsLayoutNorthArrowValidityCheck check3;
+  QVERIFY( check3.prepareCheck( &context, &f ) );
+  res = check3.runCheck( &context, &f );
+  QCOMPARE( res.size(), 1 );
+  QCOMPARE( res.at( 0 ).type, QgsValidityCheckResult::Warning );
+
+  // no longer looks like a north arrow
+  picture->setId( QStringLiteral( "a" ) );
+  QgsLayoutNorthArrowValidityCheck check4;
+  QVERIFY( check4.prepareCheck( &context, &f ) );
+  res = check4.runCheck( &context, &f );
+  QCOMPARE( res.size(), 0 );
 }
 
 void TestQgsLayoutValidityChecks::testOverviewValidity()

Original file line number	Diff line number	Diff line change
`@@ -105,8 +105,10 @@ bool QgsLayoutNorthArrowValidityCheck::prepareCheck( const QgsValidityCheckConte`
`105`	`105`	`layoutContext->layout->layoutItems( pictureItems );`
`106`	`106`	`for ( QgsLayoutItemPicture *picture : qgis::as_const( pictureItems ) )`
`107`	`107`	`{`
`108`		`- // look for pictures which use the default north arrow svg, but aren't actually linked to maps`
`109`		`- if ( !picture->linkedMap() && picture->picturePath() == QStringLiteral( ":/images/north_arrows/layout_default_north_arrow.svg" ) )`
	`108`	`+ // look for pictures which use the default north arrow svg, but aren't actually linked to maps.`
	`109`	`+ // alternatively identify them by looking for the default "North Arrow" string in their id`
	`110`	`+ if ( !picture->linkedMap() && ( picture->picturePath() == QStringLiteral( ":/images/north_arrows/layout_default_north_arrow.svg" )`
	`111`	`+ \|\| picture->id().contains( QObject::tr( "North Arrow" ), Qt::CaseInsensitive ) ) )`
`110`	`112`	`{`
`111`	`113`	`QgsValidityCheckResult res;`
`112`	`114`	`res.type = QgsValidityCheckResult::Warning;`