2024-03-26 13:42:47 +00:00
|
|
|
using Core;
|
|
|
|
using KubernetesWorkflow.Types;
|
|
|
|
using Logging;
|
|
|
|
using System.Security.Cryptography;
|
|
|
|
using System.Text;
|
|
|
|
|
|
|
|
namespace CodexPlugin
|
|
|
|
{
|
|
|
|
public class ApiChecker
|
|
|
|
{
|
|
|
|
// <INSERT-OPENAPI-YAML-HASH>
|
2024-05-07 08:21:05 +00:00
|
|
|
private const string OpenApiYamlHash = "0F-C8-02-1E-2C-2C-15-F6-91-6A-01-31-11-49-95-06-79-26-25-BF-27-3C-A8-2E-5F-7F-34-FD-C0-57-A0-9A";
|
2024-03-26 13:42:47 +00:00
|
|
|
private const string OpenApiFilePath = "/codex/openapi.yaml";
|
|
|
|
private const string DisableEnvironmentVariable = "CODEXPLUGIN_DISABLE_APICHECK";
|
|
|
|
|
|
|
|
private const bool Disable = false;
|
|
|
|
|
|
|
|
private const string Warning =
|
|
|
|
"Warning: CodexPlugin was unable to find the openapi.yaml file in the Codex container. Are you running an old version of Codex? " +
|
|
|
|
"Plugin will continue as normal, but API compatibility is not guaranteed!";
|
|
|
|
|
|
|
|
private const string Failure =
|
|
|
|
"Codex API compatibility check failed! " +
|
|
|
|
"openapi.yaml used by CodexPlugin does not match openapi.yaml in Codex container. Please update the openapi.yaml in " +
|
|
|
|
"'ProjectPlugins/CodexPlugin' 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/CodexPlugin/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.");
|
|
|
|
}
|
|
|
|
|
2024-04-13 14:09:17 +00:00
|
|
|
public void CheckCompatibility(RunningPod[] containers)
|
2024-03-26 13:42:47 +00:00
|
|
|
{
|
|
|
|
if (checkPassed) return;
|
|
|
|
|
|
|
|
Log("CodexPlugin 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 containerApi = workflow.ExecuteCommand(container, "cat", OpenApiFilePath);
|
|
|
|
|
|
|
|
if (string.IsNullOrEmpty(containerApi))
|
|
|
|
{
|
|
|
|
log.Error(Warning);
|
|
|
|
|
|
|
|
checkPassed = true;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
var containerHash = Hash(containerApi);
|
|
|
|
if (containerHash == OpenApiYamlHash)
|
|
|
|
{
|
|
|
|
Log("API compatibility check passed.");
|
|
|
|
checkPassed = true;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
log.Error(Failure);
|
|
|
|
throw new Exception(Failure);
|
|
|
|
}
|
|
|
|
|
|
|
|
private string Hash(string file)
|
|
|
|
{
|
2024-03-26 15:10:50 +00:00
|
|
|
var fileBytes = Encoding.ASCII.GetBytes(file
|
|
|
|
.Replace(Environment.NewLine, ""));
|
2024-03-26 13:42:47 +00:00
|
|
|
var sha = SHA256.Create();
|
|
|
|
var hash = sha.ComputeHash(fileBytes);
|
|
|
|
return BitConverter.ToString(hash);
|
|
|
|
}
|
|
|
|
|
|
|
|
private void Log(string msg)
|
|
|
|
{
|
|
|
|
log.Log(msg);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|