mirror of
https://github.com/logos-storage/logos-storage-nim-cs-dist-tests.git
synced 2026-07-11 01:29:32 +00:00
87bba240b2
Previously, whitespace deviations in openapi.yaml spec would cause a hash mismatch between the openapi.yaml in the Logos Storage image and the openapi.yaml in the project. This update removes whitespaces from the file contents before SHA256 hashing the contents. In addition, there were two independent Hash functions that were copies of each other to produce the same hash. This has been unified into a single FileHash utility.
108 lines
4.1 KiB
C#
108 lines
4.1 KiB
C#
using Core;
|
|
using KubernetesWorkflow.Types;
|
|
using Logging;
|
|
using System.Security.Cryptography;
|
|
using System.Text;
|
|
using Utils;
|
|
|
|
namespace StoragePlugin
|
|
{
|
|
public class ApiChecker
|
|
{
|
|
// <INSERT-OPENAPI-YAML-HASH>
|
|
private const string OpenApiYamlHash = "F2-83-6E-23-8A-30-03-34-E8-24-52-B6-C3-00-21-5C-C0-3C-9C-5E-CB-CB-BF-68-47-7E-6A-87-D0-1F-46-8D";
|
|
private const string OpenApiFilePath = "/logosstorage/openapi.yaml";
|
|
private const string DisableEnvironmentVariable = "StoragePlugin_DISABLE_APICHECK";
|
|
|
|
private const bool Disable = false;
|
|
|
|
private const string Warning =
|
|
"Warning: StoragePlugin was unable to find the openapi.yaml file in the Logos Storage container. Are you running an old version of Logos Storage? " +
|
|
"Plugin will continue as normal, but API compatibility is not guaranteed!";
|
|
|
|
private const string Failure =
|
|
"Logos Storage API compatibility check failed! " +
|
|
"openapi.yaml used by StoragePlugin does not match openapi.yaml in Logos Storage container. The openapi.yaml in " +
|
|
"'ProjectPlugins/StoragePlugin' has been overwritten with the container one. " +
|
|
"Please and rebuild this project. If you wish to disable API compatibility checking, please set " +
|
|
$"the environment variable '{DisableEnvironmentVariable}' or set the disable bool in 'ProjectPlugins/StoragePlugin/ApiChecker.cs'.";
|
|
|
|
private static bool checkPassed = false;
|
|
|
|
private readonly IPluginTools pluginTools;
|
|
private readonly ILog log;
|
|
|
|
public ApiChecker(IPluginTools pluginTools)
|
|
{
|
|
this.pluginTools = pluginTools;
|
|
log = pluginTools.GetLog();
|
|
|
|
if (string.IsNullOrEmpty(OpenApiYamlHash)) throw new Exception("OpenAPI yaml hash was not inserted by pre-build trigger.");
|
|
}
|
|
|
|
public void CheckCompatibility(RunningPod[] containers)
|
|
{
|
|
if (checkPassed) return;
|
|
|
|
Log("StoragePlugin is checking API compatibility...");
|
|
|
|
if (Disable || !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(DisableEnvironmentVariable)))
|
|
{
|
|
Log("API compatibility checking has been disabled.");
|
|
checkPassed = true;
|
|
return;
|
|
}
|
|
|
|
var workflow = pluginTools.CreateWorkflow();
|
|
var container = containers.First().Containers.First();
|
|
var openApiContents = workflow.ExecuteCommand(container, "cat", OpenApiFilePath);
|
|
|
|
if (string.IsNullOrEmpty(openApiContents))
|
|
{
|
|
log.Error(Warning);
|
|
|
|
checkPassed = true;
|
|
return;
|
|
}
|
|
|
|
var containerHash = FileHash.HashContents(openApiContents);
|
|
if (containerHash == OpenApiYamlHash)
|
|
{
|
|
Log("API compatibility check passed.");
|
|
checkPassed = true;
|
|
return;
|
|
}
|
|
|
|
OverwriteOpenApiYaml(openApiContents);
|
|
|
|
log.Error(Failure);
|
|
throw new Exception(Failure);
|
|
}
|
|
|
|
private void OverwriteOpenApiYaml(string containerApi)
|
|
{
|
|
Log("API compatibility check failed. Updating StoragePlugin...");
|
|
var openApiFilePath = Path.Combine(PluginPathUtils.ProjectPluginsDir, "LogosStorageClient", "openapi.yaml");
|
|
if (!File.Exists(openApiFilePath)) throw new Exception("Unable to locate LogosStorageClient/openapi.yaml. Expected: " + openApiFilePath);
|
|
|
|
File.Delete(openApiFilePath);
|
|
File.WriteAllText(openApiFilePath, containerApi);
|
|
Log("LogosStorageClient/openapi.yaml has been updated.");
|
|
}
|
|
|
|
private string Hash(string file)
|
|
{
|
|
var fileBytes = Encoding.ASCII.GetBytes(file
|
|
.Replace(Environment.NewLine, ""));
|
|
var sha = SHA256.Create();
|
|
var hash = sha.ComputeHash(fileBytes);
|
|
return BitConverter.ToString(hash);
|
|
}
|
|
|
|
private void Log(string msg)
|
|
{
|
|
log.Log(msg);
|
|
}
|
|
}
|
|
}
|