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

Improved namespace handling for manifest reporting #1423

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improved namespace handling for manifest reporting #1423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc7d719
Improved namespaced handling for manifest reporting
APErebus Jan 15, 2025
2d40386
Improve test coverage
APErebus Jan 15, 2025
ba39022
Add new KubernetesNamespaceResolver
APErebus Jan 16, 2025
bc3f571
Remove unused code
APErebus Jan 16, 2025
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
49 changes: 49 additions & 0 deletions source/Calamari.Tests/KubernetesFixtures/ApiResourceOutputParserTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
using System.Collections.Generic;
using Calamari.Kubernetes;
using FluentAssertions;
using NUnit.Framework;

namespace Calamari.Tests.KubernetesFixtures
{
[TestFixture]
public class ApiResourceOutputParserTests
{
[Test]
public void ShouldParseCorrectly()
{
List<string> outputLines = new List<string>
{
"NAME SHORTNAMES APIVERSION NAMESPACED KIND VERBS CATEGORIES",
"bindings v1 true Binding create ",
"componentstatuses cs v1 false ComponentStatus get,list ",
"configmaps cm v1 true ConfigMap create,delete,deletecollection,get,list,patch,update,watch ",
"endpoints ep v1 true Endpoints create,delete,deletecollection,get,list,patch,update,watch ",
"events ev v1 true Event create,delete,deletecollection,get,list,patch,update,watch ",
"limitranges limits v1 true LimitRange create,delete,deletecollection,get,list,patch,update,watch ",
"namespaces ns v1 false Namespace create,delete,get,list,patch,update,watch ",
"nodes no v1 false Node create,delete,deletecollection,get,list,patch,update,watch ",
"persistentvolumeclaims pvc v1 true PersistentVolumeClaim create,delete,deletecollection,get,list,patch,update,watch ",
"persistentvolumes pv v1 false PersistentVolume create,delete,deletecollection,get,list,patch,update,watch ",
"pods po v1 true Pod create,delete,deletecollection,get,list,patch,update,watch all",
"podtemplates v1 true PodTemplate create,delete,deletecollection,get,list,patch,update,watch ",
"replicationcontrollers rc v1 true ReplicationController create,delete,deletecollection,get,list,patch,update,watch all",
"resourcequotas quota v1 true ResourceQuota create,delete,deletecollection,get,list,patch,update,watch ",
"secrets v1 true Secret create,delete,deletecollection,get,list,patch,update,watch ",
"serviceaccounts sa v1 true ServiceAccount create,delete,deletecollection,get,list,patch,update,watch ",
"services svc v1 true Service create,delete,deletecollection,get,list,patch,update,watch all",
"mutatingwebhookconfigurations admissionregistration.k8s.io/v1 false MutatingWebhookConfiguration create,delete,deletecollection,get,list,patch,update,watch api-extensions",
"validatingadmissionpolicies admissionregistration.k8s.io/v1 false ValidatingAdmissionPolicy create,delete,deletecollection,get,list,patch,update,watch api-extensions",
"validatingadmissionpolicybindings admissionregistration.k8s.io/v1 false ValidatingAdmissionPolicyBinding create,delete,deletecollection,get,list,patch,update,watch api-extensions",
"validatingwebhookconfigurations admissionregistration.k8s.io/v1 false ValidatingWebhookConfiguration create,delete,deletecollection,get,list,patch,update,watch api-extensions",
"customresourcedefinitions crd,crds apiextensions.k8s.io/v1 false CustomResourceDefinition create,delete,deletecollection,get,list,patch,update,watch api-extensions",
"apiservices apiregistration.k8s.io/v1 false APIService create,delete,deletecollection,get,list,patch,update,watch api-extensions",
"controllerrevisions apps/v1 true ControllerRevision create,delete,deletecollection,get,list,patch,update,watch "
};

var parsedResult = ApiResourceOutputParser.ParseKubectlApiResourceOutput(outputLines);

parsedResult.Should()
.NotBeEmpty();
Comment on lines +45 to +46
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be worth asserting that the output is as expected - I'd be happy with a really cut down list compared to what you've got to save the typing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah yeah, I meant to do that. I think the original reason it was like this was I was using the test to debug and fix it... Good catch!

}
}
}
61 changes: 61 additions & 0 deletions source/Calamari.Tests/KubernetesFixtures/Builders/ApiResourcesScopeLookupBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
using System.Collections.Generic;
using Calamari.Kubernetes;
using Octopus.CoreUtilities.Extensions;

namespace Calamari.Tests.KubernetesFixtures.Builders
{
public class ApiResourcesScopeLookupBuilder
{
Dictionary<ApiResourceIdentifier, bool> namespacedResourcesLookup = new Dictionary<ApiResourceIdentifier, bool>();

public ApiResourcesScopeLookupBuilder WithNonNamespacedApiResource(ApiResourceIdentifier apiResourceIdentifier)
{
namespacedResourcesLookup.Add(apiResourceIdentifier, false);

return this;
}

public ApiResourcesScopeLookupBuilder WithNamespacedApiResource(ApiResourceIdentifier apiResourceIdentifier)
{
namespacedResourcesLookup.Add(apiResourceIdentifier, true);

return this;
}

public ApiResourcesScopeLookupBuilder WithoutApiResource(ApiResourceIdentifier apiResourceIdentifier)
{
if (namespacedResourcesLookup.ContainsKey(apiResourceIdentifier))
{
namespacedResourcesLookup.Remove(apiResourceIdentifier);
}

return this;
}

public ApiResourcesScopeLookupBuilder WithDefaults()
{
namespacedResourcesLookup.AddRangeUnique(ApiResourceScopeLookup.DefaultResourceScopeLookup);
return this;
}

public IApiResourceScopeLookup Build()
{
return new StubApiResourceScopeLookup(namespacedResourcesLookup);
}

class StubApiResourceScopeLookup : IApiResourceScopeLookup
{
readonly Dictionary<ApiResourceIdentifier, bool> lookup;

public StubApiResourceScopeLookup(Dictionary<ApiResourceIdentifier, bool> lookup)
{
this.lookup = lookup;
}

public bool TryGetIsNamespaceScoped(ApiResourceIdentifier apiResourceIdentifier, out bool isNamespaceScoped)
{
return lookup.TryGetValue(apiResourceIdentifier, out isNamespaceScoped);
}
}
}
}
160 changes: 160 additions & 0 deletions source/Calamari.Tests/KubernetesFixtures/KubernetesManifestNamespaceResolverTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
using System.IO;
using System.Linq;
using Calamari.Common.Plumbing.Variables;
using Calamari.Kubernetes;
using Calamari.Testing.Helpers;
using FluentAssertions;
using NSubstitute;
using NUnit.Framework;
using YamlDotNet.RepresentationModel;

namespace Calamari.Tests.KubernetesFixtures
{
[TestFixture]
public class KubernetesManifestNamespaceResolverTests
{
KubernetesManifestNamespaceResolver sut;
IApiResourceScopeLookup apiResourceScopeLookup;

[SetUp]
public void SetUp()
{
apiResourceScopeLookup = Substitute.For<IApiResourceScopeLookup>();
var memoryLog = new InMemoryLog();
sut = new KubernetesManifestNamespaceResolver(apiResourceScopeLookup, memoryLog);
}

[TestCaseSource(nameof(ResolveNamespaceTestData))]
public void ResolveNamespace_ShouldResolveExpectedNamespace(string yaml, bool isKnownResourceType, bool isNamespacedResourceType, CalamariVariables variables, string expectedNamespace)
{
// Arrange
apiResourceScopeLookup.TryGetIsNamespaceScoped(Arg.Any<ApiResourceIdentifier>(), out var outParam)
.Returns(ci =>
{
ci[1] = isNamespacedResourceType;
return isKnownResourceType;
});

var yamlStream = new YamlStream();
yamlStream.Load(new StringReader(yaml));
var rootNode = (YamlMappingNode)yamlStream.Documents.First().RootNode;


// Act
var @namespace = sut.ResolveNamespace(rootNode, variables ?? new CalamariVariables());

// Assert
@namespace.Should().Be(expectedNamespace);
}

public static object[] ResolveNamespaceTestData = {
//Namespaced resources
new TestCaseData(@"
metadata:
name: resource
namespace: ABC",
true,
true,
null,
"ABC"
).SetName("Known namespaced resource + namespace in manifest = Manifest namespace"),
new TestCaseData(@"
metadata:
name: resource",
true,
true,
new CalamariVariables
{
{SpecialVariables.Helm.Namespace, "DEF"}
},
"DEF"
).SetName("Known namespaced resource + namespace not in manifest + helm namespace variable = helm namespace"),
new TestCaseData(@"
metadata:
name: resource",
true,
true,
new CalamariVariables
{
{SpecialVariables.Namespace, "GHI"}
},
"GHI"
).SetName("Known namespaced resource + namespace not in manifest + namespace variable = variable namespace"),
new TestCaseData(@"
metadata:
name: resource",
true,
true,
null,
"default"
).SetName("Known namespaced resource + namespace not in manifest + no namespace variable = default namespace"),
new TestCaseData(@"
metadata:
name: resource
namespace: ABC123",
false, //unknown resource
true,
null,
"ABC123"
).SetName("Unknown namespaced resource + namespace in manifest = manifest namespace used"),
new TestCaseData(@"
metadata:
name: resource",
false, //unknown resource
true,
new CalamariVariables
{
{ SpecialVariables.Namespace, "GHI123" }
},
"GHI123"
).SetName("Unknown namespaced resource + namespace not in manifest + namespace variable = variable namespace"),
//Non-namespaced resources
new TestCaseData(@"
metadata:
name: resource
namespace: ABC",
true,
false, //non-namespaced
null,
null
).SetName("Known non-namespaced resource + namespace in manifest = null namespace"),
new TestCaseData(@"
metadata:
name: resource",
true,
false, //non-namespaced
null,
null
).SetName("Known non-namespaced resource + namespace not in manifest = null namespace"),
new TestCaseData(@"
metadata:
name: resource
namespace: ABC123",
false, //unknown resource
false, //non-namespaced
null,
"ABC123"
).SetName("Unknown non-namespaced resource + namespace in manifest = manifest namespace used"),
new TestCaseData(@"
metadata:
name: resource",
false, //unknown resource
false, //non-namespaced
null,
"default"
).SetName("Unknown non-namespaced resource + namespace not in manifest = default namespace"),
new TestCaseData(@"
metadata:
name: resource",
false, //unknown resource
false, //non-namespaced
new CalamariVariables
{
{ SpecialVariables.Namespace, "GHI123" }
},
"GHI123"
).SetName("Unknown non-namespaced resource + namespace not in manifest + namespace variable = variable namespace")

};
}
}
Loading