-
Notifications
You must be signed in to change notification settings - Fork 230
Expand file tree
/
Copy pathGitStoreTests.cs
More file actions
681 lines (595 loc) · 24.1 KB
/
GitStoreTests.cs
File metadata and controls
681 lines (595 loc) · 24.1 KB
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
using Azure.Sdk.Tools.TestProxy.Common.Exceptions;
using Azure.Sdk.Tools.TestProxy.Common;
using Azure.Sdk.Tools.TestProxy.Store;
using System;
using System.IO;
using System.Threading.Tasks;
using Xunit;
using System.Text.Json;
using System.Linq;
using System.ComponentModel;
using Azure.Sdk.tools.TestProxy.Common;
using System.Collections.Generic;
namespace Azure.Sdk.Tools.TestProxy.Tests
{
public class FakeCommandResultsHandler : GitProcessHandler
{
public string RunResult = string.Empty;
public string ErrorResult = string.Empty;
public int ErrorCode = 0;
public FakeCommandResultsHandler(string runResult, string errorResult, int errorCode)
{
}
public override bool TryRun(string arguments, string workingDirectory, out CommandResult result)
{
result = new CommandResult()
{
ExitCode = ErrorCode,
StdErr = ErrorResult,
StdOut = RunResult
};
return true;
}
public FakeCommandResultsHandler() { }
}
public class GitStoretests
{
#region variable defs
public static string AssetsJson = "assets.json";
private GitStore _defaultStore = new GitStore();
private string[] basicFolderStructure = new string[]
{
AssetsJson
};
public static Assets DefaultAssets = new Assets
{
AssetsRepo = "Azure/azure-sdk-assets-integration",
AssetsRepoPrefixPath = "python/recordings/",
AssetsRepoId = "",
TagPrefix = "scenario_clean_push",
Tag = "e4a4949a2b6cc2ff75afd0fe0d97cbcabf7b67b7"
};
public static string DefaultAssetsJson =
@"
{
// a json comment that shouldn't break parsing.
""AssetsRepo"":""Azure/azure-sdk-assets-integration"",
""AssetsRepoPrefixPath"":""python/recordings/"",
""AssetsRepoId"":"""",
""TagPrefix"":""scenario_clean_push"",
""Tag"":""e4a4949a2b6cc2ff75afd0fe0d97cbcabf7b67b7""
}
";
#endregion
[Fact]
public void TestEvaluateDirectoryGitRootExistsWithNoAssets()
{
string[] folderStructure = new string[]
{
AssetsJson,
"folder1",
Path.Join("folder2", "file1.json")
};
var testFolder = TestHelpers.DescribeTestFolder(null, folderStructure, malformedJson:String.Empty);
try
{
var evaluation = _defaultStore.EvaluateDirectory(testFolder);
Assert.True(evaluation.IsGitRoot);
Assert.False(evaluation.AssetsJsonPresent);
Assert.False(evaluation.IsRoot);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public void TestEvaluateDirectoryFindsGitAssetsAlongsideGitRoot()
{
string[] folderStructure = new string[]
{
AssetsJson,
"folder1",
Path.Join("folder2", "file1.json")
};
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, folderStructure);
try
{
var evaluation = _defaultStore.EvaluateDirectory(testFolder);
Assert.True(evaluation.IsGitRoot);
Assert.True(evaluation.AssetsJsonPresent);
Assert.False(evaluation.IsRoot);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public void TestEvaluateDirectoryIdentifiesIntermediateDirectory()
{
string[] folderStructure = new string[]
{
AssetsJson,
"folder1",
Path.Join("folder2", "file1.json")
};
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, folderStructure);
try
{
var evaluationDirectory = Path.Join(testFolder, "folder1");
var evaluation = _defaultStore.EvaluateDirectory(evaluationDirectory);
Assert.False(evaluation.IsGitRoot);
Assert.False(evaluation.AssetsJsonPresent);
Assert.False(evaluation.IsRoot);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public void ResolveAssetsJsonFindsAssetsInTargetFolder()
{
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
var path = _defaultStore.ResolveAssetsJson(testFolder);
Assert.Equal(Path.Join(testFolder, AssetsJson), path);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public void ResolveAssetsJsonFindsAssetsInTargetFolderBelowRoot()
{
string[] folderStructure = new string[]
{
Path.Join("folder1", AssetsJson)
};
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, folderStructure);
try
{
var evaluationDirectory = Path.Join(testFolder, "folder1");
var path = _defaultStore.ResolveAssetsJson(evaluationDirectory);
Assert.Equal(Path.Join(testFolder, "folder1", "assets.json"), path);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public void ResolveAssetsJsonThrowsOnUnableToLocate()
{
var testFolder = TestHelpers.DescribeTestFolder(null, new string[] { }, malformedJson:String.Empty);
try
{
var assertion = Assert.Throws<HttpException>(() =>
{
_defaultStore.ResolveAssetsJson(testFolder);
});
Assert.StartsWith("Unable to locate an assets.json at", assertion.Message);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public void ResolveAssetsJsonThrowsOnUnableToLocateAfterTraversal()
{
string[] folderStructure = new string[]
{
"folder1",
};
var testFolder = TestHelpers.DescribeTestFolder(null, folderStructure, malformedJson:String.Empty);
try
{
var evaluationDirectory = Path.Join(testFolder, "folder1");
var assertion = Assert.Throws<HttpException>(() =>
{
_defaultStore.ResolveAssetsJson(evaluationDirectory);
});
Assert.StartsWith("Unable to locate an assets.json at", assertion.Message);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Theory]
[InlineData(
@"{
""AssetsRepo"": ""Azure/azure-sdk-assets-integration"",
""AssetsRepoPrefixPath"": ""python/recordings/"",
""AssetsRepoId"": """",
""TagPrefix"": ""auto/test"",
""Tag"": ""786b4f3d380d9c36c91f5f146ce4a7661ffee3b9""
}")]
// Valid to just pass the assets repo. We can infer everything else.
[InlineData(
@"{
""AssetsRepo"": ""Azure/azure-sdk-assets-integration""
}")]
public async Task ParseConfigurationEvaluatesValidConfigs(string inputJson)
{
string[] folderStructure = new string[]
{
AssetsJson
};
var testFolder = TestHelpers.DescribeTestFolder(null, folderStructure, malformedJson:inputJson);
try
{
var jsonFileLocation = Path.Join(testFolder, AssetsJson);
var parsedConfiguration = await _defaultStore.ParseConfigurationFile(jsonFileLocation);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Theory]
[InlineData(
@"{
""AssetsRepo"": """"
}")]
[InlineData(
@"{
""AssetsRepo"": "" ""
}")]
[InlineData(
@"{
""AssetsRepoId"": """",
""TagPrefix"": ""auto/test"",
""Tag"": ""786b4f3d380d9c36c91f5f146ce4a7661ffee3b9""
}")]
public async Task ParseConfigurationThrowsOnMissingRequiredProperty(string inputJson)
{
string[] folderStructure = new string[]
{
AssetsJson
};
var testFolder = TestHelpers.DescribeTestFolder(null, folderStructure, malformedJson:inputJson);
try
{
var jsonFileLocation = Path.Join(testFolder, AssetsJson);
var assertion = await Assert.ThrowsAsync<HttpException>(async () =>
{
await _defaultStore.ParseConfigurationFile(Path.Join(testFolder, AssetsJson));
});
Assert.Contains("must contain value for the key \"AssetsRepo\"", assertion.Message);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public async Task ParseConfigurationEvaluatesTargetFolder()
{
var folderPath = Path.Join("folder1", "folder2");
var targetRelPath = Path.Join(folderPath, $"{AssetsJson}");
string[] folderStructure = new string[]
{
targetRelPath
};
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, folderStructure);
try
{
var jsonFileLocation = Path.Join(testFolder, folderPath);
var parsedConfiguration = await _defaultStore.ParseConfigurationFile(jsonFileLocation);
Assert.NotNull(parsedConfiguration);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Theory]
[InlineData("folder1", "folder2")]
[InlineData("folderabc123")]
public async Task ParseConfigurationEvaluatesRelativePathCorrectly(params string[] inputPath)
{
var targetRelPath = Path.Join(inputPath);
string[] folderStructure = new string[]
{
Path.Join(targetRelPath, AssetsJson)
};
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, folderStructure);
try
{
var jsonFileLocation = new NormalizedString(Path.Join(testFolder, targetRelPath, AssetsJson));
var parsedConfiguration = await _defaultStore.ParseConfigurationFile(jsonFileLocation);
Assert.Equal(new NormalizedString(Path.Join(targetRelPath, AssetsJson)), parsedConfiguration.AssetsJsonRelativeLocation.ToString());
Assert.Equal(jsonFileLocation, parsedConfiguration.AssetsJsonLocation.ToString());
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Theory]
[InlineData("")]
[InlineData("{}")]
public async Task ParseConfigurationThrowsOnEmptyJson(string errorJson)
{
var testFolder = TestHelpers.DescribeTestFolder(null, basicFolderStructure, ignoreEmptyAssetsJson: true, malformedJson:errorJson);
try
{
var assertion = await Assert.ThrowsAsync<HttpException>(async () =>
{
await _defaultStore.ParseConfigurationFile(Path.Join(testFolder, AssetsJson));
});
Assert.StartsWith("The provided assets.json at ", assertion.Message);
Assert.EndsWith("did not have valid json present.", assertion.Message);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public async Task ParseConfigurationThrowsOnNonExistentJson()
{
var testFolder = TestHelpers.DescribeTestFolder(null, basicFolderStructure, malformedJson:String.Empty);
try
{
var assertion = await Assert.ThrowsAsync<HttpException>(async () =>
{
await _defaultStore.ParseConfigurationFile(Path.Join(testFolder, AssetsJson));
});
Assert.StartsWith("The provided assets.json path of ", assertion.Message);
Assert.EndsWith(" does not exist.", assertion.Message);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public async Task GetDefaultBranchFailsWithInvalidRepo()
{
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
// we are resetting the default branch so we will see if fallback logic kicks in
_defaultStore.DefaultBranch = "not-main";
var assetsConfiguration = await _defaultStore.ParseConfigurationFile(Path.Join(testFolder, AssetsJson));
assetsConfiguration.AssetsRepo = "Azure/an-invalid-repo";
var result = await _defaultStore.GetDefaultBranch(assetsConfiguration);
Assert.Equal("not-main", result);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public async Task UpdateRecordingJsonUpdatesProperly()
{
var fakeSha = "FakeReplacementSha";
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
var configuration = await _defaultStore.ParseConfigurationFile(testFolder);
await _defaultStore.UpdateAssetsJson(fakeSha, configuration);
Assert.Equal(fakeSha, configuration.Tag);
var newConfiguration = await _defaultStore.ParseConfigurationFile(testFolder);
Assert.Equal(fakeSha, newConfiguration.Tag);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Theory]
[InlineData("assets.json", false, "./ eng/ .gitignore")]
[InlineData("assets.json", true, "python/recordings eng/ .gitignore")]
[InlineData("sdk/storage/assets.json", false, "sdk/storage eng/ .gitignore")]
[InlineData("sdk/storage/assets.json", true, "python/recordings/sdk/storage eng/ .gitignore")]
public async Task ResolveCheckPathsResolvesProperly(string assetsJsonPath, bool includePrefix, string expectedResult)
{
var expectedPaths = new string[]
{
assetsJsonPath
};
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, expectedPaths);
try
{
NormalizedString configLocation;
if (assetsJsonPath == "assets.json")
{
configLocation = new NormalizedString(testFolder);
}
else
{
configLocation = new NormalizedString(Path.Join(testFolder, assetsJsonPath));
}
var configuration = await _defaultStore.ParseConfigurationFile(configLocation);
if (!includePrefix)
{
configuration.AssetsRepoPrefixPath = null;
}
var result = _defaultStore.ResolveCheckoutPaths(configuration);
Assert.Equal(expectedResult, result);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public async Task UpdateRecordingJsonNoOpsProperly()
{
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
var pathToAssets = Path.Combine(testFolder, "assets.json");
var creationTime = File.GetLastWriteTime(pathToAssets);
var configuration = await _defaultStore.ParseConfigurationFile(testFolder);
await _defaultStore.UpdateAssetsJson(configuration.Tag, configuration);
var postUpdateLastWrite = File.GetLastWriteTime(pathToAssets);
Assert.Equal(creationTime, postUpdateLastWrite);
var newConfiguration = await _defaultStore.ParseConfigurationFile(testFolder);
Assert.Equal(configuration.Tag, newConfiguration.Tag);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact]
public async Task UpdateRecordingJsonOnlyUpdatesTargetSHA()
{
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
var fakeSha = "FakeReplacementSha";
var pathToAssets = Path.Combine(testFolder, "assets.json");
var contentBeforeUpdate = File.ReadAllText(pathToAssets);
var configuration = await _defaultStore.ParseConfigurationFile(pathToAssets);
var originalSHA = configuration.Tag;
await _defaultStore.UpdateAssetsJson(fakeSha, configuration);
var newConfiguration = await _defaultStore.ParseConfigurationFile(pathToAssets);
Assert.NotEqual(originalSHA, newConfiguration.Tag);
var contentAfterUpdate = File.ReadAllText(pathToAssets);
Assert.NotEqual(contentBeforeUpdate, contentAfterUpdate);
Assert.Equal(contentBeforeUpdate.Replace(originalSHA, fakeSha), contentAfterUpdate);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[EnvironmentConditionalSkipTheory]
[InlineData(
@"{
""AssetsRepo"": ""Azure/azure-sdk-assets-integration"",
""AssetsRepoPrefixPath"": ""python/recordings"",
""AssetsRepoId"": """",
""TagPrefix"": ""python/tables"",
""Tag"": ""python/tables89f51431""
}")]
[InlineData(
@"{
""AssetsRepo"": ""Azure/azure-sdk-assets-integration"",
""AssetsRepoPrefixPath"": ""python"",
""AssetsRepoId"": """",
""TagPrefix"": ""python/tables"",
""Tag"": ""python/tables4f724f0c""
}")]
[InlineData(
@"{
""AssetsRepo"": ""Azure/azure-sdk-assets-integration"",
""AssetsRepoPrefixPath"": """",
""AssetsRepoId"": """",
""TagPrefix"": ""python/tables"",
""Tag"": ""python/tablesdd6aec01""
}")]
[Trait("Category", "Integration")]
public async Task GetPathResolves(string inputJson)
{
var folderStructure = new string[]
{
Path.Combine("sdk", "tables", GitStoretests.AssetsJson)
};
Assets assets = JsonSerializer.Deserialize<Assets>(inputJson);
var testFolder = TestHelpers.DescribeTestFolder(assets, folderStructure, isPushTest: false);
try
{
var jsonFileLocation = Path.Join(testFolder, "sdk/tables", GitStoretests.AssetsJson);
var parsedConfiguration = await _defaultStore.ParseConfigurationFile(jsonFileLocation);
await _defaultStore.Restore(jsonFileLocation);
var result = await _defaultStore.GetPath(jsonFileLocation);
await TestHelpers.CheckBreadcrumbAgainstAssetsJsons(new string[] { jsonFileLocation });
Assert.True(File.Exists(Path.Combine(result, "sdk", "tables", "azure-data-tables", "tests", "recordings", "test_retry.pyTestStorageRetrytest_retry_on_server_error.json")));
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[EnvironmentConditionalSkipFact]
[Trait("Category", "Integration")]
public async Task BreadCrumbMaintainsMultipleBreadCrumbs()
{
var inputJson = @"{
""AssetsRepo"": ""Azure/azure-sdk-assets-integration"",
""AssetsRepoPrefixPath"": """",
""AssetsRepoId"": """",
""TagPrefix"": ""python/tables"",
""Tag"": ""python/tablesdd6aec01""
}";
var target1 = Path.Combine("sdk", "tables", GitStoretests.AssetsJson);
var target2 = Path.Combine("sdk", GitStoretests.AssetsJson);
var target3 = Path.Combine(GitStoretests.AssetsJson);
var folderStructure = new string[]
{
target1,
target2,
target3
};
Assets assets = JsonSerializer.Deserialize<Assets>(inputJson);
var testFolder = TestHelpers.DescribeTestFolder(assets, folderStructure, isPushTest: false);
try
{
var assetStore = (await _defaultStore.ParseConfigurationFile(Path.Join(testFolder, target1))).ResolveAssetsStoreLocation();
var breadCrumbs = new List<string>();
// run 3 restore operations
foreach (var assetsJson in folderStructure)
{
var jsonFileLocation = Path.Join(testFolder, assetsJson);
var parsedJson = await _defaultStore.ParseConfigurationFile(jsonFileLocation);
var breadCrumbFile = Path.Join(assetStore.ToString(), "breadcrumb", $"{parsedJson.AssetRepoShortHash}.breadcrumb");
breadCrumbs.Add(breadCrumbFile);
await _defaultStore.Restore(jsonFileLocation);
TestHelpers.CheckBreadcrumbAgainstAssetsConfig(parsedJson);
}
// double verify they are where we expect
foreach(var crumbFile in breadCrumbs)
{
Assert.True(File.Exists(crumbFile));
}
// we have already validated that each tag contains what we expect, just confirm we aren't eliminating lines now.
Assert.Equal(3, breadCrumbs.Count());
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact(Skip = "Skipping because we don't have an integration test suite working yet.")]
public async Task GitCallHonorsLocalCredential()
{
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
var config = await _defaultStore.ParseConfigurationFile(testFolder);
var workDone = _defaultStore.InitializeAssetsRepo(config);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
[Fact(Skip = "Skipping due to integration tests not figured out yet.")]
public async Task GetDefaultBranchWorksWithValidRepo()
{
var testFolder = TestHelpers.DescribeTestFolder(DefaultAssets, basicFolderStructure);
try
{
_defaultStore.DefaultBranch = "not-main";
var assetsConfiguration = await _defaultStore.ParseConfigurationFile(Path.Join(testFolder, AssetsJson));
var result = await _defaultStore.GetDefaultBranch(assetsConfiguration);
Assert.Equal("main", result);
}
finally
{
DirectoryHelper.DeleteGitDirectory(testFolder);
}
}
}
}