108 lines
4.0 KiB
C#
108 lines
4.0 KiB
C#
using Core;
|
|
using KubernetesWorkflow.Types;
|
|
using Logging;
|
|
using System.Security.Cryptography;
|
|
using System.Text;
|
|
using Utils;
|
|
|
|
namespace CodexPlugin
|
|
{
|
|
public class ApiChecker
|
|
{
|
|
// <INSERT-OPENAPI-YAML-HASH>
|
|
private const string OpenApiYamlHash = "D5-C3-18-71-E8-FF-8F-89-9C-6B-98-3C-F2-C2-D2-37-0A-9F-27-23-35-67-EA-F6-1F-F9-D5-C6-63-34-5A-92";
|
|
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. The openapi.yaml in " +
|
|
"'ProjectPlugins/CodexPlugin' 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/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.");
|
|
}
|
|
|
|
public void CheckCompatibility(RunningPod[] containers)
|
|
{
|
|
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;
|
|
}
|
|
|
|
OverwriteOpenApiYaml(containerApi);
|
|
|
|
log.Error(Failure);
|
|
throw new Exception(Failure);
|
|
}
|
|
|
|
private void OverwriteOpenApiYaml(string containerApi)
|
|
{
|
|
Log("API compatibility check failed. Updating CodexPlugin...");
|
|
var openApiFilePath = Path.Combine(PluginPathUtils.ProjectPluginsDir, "CodexPlugin", "openapi.yaml");
|
|
if (!File.Exists(openApiFilePath)) throw new Exception("Unable to locate CodexPlugin/openapi.yaml. Expected: " + openApiFilePath);
|
|
|
|
File.Delete(openApiFilePath);
|
|
File.WriteAllText(openApiFilePath, containerApi);
|
|
Log("CodexPlugin/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);
|
|
}
|
|
}
|
|
}
|