forked from dotnet/sourcelink
/
GitRepository.cs
517 lines (441 loc) · 21.2 KB
/
GitRepository.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
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
namespace Microsoft.Build.Tasks.Git
{
internal sealed class GitRepository
{
private const int SupportedGitRepoFormatVersion = 0;
private const string CommonDirFileName = "commondir";
private const string GitDirName = ".git";
private const string GitDirPrefix = "gitdir: ";
private const string GitDirFileName = "gitdir";
// See https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt-HEAD
internal const string GitHeadFileName = "HEAD";
private const string GitModulesFileName = ".gitmodules";
public GitConfig Config { get; }
public GitIgnore Ignore => _lazyIgnore.Value;
/// <summary>
/// Normalized full path. OS specific directory separators.
/// </summary>
public string GitDirectory { get; }
/// <summary>
/// Normalized full path. OS specific directory separators.
/// </summary>
public string CommonDirectory { get; }
/// <summary>
/// Normalized full path. OS specific directory separators. Optional.
/// </summary>
public string? WorkingDirectory { get; }
public GitEnvironment Environment { get; }
private readonly Lazy<(ImmutableArray<GitSubmodule> Submodules, ImmutableArray<string> Diagnostics)> _lazySubmodules;
private readonly Lazy<GitIgnore> _lazyIgnore;
private readonly Lazy<string?> _lazyHeadCommitSha;
private readonly GitReferenceResolver _referenceResolver;
internal GitRepository(GitEnvironment environment, GitConfig config, string gitDirectory, string commonDirectory, string? workingDirectory)
{
NullableDebug.Assert(environment != null);
NullableDebug.Assert(config != null);
NullableDebug.Assert(PathUtils.IsNormalized(gitDirectory));
NullableDebug.Assert(PathUtils.IsNormalized(commonDirectory));
NullableDebug.Assert(workingDirectory == null || PathUtils.IsNormalized(workingDirectory));
Config = config;
GitDirectory = gitDirectory;
CommonDirectory = commonDirectory;
WorkingDirectory = workingDirectory;
Environment = environment;
_referenceResolver = new GitReferenceResolver(gitDirectory, commonDirectory);
_lazySubmodules = new Lazy<(ImmutableArray<GitSubmodule>, ImmutableArray<string>)>(ReadSubmodules);
_lazyIgnore = new Lazy<GitIgnore>(LoadIgnore);
_lazyHeadCommitSha = new Lazy<string?>(ReadHeadCommitSha);
}
// test only
internal GitRepository(
GitEnvironment environment,
GitConfig config,
string gitDirectory,
string commonDirectory,
string? workingDirectory,
ImmutableArray<GitSubmodule> submodules,
ImmutableArray<string> submoduleDiagnostics,
GitIgnore ignore,
string? headCommitSha)
: this(environment, config, gitDirectory, commonDirectory, workingDirectory)
{
_lazySubmodules = new Lazy<(ImmutableArray<GitSubmodule>, ImmutableArray<string>)>(() => (submodules, submoduleDiagnostics));
_lazyIgnore = new Lazy<GitIgnore>(() => ignore);
_lazyHeadCommitSha = new Lazy<string?>(() => headCommitSha);
}
/// <summary>
/// Opens a repository at the specified location.
/// </summary>
/// <exception cref="IOException" />
/// <exception cref="InvalidDataException" />
/// <exception cref="NotSupportedException">The repository found requires higher version of git repository format that is currently supported.</exception>
/// <returns>null if no git repository can be found that contains the specified path.</returns>
internal static GitRepository? OpenRepository(string path, GitEnvironment environment)
=> TryFindRepository(path, out var location) ? OpenRepository(location, environment) : null;
/// <summary>
/// Opens a repository at the specified location.
/// </summary>
/// <exception cref="IOException" />
/// <exception cref="InvalidDataException" />
/// <exception cref="NotSupportedException">The repository found requires higher version of git repository format that is currently supported.</exception>
public static GitRepository OpenRepository(GitRepositoryLocation location, GitEnvironment environment)
{
NullableDebug.Assert(environment != null);
NullableDebug.Assert(location.GitDirectory != null);
NullableDebug.Assert(location.CommonDirectory != null);
// See https://git-scm.com/docs/gitrepository-layout
var reader = new GitConfig.Reader(location.GitDirectory, location.CommonDirectory, environment);
var config = reader.Load();
var workingDirectory = GetWorkingDirectory(config, location);
// See https://github.com/git/git/blob/master/Documentation/technical/repository-version.txt
string? versionStr = config.GetVariableValue("core", "repositoryformatversion");
if (GitConfig.TryParseInt64Value(versionStr, out var version) && version > SupportedGitRepoFormatVersion)
{
throw new NotSupportedException(string.Format(Resources.UnsupportedRepositoryVersion, versionStr, SupportedGitRepoFormatVersion));
}
return new GitRepository(environment, config, location.GitDirectory, location.CommonDirectory, workingDirectory);
}
private static string? GetWorkingDirectory(GitConfig config, GitRepositoryLocation location)
{
// Working trees cannot have the same common directory and git directory.
// 'gitdir' file in a git directory indicates a working tree.
var gitdirFilePath = Path.Combine(location.GitDirectory, GitDirFileName);
var isLinkedWorkingTree = PathUtils.ToPosixDirectoryPath(location.CommonDirectory) != PathUtils.ToPosixDirectoryPath(location.GitDirectory) &&
File.Exists(gitdirFilePath);
if (isLinkedWorkingTree)
{
// https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt-worktreesltidgtgitdir
string workingDirectory;
try
{
workingDirectory = File.ReadAllText(gitdirFilePath);
}
catch (Exception e) when (!(e is IOException))
{
throw new IOException(e.Message, e);
}
workingDirectory = workingDirectory.TrimEnd(CharUtils.AsciiWhitespace);
// Path in gitdir file must be absolute.
if (!PathUtils.IsAbsolute(workingDirectory))
{
throw new InvalidDataException(string.Format(Resources.PathSpecifiedInFileIsNotAbsolute, gitdirFilePath, workingDirectory));
}
try
{
return Path.GetFullPath(workingDirectory);
}
catch
{
throw new InvalidDataException(string.Format(Resources.PathSpecifiedInFileIsInvalid, gitdirFilePath, workingDirectory));
}
}
// See https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreworktree
string? value = config.GetVariableValue("core", "worktree");
if (value != null)
{
// git does not expand home dir relative path ("~/")
try
{
return Path.GetFullPath(Path.Combine(location.GitDirectory, value));
}
catch
{
throw new InvalidDataException(string.Format(Resources.ValueOfIsNotValidPath, "core.worktree", value));
}
}
return location.WorkingDirectory;
}
/// <summary>
/// Returns the commit SHA of the current HEAD tip.
/// </summary>
/// <exception cref="IOException"/>
/// <exception cref="InvalidDataException"/>
/// <returns>Null if the HEAD tip reference can't be resolved.</returns>
public string? GetHeadCommitSha()
=> _lazyHeadCommitSha.Value;
/// <exception cref="IOException"/>
/// <exception cref="InvalidDataException"/>
private string? ReadHeadCommitSha()
=> _referenceResolver.ResolveHeadReference();
/// <summary>
/// Reads and resolves the commit SHA of the current HEAD tip of the specified submodule.
/// </summary>
/// <exception cref="IOException"/>
/// <exception cref="InvalidDataException"/>
/// <returns>Null if the HEAD tip reference can't be resolved.</returns>
internal string? ReadSubmoduleHeadCommitSha(string submoduleWorkingDirectoryFullPath)
{
// Submodules don't usually have their own .git directories but this is still legal.
// This can occur with older versions of Git or other tools, or when a user clones one
// repo into another's source tree (but it was not yet registered as a submodule).
// See https://git-scm.com/docs/gitsubmodules#_forms for more details.
var dotGitPath = Path.Combine(submoduleWorkingDirectoryFullPath, GitDirName);
var gitDirectory = Directory.Exists(dotGitPath) ? dotGitPath : ReadDotGitFile(dotGitPath);
if (!IsGitDirectory(gitDirectory, out var commonDirectory))
{
return null;
}
var resolver = new GitReferenceResolver(gitDirectory, commonDirectory);
return resolver.ResolveHeadReference();
}
private string GetWorkingDirectory()
=> WorkingDirectory ?? throw new InvalidOperationException(Resources.RepositoryDoesNotHaveWorkingDirectory);
/// <exception cref="IOException"/>
/// <exception cref="InvalidDataException"/>
/// <exception cref="NotSupportedException"/>
public ImmutableArray<GitSubmodule> GetSubmodules()
=> _lazySubmodules.Value.Submodules;
/// <exception cref="IOException"/>
/// <exception cref="InvalidDataException"/>
/// <exception cref="NotSupportedException"/>
public ImmutableArray<string> GetSubmoduleDiagnostics()
=> _lazySubmodules.Value.Diagnostics;
/// <exception cref="IOException"/>
/// <exception cref="InvalidDataException"/>
/// <exception cref="NotSupportedException"/>
private (ImmutableArray<GitSubmodule> Submodules, ImmutableArray<string> Diagnostics) ReadSubmodules()
{
var workingDirectory = GetWorkingDirectory();
var submoduleConfig = ReadSubmoduleConfig();
if (submoduleConfig == null)
{
return (ImmutableArray<GitSubmodule>.Empty, ImmutableArray<string>.Empty);
}
ImmutableArray<string>.Builder? lazyDiagnostics = null;
void reportDiagnostic(string diagnostic)
=> (lazyDiagnostics ??= ImmutableArray.CreateBuilder<string>()).Add(diagnostic);
var builder = ImmutableArray.CreateBuilder<GitSubmodule>();
foreach (var (name, path, url) in EnumerateSubmoduleConfig(submoduleConfig))
{
if (NullableString.IsNullOrWhiteSpace(path))
{
reportDiagnostic(string.Format(Resources.InvalidSubmodulePath, name, path));
continue;
}
// Ignore unspecified URL - Source Link doesn't use it.
string fullPath;
try
{
fullPath = Path.GetFullPath(Path.Combine(workingDirectory, path));
}
catch
{
reportDiagnostic(string.Format(Resources.InvalidSubmodulePath, name, path));
continue;
}
string? headCommitSha;
try
{
headCommitSha = ReadSubmoduleHeadCommitSha(fullPath);
}
catch (Exception e) when (e is IOException || e is InvalidDataException)
{
reportDiagnostic(e.Message);
continue;
}
builder.Add(new GitSubmodule(name, path, fullPath, url, headCommitSha));
}
return (builder.ToImmutable(), (lazyDiagnostics != null) ? lazyDiagnostics.ToImmutable() : ImmutableArray<string>.Empty);
}
// internal for testing
internal GitConfig? ReadSubmoduleConfig()
{
var workingDirectory = GetWorkingDirectory();
var submodulesConfigFile = Path.Combine(workingDirectory, GitModulesFileName);
if (!File.Exists(submodulesConfigFile))
{
return null;
}
var reader = new GitConfig.Reader(GitDirectory, CommonDirectory, Environment);
return reader.LoadFrom(submodulesConfigFile);
}
// internal for testing
internal static IEnumerable<(string Name, string? Path, string? Url)> EnumerateSubmoduleConfig(GitConfig submoduleConfig)
{
foreach (var group in submoduleConfig.Variables.
Where(kvp => kvp.Key.SectionNameEquals("submodule")).
GroupBy(kvp => kvp.Key.SubsectionName, GitVariableName.SubsectionNameComparer).
OrderBy(group => group.Key))
{
string name = group.Key;
string? url = null;
string? path = null;
foreach (var variable in group)
{
if (variable.Key.VariableNameEquals("path"))
{
path = variable.Value.Last();
}
else if (variable.Key.VariableNameEquals("url"))
{
url = variable.Value.Last();
}
}
yield return (name, path, url);
}
}
private GitIgnore LoadIgnore()
{
var workingDirectory = GetWorkingDirectory();
var ignoreCase = GitConfig.ParseBooleanValue(Config.GetVariableValue("core", "ignorecase"));
var excludesFile = Config.GetVariableValue("core", "excludesFile");
var commonInfoExclude = Path.Combine(CommonDirectory, "info", "exclude");
var root = GitIgnore.LoadFromFile(commonInfoExclude, GitIgnore.LoadFromFile(excludesFile, parent: null));
return new GitIgnore(root, workingDirectory, ignoreCase);
}
/// <summary>
/// Returns <see cref="GitRepositoryLocation"/> if the specified <paramref name="repositoryDirectory"/> is
/// a valid repository directory.
/// </summary>
/// <exception cref="IOException" />
/// <exception cref="InvalidDataException" />
/// <exception cref="NotSupportedException">The repository found requires higher version of git repository format that is currently supported.</exception>
/// <returns>False if no git repository can be found that contains the specified path.</returns>
public static bool TryGetRepositoryLocation(string directory, out GitRepositoryLocation location)
{
try
{
directory = Path.GetFullPath(directory);
}
catch
{
location = default;
return false;
}
return TryGetRepositoryLocationImpl(directory, out location);
}
/// <summary>
/// Finds a git repository containing the specified path, if any.
/// </summary>
/// <exception cref="IOException" />
/// <exception cref="InvalidDataException" />
/// <exception cref="NotSupportedException">The repository found requires higher version of git repository format that is currently supported.</exception>
/// <returns>False if no git repository can be found that contains the specified path.</returns>
public static bool TryFindRepository(string directory, out GitRepositoryLocation location)
{
var dir = directory;
try
{
dir = Path.GetFullPath(dir);
}
catch
{
location = default;
return false;
}
while (dir != null)
{
if (TryGetRepositoryLocationImpl(dir, out location))
{
return true;
}
// TODO: https://github.com/dotnet/sourcelink/issues/302
// stop on device boundary
dir = Path.GetDirectoryName(dir);
}
location = default;
return false;
}
private static bool TryGetRepositoryLocationImpl(string directory, out GitRepositoryLocation location)
{
string? commonDirectory;
var dotGitPath = Path.Combine(directory, GitDirName);
if (Directory.Exists(dotGitPath))
{
if (IsGitDirectory(dotGitPath, out commonDirectory))
{
location = new GitRepositoryLocation(gitDirectory: dotGitPath, commonDirectory, workingDirectory: directory);
return true;
}
}
else if (File.Exists(dotGitPath))
{
var link = ReadDotGitFile(dotGitPath);
if (IsGitDirectory(link, out commonDirectory))
{
location = new GitRepositoryLocation(gitDirectory: link, commonDirectory, workingDirectory: directory);
return true;
}
location = default;
return false;
}
if (Directory.Exists(directory))
{
if (IsGitDirectory(directory, out commonDirectory))
{
location = new GitRepositoryLocation(gitDirectory: directory, commonDirectory, workingDirectory: null);
return true;
}
}
location = default;
return false;
}
private static string ReadDotGitFile(string path)
{
string content;
try
{
content = File.ReadAllText(path);
}
catch (Exception e) when (!(e is IOException))
{
throw new IOException(e.Message, e);
}
if (!content.StartsWith(GitDirPrefix))
{
throw new InvalidDataException(string.Format(Resources.FormatOfFileIsInvalid, path));
}
var link = content.Substring(GitDirPrefix.Length).TrimEnd(CharUtils.AsciiWhitespace);
try
{
// link is relative to the directory containing the file:
return Path.GetFullPath(Path.Combine(Path.GetDirectoryName(path)!, link));
}
catch
{
throw new InvalidDataException(string.Format(Resources.PathSpecifiedInFileIsInvalid, path, link));
}
}
private static bool IsGitDirectory(string directory, [NotNullWhen(true)]out string? commonDirectory)
{
// HEAD file is required
if (!File.Exists(Path.Combine(directory, GitHeadFileName)))
{
commonDirectory = null;
return false;
}
// Spec https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt-commondir:
var commonLinkPath = Path.Combine(directory, CommonDirFileName);
if (File.Exists(commonLinkPath))
{
try
{
commonDirectory = Path.Combine(directory, File.ReadAllText(commonLinkPath).TrimEnd(CharUtils.AsciiWhitespace));
// Normalize relative paths. For example, git worktrees typically have "../.." in this file.
commonDirectory = Path.GetFullPath(commonDirectory);
}
catch
{
// git does not consider the directory valid git directory if the content of commondir file is malformed
commonDirectory = null;
return false;
}
}
else
{
commonDirectory = directory;
}
// Git also requires objects and refs directories, but we allow them to be missing.
// See https://github.com/dotnet/sourcelink/tree/master/docs#minimal-git-repository-metadata
return Directory.Exists(commonDirectory);
}
}
}