Skip to content

Commit

Permalink
PR Feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
@liam-mackie
liam-mackie committed Feb 13, 2025
1 parent 99e0f16 commit 1a28ce6
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 79 deletions.
136 changes: 63 additions & 73 deletions ...rnetes.Tests.Integration/KubernetesAgent/KubernetesAgentMigrateFromPreinstallationTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,37 @@ public class KubernetesAgentMigrateFromPreinstallationTest

readonly ISystemLog systemLog = new SystemLog();

const string SourceConfigMapName = "tentacle-config-pre";
const string SourceSecretName = "tentacle-secret-pre";
const string DestinationConfigMapName = "tentacle-config";
const string DestinationSecretName = "tentacle-secret";
MigratePreInstalledKubernetesDeploymentTargetCommand commandToRun;
KubernetesFileWrappedProvider kubernetesConfigClient;
string commandNamespace;
k8s.Kubernetes client;
string[] commandArguments;

[SetUp]
public void Init()
{
kubernetesConfigClient = new KubernetesFileWrappedProvider(KubernetesTestsGlobalContext.Instance.KubeConfigPath);
commandToRun = new MigratePreInstalledKubernetesDeploymentTargetCommand(new Lazy<IKubernetesClientConfigProvider>(kubernetesConfigClient), systemLog, new LogFileOnlyLogger());
commandNamespace = Guid.NewGuid().ToString("N");
Environment.SetEnvironmentVariable(KubernetesConfig.NamespaceVariableName, commandNamespace);
client = new k8s.Kubernetes(kubernetesConfigClient.Get());
commandArguments = [
$"--source-config-map-name={SourceConfigMapName}",
$"--source-secret-name={SourceSecretName}",
$"--destination-config-map-name={DestinationConfigMapName}",
$"--destination-secret-name={DestinationSecretName}",
$"--namespace={commandNamespace}"
];
}

[Test]
public async Task MigrationFromPreinstallHookShouldCopyData()
public async Task MigrationFromPreinstallHook_ShouldCopyData()
{
//Arrange
var kubernetesConfigClient = new KubernetesFileWrappedProvider(KubernetesTestsGlobalContext.Instance.KubeConfigPath);
var commandNamespace = Guid.NewGuid().ToString("N");
Environment.SetEnvironmentVariable(KubernetesConfig.NamespaceVariableName, commandNamespace);
var commandToRun = new MigratePreInstalledKubernetesDeploymentTargetCommand(new Lazy<IKubernetesClientConfigProvider>(kubernetesConfigClient), systemLog, new LogFileOnlyLogger());
var client = new k8s.Kubernetes(kubernetesConfigClient.Get());
var validationKey = Guid.NewGuid().ToString("N");
var sourceConfigMapData = new Dictionary<string, string>
{
Expand All @@ -31,57 +53,41 @@ public async Task MigrationFromPreinstallHookShouldCopyData()
};
var sourceSecretData = new Dictionary<string, string>
{
{"machine-iv", "testData"},
{"machine-key", validationKey}
{"validationKey", validationKey}
};
const string sourceConfigMapName = "tentacle-config-pre";
const string sourceSecretName = "tentacle-secret-pre";
const string destinationConfigMapName = "tentacle-config";
const string destinationSecretName = "tentacle-secret";


string[] commandArguments = [
$"--source-config-map-name={sourceConfigMapName}",
$"--source-secret-name={sourceSecretName}",
$"--destination-config-map-name={destinationConfigMapName}",
$"--destination-secret-name={destinationSecretName}",
$"--namespace={commandNamespace}"
];

//Act
await CreateCommandNamespace(client, commandNamespace);
// Namespace
await CreateCommandNamespace(commandNamespace);

//Sources
await CreateConfigmap(client, sourceConfigMapName, commandNamespace, sourceConfigMapData);
await CreateSecret(client, sourceSecretName, commandNamespace, sourceSecretData);
// Sources
await CreateConfigmap(SourceConfigMapName, commandNamespace, sourceConfigMapData);
await CreateSecret(SourceSecretName, commandNamespace, sourceSecretData);


// Targets
await CreateConfigmap(client, destinationConfigMapName, commandNamespace);
await CreateSecret(client, destinationSecretName, commandNamespace);
await CreateConfigmap(DestinationConfigMapName, commandNamespace);
await CreateSecret(DestinationSecretName, commandNamespace);



//Act
commandToRun.Start(commandArguments, new NoninteractiveHost(), []);

//Assert
var configMap = await client.CoreV1.ReadNamespacedConfigMapAsync(destinationConfigMapName, commandNamespace);
var secret = await client.CoreV1.ReadNamespacedSecretAsync(destinationSecretName, commandNamespace);
var configMap = await client.CoreV1.ReadNamespacedConfigMapAsync(DestinationConfigMapName, commandNamespace);
var secret = await client.CoreV1.ReadNamespacedSecretAsync(DestinationSecretName, commandNamespace);

configMap.Data.TryGetValue("validationKey", out var validationKeyFromKubernetes);
validationKeyFromKubernetes.Should().NotBeNull().And.Be(validationKey);
configMap.Data.TryGetValue("validationKey", out var validationKeyFromKubernetesConfigMap);
validationKeyFromKubernetesConfigMap.Should().Be(validationKey);

secret.Data.TryGetValue("machine-key", out var hostKeyFromKubernetes);
hostKeyFromKubernetes.Should().NotBeNull().And.Equal(Encoding.UTF8.GetBytes(validationKey));
secret.Data.TryGetValue("validationKey", out var validationKeyFromKubernetesSecret);
validationKeyFromKubernetesSecret.Should().Equal(Encoding.UTF8.GetBytes(validationKey));
}

[Test]
public async Task MigrationFromPreinstallHookShouldOnlyRunWhenNotRegistered()
public async Task MigrationFromPreinstallHook_ShouldNotRunWhenTentacleIsAlreadyRegistered()
{
//Arrange
var kubernetesConfigClient = new KubernetesFileWrappedProvider(KubernetesTestsGlobalContext.Instance.KubeConfigPath);
var commandNamespace = Guid.NewGuid().ToString("N");
Environment.SetEnvironmentVariable(KubernetesConfig.NamespaceVariableName, commandNamespace);
var commandToRun = new MigratePreInstalledKubernetesDeploymentTargetCommand(new Lazy<IKubernetesClientConfigProvider>(kubernetesConfigClient), systemLog, new LogFileOnlyLogger());
var client = new k8s.Kubernetes(kubernetesConfigClient.Get());
var validationKey = Guid.NewGuid().ToString("N");
var sourceConfigMapData = new Dictionary<string, string>
{
Expand All @@ -90,8 +96,7 @@ public async Task MigrationFromPreinstallHookShouldOnlyRunWhenNotRegistered()
};
var sourceSecretData = new Dictionary<string, string>
{
{"machine-iv", "testData"},
{"machine-key", validationKey}
{"validationKey", "should-not-be-here"}
};
var destinationConfigMapData = new Dictionary<string, string>
{
Expand All @@ -100,51 +105,36 @@ public async Task MigrationFromPreinstallHookShouldOnlyRunWhenNotRegistered()
};
var destinationSecretData = new Dictionary<string, string>
{
{"machine-iv", "testData"},
{"machine-key", validationKey}
{"validationKey", validationKey}
};


const string sourceConfigMapName = "tentacle-config-pre";
const string sourceSecretName = "tentacle-secret-pre";
const string destinationConfigMapName = "tentacle-config";
const string destinationSecretName = "tentacle-secret";


string[] commandArguments = [
$"--source-config-map-name={sourceConfigMapName}",
$"--source-secret-name={sourceSecretName}",
$"--destination-config-map-name={destinationConfigMapName}",
$"--destination-secret-name={destinationSecretName}",
$"--namespace={commandNamespace}"
];

//Act
await CreateCommandNamespace(client, commandNamespace);
// namespace
await CreateCommandNamespace(commandNamespace);

//Sources
await CreateConfigmap(client, sourceConfigMapName, commandNamespace, sourceConfigMapData);
await CreateSecret(client, sourceSecretName, commandNamespace, sourceSecretData);

await CreateConfigmap(SourceConfigMapName, commandNamespace, sourceConfigMapData);
await CreateSecret(SourceSecretName, commandNamespace, sourceSecretData);

// Targets
await CreateConfigmap(client, destinationConfigMapName, commandNamespace, destinationConfigMapData);
await CreateSecret(client, destinationSecretName, commandNamespace, destinationSecretData);
await CreateConfigmap(DestinationConfigMapName, commandNamespace, destinationConfigMapData);
await CreateSecret(DestinationSecretName, commandNamespace, destinationSecretData);


//Act
commandToRun.Start(commandArguments, new NoninteractiveHost(), []);

//Assert
var configMap = await client.CoreV1.ReadNamespacedConfigMapAsync(destinationConfigMapName, commandNamespace);
var secret = await client.CoreV1.ReadNamespacedSecretAsync(destinationSecretName, commandNamespace);
var configMap = await client.CoreV1.ReadNamespacedConfigMapAsync(DestinationConfigMapName, commandNamespace);
var secret = await client.CoreV1.ReadNamespacedSecretAsync(DestinationSecretName, commandNamespace);

configMap.Data.TryGetValue("validationKey", out var validationKeyFromKubernetes);
validationKeyFromKubernetes.Should().NotBeNull().And.Be(validationKey);
validationKeyFromKubernetes.Should().Be(validationKey);

secret.Data.TryGetValue("machine-key", out var hostKeyFromKubernetes);
hostKeyFromKubernetes.Should().NotBeNull().And.Equal(Encoding.UTF8.GetBytes(validationKey));
hostKeyFromKubernetes.Should().Equal(Encoding.UTF8.GetBytes(validationKey));
}

async Task CreateCommandNamespace(k8s.Kubernetes client, string name)
async Task CreateCommandNamespace(string name)
{
await client.CoreV1.CreateNamespaceAsync(new V1Namespace
{
Expand All @@ -155,7 +145,7 @@ await client.CoreV1.CreateNamespaceAsync(new V1Namespace
});
}

async Task<V1ConfigMap> CreateConfigmap(k8s.Kubernetes client, string name, string ns, Dictionary<string, string>? data = null)
async Task<V1ConfigMap> CreateConfigmap(string name, string ns, Dictionary<string, string>? data = null)
{
return await client.CoreV1.CreateNamespacedConfigMapAsync(new V1ConfigMap
{
Expand All @@ -167,7 +157,7 @@ async Task<V1ConfigMap> CreateConfigmap(k8s.Kubernetes client, string name, stri
}, ns);
}

async Task<V1Secret> CreateSecret(k8s.Kubernetes client, string name, string ns, Dictionary<string, string>? data = null)
async Task<V1Secret> CreateSecret(string name, string ns, Dictionary<string, string>? data = null)
{
return await client.CoreV1.CreateNamespacedSecretAsync(new V1Secret
{
Expand Down
2 changes: 1 addition & 1 deletion ...topus.Tentacle.Tests/Commands/MigratePreInstalledKubernetesDeploymentTargetCommandTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace Octopus.Tentacle.Tests.Commands
public class MigratePreInstalledKubernetesDeploymentTargetCommandFixture
{
[Test]
public void ShouldNotMigrate_ifNoSource()
public void ShouldNotMigrate_IfNoSource()
{
var targetConfigMap = Substitute.For<V1ConfigMap>();
var targetSecret = Substitute.For<V1Secret>();
Expand Down
9 changes: 4 additions & 5 deletions source/Octopus.Tentacle/Commands/MigratePreInstalledKubernetesDeploymentTargetCommand.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public MigratePreInstalledKubernetesDeploymentTargetCommand(Lazy<IKubernetesClie
}

// This command is only used as a way to programatically copy the config map and secret from the pre-installation hook to the new agent
// It does not access tentacle configuration so that it doesn't
// It does not use the IWritableTentacleConfiguration so we don't accidentally generate any new keys
protected override void Start()
{
if (!PlatformDetection.Kubernetes.IsRunningAsKubernetesAgent)
Expand All @@ -45,8 +45,7 @@ protected override void Start()
// Check that the sources and destinations are different
if (sourceSecretName == destinationSecretName || sourceConfigMapName == destinationConfigMapName)
{
log.Error("Source and destination names must be different.");
return;
throw new ControlledFailureException("Source and destination names must be different.");
}

var migrationNamespace = @namespace ?? KubernetesConfig.Namespace;
Expand Down Expand Up @@ -78,7 +77,7 @@ protected override void Start()
log.Info("Migration complete.");
}

public static (bool, string) ShouldMigrateData(V1ConfigMap? sourceConfigMap, V1Secret? sourceSecret, V1ConfigMap? destinationConfigMap, V1Secret? destinationSecret)
public static (bool ShouldMigrate, string Reason) ShouldMigrateData(V1ConfigMap? sourceConfigMap, V1Secret? sourceSecret, V1ConfigMap? destinationConfigMap, V1Secret? destinationSecret)
{
// Check that the sources exist
if (sourceConfigMap is null || sourceSecret is null)
Expand All @@ -102,7 +101,7 @@ public static (bool, string) ShouldMigrateData(V1ConfigMap? sourceConfigMap, V1S
return (true, string.Empty);
}

T? TryGetCoreV1Object<T>(Func<T> kubernetesFunc) where T : class
static T? TryGetCoreV1Object<T>(Func<T> kubernetesFunc) where T : class
{
try
{
Expand Down

0 comments on commit 1a28ce6

Please sign in to comment.