Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ACR Integration: Add JSON metadata to package manifest in ACR registries #1522

Merged
merged 10 commits into from
Jan 23, 2024
Merged

ACR Integration: Add JSON metadata to package manifest in ACR registries #1522

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4328f56
get install working for version with 4 digits (last digit non-zero)
anamnavi Jan 3, 2024
bd99a7c
code cleanup
anamnavi Jan 3, 2024
a4549c8
code cleanup
anamnavi Jan 3, 2024
42f8ff1
Create metadata.json file and update manifest
alerickson Jan 4, 2024
219824e
Merge branch 'acr-install-serverapis' of https://github.com/anamnavi/…
alerickson Jan 4, 2024
66b7144
Create metadata json string and add to manifest
alerickson Jan 17, 2024
8840de4
Merge branch 'master' of https://github.com/powershell/PSResourceGet …
alerickson Jan 17, 2024
a3e4a99
Fix InstallVersion method
alerickson Jan 17, 2024
a7c636d
Remove JsonSerializerOptions
alerickson Jan 17, 2024
216696b
Remove metadataDigest param from CreateJsonContent
alerickson Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 78 additions & 39 deletions src/code/ACRServerAPICalls.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,7 +603,6 @@ private Stream InstallVersion(
{
return null;
}

string digest = GetDigestFromManifest(manifest, out errRecord);
if (errRecord != null)
{
Expand Down Expand Up @@ -1018,7 +1017,7 @@ private static Collection<KeyValuePair<string, string>> GetDefaultHeaders(string
};
}

internal bool PushNupkgACR(string outputNupkgDir, string pkgName, NuGetVersion pkgVersion, PSRepositoryInfo repository, out ErrorRecord errRecord)
internal bool PushNupkgACR(string psd1OrPs1File, string outputNupkgDir, string pkgName, NuGetVersion pkgVersion, PSRepositoryInfo repository, Hashtable parsedMetadataHash, out ErrorRecord errRecord)
{
errRecord = null;
// Push the nupkg to the appropriate repository
Expand Down Expand Up @@ -1050,42 +1049,19 @@ internal bool PushNupkgACR(string outputNupkgDir, string pkgName, NuGetVersion p
_cmdletPassedIn.WriteVerbose("Getting acr access token");
var acrAccessToken = GetAcrAccessToken(registry, acrRefreshToken, out errRecord);

/* Uploading .nupkg */
_cmdletPassedIn.WriteVerbose("Start uploading blob");
var moduleLocation = GetStartUploadBlobLocation(registry, pkgName, acrAccessToken).Result;

_cmdletPassedIn.WriteVerbose("Computing digest for .nupkg file");
bool digestCreated = CreateDigest(fullNupkgFile, out string digest, out ErrorRecord digestError);
if (!digestCreated)
bool nupkgDigestCreated = CreateDigest(fullNupkgFile, out string nupkgDigest, out ErrorRecord nupkgDigestError);
if (!nupkgDigestCreated)
{
_cmdletPassedIn.ThrowTerminatingError(digestError);
_cmdletPassedIn.ThrowTerminatingError(nupkgDigestError);
}

_cmdletPassedIn.WriteVerbose("Finish uploading blob");
bool moduleUploadSuccess = EndUploadBlob(registry, moduleLocation, fullNupkgFile, digest, false, acrAccessToken).Result;

_cmdletPassedIn.WriteVerbose("Create an empty file");
string emptyFileName = "empty.txt";
var emptyFilePath = System.IO.Path.Combine(outputNupkgDir, emptyFileName);
// Rename the empty file in case such a file already exists in the temp folder (although highly unlikely)
while (File.Exists(emptyFilePath))
{
emptyFilePath = Guid.NewGuid().ToString() + ".txt";
}
FileStream emptyStream = File.Create(emptyFilePath);
emptyStream.Close();

_cmdletPassedIn.WriteVerbose("Start uploading an empty file");
var emptyLocation = GetStartUploadBlobLocation(registry, pkgName, acrAccessToken).Result;

_cmdletPassedIn.WriteVerbose("Computing digest for empty file");
bool emptyDigestCreated = CreateDigest(emptyFilePath, out string emptyDigest, out ErrorRecord emptyDigestError);
if (!emptyDigestCreated)
{
_cmdletPassedIn.ThrowTerminatingError(emptyDigestError);
}

_cmdletPassedIn.WriteVerbose("Finish uploading empty file");
bool emptyFileUploadSuccess = EndUploadBlob(registry, emptyLocation, emptyFilePath, emptyDigest, false, acrAccessToken).Result;
bool moduleUploadSuccess = EndUploadBlob(registry, moduleLocation, fullNupkgFile, nupkgDigest, false, acrAccessToken).Result;

_cmdletPassedIn.WriteVerbose("Create the config file");
string configFileName = "config.json";
Expand All @@ -1096,11 +1072,25 @@ internal bool PushNupkgACR(string outputNupkgDir, string pkgName, NuGetVersion p
}
FileStream configStream = File.Create(configFilePath);
configStream.Close();
_cmdletPassedIn.WriteVerbose("Computing digest for config");
bool configDigestCreated = CreateDigest(configFilePath, out string configDigest, out ErrorRecord configDigestError);
if (!configDigestCreated)
{
_cmdletPassedIn.ThrowTerminatingError(configDigestError);
}

/* Create manifest layer */
_cmdletPassedIn.WriteVerbose("Create package version metadata as JSON string");
string jsonString = CreateMetadataContent(psd1OrPs1File, parsedMetadataHash, out ErrorRecord metadataCreationError);
if (metadataCreationError != null)
{
_cmdletPassedIn.ThrowTerminatingError(metadataCreationError);
}

FileInfo nupkgFile = new FileInfo(fullNupkgFile);
var fileSize = nupkgFile.Length;
var fileName = System.IO.Path.GetFileName(fullNupkgFile);
string fileContent = CreateJsonContent(digest, emptyDigest, fileSize, fileName);
string fileContent = CreateJsonContent(nupkgDigest, configDigest, configDigest, fileSize, fileName, jsonString);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the value of configDigest and metadataDigest the same? Earlier there was emptydigest

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadataDigest is no longer used, nor is emptyDigest. I removed the metadataDigest parameter because that should no longer be there.

File.WriteAllText(configFilePath, fileContent);

_cmdletPassedIn.WriteVerbose("Create the manifest layer");
Expand All @@ -1113,7 +1103,13 @@ internal bool PushNupkgACR(string outputNupkgDir, string pkgName, NuGetVersion p
return false;
}

private string CreateJsonContent(string digest, string emptyDigest, long fileSize, string fileName)
private string CreateJsonContent(
string nupkgDigest,
string configDigest,
string metadataDigest,
long nupkgFileSize,
string fileName,
string jsonString)
{
StringBuilder stringBuilder = new StringBuilder();
StringWriter stringWriter = new StringWriter(stringBuilder);
Expand All @@ -1131,31 +1127,31 @@ private string CreateJsonContent(string digest, string emptyDigest, long fileSiz
jsonWriter.WritePropertyName("mediaType");
jsonWriter.WriteValue("application/vnd.unknown.config.v1+json");
jsonWriter.WritePropertyName("digest");
jsonWriter.WriteValue($"sha256:{emptyDigest}");
jsonWriter.WriteValue($"sha256:{configDigest}");
jsonWriter.WritePropertyName("size");
jsonWriter.WriteValue(0);
jsonWriter.WriteEndObject();

jsonWriter.WritePropertyName("layers");
jsonWriter.WriteStartArray();
jsonWriter.WriteStartObject();

jsonWriter.WriteStartObject();
jsonWriter.WritePropertyName("mediaType");
jsonWriter.WriteValue("application/vnd.oci.image.layer.nondistributable.v1.tar+gzip'");
jsonWriter.WritePropertyName("digest");
jsonWriter.WriteValue($"sha256:{digest}");
jsonWriter.WriteValue($"sha256:{nupkgDigest}");
jsonWriter.WritePropertyName("size");
jsonWriter.WriteValue(fileSize);
jsonWriter.WriteValue(nupkgFileSize);
jsonWriter.WritePropertyName("annotations");

jsonWriter.WriteStartObject();
jsonWriter.WritePropertyName("org.opencontainers.image.title");
jsonWriter.WriteValue(fileName);
jsonWriter.WritePropertyName("metadata");
jsonWriter.WriteValue(jsonString);
jsonWriter.WriteEndObject();

jsonWriter.WriteEndObject();
jsonWriter.WriteEndArray();

jsonWriter.WriteEndArray();
jsonWriter.WriteEndObject();

return stringWriter.ToString();
Expand Down Expand Up @@ -1205,6 +1201,49 @@ private bool CreateDigest(string fileName, out string digest, out ErrorRecord er
return true;
}

private string CreateMetadataContent(string manifestFilePath, Hashtable parsedMetadata, out ErrorRecord metadataCreationError)
{
metadataCreationError = null;
Hashtable parsedMetadataHash = null;
string jsonString = string.Empty;

// A script will already have the metadata parsed into the parsedMetadatahash,
// a module will still need the module manifest to be parsed.
if (parsedMetadata == null || parsedMetadata.Count == 0)
{
// Use the parsed module manifest data as 'parsedMetadataHash' instead of the passed-in data.
if (!Utils.TryReadManifestFile(
manifestFilePath: manifestFilePath,
manifestInfo: out parsedMetadataHash,
error: out Exception manifestReadError))
{
metadataCreationError = new ErrorRecord(
manifestReadError,
"ManifestFileReadParseForACRPublishError",
ErrorCategory.ReadError,
_cmdletPassedIn);

return jsonString;
}
}

if (parsedMetadataHash == null)
{
metadataCreationError = new ErrorRecord(
new InvalidOperationException("Error parsing package metadata into hashtable."),
"PackageMetadataHashEmptyError",
ErrorCategory.InvalidData,
_cmdletPassedIn);

return jsonString;
}

_cmdletPassedIn.WriteVerbose("Serialize JSON into string.");
jsonString = System.Text.Json.JsonSerializer.Serialize(parsedMetadataHash);

return jsonString;
}

#endregion
}
}
3 changes: 2 additions & 1 deletion src/code/PublishPSResource.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,8 @@ out string[] _
{
ACRServerAPICalls acrServer = new ACRServerAPICalls(repository, this, _networkCredential, userAgentString);

if (!acrServer.PushNupkgACR(outputNupkgDir, _pkgName.ToLower(), _pkgVersion, repository, out ErrorRecord pushNupkgACRError))
var pkgMetadataFile = (resourceType == ResourceType.Script) ? pathToScriptFileToPublish : pathToModuleManifestToPublish;
if (!acrServer.PushNupkgACR(pkgMetadataFile, outputNupkgDir, _pkgName, _pkgVersion, repository, parsedMetadata, out ErrorRecord pushNupkgACRError))
{
WriteError(pushNupkgACRError);
// exit out of processing
Expand Down
Loading