kubernetes-client/csharp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Metrics optional property (#474)

Browse Source 
* fix: timespan can be optional

* use one comment on properties
This commit is contained in:
Ludovic Alarcon
2020-08-11 00:51:59 +02:00
committed by GitHub
parent 4ea7c26f11
commit 2d5c7c0317
3 changed files with 33 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/KubernetesClient/NodeMetrics.cs
View File

@@ -19,7 +19,7 @@ namespace k8s.Models
/// The timestamp when metrics were collected.
/// </summary>
[JsonProperty(PropertyName = "timestamp")]
public DateTime Timestamp { get; set; }
public DateTime? Timestamp { get; set; }
/// <summary>
/// The interval from which metrics were collected.

2
src/KubernetesClient/PodMetrics.cs
View File

@@ -19,7 +19,7 @@ namespace k8s.Models
/// The timestamp when metrics were collected.
/// </summary>
[JsonProperty(PropertyName = "timestamp")]
public DateTime Timestamp { get; set; }
public DateTime? Timestamp { get; set; }
/// <summary>
/// The interval from which metrics were collected.

35
tests/KubernetesClient.Tests/Kubernetes.Metrics.Tests.cs
View File

@@ -10,13 +10,12 @@ namespace k8s.Tests
{
private readonly ITestOutputHelper testOutput;
// Copy / Paste from metrics server on minikube
// All payloads' response are Copy / Paste from metrics server on minikube
public const string NodeMetricsResponse = "{\n \"kind\": \"NodeMetricsList\",\n \"apiVersion\": \"metrics.k8s.io/v1beta1\",\n \"metadata\": {\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/nodes/\"\n },\n \"items\": [\n {\n \"metadata\": {\n \"name\": \"minikube\",\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/nodes/minikube\",\n \"creationTimestamp\": \"2020-07-28T20:01:05Z\"\n },\n \"timestamp\": \"2020-07-28T20:01:00Z\",\n \"window\": \"1m0s\",\n \"usage\": {\n \"cpu\": \"394m\",\n \"memory\": \"1948140Ki\"\n }\n }\n ]\n}";
// Copy / Paste from metrics server minikube
public const string OptionalPropertyNodeMetricsResponse = "{\n \"kind\": \"NodeMetricsList\",\n \"apiVersion\": \"metrics.k8s.io/v1beta1\",\n \"metadata\": {\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/nodes/\"\n },\n \"items\": [\n {\n \"metadata\": {\n \"name\": \"minikube\",\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/nodes/minikube\",\n \"creationTimestamp\": \"2020-07-28T20:01:05Z\"\n },\n \"timestamp\": null,\n \"window\": \"1m0s\",\n \"usage\": {\n \"cpu\": \"394m\",\n \"memory\": \"1948140Ki\"\n }\n }\n ]\n}";
public const string PodMetricsResponse = "{\n \"kind\": \"PodMetricsList\",\n \"apiVersion\": \"metrics.k8s.io/v1beta1\",\n \"metadata\": {\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/namespaces/default/pods/\"\n },\n \"items\": [\n {\n \"metadata\": {\n \"name\": \"dotnet-test-d4894bfbd-2q2dw\",\n \"namespace\": \"default\",\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/namespaces/default/pods/dotnet-test-d4894bfbd-2q2dw\",\n \"creationTimestamp\": \"2020-08-01T07:40:05Z\"\n },\n \"timestamp\": \"2020-08-01T07:40:00Z\",\n \"window\": \"1m0s\",\n \"containers\": [\n {\n \"name\": \"dotnet-test\",\n \"usage\": {\n \"cpu\": \"0\",\n \"memory\": \"14512Ki\"\n }\n }\n ]\n }\n ]\n}";
// Copy / Paste from metrics server minikube
public const string OptionalPropertyPodMetricsResponse = "{\n \"kind\": \"PodMetricsList\",\n \"apiVersion\": \"metrics.k8s.io/v1beta1\",\n \"metadata\": {\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/namespaces/default/pods/\"\n },\n \"items\": [\n {\n \"metadata\": {\n \"name\": \"dotnet-test-d4894bfbd-2q2dw\",\n \"namespace\": \"default\",\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/namespaces/default/pods/dotnet-test-d4894bfbd-2q2dw\",\n \"creationTimestamp\": \"2020-08-01T07:40:05Z\"\n },\n \"timestamp\": null,\n \"window\": \"1m0s\",\n \"containers\": [\n {\n \"name\": \"dotnet-test\",\n \"usage\": {\n \"cpu\": \"0\",\n \"memory\": \"14512Ki\"\n }\n }\n ]\n }\n ]\n}"; // Copy / Paste from metrics server minikube
public const string EmptyPodMetricsResponse = "{\n \"kind\": \"PodMetricsList\",\n \"apiVersion\": \"metrics.k8s.io/v1beta1\",\n \"metadata\": {\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/namespaces/empty/pods/\"\n },\n \"items\": []\n}";
// Copy / Paste from metrics server minikube
public const string NonExistingNamespaceResponse = "{\n \"kind\": \"PodMetricsList\",\n \"apiVersion\": \"metrics.k8s.io/v1beta1\",\n \"metadata\": {\n \"selfLink\": \"/apis/metrics.k8s.io/v1beta1/namespaces/nonexisting/pods/\"\n },\n \"items\": []\n}";
public const string DefaultNodeName = "minikube";
@@ -49,6 +48,20 @@ namespace k8s.Tests
}
}
[Fact(DisplayName = "Node metrics optionnal property")]
public async Task NodesMetricsOptionalProperty()
{
using (var server = new MockKubeApiServer(testOutput, resp: OptionalPropertyNodeMetricsResponse))
{
var client = new Kubernetes(new KubernetesClientConfiguration { Host = server.Uri.ToString() });
// Should not throw with timespan optional property
var exception = await Record.ExceptionAsync(async () => await client.GetKubernetesNodesMetricsAsync().ConfigureAwait(false)).ConfigureAwait(false);
Assert.Null(exception);
}
}
[Fact(DisplayName = "Pod metrics")]
public async Task PodsMetrics()
{
@@ -73,6 +86,20 @@ namespace k8s.Tests
}
}
[Fact(DisplayName = "Pod metrics optionnal property")]
public async Task PodsMetricsOptionalProperty()
{
using (var server = new MockKubeApiServer(testOutput, resp: OptionalPropertyPodMetricsResponse))
{
var client = new Kubernetes(new KubernetesClientConfiguration { Host = server.Uri.ToString() });
// Should not throw with timespan optional property
var exception = await Record.ExceptionAsync(async () => await client.GetKubernetesPodsMetricsAsync().ConfigureAwait(false)).ConfigureAwait(false);
Assert.Null(exception);
}
}
[Fact(DisplayName = "Pod metrics empty response")]
public async Task PodsMetricsEmptyResponse()
{