Skip to main content
summaryrefslogtreecommitdiffstats
blob: f155538439602f11fba891c107156bbebabf26f9 (plain) (blame)
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
/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.orcs.api;

import static org.eclipse.osee.framework.core.enums.CoreBranches.COMMON;
import static org.eclipse.osee.framework.core.enums.DemoBranches.SAW_Bld_1;
import static org.eclipse.osee.framework.core.enums.DemoBranches.SAW_Bld_2;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import com.google.common.collect.Ordering;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import org.eclipse.osee.framework.core.data.ArtifactId;
import org.eclipse.osee.framework.core.data.IArtifactType;
import org.eclipse.osee.framework.core.data.IAttributeType;
import org.eclipse.osee.framework.core.data.IOseeBranch;
import org.eclipse.osee.framework.core.data.TokenFactory;
import org.eclipse.osee.framework.core.data.TransactionId;
import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
import org.eclipse.osee.framework.core.enums.QueryOption;
import org.eclipse.osee.framework.core.enums.SystemUser;
import org.eclipse.osee.framework.jdk.core.type.MatchLocation;
import org.eclipse.osee.framework.jdk.core.type.Named;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.jdk.core.type.ResultSet;
import org.eclipse.osee.framework.jdk.core.util.Lib;
import org.eclipse.osee.orcs.OrcsApi;
import org.eclipse.osee.orcs.OrcsBranch;
import org.eclipse.osee.orcs.data.ArtifactReadable;
import org.eclipse.osee.orcs.data.AttributeReadable;
import org.eclipse.osee.orcs.data.BranchReadable;
import org.eclipse.osee.orcs.db.mock.OrcsIntegrationByClassRule;
import org.eclipse.osee.orcs.db.mock.OseeClassDatabase;
import org.eclipse.osee.orcs.db.mock.OsgiService;
import org.eclipse.osee.orcs.search.Match;
import org.eclipse.osee.orcs.search.QueryBuilder;
import org.eclipse.osee.orcs.search.QueryFactory;
import org.eclipse.osee.orcs.transaction.TransactionBuilder;
import org.eclipse.osee.orcs.transaction.TransactionFactory;
import org.eclipse.osee.orcs.utility.MatchComparator;
import org.eclipse.osee.orcs.utility.NameComparator;
import org.eclipse.osee.orcs.utility.SortOrder;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestRule;

/**
 * @author Roberto E. Escobar
 */
public class OrcsQueryTest {

   @Rule
   public TestRule db = OrcsIntegrationByClassRule.integrationRule(this);

   private final boolean includeMatchLocationTests = false;

   @OsgiService
   private OrcsApi orcsApi;

   private OrcsBranch branchApi;
   private TransactionFactory txFactory;
   private QueryFactory factory;
   private final ArtifactId author = SystemUser.OseeSystem;

   @Before
   public void setup() {
      factory = orcsApi.getQueryFactory();
      branchApi = orcsApi.getBranchOps();
      txFactory = orcsApi.getTransactionFactory();
   }

   @AfterClass
   public static void cleanup() throws Exception {
      OseeClassDatabase.cleanup();
   }

   @Test
   public void testAllArtifactsFromBranch() {
      QueryBuilder builder = factory.fromBranch(COMMON);
      assertEquals(245, builder.getCount());

      assertEquals(245, builder.getResults().size());
   }

   @Test
   public void testNameAttributeNotExists() {
      QueryBuilder builder = factory.fromBranch(COMMON);
      builder.andNotExists(CoreAttributeTypes.Name);
      assertEquals(0, builder.getCount());
   }

   @Test
   public void testAttributeNotExists() {
      QueryBuilder builder = factory.fromBranch(COMMON);
      builder.andNotExists(CoreAttributeTypes.Afha);
      assertTrue(builder.getCount() >= 245);
   }

   @Test
   public void testQueryByIds() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON).andId(CoreArtifactTokens.UserGroups);
      assertEquals(1, builder.getCount());

      ArtifactReadable artifact = builder.getResults().getExactlyOne();
      assertEquals(CoreArtifactTokens.UserGroups.getGuid(), artifact.getGuid());
   }

   @Test
   public void testQueryArtifactType() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON).andIsOfType(CoreArtifactTypes.Folder);

      assertTrue(builder.getCount() >= 6);

      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertTrue(artifacts.size() >= 6);

      checkContainsTypes(artifacts, CoreArtifactTypes.Folder);

      Collection<String> names = Lib.getNames(artifacts.getList());
      assertTrue(names.contains("Document Templates"));
      assertTrue(names.contains("User Groups"));

      if (includeMatchLocationTests) {
         ResultSet<Match<ArtifactReadable, AttributeReadable<?>>> matches = builder.getMatches();
         assertEquals(2, matches.size());

         Iterator<Match<ArtifactReadable, AttributeReadable<?>>> matchIterator = matches.iterator();
         checkMatch(matchIterator.next(), "Document Templates");
         checkMatch(matchIterator.next(), "User Groups");
      }
   }

   @Test
   public void testQueryArtifactTypeInheritance() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1).andTypeEquals(CoreArtifactTypes.AbstractSoftwareRequirement);

      assertEquals(0, builder.getCount());

      ArtifactReadable artifact = builder.getResults().getOneOrNull();
      assertNull(artifact);

      builder = factory.fromBranch(SAW_Bld_1).andIsOfType(CoreArtifactTypes.AbstractSoftwareRequirement);

      assertEquals(24, builder.getCount());

      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertEquals(24, artifacts.size());

      checkContainsTypes(artifacts, CoreArtifactTypes.SoftwareRequirement);
   }

   @Test
   public void testQueryArtifactTypesMatch() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON);
      builder.andTypeEquals(CoreArtifactTypes.OseeTypeDefinition, CoreArtifactTypes.Folder);

      assertTrue(builder.getCount() >= 14);

      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertTrue(artifacts.size() >= 14);

      checkContainsTypes(artifacts, CoreArtifactTypes.OseeTypeDefinition, CoreArtifactTypes.Folder);

      Set<String> names = new HashSet<>();
      for (ArtifactReadable art : artifacts) {
         names.add(art.getName());
      }
      assertTrue("Missing \"Document Templates\"", names.contains("Document Templates"));
      assertTrue("Missing \"User Groups\"", names.contains("User Groups"));

      assertTrue("Missing \"org.eclipse.osee.client.demo.OseeTypes_ClientDemo\"",
         names.contains("org.eclipse.osee.client.demo.OseeTypes_ClientDemo"));
      assertTrue("Missing \"org.eclipse.osee.framework.skynet.core.OseeTypes_Framework\"",
         names.contains("org.eclipse.osee.framework.skynet.core.OseeTypes_Framework"));
      assertTrue("Missing \"org.eclipse.osee.ote.define.OseeTypesOTE\"",
         names.contains("org.eclipse.osee.ote.define.OseeTypesOTE"));
   }

   @Test
   public void testQueryAttributeValue() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON);
      builder.and(CoreAttributeTypes.Name, "User Groups");

      assertEquals(1, builder.getCount());

      ArtifactReadable artifact = builder.getResults().getExactlyOne();

      assertEquals("User Groups", artifact.getName());
      assertEquals(CoreArtifactTypes.Folder, artifact.getArtifactType());

      if (includeMatchLocationTests) {
         Match<ArtifactReadable, AttributeReadable<?>> result = builder.getMatches().getExactlyOne();

         assertEquals(artifact, result.getItem());
         checkMatch(result, "User Groups", CoreAttributeTypes.Name);

         AttributeReadable<?> attr = result.getElements().iterator().next();
         List<MatchLocation> location = result.getLocation(attr);
         assertEquals(1, location.size());

         MatchLocation loc1 = location.iterator().next();
         assertEquals(0, loc1.getStartPosition());
         assertEquals("User Groups".length(), loc1.getEndPosition());
      }
   }

   @Test
   public void testQueryMultipleArtifactType() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON);
      builder.andIsOfType(CoreArtifactTypes.AccessControlModel, CoreArtifactTypes.GlobalPreferences);

      assertEquals(2, builder.getCount());
      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertEquals(2, artifacts.size());

      checkContainsTypes(artifacts, CoreArtifactTypes.AccessControlModel, CoreArtifactTypes.GlobalPreferences);

      Iterator<ArtifactReadable> iterator = sort(artifacts);
      assertEquals("Framework Access Model", iterator.next().getName());
      assertEquals("Global Preferences", iterator.next().getName());
   }

   @Test
   public void testQueryMultipleAttributeExistsType() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON);
      List<IAttributeType> attributeTypes =
         Arrays.asList(CoreAttributeTypes.AccessContextId, CoreAttributeTypes.Dictionary);
      builder.andExists(attributeTypes);

      assertEquals(0, builder.getCount());
      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertEquals(0, artifacts.size());
   }

   @Test
   public void testQueryMultipleAttributeNotExistsType() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(COMMON);
      List<IAttributeType> attributeTypes = Arrays.asList(CoreAttributeTypes.ContentUrl, CoreAttributeTypes.Name);
      builder.andNotExists(attributeTypes);

      assertTrue(builder.getCount() >= 245);
      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertTrue(artifacts.size() >= 245);

      Collection<String> names = Lib.getNames(artifacts.getList());

      for (String name : Arrays.asList("Alex Kay", "Anonymous", "Boot Strap", "Default Hierarchy Root",
         "Document Templates", "Everyone", "Framework Access Model", "Global Preferences", "Inactive Steve",
         "Jason Michael", "Joe Smith", "Kay Jones", "OSEE System", "OseeAdmin", "PREVIEW_ALL", "PREVIEW_ALL_RECURSE",
         "Root Artifact", "UnAssigned", "User Groups", "Word Edit Template", "Word Edit Template",
         "XViewer Global Customization", "org.eclipse.osee.client.demo.OseeTypes_ClientDemo",
         "org.eclipse.osee.framework.skynet.core.OseeTypes_Framework", "org.eclipse.osee.ote.define.OseeTypesOTE")) {
         assertTrue("Missing expected artifact named [" + name + "]", names.contains(name));
      }
   }

   @Test
   public void testQueryArtifactTypeAndNameValue() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1);
      builder.and(CoreAttributeTypes.Name, "Requirements", QueryOption.TOKEN_COUNT__IGNORE);

      assertEquals(7, builder.getCount());
      ResultSet<ArtifactReadable> artifacts = builder.getResults();
      assertEquals(7, artifacts.size());
      checkContainsTypes(artifacts, CoreArtifactTypes.Folder, CoreArtifactTypes.SubsystemRequirementMSWord,
         CoreArtifactTypes.SystemRequirementMSWord);

      builder.andIsOfType(CoreArtifactTypes.Folder);
      assertEquals(4, builder.getCount());

      ResultSet<ArtifactReadable> folders = builder.getResults();
      assertEquals(4, folders.size());
      Iterator<ArtifactReadable> folderIterator = sort(folders);
      assertEquals("Hardware Requirements", folderIterator.next().getName());
      assertEquals("Software Requirements", folderIterator.next().getName());
      assertEquals("Subsystem Requirements", folderIterator.next().getName());
      assertEquals("System Requirements", folderIterator.next().getName());
      checkContainsTypes(folders, CoreArtifactTypes.Folder);

      //////////////////////
      QueryBuilder builder1 = factory.fromBranch(SAW_Bld_1);
      builder1.and(CoreAttributeTypes.Name, "Requirements", QueryOption.TOKEN_COUNT__IGNORE);
      builder1.andTypeEquals(CoreArtifactTypes.SubsystemRequirementMSWord);
      assertEquals(1, builder1.getCount());
      ResultSet<ArtifactReadable> subSystemReqs = builder1.getResults();
      assertEquals(1, subSystemReqs.size());
      assertEquals("Subsystem Requirements", subSystemReqs.iterator().next().getName());
      checkContainsTypes(subSystemReqs, CoreArtifactTypes.SubsystemRequirementMSWord);

      //////////////////////
      QueryBuilder builder2 = factory.fromBranch(SAW_Bld_1);
      builder2.and(CoreAttributeTypes.Name, "Requirements", QueryOption.TOKEN_COUNT__IGNORE);
      builder2.andIsOfType(CoreArtifactTypes.Requirement);
      assertEquals(3, builder2.getCount());

      ResultSet<ArtifactReadable> requirements = builder2.getResults();
      assertEquals(3, requirements.size());
      Iterator<ArtifactReadable> reqIterator = sort(requirements);
      assertEquals("Performance Requirements", reqIterator.next().getName());
      assertEquals("Safety Requirements", reqIterator.next().getName());
      assertEquals("Subsystem Requirements", reqIterator.next().getName());
      checkContainsTypes(subSystemReqs, CoreArtifactTypes.SubsystemRequirementMSWord,
         CoreArtifactTypes.SystemRequirementMSWord);
   }

   @Test
   public void testQueryRequirementsAsLocalIds() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1);
      builder.and(CoreAttributeTypes.Name, "REQUIREMENTS", QueryOption.CASE__IGNORE,
         QueryOption.TOKEN_MATCH_ORDER__MATCH, QueryOption.TOKEN_DELIMITER__ANY, QueryOption.TOKEN_COUNT__IGNORE);

      ResultSet<? extends ArtifactId> results = builder.getResultsAsLocalIds();
      assertEquals(7, results.size());
      assertEquals(7, builder.getCount());
   }

   @Test
   public void testQueryAttributeKeyword() throws OseeCoreException {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1);
      builder.and(CoreAttributeTypes.Name, "REQUIREMENTS", QueryOption.CONTAINS_MATCH_OPTIONS);

      assertEquals(7, builder.getCount());
      ResultSet<ArtifactReadable> requirements = builder.getResults();
      assertEquals(7, requirements.size());
      checkContainsTypes(requirements, CoreArtifactTypes.Folder, CoreArtifactTypes.SubsystemRequirementMSWord,
         CoreArtifactTypes.SystemRequirementMSWord);
      Iterator<ArtifactReadable> reqIterator = sort(requirements);
      assertEquals("Hardware Requirements", reqIterator.next().getName());
      assertEquals("Performance Requirements", reqIterator.next().getName());
      assertEquals("Safety Requirements", reqIterator.next().getName());
      assertEquals("Software Requirements", reqIterator.next().getName());
      assertEquals("Subsystem Requirements", reqIterator.next().getName());
      assertEquals("Subsystem Requirements", reqIterator.next().getName());
      assertEquals("System Requirements", reqIterator.next().getName());

      ResultSet<Match<ArtifactReadable, AttributeReadable<?>>> matches = builder.getMatches();
      assertEquals(7, matches.size());

      // @formatter:off
      Iterator<Match<ArtifactReadable, AttributeReadable<?>>> matchIterator = sortMatch(matches);
      checkMatchSingleAttribute(matchIterator.next(), "Hardware Requirements", CoreAttributeTypes.Name, "Requirements");
      checkMatchSingleAttribute(matchIterator.next(), "Performance Requirements", CoreAttributeTypes.Name, "Requirements");
      checkMatchSingleAttribute(matchIterator.next(), "Safety Requirements", CoreAttributeTypes.Name, "Requirements");
      checkMatchSingleAttribute(matchIterator.next(), "Software Requirements", CoreAttributeTypes.Name, "Requirements");
      checkMatchSingleAttribute(matchIterator.next(), "Subsystem Requirements", CoreAttributeTypes.Name, "Requirements");
      checkMatchSingleAttribute(matchIterator.next(), "Subsystem Requirements", CoreAttributeTypes.Name, "Requirements");
      checkMatchSingleAttribute(matchIterator.next(), "System Requirements", CoreAttributeTypes.Name, "Requirements");
      // @formatter:on

      QueryBuilder builder1 = factory.fromBranch(SAW_Bld_1);
      builder1.and(CoreAttributeTypes.Name, "REQUIREMENTS", QueryOption.TOKEN_DELIMITER__ANY, QueryOption.CASE__MATCH);
      assertEquals(0, builder1.getCount());
   }

   @Test
   public void testRelatedToTest() throws OseeCoreException {
      QueryBuilder builder1 = factory.fromBranch(SAW_Bld_1);
      builder1.and(CoreAttributeTypes.Name, "Frame Synchronization");
      assertEquals("Frame Synchronization", builder1.getResults().getExactlyOne().getName());

      QueryBuilder builder2 = factory.fromBranch(SAW_Bld_1);
      builder2.andRelatedTo(CoreRelationTypes.Default_Hierarchical__Child, builder1.getResults().getExactlyOne());
      assertEquals("Video processing", builder2.getResults().getExactlyOne().getName());

      QueryBuilder builder3 = factory.fromBranch(SAW_Bld_1);
      builder3.andRelatedTo(CoreRelationTypes.Default_Hierarchical__Child, builder2.getResults().getExactlyOne());
      assertEquals("Subsystem Requirements", builder3.getResults().getExactlyOne().getName());
   }

   @Test
   public void testAndNameEquals() throws Exception {
      // This test sets up two folders, the name of the first has the name of the second in it
      // The goal is to make sure query.AndNameEquals doesn't return a match unless it matches exactly
      BranchReadable branch = setupNameEqualsArtifacts();
      try {
         QueryBuilder builder = factory.fromBranch(branch);
         builder.andNameEquals("Folder");
         ResultSet<ArtifactReadable> artifacts = builder.getResults();
         assertEquals(1, artifacts.size());
         assertEquals("Folder", artifacts.getExactlyOne().getName());
      } finally {
         branchApi.purgeBranch(branch, true).call();
      }
   }

   @Test
   public void testFollowRelationType1() throws Exception {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1) //
         .andIsOfType(CoreArtifactTypes.RootArtifact)//
         .followRelation(CoreRelationTypes.Default_Hierarchical__Child);

      ResultSet<ArtifactReadable> results = builder.getResults();
      assertEquals(9, results.size());

      Iterator<String> iterator = getNames(results).iterator();
      assertEquals("Hardware Requirements", iterator.next());
      assertEquals("Integration Tests", iterator.next());
      assertEquals("Product Line", iterator.next());
      assertEquals("SAW Product Decomposition", iterator.next());
      assertEquals("Software Requirements", iterator.next());
      assertEquals("Subsystem Requirements", iterator.next());
      assertEquals("System Requirements", iterator.next());
      assertEquals("Validation Tests", iterator.next());
      assertEquals("Verification Tests", iterator.next());
   }

   @Test
   public void testFollowRelationType2() throws Exception {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1) //
         .andIsOfType(CoreArtifactTypes.RootArtifact)//
         .followRelation(CoreRelationTypes.Default_Hierarchical__Child)//
         .andIsOfType(CoreArtifactTypes.Component);

      ResultSet<ArtifactReadable> results = builder.getResults();
      assertEquals(1, results.size());

      assertEquals("SAW Product Decomposition", results.getExactlyOne().getName());
   }

   @Test
   public void testFollowRelationType3() throws Exception {
      QueryBuilder builder = factory.fromBranch(SAW_Bld_1) //
         .and(CoreAttributeTypes.Name, "collaboration", QueryOption.TOKEN_MATCH_ORDER__ANY, QueryOption.CASE__IGNORE)//
         .followRelation(CoreRelationTypes.Default_Hierarchical__Child)//
         .and(CoreAttributeTypes.Name, "object", QueryOption.CONTAINS_MATCH_OPTIONS);

      ResultSet<ArtifactReadable> results = builder.getResults();
      assertEquals(1, results.size());

      assertEquals("Robot Object", results.getExactlyOne().getName());
   }

   @Test
   public void testFollowRelationTypeHistorical() throws Exception {
      QueryBuilder query = factory.fromBranch(SAW_Bld_2) //
         .andNameEquals("Robot API") //
         .andIsOfType(CoreArtifactTypes.SoftwareRequirement)//
         .followRelation(CoreRelationTypes.Default_Hierarchical__Child)//
         .and(CoreAttributeTypes.Name, "Robot", QueryOption.CONTAINS_MATCH_OPTIONS);

      ResultSet<ArtifactReadable> results = query.getResults();
      assertEquals(2, results.size());

      Iterator<String> iterator = getNames(results).iterator();
      assertEquals("Robot Interfaces", iterator.next());
      assertEquals("Robot collaboration", iterator.next());

      // Add a child
      ArtifactReadable parent = results.iterator().next().getParent();
      TransactionBuilder tx = orcsApi.getTransactionFactory().createTransaction(SAW_Bld_2, author, "FollowTest");
      ArtifactId child = tx.createArtifact(CoreArtifactTypes.SoftwareRequirement, "Dummy Robot");
      tx.relate(parent, CoreRelationTypes.Default_Hierarchical__Child, child);
      TransactionId commitTx = tx.commit();
      TransactionId headTx = commitTx;

      results = query.getResults();
      assertEquals(3, results.size());

      iterator = getNames(results).iterator();
      assertEquals("Dummy Robot", iterator.next());
      assertEquals("Robot Interfaces", iterator.next());
      assertEquals("Robot collaboration", iterator.next());

      query.fromTransaction(TransactionId.valueOf(headTx.getId() - 1));
      results = query.getResults();
      assertEquals(2, results.size());

      iterator = getNames(results).iterator();
      assertEquals("Robot Interfaces", iterator.next());
      assertEquals("Robot collaboration", iterator.next());
   }

   @Test
   public void testRelatedTo() {
      // do a query on branch
      ArtifactReadable robotApi = factory.fromBranch(SAW_Bld_2) //
         .andNameEquals("Robot API") //
         .andIsOfType(CoreArtifactTypes.SoftwareRequirement).getResults().getExactlyOne();

      // create a tx on branch
      TransactionBuilder tx = txFactory.createTransaction(SAW_Bld_2, author, "Simple Tx");
      tx.createArtifact(CoreArtifactTypes.Folder, "Just a Folder");
      tx.commit();

      // do another query on branch
      ArtifactReadable robotInt = factory.fromBranch(SAW_Bld_2) //
         .andNameEquals("Robot Interfaces").getResults().getExactlyOne();

      // see if artifact from query 1 is related to artifact from query 2
      Assert.assertTrue(robotApi.areRelated(CoreRelationTypes.Default_Hierarchical__Child, robotInt));
   }

   @Test
   public void testMultipleTxs() {
      // do a query on branch
      ArtifactReadable robotApi = factory.fromBranch(SAW_Bld_2) //
         .andNameEquals("Robot API") //
         .andIsOfType(CoreArtifactTypes.SoftwareRequirement).getResults().getExactlyOne();

      // create a tx on branch
      TransactionBuilder tx1 = txFactory.createTransaction(SAW_Bld_2, author, "Simple Tx1");
      TransactionBuilder tx2 = txFactory.createTransaction(SAW_Bld_2, author, "Simple Tx2");

      ArtifactId folder = tx1.createArtifact(CoreArtifactTypes.Folder, "Just a Folder");
      tx1.commit();

      tx2.addChildren(robotApi, folder);

      tx2.commit();

      factory.fromBranch(SAW_Bld_2) //
         .andNameEquals("Robot Interfaces").getResults().getExactlyOne();

      ArtifactReadable folderArt = factory.fromBranch(SAW_Bld_2) //
         .andIds(folder).getResults().getExactlyOne();
      // robotApi should be related to folder
      Assert.assertTrue(robotApi.areRelated(CoreRelationTypes.Default_Hierarchical__Child, folderArt));
   }

   private Set<String> getNames(ResultSet<ArtifactReadable> results) {
      Set<String> names = new TreeSet<>();
      for (ArtifactReadable art : results) {
         names.add(art.getName());
      }
      return names;
   }

   private BranchReadable setupNameEqualsArtifacts() throws Exception {
      IOseeBranch branchToken = IOseeBranch.create("TestAndNameEquals");
      BranchReadable branch = branchApi.createTopLevelBranch(branchToken, author).call();
      TransactionBuilder tx = txFactory.createTransaction(branch, author, "add folders");
      tx.createArtifact(CoreArtifactTypes.Folder, "First Folder");
      tx.createArtifact(CoreArtifactTypes.Folder, "Folder");
      tx.commit();
      return branch;
   }

   private static void checkContainsTypes(Iterable<ArtifactReadable> arts, IArtifactType... types) throws OseeCoreException {
      List<IArtifactType> expected = Arrays.asList(types);
      for (ArtifactReadable art : arts) {
         assertTrue(String.format("artifact type [%s] not found", art.getArtifactType()),
            expected.contains(art.getArtifactType()));
      }
   }

   private static void checkMatchSingleAttribute(Match<ArtifactReadable, AttributeReadable<?>> match, String artName, IAttributeType types, String matched) throws OseeCoreException {
      assertEquals(artName, match.getItem().getName());

      AttributeReadable<?> attribute = match.getElements().iterator().next();
      assertEquals(types, attribute.getAttributeType());
      List<MatchLocation> locations = match.getLocation(attribute);
      assertEquals(1, locations.size());

      MatchLocation location = locations.get(0);
      String value = String.valueOf(attribute.getValue());
      assertEquals(matched, value.substring(location.getStartPosition() - 1, location.getEndPosition()));
   }

   private static void checkMatch(Match<ArtifactReadable, AttributeReadable<?>> match, String artName, IAttributeType... types) throws OseeCoreException {
      assertEquals(artName, match.getItem().getName());
      if (types.length > 0) {
         assertEquals(types.length, match.getElements().size());

         Iterator<AttributeReadable<?>> iterator = match.getElements().iterator();
         for (int index = 0; index < types.length; index++) {
            assertEquals(types[index], iterator.next().getAttributeType());
         }
      }
   }

   private static Iterator<Match<ArtifactReadable, AttributeReadable<?>>> sortMatch(Iterable<Match<ArtifactReadable, AttributeReadable<?>>> iterable) {
      Ordering<Match<ArtifactReadable, AttributeReadable<?>>> from =
         Ordering.from(new MatchComparator(SortOrder.ASCENDING));
      return from.sortedCopy(iterable).iterator();
   }

   @SuppressWarnings("unchecked")
   private static <T extends Named> Iterator<T> sort(Iterable<T> iterable) {
      Ordering<T> from = (Ordering<T>) Ordering.from(new NameComparator(SortOrder.ASCENDING));
      return from.sortedCopy(iterable).iterator();
   }
}

Back to the top