Skip to content

Commit

Permalink
Fixes handling of local and network paths in remote URL (#1150)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tmat
tmat committed Dec 15, 2023
1 parent 0647320 commit 17ff6eb
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 192 deletions.
2 changes: 1 addition & 1 deletion src/Microsoft.Build.Tasks.Git.UnitTests/GitDataTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public void MinimalGitData()
Assert.Equal("1111111111111111111111111111111111111111", repository.GetHeadCommitSha());

var warnings = new List<(string, object?[])>();
var sourceRoots = GitOperations.GetSourceRoots(repository, remoteName: null, warnOnMissingCommit: true, (message, args) => warnings.Add((message, args)));
var sourceRoots = GitOperations.GetSourceRoots(repository, remoteName: null, warnOnMissingCommitOrUnsupportedUri: true, (message, args) => warnings.Add((message, args)));
AssertEx.Equal(new[]
{
$@"'{repoDir.Path}{s}' SourceControl='git' RevisionId='1111111111111111111111111111111111111111' ScmRepositoryUrl='http://github.com/test-org/test-repo'",
Expand Down
177 changes: 38 additions & 139 deletions src/Microsoft.Build.Tasks.Git.UnitTests/GitOperationsTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,147 +192,33 @@ public void GetRepositoryUrl_InsteadOf()
Assert.Empty(warnings);
}

/// <summary>
/// Test scenario where a local repository is cloned from another local repository that was cloned from a remote repository.
/// </summary>
[Theory]
[InlineData(true)]
[InlineData(false)]
public void GetRepositoryUrl_Local(bool useFileUrl)
[InlineData("local")]
[InlineData("file")]
[InlineData("xyz://a/b")]
public void GetRepositoryUrl_UnsupportedUrl(string kind)
{
using var temp = new TempRoot();

var dir = temp.CreateDirectory();
var mainWorkingDir = dir.CreateDirectory("x \u1234");
var mainGitDir = mainWorkingDir.CreateDirectory(".git");
mainGitDir.CreateFile("HEAD");
mainGitDir.CreateFile("config").WriteAllText(@"[remote ""origin""] url = http://github.com/repo");
var originRepoPath = dir.CreateDirectory("x \u1234").Path;

var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[]
{
KVP(new GitVariableName("remote", "origin", "url"),
ImmutableArray.Create(useFileUrl ? new Uri(mainWorkingDir.Path).AbsolutePath : mainWorkingDir.Path)),
})));

var warnings = new List<(string, object?[])>();
Assert.Equal("http://github.com/repo", GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args))));
Assert.Empty(warnings);
}

/// <summary>
/// Test scenario where a local repository is cloned from another local repository that was cloned from a remote repository.
/// With custom remote name.
/// </summary>
[Fact]
public void GetRepositoryUrl_Local_CustomRemoteName()
{
using var temp = new TempRoot();

var mainWorkingDir = temp.CreateDirectory();
var mainGitDir = mainWorkingDir.CreateDirectory(".git");
mainGitDir.CreateFile("HEAD");
mainGitDir.CreateFile("config").WriteAllText(@"[remote ""origin""] url = http://github.com/repo");

var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[]
{
KVP(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(mainWorkingDir.Path)),
})));

var warnings = new List<(string, object?[])>();
Assert.Equal("http://github.com/repo", GitOperations.GetRepositoryUrl(repo, remoteName: "myremote", logWarning: (message, args) => warnings.Add((message, args))));
AssertEx.Equal(new[] { string.Format(Resources.RepositoryDoesNotHaveSpecifiedRemote, repo.WorkingDirectory, "myremote", "origin") }, warnings.Select(TestUtilities.InspectDiagnostic));
}

/// <summary>
/// Test scenario where a local repository is cloned from another local repository that does not have remote URL specified.
/// </summary>
[Fact]
public void GetRepositoryUrl_Local_NoRemoteOriginUrl()
{
using var temp = new TempRoot();

var mainWorkingDir = temp.CreateDirectory();
var mainGitDir = mainWorkingDir.CreateDirectory(".git");
mainGitDir.CreateFile("HEAD");

var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[]
var url = kind switch
{
KVP(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(mainWorkingDir.Path)),
})));

var warnings = new List<(string, object?[])>();
Assert.Equal(new Uri(mainWorkingDir.Path).AbsoluteUri, GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args))));
AssertEx.Equal(new[] { string.Format(Resources.RepositoryHasNoRemote, mainWorkingDir.Path) }, warnings.Select(TestUtilities.InspectDiagnostic));
}

/// <summary>
/// Test scenario where a local repository is cloned from another local repository that does not have a working directory.
/// </summary>
[Fact]
public void GetRepositoryUrl_Local_NoWorkingDirectory()
{
using var temp = new TempRoot();

var dir = temp.CreateDirectory();

var gitDir1 = dir.CreateDirectory("1");
gitDir1.CreateFile("HEAD");
gitDir1.CreateFile("config").WriteAllText(@"[remote ""origin""] url = http://github.com/repo");

var gitDir2 = dir.CreateDirectory("2");
gitDir2.CreateFile("HEAD");
gitDir2.CreateFile("config").WriteAllText(@"[remote ""origin""] url = ../1");

var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[]
{
KVP(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(gitDir2.Path)),
})));

var warnings = new List<(string, object?[])>();
Assert.Null(GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args))));
AssertEx.Equal(new[] { string.Format(Resources.UnableToLocateRepository, gitDir2.Path) }, warnings.Select(TestUtilities.InspectDiagnostic));
}

/// <summary>
/// Test scenario where a local repository is cloned from another local repository that was cloned from a remote repository.
/// </summary>
[Fact]
public void GetRepositoryUrl_Local_BadRepo()
{
using var temp = new TempRoot();

var mainWorkingDir = temp.CreateDirectory();
var mainGitDir = mainWorkingDir.CreateDirectory(".git");

var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[]
{
KVP(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(mainWorkingDir.Path)),
})));

var warnings = new List<(string, object?[])>();
Assert.Equal(new Uri(mainWorkingDir.Path).AbsoluteUri, GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args))));
AssertEx.Equal(new[] { string.Format(Resources.RepositoryHasNoRemote, mainWorkingDir.Path) }, warnings.Select(TestUtilities.InspectDiagnostic));
}

[Fact]
public void GetRepositoryUrl_LocalRecursion()
{
using var temp = new TempRoot();

var mainWorkingDir = temp.CreateDirectory();
var mainGitDir = mainWorkingDir.CreateDirectory(".git");
mainGitDir.CreateFile("HEAD");
mainGitDir.CreateFile("config").WriteAllText($@"[remote ""origin""] url = {mainWorkingDir.Path.Replace('\\', '/')}");
"local" => originRepoPath,
"file" => new Uri(originRepoPath).AbsolutePath,
_ => kind
};

var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[]
{
KVP(new GitVariableName("remote", "origin", "url"),
ImmutableArray.Create(mainWorkingDir.Path)),
KVP(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(url)),
})));

var warnings = new List<(string, object?[])>();
Assert.Equal(new Uri(mainWorkingDir.Path).AbsoluteUri, GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args))));
AssertEx.Equal(new[] { string.Format(Resources.RepositoryUrlEvaluationExceededMaximumAllowedDepth, "10") }, warnings.Select(TestUtilities.InspectDiagnostic));
var uri = GitOperations.GetRepositoryUrl(repo, remoteName: null, warnOnMissingOrUnsupportedRemote: true, logWarning: (message, args) => warnings.Add((message, args)));
Assert.Null(uri);
AssertEx.Equal(new[] { string.Format(Resources.InvalidRepositoryRemoteUrl, "origin", url) }, warnings.Select(TestUtilities.InspectDiagnostic));
}

[Theory]
Expand Down Expand Up @@ -468,7 +354,7 @@ public void GetSourceRoots_RepoWithCommits_WithoutUrl()
commitSha: "0000000000000000000000000000000000000000");

var warnings = new List<(string, object?[])>();
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommit: true, (message, args) => warnings.Add((message, args)));
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommitOrUnsupportedUri: true, (message, args) => warnings.Add((message, args)));

AssertEx.Equal(new[]
{
Expand All @@ -487,7 +373,7 @@ public void GetSourceRoots_RepoWithCommits_WithUrl()
("remote.origin.url", "http://github.com/abc")));

var warnings = new List<(string, object?[])>();
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommit: true, (message, args) => warnings.Add((message, args)));
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommitOrUnsupportedUri: true, (message, args) => warnings.Add((message, args)));

AssertEx.Equal(new[]
{
Expand Down Expand Up @@ -517,7 +403,7 @@ public void GetSourceRoots_RepoWithoutCommitsWithSubmodules()
CreateSubmodule("sub6", "sub/6", "", "6666666666666666666666666666666666666666")));

var warnings = new List<(string, object?[])>();
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommit: false, (message, args) => warnings.Add((message, args)));
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommitOrUnsupportedUri: false, (message, args) => warnings.Add((message, args)));

// Module without a configuration entry is not initialized.
// URLs listed in .submodules are ignored (they are used by git submodule initialize to generate URLs stored in config).
Expand Down Expand Up @@ -567,8 +453,9 @@ public void GetSourceRoots_RepoWithCommitsWithSubmodules(bool warnOnMissingCommi
}
}

[Fact]
public void GetSourceRoots_RelativeSubmodulePath()
[Theory]
[CombinatorialData]
public void GetSourceRoots_RelativeSubmodulePath(bool warnOnMissingCommitOrUnsupportedUri)
{
using var temp = new TempRoot();

Expand All @@ -586,20 +473,32 @@ public void GetSourceRoots_RelativeSubmodulePath()
workingDir: repoDir.Path,
commitSha: "0000000000000000000000000000000000000000",
config: CreateConfig(
("submodule.1.url", "../1")),
("submodule.1.url", "../1"),
("submodule.2.url", "xyz://a/b")),
submodules: ImmutableArray.Create(
CreateSubmodule("1", "sub/1", "---", "1111111111111111111111111111111111111111", containingRepositoryWorkingDir: repoDir.Path)));
CreateSubmodule("1", "sub/1", "---", "1111111111111111111111111111111111111111", containingRepositoryWorkingDir: repoDir.Path),
CreateSubmodule("2", "sub/2", "---", "2222222222222222222222222222222222222222", containingRepositoryWorkingDir: repoDir.Path)));

var warnings = new List<(string, object?[])>();
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommit: false, (message, args) => warnings.Add((message, args)));
var items = GitOperations.GetSourceRoots(repo, remoteName: null, warnOnMissingCommitOrUnsupportedUri, (message, args) => warnings.Add((message, args)));

AssertEx.Equal(new[]
{
$@"'{repoDir.Path}{s}' SourceControl='git' RevisionId='0000000000000000000000000000000000000000'",
$@"'{repoDir.Path}{s}sub{s}1{s}' SourceControl='git' RevisionId='1111111111111111111111111111111111111111' NestedRoot='sub/1/' ContainingRoot='{repoDir.Path}{s}' ScmRepositoryUrl='http://github.com/repo1'",
$@"'{repoDir.Path}{s}' SourceControl='git' RevisionId='0000000000000000000000000000000000000000'"
}, items.Select(TestUtilities.InspectSourceRoot));

Assert.Empty(warnings);
if (warnOnMissingCommitOrUnsupportedUri)
{
AssertEx.Equal(new[]
{
string.Format(Resources.SourceCodeWontBeAvailableViaSourceLink, string.Format(Resources.InvalidSubmoduleUrl, "1", "../1")),
string.Format(Resources.SourceCodeWontBeAvailableViaSourceLink, string.Format(Resources.InvalidSubmoduleUrl, "2", "xyz://a/b"))
}, warnings.Select(TestUtilities.InspectDiagnostic));
}
else
{
Assert.Empty(warnings);
}
}

private static GitOperations.DirectoryNode CreateNode(string name, string? submoduleWorkingDirectory, List<GitOperations.DirectoryNode>? children = null)
Expand Down
Loading

0 comments on commit 17ff6eb

Please sign in to comment.