Skip to content

Value relation model and controller unit tests #4531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gabriel-bolbotina wants to merge 3 commits into
base: fix/value-relation-2026
Choose a base branch
from
Open

Value relation model and controller unit tests #4531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
338723d
Added functions in test utils to create value relation lookup and ord…
gabriel-bolbotina Jun 10, 2026
12e94f6
Minor changes
gabriel-bolbotina Jun 10, 2026
367905b
Changed comments
gabriel-bolbotina Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
317 changes: 185 additions & 132 deletions app/test/testformeditors.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,151 +449,204 @@ void TestFormEditors::testRelationsWidgetPresence()
QVERIFY( relationReferencesCount == 1 );
}

void TestFormEditors::testValueRelationsEditor() {}
// {
// /* Test project: project_value_relations
// * It has value relations sets up followingly:
// *
// * - Main Layer has VR to:
// * - sub layer
// * - subsub layer ( with filter expression that subsub is categorized based on sub )
// * - another layer ( key is not fid, but textual )
// */

// QString projectDir = TestUtils::testDataDir() + "/project_value_relations";
// QString projectName = "proj.qgz";

// QVERIFY( QgsProject::instance()->read( projectDir + "/" + projectName ) );

// QgsMapLayer *mainL = QgsProject::instance()->mapLayersByName( QStringLiteral( "main" ) ).at( 0 );
// QgsVectorLayer *mainLayer = static_cast<QgsVectorLayer *>( mainL );

// QVERIFY( mainLayer && mainLayer->isValid() );

// QgsMapLayer *subL = QgsProject::instance()->mapLayersByName( QStringLiteral( "sub" ) ).at( 0 );
// QgsVectorLayer *subLayer = static_cast<QgsVectorLayer *>( subL );

// QVERIFY( subLayer && subLayer->isValid() );

// QgsMapLayer *subsubL = QgsProject::instance()->mapLayersByName( QStringLiteral( "subsub" ) ).at( 0 );
// QgsVectorLayer *subsubLayer = static_cast<QgsVectorLayer *>( subsubL );

// QVERIFY( subsubLayer && subsubLayer->isValid() );

// QgsMapLayer *anotherL = QgsProject::instance()->mapLayersByName( QStringLiteral( "another" ) ).at( 0 );
// QgsVectorLayer *anotherLayer = static_cast<QgsVectorLayer *>( anotherL );

// QVERIFY( anotherLayer && anotherLayer->isValid() );

// // test ValueRelationsFeaturesModel (drawer model) and ValueRelationController

// QgsFeature f = mainLayer->getFeature( 1 );
// FeatureLayerPair pair( f, mainLayer );

// AttributeController controller;
// controller.setFeatureLayerPair( pair );

// const TabItem *tab = controller.tabItem( 0 );
// QVector<QUuid> items = tab->formItems();

// QVERIFY( items.length() == 5 );

// // order: 0 - fid, 1 - Name, 2 - subfk, 3 - anotherfk, 4 - subsubfk

// // ------- FIELD SubFK: drawer model loads all sub-layer features on demand

// const FormItem *subFkItem = controller.formItem( items.at( 2 ) );

// ValueRelationFeaturesModel subVRModel;
// QSignalSpy subSpy( &subVRModel, &LayerFeaturesModel::fetchingResultsChanged );

// subVRModel.setConfig( subFkItem->editorWidgetConfig() );

// // No features before explicit load (lazy loading)
// QCOMPARE( subVRModel.rowCount(), 0 );

// subVRModel.reloadFeatures();
// subSpy.wait();
// QCOMPARE( subVRModel.rowCount(), subLayer->dataProvider()->featureCount() );
// QCOMPARE( subVRModel.layer()->id(), subLayer->id() );

// // KeyColumn and ValueColumn roles are present
// QVERIFY( subVRModel.data( subVRModel.index( 0, 0 ), ValueRelationFeaturesModel::KeyColumn ).isValid() );
// QVERIFY( subVRModel.data( subVRModel.index( 0, 0 ), ValueRelationFeaturesModel::ValueColumn ).isValid() );
void TestFormEditors::testValueRelationConversions()
{
/* Tests qgisFormatToArray() and arrayToQgisFormat() for null, single,
* and multi values.
*
* AllowMulti=false:
* QGIS value -> keys: "1" -> ["1"]
* keys -> QGIS value: ["42"] -> "42"
*
* AllowMulti=true:
* QGIS value -> keys: "{1,3,4}" -> ["1","3","4"]
* keys -> QGIS value: ["1","3","4"] -> "{1,3,4}"; ["1"] -> "{1}"
*/
QgsProject::instance()->removeAllMapLayers();

// // ------- FIELD SubSubFK: form-scoped FilterExpression + drill-down
QgsVectorLayer *layer = TestUtils::createVRLookupLayer( 5 );
QVERIFY( layer && layer->isValid() );
QgsProject::instance()->addMapLayer( layer );

// const FormItem *subsubFkItem = controller.formItem( items.at( 4 ) );
// Single value test
ValueRelationController controller;
controller.setConfig(
{
{ QStringLiteral( "Layer" ), layer->id() },
{ QStringLiteral( "Key" ), QStringLiteral( "key" ) },
{ QStringLiteral( "Value" ), QStringLiteral( "label" ) },
{ QStringLiteral( "AllowMulti" ), false }
} );

// ValueRelationFeaturesModel subsubVRModel;
// QSignalSpy subsubSpy( &subsubVRModel, &LayerFeaturesModel::fetchingResultsChanged );
// subsubVRModel.setConfig( subsubFkItem->editorWidgetConfig() );
// subsubVRModel.setPair( pair ); // form scope resolves current_value() in the filter
// subsubVRModel.reloadFeatures();
// null/empty : empty list
QCOMPARE( controller.qgisFormatToArray( QVariant() ), QStringList() );
QCOMPARE( controller.qgisFormatToArray( QStringLiteral( "" ) ), QStringList() );

// subsubSpy.wait();
// QCOMPARE( subsubVRModel.layer()->id(), subsubLayer->id() );
// single value "1" : ["1"]
QCOMPARE( controller.qgisFormatToArray( QStringLiteral( "1" ) ),
QStringList( { QStringLiteral( "1" ) } ) );

// // With the pair set the form-scoped filter must restrict the result set
// QCOMPARE( subsubVRModel.rowCount(), 2 );
// empty keys : ""
QCOMPARE( controller.arrayToQgisFormat( {} ), QString() );

// // Filter expression is present and valid in the request
// QgsFeatureRequest request;
// subsubVRModel.setupFeatureRequest( request );
// QVERIFY( !request.filterExpression()->operator QString().isEmpty() );
// QVERIFY( request.filterExpression()->isValid() );
// single key : plain value
QCOMPARE( controller.arrayToQgisFormat( { QStringLiteral( "42" ) } ),
QStringLiteral( "42" ) );

// // Search combined with the filter expression
// subsubVRModel.setSearchExpression( QStringLiteral( "2" ) );
// subsubSpy.wait();
// QCOMPARE( subsubVRModel.rowCount(), 1 );
// Multi value test
controller.setConfig(
{
{ QStringLiteral( "Layer" ), layer->id() },
{ QStringLiteral( "Key" ), QStringLiteral( "key" ) },
{ QStringLiteral( "Value" ), QStringLiteral( "label" ) },
{ QStringLiteral( "AllowMulti" ), true }
} );

// // featureTitle returns the value column
// {
// QModelIndex idx = subsubVRModel.index( 0, 0 );
// FeatureLayerPair tempPair = subsubVRModel.data( idx, FeaturesModel::FeaturePair ).value<FeatureLayerPair>();
// QCOMPARE( subsubVRModel.featureTitle( tempPair ), QStringLiteral( "A2" ) );
// }
// null : empty list
QCOMPARE( controller.qgisFormatToArray( QVariant() ), QStringList() );

// // ------- FIELD AnotherFK: helper-based conversions and invalidation
// "{1,3,4}" : ["1","3","4"]
QCOMPARE( controller.qgisFormatToArray( QStringLiteral( "{1,3,4}" ) ),
QStringList( { QStringLiteral( "1" ), QStringLiteral( "3" ), QStringLiteral( "4" ) } ) );

// const FormItem *anotherFkItem = controller.formItem( items.at( 3 ) );
// "{1}" : ["1"]
QCOMPARE( controller.qgisFormatToArray( QStringLiteral( "{1}" ) ),
QStringList( { QStringLiteral( "1" ) } ) );

// ValueRelationFeaturesModel anotherVRModel;
// QSignalSpy anotherSpy( &anotherVRModel, &LayerFeaturesModel::fetchingResultsChanged );
// anotherVRModel.setConfig( anotherFkItem->editorWidgetConfig() );
// anotherVRModel.reloadFeatures();
// anotherSpy.wait();
// QCOMPARE( anotherVRModel.rowCount(), anotherLayer->dataProvider()->featureCount() );
// QCOMPARE( anotherVRModel.layer()->id(), anotherLayer->id() );
// empty keys : ""
QCOMPARE( controller.arrayToQgisFormat( {} ), QString() );

// // ValueRelationController handles conversions (static) and lookups (instance).
// // The "another" layer uses text keys; we look up a single known key "B".
// ValueRelationController anotherHelper;
// anotherHelper.setConfig( anotherFkItem->editorWidgetConfig() );
// ["1","3","4"] : "{1,3,4}"
QCOMPARE( controller.arrayToQgisFormat( { QStringLiteral( "1" ), QStringLiteral( "3" ), QStringLiteral( "4" ) } ),
QStringLiteral( "{1,3,4}" ) );

// // Single key lookup: pick the first key from the already-loaded model so the
// // test is not sensitive to the exact fixture values.
// QVERIFY( anotherVRModel.rowCount() > 0 );
// const QVariant firstKey = anotherVRModel.data( anotherVRModel.index( 0, 0 ), ValueRelationFeaturesModel::KeyColumn );
// QVERIFY( firstKey.isValid() );
// ["1"] : "{1}"
QCOMPARE( controller.arrayToQgisFormat( { QStringLiteral( "1" ) } ),
QStringLiteral( "{1}" ) );

// QSignalSpy lookupSpy( &anotherHelper, &ValueRelationController::displayValuesReady );
// anotherHelper.lookupDisplayValues( firstKey );
// QVERIFY( lookupSpy.wait() );
// QCOMPARE( lookupSpy.last().at( 0 ).toList().size(), 1 );
QgsProject::instance()->removeAllMapLayers();
}

// // Static: round-trip QGIS format (type-independent, no layer access)
// QCOMPARE( anotherHelper.convertToQgisFormat( { QStringLiteral( "B" ), QStringLiteral( "C" ) } ),
// QStringLiteral( "{B,C}" ) );
// QCOMPARE( anotherHelper.convertFromQgisFormat( QStringLiteral( "{B,C}" ), true ),
// QStringList( { QStringLiteral( "B" ), QStringLiteral( "C" ) } ) );
void TestFormEditors::testValueRelationControllerLookup()
{
/* Tests async display-text lookup for ValueRelationController:
*
* baseConfig controller (no FilterExpression):
* 1. Missing key -> presentRawValue fires; invalidateSelection does NOT fire; displayText=""
* 2. lookupDisplayTextOnHotreload without FilterExpression -> returns early, no signals
* 3. Basic lookup: lookupDisplayTextOnValueChanged("1") -> "Cat1-A"
*
* filterConfig controller (FilterExpression set):
* 4. lookupDisplayTextOnHotreload, key valid in context -> displayText updated ("Cat1-A")
* 5. lookupDisplayTextOnHotreload, key no longer in context -> invalidateSelection fires
*
* Cases 1-2 run before case 3 so that mDisplayText is "" when case 1 checks
* displaySpy.isEmpty() -> the setDisplayText guard skips emission for equal values.
*
* Lookup layer:
* key=1 label="Cat1-A" category=1
* key=2 label="Cat1-B" category=1
* key=3 label="Cat2-A" category=2
* key=4 label="Cat2-B" category=2
*
* Filter expression: "category" = current_value('cat')
* Form feature cat=1 -> keys 1,2 reachable; cat=2 -> keys 3,4 reachable.
*/
QgsProject::instance()->removeAllMapLayers();

// create the lookup layer
QgsVectorLayer *lookupLayer = new QgsVectorLayer(
QStringLiteral( "None?field=key:integer&field=label:string&field=category:integer" ),
QStringLiteral( "vr_lookup" ),
QStringLiteral( "memory" )
);
QVERIFY( lookupLayer && lookupLayer->isValid() );

const QStringList labels = { QStringLiteral( "Cat1-A" ), QStringLiteral( "Cat1-B" ),
QStringLiteral( "Cat2-A" ), QStringLiteral( "Cat2-B" )
};
QgsFeatureList features;
for ( int i = 0; i < 4; ++i )
{
QgsFeature feature( lookupLayer->fields() );
feature.setAttribute( QStringLiteral( "key" ), i + 1 );
feature.setAttribute( QStringLiteral( "label" ), labels.at( i ) );
feature.setAttribute( QStringLiteral( "category" ), i < 2 ? 1 : 2 );
features << feature;
}
lookupLayer->dataProvider()->addFeatures( features );
QgsProject::instance()->addMapLayer( lookupLayer );

// create the form layer, that provides fields for building form-scope features
QgsVectorLayer *formLayer = new QgsVectorLayer(
QStringLiteral( "None?field=cat:integer" ),
QStringLiteral( "vr_form" ),
QStringLiteral( "memory" )
);
QVERIFY( formLayer && formLayer->isValid() );
QgsProject::instance()->addMapLayer( formLayer );

const QVariantMap baseConfig =
{
{ QStringLiteral( "Layer" ), lookupLayer->id() },
{ QStringLiteral( "Key" ), QStringLiteral( "key" ) },
{ QStringLiteral( "Value" ), QStringLiteral( "label" ) },
{ QStringLiteral( "AllowMulti" ), false }
};

// // Invalidation: helper with no FilterExpression must NOT emit invalidate
// // (the "another" layer config has no filter expression)
// QSignalSpy helperInvalidateSpy( &anotherHelper, &ValueRelationController::invalidate );
// QSignalSpy helperResultSpy( &anotherHelper, &ValueRelationController::displayValuesReady );
// anotherHelper.lookupDisplayValues( QStringLiteral( "NONEXISTENT_KEY" ) );
// QVERIFY( helperResultSpy.wait() );
// QVERIFY( helperInvalidateSpy.isEmpty() );
// }
QVariantMap filterConfig = baseConfig;
filterConfig[ QStringLiteral( "FilterExpression" ) ] =
QStringLiteral( "\"category\" = current_value('cat')" );

ValueRelationController baseController;
baseController.setConfig( baseConfig );

QSignalSpy rawSpy( &baseController, &ValueRelationController::presentRawValue );
QSignalSpy invalidateSpy( &baseController, &ValueRelationController::invalidateSelection );
QSignalSpy displaySpy( &baseController, &ValueRelationController::displayTextChanged );

// 1. Missing key, no filter -> presentRawValue; NOT invalidateSelection
baseController.lookupDisplayTextOnValueChanged( QStringLiteral( "99999" ) );
QVERIFY( rawSpy.wait( 5000 ) );
QVERIFY( displaySpy.isEmpty() ); // mDisplayText was already ""; setDisplayText skips emission
QVERIFY( invalidateSpy.isEmpty() );
QCOMPARE( baseController.displayText(), QString() );

// 2. Hotreload without FilterExpression -> early return, no signals
rawSpy.clear();
displaySpy.clear();
baseController.lookupDisplayTextOnHotreload( QStringLiteral( "1" ), QgsFeature() );
QVERIFY( displaySpy.isEmpty() );

// 3. Basic lookup: key "1" -> "Cat1-A"
displaySpy.clear();
baseController.lookupDisplayTextOnValueChanged( QStringLiteral( "1" ) );
QVERIFY( displaySpy.wait( 5000 ) );
QCOMPARE( baseController.displayText(), QStringLiteral( "Cat1-A" ) );

ValueRelationController filterController;
filterController.setConfig( filterConfig );

QSignalSpy filterDisplaySpy( &filterController, &ValueRelationController::displayTextChanged );
QSignalSpy filterInvalidateSpy( &filterController, &ValueRelationController::invalidateSelection );

// 4. Hotreload with filter, key valid in context -> displayText updated
// Form context: cat=1 -> key 1 ("Cat1-A") is reachable (category=1)
QgsFeature formFeature( formLayer->fields() );
formFeature.setAttribute( QStringLiteral( "cat" ), 1 );
formFeature.setValid( true );
filterController.lookupDisplayTextOnHotreload( QStringLiteral( "1" ), formFeature );
QVERIFY( filterDisplaySpy.wait( 5000 ) );
QCOMPARE( filterController.displayText(), QStringLiteral( "Cat1-A" ) );

// 5. Hotreload with filter, key not in context -> invalidateSelection
// Form context: cat=2 -> key 1 ("Cat1-A") is NOT reachable (category=1 ≠ 2)
filterDisplaySpy.clear();
QgsFeature formFeature2( formLayer->fields() );
formFeature2.setAttribute( QStringLiteral( "cat" ), 2 );
formFeature2.setValid( true );
filterController.lookupDisplayTextOnHotreload( QStringLiteral( "1" ), formFeature2 );
QVERIFY( filterInvalidateSpy.wait( 5000 ) );

QgsProject::instance()->removeAllMapLayers();
}
3 changes: 2 additions & 1 deletion app/test/testformeditors.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ class TestFormEditors : public QObject
void testRelationsEditor();
void testRelationsReferenceEditor();
void testRelationsWidgetPresence();
void testValueRelationsEditor();
void testValueRelationConversions();
void testValueRelationControllerLookup();
};

#endif // TESTFORMEDITORS_H
Loading
Loading