-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathTopicMappingServiceTest.cs
1654 lines (1272 loc) · 82.7 KB
/
TopicMappingServiceTest.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*==============================================================================================================================
| Author Ignia, LLC
| Client Ignia, LLC
| Project Topics Library
\=============================================================================================================================*/
using System.ComponentModel.DataAnnotations;
using System.Globalization;
using OnTopic.Data.Caching;
using OnTopic.Mapping;
using OnTopic.Mapping.Internal;
using OnTopic.Metadata;
using OnTopic.Repositories;
using OnTopic.TestDoubles;
using OnTopic.TestDoubles.Metadata;
using OnTopic.Tests.Entities;
using OnTopic.Tests.Fixtures;
using OnTopic.Tests.ViewModels;
using OnTopic.Tests.ViewModels.Metadata;
using Xunit;
namespace OnTopic.Tests {
/*============================================================================================================================
| CLASS: TOPIC MAPPING SERVICE TESTS
\---------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Provides unit tests for the <see cref="TopicMappingService"/> using local DTOs.
/// </summary>
[ExcludeFromCodeCoverage]
[Xunit.Collection("Shared Repository")]
public class TopicMappingServiceTest {
/*==========================================================================================================================
| PRIVATE VARIABLES
\-------------------------------------------------------------------------------------------------------------------------*/
readonly ITopicRepository _topicRepository;
readonly ITopicMappingService _mappingService;
/*==========================================================================================================================
| CONSTRUCTOR
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Initializes a new instance of the <see cref="TopicMappingServiceTest"/> with shared resources.
/// </summary>
/// <remarks>
/// This uses the <see cref="StubTopicRepository"/> to provide data, and then <see cref="CachedTopicRepository"/> to
/// manage the in-memory representation of the data. While this introduces some overhead to the tests, the latter is a
/// relatively lightweight façade to any <see cref="ITopicRepository"/>, and prevents the need to duplicate logic for
/// crawling the object graph.
/// </remarks>
public TopicMappingServiceTest(TopicInfrastructureFixture<StubTopicRepository> fixture) {
/*------------------------------------------------------------------------------------------------------------------------
| Validate parameters
\-----------------------------------------------------------------------------------------------------------------------*/
Contract.Requires(fixture, nameof(fixture));
/*------------------------------------------------------------------------------------------------------------------------
| Set services
\-----------------------------------------------------------------------------------------------------------------------*/
_topicRepository = fixture.CachedTopicRepository;
_mappingService = fixture.MappingService;
}
/*==========================================================================================================================
| TEST: MAP: LOAD TESTING: EVALUATE THRESHOLD
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests creating and mapping <see cref="Topic"/> instances in bulk,
/// as a quick-and-easy way of assessing performance.
/// </summary>
/// <remarks>
/// <para>
/// The <see cref="TopicMappingService"/> includes functionality to map properties to attributes via a constructor that
/// accepts a <see cref="AttributeDictionary"/>. This introduces some overhead which is not cost effective if there are
/// not any attributes that map to properties. For larger numbers of mapped attributes, however, the <see cref="
/// AttributeDictionary"/> can reduce the mapping time considerably, while also giving more control over the model
/// construction to the model developer. This test is intended to help identify and optimize that threshold based on
/// improvements to the underlying <see cref="AttributeDictionary"/>, <see cref="TopicMappingService.MapAsync(Topic?,
/// AssociationTypes)"/>, and <see cref="AttributeCollection.AsAttributeDictionary(bool)"/> convenience method.
/// </para>
/// <para>
/// This is only intended to be enabled when needed for specialized performance testing.
/// </para>
/// </remarks>
[Fact]
public async Task Map_LoadTesting_EvaluateThreshold() {
/*------------------------------------------------------------------------------------------------------------------------
| Establish variables
\-----------------------------------------------------------------------------------------------------------------------*/
var runs = 0; // The number of mapping operations to perform
var propertyCount = 10; // The number of property values to set on the LoadTestingModel
/*------------------------------------------------------------------------------------------------------------------------
| Establish data model
\-----------------------------------------------------------------------------------------------------------------------*/
var topic = new Topic("Test", "ContentList", null);
for (var i = 0; i <= propertyCount; i++) {
topic.Attributes.SetInteger("Property"+i, i);
}
/*------------------------------------------------------------------------------------------------------------------------
| Run load testing
\-----------------------------------------------------------------------------------------------------------------------*/
for (var i = 0; i < runs; i++) {
await _mappingService.MapAsync<LoadTestingViewModel>(topic).ConfigureAwait(false);
}
/*------------------------------------------------------------------------------------------------------------------------
| Always assume the test passed
\-----------------------------------------------------------------------------------------------------------------------*/
Assert.True(true);
}
/*==========================================================================================================================
| TEST: MAP: LOAD TESTING: EVALUATE TIME
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests creating and mapping <see cref="Topic"/> instances in bulk,
/// as a quick-and-easy way of assessing performance.
/// </summary>
[Fact]
public async Task Map_LoadTesting_EvaluateTime() {
/*------------------------------------------------------------------------------------------------------------------------
| Establish variables
\-----------------------------------------------------------------------------------------------------------------------*/
var runs = 0; // The number of mapping operations to perform
var useFullAttributeSet = false; // Include a larget set of attribute values
var includeNestedTopics = false; // Only include a minimal set of properties
/*------------------------------------------------------------------------------------------------------------------------
| Establish object model
\-----------------------------------------------------------------------------------------------------------------------*/
var currentId = 1;
var baseTopic = new Topic("Base", "Page", null, currentId++);
var grandparent = new Topic("Grandparent", "Page", null, currentId++);
var parent = new Topic("Parent", "Page", grandparent, currentId++);
var topic = new Topic("Test", "ContentList", parent, currentId++);
var contentItems = new Topic("ContentItems", "List", topic, currentId++);
if (includeNestedTopics) {
_ = new Topic("Item1", "ContentItem", contentItems, currentId++);
_ = new Topic("Item2", "ContentItem", contentItems, currentId++);
_ = new Topic("Item3", "ContentItem", contentItems, currentId++);
_ = new Topic("Item4", "ContentItem", contentItems, currentId++);
_ = new Topic("Item5", "ContentItem", contentItems, currentId++);
_ = new Topic("Item6", "ContentItem", contentItems, currentId++);
}
grandparent.BaseTopic = baseTopic;
/*------------------------------------------------------------------------------------------------------------------------
| Populate attributes
\-----------------------------------------------------------------------------------------------------------------------*/
foreach (var contentItem in contentItems.Children) {
contentItem.Attributes.SetDateTime("LastModified", DateTime.Now);
contentItem.Attributes.SetValue("Description", "Value1");
if (useFullAttributeSet) {
contentItem.Attributes.SetValue("LearnMoreUrl", "/Topic/23/");
contentItem.Attributes.SetValue("ThumbnailImage", "/Image.jpg");
contentItem.Attributes.SetValue("Description", "Value1");
contentItem.Attributes.SetValue("Category", "Gumby");
}
}
topic.Attributes.SetValue("Title", "Friendly Title");
topic.Attributes.SetValue("IsHidden", "0");
if (useFullAttributeSet) {
topic.Attributes.SetValue("View", "Test");
topic.Attributes.SetValue("ShortTitle", "Short Title");
topic.Attributes.SetValue("Subtitle", "Subtitle");
topic.Attributes.SetValue("MetaTitle", "Meta Title");
topic.Attributes.SetValue("MetaDescription", "Meta Description");
topic.Attributes.SetValue("MetaKeywords", "Load;Test;Keywords");
topic.Attributes.SetValue("NoIndex", "0");
topic.Attributes.SetValue("Body", "Body of test topic");
}
baseTopic.Attributes.SetValue("Title", "Inherited Title");
/*------------------------------------------------------------------------------------------------------------------------
| Run load testing
\-----------------------------------------------------------------------------------------------------------------------*/
for (var i = 0; i <= runs; i++) {
await _mappingService.MapAsync(topic).ConfigureAwait(false);
}
/*------------------------------------------------------------------------------------------------------------------------
| Always assume the test passed
\-----------------------------------------------------------------------------------------------------------------------*/
Assert.True(true);
}
/*==========================================================================================================================
| TEST: MAP: GENERIC: RETURNS NEW MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests setting basic scalar values by specifying an explicit type.
/// </summary>
[Fact]
public async Task Map_Generic_ReturnsNewModel() {
var topic = new Topic("Test", "Page");
topic.Attributes.SetValue("MetaTitle", "ValueA");
topic.Attributes.SetValue("Title", "Value1");
var target = await _mappingService.MapAsync<PageTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal("ValueA", target?.MetaTitle);
Assert.Equal("Value1", target?.Title);
}
/*==========================================================================================================================
| TEST: MAP: GENERIC: RETURNS NEW RECORD
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and confirms that a basic <c>record</c> type can be mapped by
/// explicitly setting defining the target type.
/// </summary>
[Fact]
public async Task Map_Generic_ReturnsNewRecord() {
var topic = new Topic("Test", "Page");
var target = await _mappingService.MapAsync<RecordTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal(topic.Key, target?.Key);
}
/*==========================================================================================================================
| TEST: MAP: DYNAMIC: RETURNS NEW MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests setting basic scalar values by allowing it to dynamically
/// determine the instance type.
/// </summary>
[Fact]
public async Task Map_Dynamic_ReturnsNewModel() {
var topic = new Topic("Test", "Page");
topic.Attributes.SetValue("MetaTitle", "ValueA");
topic.Attributes.SetValue("Title", "Value1");
var target = (PageTopicViewModel?)await _mappingService.MapAsync(topic).ConfigureAwait(false);
Assert.Equal("ValueA", target?.MetaTitle);
Assert.Equal("Value1", target?.Title);
}
/*==========================================================================================================================
| TEST: MAP: GENERIC: RETURNS CONVERTED PROPERTY
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and confirms that a basic source property of type string—e.g., <see
/// cref="CustomTopic.BooleanAsStringAttribute"/>—can successfully be converted to a target type of an integer—e.g., <see
/// cref="ConvertPropertyViewModel.BooleanAttribute"/>.
/// </summary>
[Fact]
public async Task Map_Generic_ReturnsConvertedProperty() {
var topic = new CustomTopic("Test", "CustomTopic") {
NumericAttribute = 1,
BooleanAsStringAttribute = "1"
};
var target = await _mappingService.MapAsync<ConvertPropertyViewModel>(topic).ConfigureAwait(false);
Assert.True(target?.BooleanAttribute);
Assert.Equal(topic.NumericAttribute.ToString(CultureInfo.InvariantCulture), target?.NumericAsStringAttribute);
}
/*==========================================================================================================================
| TEST: MAP: ATTRIBUTE DICTIONARY: RETURNS NEW MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and attempts to map a view model with a constructor containing a <see
/// cref="AttributeDictionary"/>. Confirms that the expected model is returned.
/// </summary>
[Fact]
public async Task Map_AttributeDictionary_ReturnsNewModel() {
var topic = new Topic("Test", "Page");
var lastModified = new DateTime(2021, 12, 22);
topic.Attributes.SetValue("Title", "Value");
topic.Attributes.SetValue("ShortTitle", "Short Title");
topic.Attributes.SetValue("Subtitle", "Subtitle");
topic.Attributes.SetValue("MetaTitle", "Meta Title");
topic.Attributes.SetValue("MetaDescription", "Meta Description");
topic.Attributes.SetValue("MetaKeywords", "Load;Test;Keywords");
topic.Attributes.SetValue("NoIndex", "0");
topic.Attributes.SetValue("Body", "Body of test topic");
topic.Attributes.SetValue("MappedProperty", "Mapped Value");
topic.Attributes.SetValue("UnmappedProperty", "Unmapped Value");
topic.VersionHistory.Add(lastModified);
var target = await _mappingService.MapAsync<AttributeDictionaryConstructorTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal("Value", target?.Title);
Assert.Equal("Short Title", target?.ShortTitle);
Assert.Equal("Subtitle", target?.Subtitle);
Assert.Equal("Meta Title", target?.MetaTitle);
Assert.Equal("Meta Description", target?.MetaDescription);
Assert.Equal(false, target?.NoIndex);
Assert.Equal("Load;Test;Keywords", target?.MetaKeywords);
Assert.Equal("Mapped Value", target?.MappedProperty);
Assert.Null(target?.UnmappedProperty);
Assert.Equal(lastModified, target?.LastModified);
}
/*==========================================================================================================================
| TEST: MAP: CONSTRUCTOR: RETURNS NEW MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and attempts to map a view model with a constructor containing a
/// scalar value, topic reference, relationship, and an optional parameter. Confirms that the expected model is returned.
/// </summary>
[Fact]
public async Task Map_Constructor_ReturnsNewModel() {
var topic = new Topic("Topic", "Constructed", null, 1);
var related1 = new Topic("Related1", "Constructed", null, 2);
var related2 = new Topic("Related2", "Constructed", null, 3);
var related3 = new Topic("Related3", "Constructed", null, 4);
topic.Attributes.SetValue("Value", "Foo");
topic.Attributes.SetValue("ScalarValue", "Invalid");
topic.Attributes.SetValue("OptionalValue", "3");
topic.References.SetValue("TopicReference", related1);
topic.Relationships.SetValue("Related", related2);
topic.Relationships.SetValue("Relationships", related2); //Should not be mapped
topic.Relationships.SetValue("Relationships", related3); //Should not be mapped
related1.Attributes.SetValue("Value", "Bar");
related1.References.SetValue("TopicReference", related3);
related3.Attributes.SetValue("Value", "Baz");
var target = await _mappingService.MapAsync<ConstructedTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal("Foo", target?.ScalarValue);
Assert.NotNull(target?.TopicReference);
Assert.NotNull(target?.Relationships);
Assert.Equal(5, target?.OptionalValue);
Assert.Single(target?.Relationships);
Assert.Equal("Bar", target?.TopicReference?.ScalarValue);
Assert.NotNull(target?.TopicReference?.TopicReference);
Assert.Equal("Baz", target?.TopicReference!.TopicReference!.ScalarValue);
Assert.Null(target?.TopicReference!.TopicReference!.TopicReference);
}
/*==========================================================================================================================
| TEST: MAP: GENERIC: INITIALIZES COLLECTIONS
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and attempts to map a view model whose collections are not initialized
/// in order to confirm that it can successfully initialize them.
/// </summary>
[Fact]
public async Task Map_Generic_InitializesCollections() {
var topic = new Topic("Topic", "NullCollection", null, 1);
var reference = new Topic("Reference", "KeyOnly", null, 2);
topic.Relationships.SetValue("Collection", reference);
var result = await _mappingService.MapAsync<NullCollectionTopicViewModel>(topic).ConfigureAwait(false);
Assert.NotNull(result?.NullCollection);
Assert.NotNull(result?.NullICollection);
Assert.NotNull(result?.NullIList);
Assert.NotNull(result?.NullIEnumerable);
Assert.NotNull(result?.NullTypedCollection);
Assert.NotEmpty(result?.NullCollection);
Assert.NotEmpty(result?.NullICollection);
Assert.NotEmpty(result?.NullIList);
Assert.NotEmpty(result?.NullIEnumerable);
Assert.NotEmpty(result?.NullTypedCollection);
}
/*==========================================================================================================================
| TEST: MAP: CONSTRUCTOR: THROWS EXCEPTION
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and attempts to map a view model with a constructor containing a
/// circular reference, and confirms that a <see cref="TopicMappingException"/> is correctly thrown.
/// </summary>
[Fact]
public async Task Map_Constructor_ThrowsException() {
var topic = new Topic("Topic", "Constructed", null, 1);
var related = new Topic("Related", "Constructed", null, 2);
topic.References.SetValue("TopicReference", related);
related.References.SetValue("TopicReference", topic);
await Assert.ThrowsAsync<TopicMappingException>(async () =>
await _mappingService.MapAsync<ConstructedTopicViewModel>(topic).ConfigureAwait(false)
).ConfigureAwait(false);
}
/*==========================================================================================================================
| TEST: MAP: DISABLED PROPERTY: RETURNS NULL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it maps a property decorated with the <see
/// cref="DisableMappingAttribute"/>.
/// </summary>
[Fact]
public async Task Map_DisabledProperty_ReturnsNull() {
var topic = new Topic("Test", "DisableMapping");
var viewModel = await _mappingService.MapAsync<DisableMappingTopicViewModel>(topic).ConfigureAwait(false);
Assert.NotNull(viewModel);
Assert.Null(viewModel?.Key);
}
/*==========================================================================================================================
| TEST: MAP: PARENTS: RETURNS ASCENDENTS
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully crawls the parent tree.
/// </summary>
[Fact]
public async Task Map_Parents_ReturnsAscendents() {
var grandParent = new Topic("Grandparent", "AscendentSpecialized");
var parent = new Topic("Parent", "Ascendent", grandParent);
var topic = new Topic("Test", "Ascendent", parent);
grandParent.Attributes.SetValue("IsRoot", "1");
var viewModel = await _mappingService.MapAsync<AscendentTopicViewModel>(topic).ConfigureAwait(false);
var parentViewModel = viewModel?.Parent;
var grandParentViewModel = parentViewModel?.Parent as AscendentSpecializedTopicViewModel;
Assert.NotNull(viewModel);
Assert.NotNull(parentViewModel);
Assert.NotNull(grandParentViewModel);
Assert.Equal("Test", viewModel?.Key);
Assert.Equal("Parent", parentViewModel?.Key);
Assert.Equal("Grandparent", grandParentViewModel?.Key);
Assert.True(grandParentViewModel?.IsRoot);
Assert.Null(grandParentViewModel?.Parent);
}
/*==========================================================================================================================
| TEST: MAP: INHERIT ATTRIBUTE: INHERITS VALUE
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully inherits values as specified by
/// <see cref="InheritAttribute"/>.
/// </summary>
[Fact]
public async Task Map_InheritAttribute_InheritsValue() {
var grandParent = new Topic("Grandparent", "Page");
var parent = new Topic("Parent", "Page", grandParent);
var topic = new Topic("Test", "InheritedProperty", parent);
grandParent.Attributes.SetValue("Property", "ValueA");
grandParent.Attributes.SetValue("InheritedProperty", "ValueB");
var viewModel = await _mappingService.MapAsync<InheritedPropertyTopicViewModel>(topic).ConfigureAwait(false);
Assert.Null(viewModel?.Property);
Assert.Equal("ValueB", viewModel?.InheritedProperty);
}
/*==========================================================================================================================
| TEST: MAP: NULLABLE PROPERTIES WITH INVALID VALUES: RETURNS NULL OR DEFAULT
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests setting nullable scalar values with invalid values with the
/// expectation that they will be returned as null.
/// </summary>
[Fact]
public async Task Map_NullablePropertiesWithInvalidValues_ReturnsNullOrDefault() {
var topic = new Topic("Test", "Page");
topic.Attributes.SetValue("NullableInteger", "A");
topic.Attributes.SetValue("NullableBoolean", "43");
topic.Attributes.SetValue("NullableDateTime", "Hello World");
topic.Attributes.SetValue("NullableUrl", "invalid://Web\\Path\\File!?@Query=String?");
var target = await _mappingService.MapAsync<NullablePropertyTopicViewModel>(topic).ConfigureAwait(false);
Assert.Null(target?.NullableInteger);
Assert.Null(target?.NullableBoolean);
Assert.Null(target?.NullableDateTime);
Assert.Null(target?.NullableUrl);
//The following should not be null since they map to non-nullable properties which will have default values
Assert.Equal(topic.Title, target?.Title);
Assert.Equal(topic.IsHidden, target?.IsHidden);
Assert.Equal(topic.LastModified, target?.LastModified);
}
/*==========================================================================================================================
| TEST: MAP: NULLABLE PROPERTIES WITH VALID VALUES: RETURNS VALUES
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests setting nullable scalar values with valid values with the
/// expectation that they will be mapped correctly.
/// </summary>
[Fact]
public async Task Map_NullablePropertiesWithInvalidValues_ReturnsValues() {
var topic = new Topic("Test", "Page");
topic.Attributes.SetValue("NullableString", "Hello World.");
topic.Attributes.SetValue("NullableInteger", "43");
topic.Attributes.SetValue("NullableDouble", "3.14159265359");
topic.Attributes.SetValue("NullableBoolean", "tRuE");
topic.Attributes.SetValue("NullableDateTime", "10/15/1976");
topic.Attributes.SetValue("NullableUrl", "/Web/Path/File?Query=String");
topic.Attributes.SetValue("Title", "Hello World.");
topic.Attributes.SetValue("IsHidden", "true");
topic.Attributes.SetValue("LastModified", "10/15/1976");
var target = await _mappingService.MapAsync<NullablePropertyTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal("Hello World.", target?.NullableString);
Assert.Equal(43, target?.NullableInteger);
Assert.Equal(3.14159265359, target?.NullableDouble);
Assert.Equal(true, target?.NullableBoolean);
Assert.Equal(new(1976, 10, 15), target?.NullableDateTime);
Assert.Equal(new("/Web/Path/File?Query=String", UriKind.RelativeOrAbsolute), target?.NullableUrl);
Assert.Equal(topic.Title, target?.Title);
Assert.Equal(topic.IsHidden, target?.IsHidden);
Assert.Equal(topic.LastModified, target?.LastModified);
}
/*==========================================================================================================================
| TEST: MAP: ALTERNATE ATTRIBUTE KEY: RETURNS MAPPED MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully derives values from the key
/// specified by <see cref="AttributeKeyAttribute"/>.
/// </summary>
[Fact]
public async Task Map_AlternateAttributeKey_ReturnsMappedModel() {
var topic = new Topic("Test", "PropertyAlias");
topic.Attributes.SetValue("Property", "ValueA");
topic.Attributes.SetValue("PropertyAlias", "ValueB");
var viewModel = await _mappingService.MapAsync<PropertyAliasTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal("ValueA", viewModel?.PropertyAlias);
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE: TRY GET VALUE: RETURNS ENTRY
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCacheEntry"/> and then confirms that it is returned via <see cref="
/// MappedTopicCache.TryGetValue(Int32, Type, out MappedTopicCacheEntry)"/>.
/// </summary>
[Fact]
public void MappedTopicCache_TryGetValue_ReturnsEntry() {
var cache = new MappedTopicCache();
var topicId = 1;
var viewModel = new EmptyViewModel();
cache.Register(topicId, AssociationTypes.None, viewModel);
var isSuccess = cache.TryGetValue(topicId, viewModel.GetType(), out var result);
Assert.True(isSuccess);
Assert.Equal(viewModel, result?.MappedTopic);
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE: TRY GET VALUE: RETURNS NULL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCache"/> and then confirms that it is not returned via <see cref="MappedTopicCache
/// .TryGetValue(Int32, Type, out MappedTopicCacheEntry)"/> if the <see cref="Type"/> doesn't match.
/// </summary>
[Fact]
public void MappedTopicCache_TryGetValue_ReturnsNull() {
var cache = new MappedTopicCache();
var topicId = 1;
cache.Register(topicId, AssociationTypes.None, new EmptyViewModel());
var isSuccess = cache.TryGetValue(topicId, typeof(TopicViewModel), out var result);
Assert.False(isSuccess);
Assert.Null(result);
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE: GET OR ADD: RETURNS EXISTING
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCache"/> and then confirms that the existing entry is returned when calling <see
/// cref="MappedTopicCache.Register(Int32, AssociationTypes, Object)"/> with duplicate parameters.
/// </summary>
[Fact]
public void MappedTopicCache_GetOrAdd_ReturnsExisting() {
var cache = new MappedTopicCache();
var initialViewModel = new EmptyViewModel();
var newViewModel = new EmptyViewModel();
cache.Register(1, AssociationTypes.None, initialViewModel);
cache.Register(1, AssociationTypes.None, newViewModel);
var isSuccess = cache.TryGetValue(1, newViewModel.GetType(), out var result);
Assert.True(isSuccess);
Assert.Equal(initialViewModel, result?.MappedTopic);
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE: GET OR ADD: NEW TOPIC: IS NOT CACHED
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCache"/> and then confirms that entries are <i>not</i> added when using <see cref=
/// "MappedTopicCache.Register(Int32, AssociationTypes, Object)"/> doesn't add entries with <see cref="Topic.IsNew"/>.
/// </summary>
[Fact]
public void MappedTopicCache_GetOrAdd_NewTopic_IsNotCached() {
var cache = new MappedTopicCache();
cache.Register(-1, AssociationTypes.None, new EmptyViewModel());
var isSuccess = cache.TryGetValue(-1, typeof(EmptyViewModel), out var result);
Assert.False(isSuccess);
Assert.Null(result);
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE: GET OR ADD: OBJECT: IS NOT CACHED
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCache"/> and then confirms that entries are <i>not</i> added when using <see cref=
/// "MappedTopicCache.Register(Int32, AssociationTypes, Object)"/> doesn't add entries with view models of type <see cref=
/// "Object"/>.
/// </summary>
[Fact]
public void MappedTopicCache_GetOrAdd_IsNotCached() {
var cache = new MappedTopicCache();
cache.Register(1, AssociationTypes.None, new object());
var isSuccess = cache.TryGetValue(-1, typeof(object), out var result);
Assert.False(isSuccess);
Assert.Null(result);
Assert.Null(result);
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE ENTRY: GET MISSING ASSOCIATIONS: RETURNS DIFFERENCE
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCacheEntry"/> with a set of <see cref="AssociationTypes"/>, and then confirms that
/// its <see cref="MappedTopicCacheEntry.GetMissingAssociations(AssociationTypes)"/> correctly returns the missing
/// associations.
/// </summary>
[Fact]
public void MappedTopicCacheEntry_GetMissingAssociations_ReturnsDifference() {
var cacheEntry = new MappedTopicCacheEntry() {
Associations = AssociationTypes.Children | AssociationTypes.Parents
};
var associations = AssociationTypes.Children | AssociationTypes.References;
var difference = cacheEntry.GetMissingAssociations(associations);
cacheEntry.AddMissingAssociations(difference);
Assert.True(difference.HasFlag(AssociationTypes.References));
Assert.False(difference.HasFlag(AssociationTypes.Children));
Assert.False(difference.HasFlag(AssociationTypes.Parents));
}
/*==========================================================================================================================
| TEST: MAPPED TOPIC CACHE ENTRY: ADD MISSING ASSOCIATIONS: SETS UNION
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="MappedTopicCacheEntry"/> with a set of <see cref="AssociationTypes"/>, and then confirms that
/// its <see cref="MappedTopicCacheEntry.AddMissingAssociations(AssociationTypes)"/> correctly extends the missing
/// associations.
/// </summary>
[Fact]
public void MappedTopicCacheEntry_AddMissingAssociations_SetsUnion() {
var cacheEntry = new MappedTopicCacheEntry() {
Associations = AssociationTypes.Children
};
var associations = AssociationTypes.Children | AssociationTypes.Parents;
cacheEntry.AddMissingAssociations(associations);
Assert.Equal(AssociationTypes.Children | AssociationTypes.Parents, cacheEntry.Associations);
}
/*==========================================================================================================================
| TEST: MAP: RELATIONSHIPS: RETURNS MAPPED MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully crawls the relationships.
/// </summary>
[Fact]
public async Task Map_Relationships_ReturnsMappedModel() {
var relatedTopic1 = new Topic("Cousin1", "Relation");
var relatedTopic2 = new Topic("Cousin2", "Relation");
var relatedTopic3 = new Topic("Sibling", "Relation");
var topic = new Topic("Test", "Relation");
topic.Relationships.SetValue("Cousins", relatedTopic1);
topic.Relationships.SetValue("Cousins", relatedTopic2);
topic.Relationships.SetValue("Siblings", relatedTopic3);
var target = await _mappingService.MapAsync<RelationTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal(2, target?.Cousins.Count);
Assert.NotNull(GetChildTopic(target?.Cousins, "Cousin1"));
Assert.NotNull(GetChildTopic(target?.Cousins, "Cousin2"));
Assert.Null(GetChildTopic(target?.Cousins, "Sibling"));
}
/*==========================================================================================================================
| TEST: MAP: RELATIONSHIPS: SKIPS DISABLED
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully skips disabled.
/// </summary>
[Fact]
public async Task Map_Relationships_SkipsDisabled() {
var relatedTopic1 = new Topic("Cousin1", "Relation");
var relatedTopic2 = new Topic("Cousin2", "Relation");
var topic = new Topic("Test", "Relation");
topic.Relationships.SetValue("Cousins", relatedTopic1);
topic.Relationships.SetValue("Cousins", relatedTopic2);
topic.IsDisabled = true;
relatedTopic2.IsDisabled = true;
var target = await _mappingService.MapAsync<RelationTopicViewModel>(topic).ConfigureAwait(false);
Assert.Single(target?.Cousins);
Assert.NotNull(GetChildTopic(target?.Cousins, "Cousin1"));
Assert.Null(GetChildTopic(target?.Cousins, "Cousin2"));
}
/*==========================================================================================================================
| TEST: MAP: ALTERNATE RELATIONSHIP: RETURNS CORRECT RELATIONSHIP
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully derives values from the key and
/// type specified by <see cref="Mapping.Annotations.CollectionAttribute"/>.
/// </summary>
/// <remarks>
/// The <see cref="AmbiguousRelationTopicViewModel.RelationshipAlias"/> uses <see cref="Mapping.Annotations.
/// CollectionAttribute"/> to set the relationship key to <c>AmbiguousRelationship</c> and the <see cref="CollectionType"
/// /> to <see cref="CollectionType.IncomingRelationship"/>. <c>AmbiguousRelationship</c> refers to a relationship that is
/// both outgoing and incoming. It should be smart enough to a) look for the <c>AmbigousRelationship</c> instead of the
/// <c>RelationshipAlias</c>, and b) source from the <see cref="Topic.IncomingRelationships"/> collection.
/// </remarks>
[Fact]
public async Task Map_AlternateRelationship_ReturnsCorrectRelationship() {
var outgoingRelation = new Topic("OutgoingRelation", "KeyOnly");
var incomingRelation = new Topic("IncomingRelation", "KeyOnly");
var ambiguousRelation = new Topic("AmbiguousRelation", "KeyOnly");
var topic = new Topic("Test", "AmbiguousRelation");
//Set outgoing relationships
topic.Relationships.SetValue("RelationshipAlias", ambiguousRelation);
topic.Relationships.SetValue("AmbiguousRelationship", outgoingRelation);
//Set incoming relationships
ambiguousRelation.Relationships.SetValue("RelationshipAlias", topic);
incomingRelation.Relationships.SetValue("AmbiguousRelationship", topic);
var target = await _mappingService.MapAsync<AmbiguousRelationTopicViewModel>(topic).ConfigureAwait(false);
Assert.Single(target?.RelationshipAlias);
Assert.NotNull(GetChildTopic(target?.RelationshipAlias, "IncomingRelation"));
}
/*==========================================================================================================================
| TEST: MAP: CUSTOM COLLECTION: RETURNS COLLECTION
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully derives values from a custom source
/// collection compatible with <see cref="IList{T}"/>, where <c>{T}</c> is a <see cref="Topic"/>, or derivative.
/// </summary>
[Fact]
public async Task Map_CustomCollection_ReturnsCollection() {
var topic = (ContentTypeDescriptor?)_topicRepository.Load("Root:Configuration:ContentTypes:Page");
var target = await _mappingService.MapAsync<ContentTypeDescriptorTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal(8, target?.AttributeDescriptors.Count);
Assert.Equal(2, target?.PermittedContentTypes.Count);
//Ensure custom collections are not recursively followed without instruction
Assert.NotEqual<Topic?>(topic, topic?.PermittedContentTypes.LastOrDefault());
Assert.NotEmpty(topic?.PermittedContentTypes.LastOrDefault()?.PermittedContentTypes);
Assert.Empty(target?.PermittedContentTypes.LastOrDefault()?.PermittedContentTypes);
}
/*==========================================================================================================================
| TEST: MAP: NESTED TOPICS: RETURNS MAPPED MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully crawls the nested topics.
/// </summary>
[Fact]
public async Task Map_NestedTopics_ReturnsMappedModel() {
var topic = new Topic("Test", "Nested");
var topicList = new Topic("Categories", "List", topic);
_ = new Topic("ChildTopic", "KeyOnly", topic);
_ = new Topic("NestedTopic1", "KeyOnly", topicList);
_ = new Topic("NestedTopic2", "KeyOnly", topicList);
topicList.IsHidden = true;
var target = await _mappingService.MapAsync<NestedTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal(2, target?.Categories.Count);
Assert.NotNull(GetChildTopic(target?.Categories, "NestedTopic1"));
Assert.NotNull(GetChildTopic(target?.Categories, "NestedTopic2"));
Assert.Null(GetChildTopic(target?.Categories, "Categories"));
Assert.Null(GetChildTopic(target?.Categories, "ChildTopic"));
}
/*==========================================================================================================================
| TEST: MAP: CHILDREN: RETURNS MAPPED MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully crawls child topics.
/// </summary>
[Fact]
public async Task Map_Children_ReturnsMappedModel() {
var topic = new Topic("Test", "Descendent");
_ = new Topic("ChildTopic1", "Descendent", topic);
_ = new Topic("ChildTopic2", "Descendent", topic);
var childTopic3 = new Topic("ChildTopic3", "Descendent", topic);
var childTopic4 = new Topic("ChildTopic4", "DescendentSpecialized", topic);
_ = new Topic("invalidChildTopic", "KeyOnly", topic);
_ = new Topic("GrandchildTopic", "Descendent", childTopic3);
childTopic4.Attributes.SetBoolean("IsLeaf", true);
var target = await _mappingService.MapAsync<DescendentTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal(4, target?.Children.Count);
Assert.NotNull(GetChildTopic(target?.Children, "ChildTopic1"));
Assert.NotNull(GetChildTopic(target?.Children, "ChildTopic2"));
Assert.NotNull(GetChildTopic(target?.Children, "ChildTopic3"));
Assert.NotNull(GetChildTopic(target?.Children, "ChildTopic4"));
Assert.True(((DescendentSpecializedTopicViewModel?)GetChildTopic(target?.Children, "ChildTopic4"))?.IsLeaf);
Assert.Null(GetChildTopic(target?.Children, "invalidChildTopic"));
Assert.Null(GetChildTopic(target?.Children, "GrandchildTopic"));
Assert.NotNull(GetChildTopic(
((DescendentTopicViewModel?)GetChildTopic(target?.Children, "ChildTopic3"))?.Children,
"GrandchildTopic"
));
}
/*==========================================================================================================================
| TEST: MAP: WITH DISABLED: SKIPS DISABLED
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> with children and tests whether it successfully skips disabled child
/// topics.
/// </summary>
[Fact]
public async Task Map_Children_SkipsDisabled() {
var topic = new Topic("Test", "Descendent");
_ = new Topic("ChildTopic1", "Descendent", topic);
_ = new Topic("ChildTopic2", "Descendent", topic);
var childTopic3 = new Topic("ChildTopic3", "Descendent", topic);
topic.IsDisabled = true;
childTopic3.IsDisabled = true;
var target = await _mappingService.MapAsync<DescendentTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal(2, target?.Children.Count);
Assert.NotNull(GetChildTopic(target?.Children, "ChildTopic1"));
Assert.NotNull(GetChildTopic(target?.Children, "ChildTopic2"));
Assert.Null(GetChildTopic(target?.Children, "ChildTopic3"));
}
/*==========================================================================================================================
| TEST: MAP: MAP TO PARENT: RETURNS MAPPED MODEL
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether the resulting object's nested complex objects are
/// property mapped with attribute values from the parent, based on their <see cref="MapToParentAttribute"/>
/// configuration.
/// </summary>
[Fact]
public async Task Map_MapToParent_ReturnsMappedModel() {
var topic = new Topic("Test", "FlattenChildren");
topic.Attributes.SetValue("PrimaryKey", "Primary Key");
topic.Attributes.SetValue("AlternateKey", "Alternate Key");
topic.Attributes.SetValue("AncillaryKey", "Ancillary Key");
topic.Attributes.SetValue("AliasedKey", "Aliased Key");
var target = await _mappingService.MapAsync<MapToParentTopicViewModel>(topic).ConfigureAwait(false);
Assert.Equal("Test", target?.Primary?.Key);
Assert.Equal("Aliased Key", target?.Alternate?.Key);
Assert.Equal("Ancillary Key", target?.Ancillary?.Key);
}
/*==========================================================================================================================
| TEST: MAP: MAP AS: RETURNS TOPIC REFERENCE
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Establishes a <see cref="TopicMappingService"/> and tests whether it successfully maps a topic reference using the
/// type specified in the <see cref="MapAsAttribute"/>.
/// </summary>
[Fact]
public async Task Map_MapAs_ReturnsTopicReference() {
var topicReference = _topicRepository.Load(11111);
Contract.Assume(topicReference);
var topic = new Topic("Test", "MapAs");
topic.References.SetValue("TopicReference", topicReference);
var target = (MapAsTopicViewModel?)await _mappingService.MapAsync(topic).ConfigureAwait(false);
Assert.NotNull(target?.TopicReference);
Assert.IsType<AscendentTopicViewModel>(target?.TopicReference);
}