private GitObject[] GetUpdatedTagsMetadata()
{
List <GitObject> metadata = new();
foreach (RepoInfo repo in Manifest.FilteredRepos)
{
string updatedMetadata = McrTagsMetadataGenerator.Execute(_gitService, Manifest, repo, Options.SourceRepoUrl);
string metadataFileName = Path.GetFileName(repo.Model.McrTagsMetadataTemplate);
metadata.Add(GetGitObject(GetProductRepoName(repo), metadataFileName, updatedMetadata));
}
return(metadata.ToArray());
}
private string UpdateTagsListing(string readme, RepoInfo repo)
{
if (repo.Model.McrTagsMetadataTemplate == null)
{
return(readme);
}
string tagsMetadata = McrTagsMetadataGenerator.Execute(
_gitService, Manifest, repo, Options.SourceRepoUrl, Options.SourceRepoBranch);
string tagsListing = GenerateTagsListing(repo, tagsMetadata);
return(ReadmeHelper.UpdateTagsListing(readme, tagsListing));
}
private async Task <GitObject[]> GetUpdatedTagsMetadata(string productRepo, IGitHubClient client, GitHubBranch branch)
{
List <GitObject> metadata = new List <GitObject>();
foreach (RepoInfo repo in Manifest.FilteredRepos)
{
string updatedMetadata = McrTagsMetadataGenerator.Execute(this.gitService, Manifest, repo, Options.SourceRepoUrl);
string metadataFileName = Path.GetFileName(repo.Model.McrTagsMetadataTemplatePath);
await AddUpdatedFile(metadata, client, branch, productRepo, metadataFileName, updatedMetadata);
}
return(metadata.ToArray());
}
public override Task ExecuteAsync()
{
if (Manifest.FilteredRepos.Count() != 1)
{
throw new InvalidOperationException(
$"{Options.GetCommandName()} only supports generating the tags readme for one repo per invocation.");
}
RepoInfo repo = Manifest.FilteredRepos.First();
string tagsMetadata = McrTagsMetadataGenerator.Execute(
this.gitService, Manifest, repo, Options.SourceRepoUrl, Options.SourceRepoBranch);
string tagsListing = GenerateTagsListing(repo, tagsMetadata);
UpdateReadme(repo, tagsListing);
return(Task.CompletedTask);
}
public void DockerfileUrl(string sourceRepoBranch)
{
using TempFolderContext tempFolderContext = TestHelper.UseTempFolder();
const string SourceRepoUrl = "https://www.github.com/dotnet/dotnet-docker";
const string RepoName = "repo";
const string TagName = "tag";
// Create Dockerfile
string DockerfileDir = $"1.0/{RepoName}/os";
Directory.CreateDirectory(Path.Combine(tempFolderContext.Path, DockerfileDir));
string dockerfileRelativePath = Path.Combine(DockerfileDir, "Dockerfile");
string dockerfileFullPath = PathHelper.NormalizePath(Path.Combine(tempFolderContext.Path, dockerfileRelativePath));
File.WriteAllText(dockerfileFullPath, "FROM base:tag");
// Create MCR tags metadata template file
StringBuilder tagsMetadataTemplateBuilder = new StringBuilder();
tagsMetadataTemplateBuilder.AppendLine($"$(McrTagsYmlRepo:{RepoName})");
tagsMetadataTemplateBuilder.Append($"$(McrTagsYmlTagGroup:{TagName})");
string tagsMetadataTemplatePath = Path.Combine(tempFolderContext.Path, "tags.yaml");
File.WriteAllText(tagsMetadataTemplatePath, tagsMetadataTemplateBuilder.ToString());
// Create manifest
Manifest manifest = ManifestHelper.CreateManifest(
ManifestHelper.CreateRepo(RepoName,
new Image[]
{
ManifestHelper.CreateImage(
ManifestHelper.CreatePlatform(dockerfileRelativePath, new string[] { TagName }))
},
mcrTagsMetadataTemplatePath: Path.GetFileName(tagsMetadataTemplatePath))
);
string manifestPath = Path.Combine(tempFolderContext.Path, "manifest.json");
File.WriteAllText(manifestPath, JsonConvert.SerializeObject(manifest));
// Load manifest
IManifestOptionsInfo manifestOptions = GetManifestOptions(manifestPath);
ManifestInfo manifestInfo = ManifestInfo.Load(manifestOptions);
RepoInfo repo = manifestInfo.AllRepos.First();
Mock <IGitService> gitServiceMock = new Mock <IGitService>();
const string DockerfileSha = "random_sha";
if (sourceRepoBranch == null)
{
gitServiceMock
.Setup(o => o.GetCommitSha(dockerfileFullPath, true))
.Returns(DockerfileSha);
}
// Execute generator
string result = McrTagsMetadataGenerator.Execute(
gitServiceMock.Object, manifestInfo, repo, SourceRepoUrl, sourceRepoBranch);
Models.Mcr.McrTagsMetadata tagsMetadata = new DeserializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance)
.Build()
.Deserialize <Models.Mcr.McrTagsMetadata>(result);
string branchOrSha = sourceRepoBranch ?? DockerfileSha;
Assert.Equal($"{SourceRepoUrl}/blob/{branchOrSha}/{DockerfileDir}/Dockerfile",
tagsMetadata.Repos[0].TagGroups[0].Dockerfile);
}
public void DuplicatedPlatform()
{
using TempFolderContext tempFolderContext = TestHelper.UseTempFolder();
const string SourceRepoUrl = "https://www.github.com/dotnet/dotnet-docker";
const string RepoName = "repo";
const string SourceBranch = "branch";
// Create MCR tags metadata template file
StringBuilder tagsMetadataTemplateBuilder = new StringBuilder();
tagsMetadataTemplateBuilder.AppendLine($"$(McrTagsYmlRepo:{RepoName})");
tagsMetadataTemplateBuilder.AppendLine($"$(McrTagsYmlTagGroup:concreteTagA)");
string tagsMetadataTemplatePath = Path.Combine(tempFolderContext.Path, "tags.yaml");
File.WriteAllText(tagsMetadataTemplatePath, tagsMetadataTemplateBuilder.ToString());
string emptyFileName = "emptyFile.md";
string emptyFilePath = Path.Combine(tempFolderContext.Path, emptyFileName);
File.WriteAllText(emptyFilePath, string.Empty);
// Create manifest
Manifest manifest = ManifestHelper.CreateManifest(
ManifestHelper.CreateRepo(RepoName,
new Image[]
{
ManifestHelper.CreateImage(
new Platform[]
{
ManifestHelper.CreatePlatform(
DockerfileHelper.CreateDockerfile($"1.0/{RepoName}/os", tempFolderContext),
new string[] { "concreteTagZ", "concreteTagA" })
},
sharedTags: new Dictionary <string, Tag>
{
{ "shared1", new Tag() },
{ "latest", new Tag() },
}),
ManifestHelper.CreateImage(
new Platform[]
{
ManifestHelper.CreatePlatform(
DockerfileHelper.CreateDockerfile($"1.0/{RepoName}/os", tempFolderContext),
Array.Empty <string>())
},
sharedTags: new Dictionary <string, Tag>
{
{ "shared2", new Tag() }
})
},
readme: emptyFileName,
readmeTemplate: emptyFileName,
mcrTagsMetadataTemplate: Path.GetFileName(tagsMetadataTemplatePath))
);
string manifestPath = Path.Combine(tempFolderContext.Path, "manifest.json");
File.WriteAllText(manifestPath, JsonConvert.SerializeObject(manifest));
// Load manifest
IManifestOptionsInfo manifestOptions = ManifestHelper.GetManifestOptions(manifestPath);
ManifestInfo manifestInfo = ManifestInfo.Load(manifestOptions);
RepoInfo repo = manifestInfo.AllRepos.First();
Mock <IGitService> gitServiceMock = new Mock <IGitService>();
// Execute generator
string result = McrTagsMetadataGenerator.Execute(
gitServiceMock.Object, manifestInfo, repo, SourceRepoUrl, SourceBranch);
TagsMetadata tagsMetadata = new DeserializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance)
.Build()
.Deserialize <TagsMetadata>(result);
// Verify the output only contains the platform with the documented tag
Assert.Single(tagsMetadata.Repos[0].TagGroups);
Assert.Equal(
$"{SourceRepoUrl}/blob/{SourceBranch}/1.0/{RepoName}/os/Dockerfile",
tagsMetadata.Repos[0].TagGroups[0].Dockerfile);
List <string> expectedTags = new List <string>
{
"concreteTagZ",
"concreteTagA",
"shared2",
"shared1",
"latest"
};
Assert.Equal(expectedTags, tagsMetadata.Repos[0].TagGroups[0].Tags);
}
public void HandlesUndocumentedPlatform()
{
using TempFolderContext tempFolderContext = TestHelper.UseTempFolder();
const string SourceRepoUrl = "https://www.github.com/dotnet/dotnet-docker";
const string RepoName = "repo";
const string SourceBranch = "branch";
// Create MCR tags metadata template file
StringBuilder tagsMetadataTemplateBuilder = new StringBuilder();
tagsMetadataTemplateBuilder.AppendLine($"$(McrTagsYmlRepo:{RepoName})");
tagsMetadataTemplateBuilder.AppendLine($"$(McrTagsYmlTagGroup:tag1a)");
string tagsMetadataTemplatePath = Path.Combine(tempFolderContext.Path, "tags.yaml");
File.WriteAllText(tagsMetadataTemplatePath, tagsMetadataTemplateBuilder.ToString());
Platform platform = ManifestHelper.CreatePlatform(
DockerfileHelper.CreateDockerfile($"1.0/{RepoName}/os", tempFolderContext),
Array.Empty <string>());
platform.Tags = new Dictionary <string, Tag>
{
{
"tag2",
new Tag
{
IsUndocumented = true
}
}
};
// Create manifest
Manifest manifest = ManifestHelper.CreateManifest(
ManifestHelper.CreateRepo(RepoName,
new Image[]
{
ManifestHelper.CreateImage(
platform,
ManifestHelper.CreatePlatform(
DockerfileHelper.CreateDockerfile($"1.0/{RepoName}/os2", tempFolderContext),
new string[] { "tag1a", "tag1b" }))
},
mcrTagsMetadataTemplatePath: Path.GetFileName(tagsMetadataTemplatePath))
);
string manifestPath = Path.Combine(tempFolderContext.Path, "manifest.json");
File.WriteAllText(manifestPath, JsonConvert.SerializeObject(manifest));
// Load manifest
IManifestOptionsInfo manifestOptions = GetManifestOptions(manifestPath);
ManifestInfo manifestInfo = ManifestInfo.Load(manifestOptions);
RepoInfo repo = manifestInfo.AllRepos.First();
Mock <IGitService> gitServiceMock = new Mock <IGitService>();
// Execute generator
string result = McrTagsMetadataGenerator.Execute(
gitServiceMock.Object, manifestInfo, repo, SourceRepoUrl, SourceBranch);
Models.Mcr.McrTagsMetadata tagsMetadata = new DeserializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance)
.Build()
.Deserialize <Models.Mcr.McrTagsMetadata>(result);
// Verify the output only contains the platform with the documented tag
Assert.Single(tagsMetadata.Repos[0].TagGroups);
Assert.Equal(
$"{SourceRepoUrl}/blob/{SourceBranch}/1.0/{RepoName}/os2/Dockerfile",
tagsMetadata.Repos[0].TagGroups[0].Dockerfile);
Assert.Equal(new string[] { "tag1a", "tag1b" }, tagsMetadata.Repos[0].TagGroups[0].Tags);
}
