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

Add a common IKubernetesObject interface, expose type metadata (#152)

Browse Source 
* - Implement common interface across all Kubernetes elements
- Add ApiVersion, Kind and Group properties

* Add IKubernetesObject interface

* Regenerate code

* Fixup after rebase

* Fixes after rebase, make method names consistent
This commit is contained in:
Frederik Carlier
2018-05-03 07:04:47 +02:00
committed by Brendan Burns
parent 0f2832b86c
commit bf4a7040d4
8 changed files with 1203 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
gen/KubernetesWatchGenerator/IKubernetes.Watch.cs.template
View File

@@ -41,7 +41,7 @@ namespace k8s
/// <returns>
/// A <see cref="Task"/> which represents the asynchronous operation, and returns a new watcher.
/// </returns>
Task<Watcher<{{ClassName operation}}>> {{MethodName operation}}(
Task<Watcher<{{GetClassName operation}}>> {{GetMethodName operation}}(
{{#operation.actualParameters}}
{{#isRequired}}
{{GetDotNetType type name isRequired}} {{GetDotNetName name}},
@@ -53,7 +53,7 @@ namespace k8s
{{/isRequired}}
{{/operation.actualParameters}}
Dictionary<string, List<string>> customHeaders = null,
Action<WatchEventType, {{ClassName operation}}> onEvent = null,
Action<WatchEventType, {{GetClassName operation}}> onEvent = null,
Action<Exception> onError = null,
CancellationToken cancellationToken = default(CancellationToken));

6
gen/KubernetesWatchGenerator/Kubernetes.Watch.cs.template
View File

@@ -10,7 +10,7 @@ namespace k8s
{
{{#.}}
/// <inheritdoc>
public Task<Watcher<{{ClassName operation}}>> {{MethodName operation}}(
public Task<Watcher<{{GetClassName operation}}>> {{GetMethodName operation}}(
{{#operation.actualParameters}}
{{#isRequired}}
{{GetDotNetType type name isRequired}} {{GetDotNetName name}},
@@ -22,12 +22,12 @@ namespace k8s
{{/isRequired}}
{{/operation.actualParameters}}
Dictionary<string, List<string>> customHeaders = null,
Action<WatchEventType, {{ClassName operation}}> onEvent = null,
Action<WatchEventType, {{GetClassName operation}}> onEvent = null,
Action<Exception> onError = null,
CancellationToken cancellationToken = default(CancellationToken))
{
string path = $"{{GetPathExpression .}}";
return WatchObjectAsync<{{ClassName operation}}>(path: path, @continue: @continue, fieldSelector: fieldSelector, includeUninitialized: includeUninitialized, labelSelector: labelSelector, limit: limit, pretty: pretty, timeoutSeconds: timeoutSeconds, resourceVersion: resourceVersion, customHeaders: customHeaders, onEvent: onEvent, onError: onError, cancellationToken: cancellationToken);
return WatchObjectAsync<{{GetClassName operation}}>(path: path, @continue: @continue, fieldSelector: fieldSelector, includeUninitialized: includeUninitialized, labelSelector: labelSelector, limit: limit, pretty: pretty, timeoutSeconds: timeoutSeconds, resourceVersion: resourceVersion, customHeaders: customHeaders, onEvent: onEvent, onError: onError, cancellationToken: cancellationToken);
}
{{/.}}

10
gen/KubernetesWatchGenerator/KubernetesWatchGenerator.csproj
View File

@@ -3,9 +3,6 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp2.0</TargetFramework>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<LangVersion>latest</LangVersion>
</PropertyGroup>
@@ -16,10 +13,9 @@
</ItemGroup>
<ItemGroup>
<Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
</ItemGroup>
<ItemGroup>
<None Update="ModelExtensions.cs.template">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Update="Kubernetes.Watch.cs.template">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>

12
gen/KubernetesWatchGenerator/ModelExtensions.cs.template Normal file
View File

@@ -0,0 +1,12 @@
namespace k8s.Models
{
{{#.}}
public partial class {{GetClassName . }} : IKubernetesObject
{
public const string KubeApiVersion = "{{GetApiVersion . }}";
public const string KubeKind = "{{GetKind . }}";
public const string KubeGroup = "{{GetGroup . }}";
}
{{/.}}
}

160
gen/KubernetesWatchGenerator/Program.cs
View File

@@ -45,6 +45,19 @@ namespace KubernetesWatchGenerator
// Read the spec
var swagger = await SwaggerDocument.FromFileAsync(specPath);
// Register helpers used in the templating.
Helpers.Register(nameof(ToXmlDoc), ToXmlDoc);
Helpers.Register(nameof(GetClassName), GetClassName);
Helpers.Register(nameof(GetMethodName), GetMethodName);
Helpers.Register(nameof(GetDotNetName), GetDotNetName);
Helpers.Register(nameof(GetDotNetType), GetDotNetType);
Helpers.Register(nameof(GetPathExpression), GetPathExpression);
Helpers.Register(nameof(GetGroup), GetGroup);
Helpers.Register(nameof(GetApiVersion), GetApiVersion);
Helpers.Register(nameof(GetKind), GetKind);
// Generate the Watcher operations
// We skip operations where the name of the class in the C# client could not be determined correctly.
// That's usually because there are different version of the same object (e.g. for deployments).
Collection<string> blacklistedOperations = new Collection<string>()
@@ -62,17 +75,31 @@ namespace KubernetesWatchGenerator
&& o.Operation.ActualParameters.Any(p => p.Name == "name")
&& !blacklistedOperations.Contains(o.Operation.OperationId)).ToArray();
// Register helpers used in the templating.
Helpers.Register(nameof(ToXmlDoc), ToXmlDoc);
Helpers.Register(nameof(ClassName), ClassName);
Helpers.Register(nameof(MethodName), MethodName);
Helpers.Register(nameof(GetDotNetName), GetDotNetName);
Helpers.Register(nameof(GetDotNetType), GetDotNetType);
Helpers.Register(nameof(GetPathExpression), GetPathExpression);
// Render.
Render.FileToFile("IKubernetes.Watch.cs.template", watchOperations, $"{outputDirectory}IKubernetes.Watch.cs");
Render.FileToFile("Kubernetes.Watch.cs.template", watchOperations, $"{outputDirectory}Kubernetes.Watch.cs");
// Generate the interface declarations
var skippedTypes = new Collection<string>()
{
"V1beta1Deployment",
"V1beta1DeploymentList",
"V1beta1DeploymentRollback",
"V1beta1DeploymentRollback",
"V1beta1Scale",
"V1beta1PodSecurityPolicy",
"V1beta1PodSecurityPolicyList",
"V1WatchEvent",
};
var definitions = swagger.Definitions.Values
.Where(
d => d.ExtensionData != null
&& d.ExtensionData.ContainsKey("x-kubernetes-group-version-kind")
&& !skippedTypes.Contains(GetClassName(d)));
// Render.
Render.FileToFile("ModelExtensions.cs.template", definitions, $"{outputDirectory}ModelExtensions.cs");
}
static void ToXmlDoc(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
@@ -101,15 +128,82 @@ namespace KubernetesWatchGenerator
}
}
static void MethodName(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
static void GetClassName(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is SwaggerOperation)
{
context.Write(MethodName(arguments[0] as SwaggerOperation));
context.Write(GetClassName(arguments[0] as SwaggerOperation));
}
else if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is JsonSchema4)
{
context.Write(GetClassName(arguments[0] as JsonSchema4));
}
}
static string MethodName(SwaggerOperation watchOperation)
static string GetClassName(SwaggerOperation watchOperation)
{
var groupVersionKind = (Dictionary<string, object>)watchOperation.ExtensionData["x-kubernetes-group-version-kind"];
var group = (string)groupVersionKind["group"];
var kind = (string)groupVersionKind["kind"];
var version = (string)groupVersionKind["version"];
var className = $"{ToPascalCase(version)}{kind}";
return className;
}
private static string GetClassName(JsonSchema4 definition)
{
var groupVersionKindElements = (object[])definition.ExtensionData["x-kubernetes-group-version-kind"];
var groupVersionKind = (Dictionary<string, object>)groupVersionKindElements[0];
var group = groupVersionKind["group"] as string;
var version = groupVersionKind["version"] as string;
var kind = groupVersionKind["kind"] as string;
return $"{ToPascalCase(version)}{ToPascalCase(kind)}";
}
static void GetKind(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is JsonSchema4)
{
context.Write(GetKind(arguments[0] as JsonSchema4));
}
}
private static string GetKind(JsonSchema4 definition)
{
var groupVersionKindElements = (object[])definition.ExtensionData["x-kubernetes-group-version-kind"];
var groupVersionKind = (Dictionary<string, object>)groupVersionKindElements[0];
return groupVersionKind["kind"] as string;
}
static void GetGroup(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is JsonSchema4)
{
context.Write(GetGroup(arguments[0] as JsonSchema4));
}
}
private static string GetGroup(JsonSchema4 definition)
{
var groupVersionKindElements = (object[])definition.ExtensionData["x-kubernetes-group-version-kind"];
var groupVersionKind = (Dictionary<string, object>)groupVersionKindElements[0];
return groupVersionKind["group"] as string;
}
static void GetMethodName(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is SwaggerOperation)
{
context.Write(GetMethodName(arguments[0] as SwaggerOperation));
}
}
static string GetMethodName(SwaggerOperation watchOperation)
{
var tag = watchOperation.Tags[0];
tag = tag.Replace("_", string.Empty);
@@ -122,25 +216,6 @@ namespace KubernetesWatchGenerator
return methodName;
}
static void ClassName(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is SwaggerOperation)
{
context.Write(ClassName(arguments[0] as SwaggerOperation));
}
}
static string ClassName(SwaggerOperation watchOperation)
{
var groupVersionKind = (Dictionary<string, object>)watchOperation.ExtensionData["x-kubernetes-group-version-kind"];
var group = (string)groupVersionKind["group"];
var kind = (string)groupVersionKind["kind"];
var version = (string)groupVersionKind["version"];
var className = $"{ToPascalCase(version)}{kind}";
return className;
}
static void GetDotNetType(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is SwaggerParameter)
@@ -148,11 +223,11 @@ namespace KubernetesWatchGenerator
var parameter = arguments[0] as SwaggerParameter;
context.Write(GetDotNetType(parameter.Type, parameter.Name, parameter.IsRequired));
}
else if(arguments != null && arguments.Count > 2 && arguments[0] != null && arguments[1] != null && arguments[2] != null && arguments[0] is JsonObjectType && arguments[1] is string && arguments[2] is bool)
else if (arguments != null && arguments.Count > 2 && arguments[0] != null && arguments[1] != null && arguments[2] != null && arguments[0] is JsonObjectType && arguments[1] is string && arguments[2] is bool)
{
context.Write(GetDotNetType((JsonObjectType)arguments[0], (string)arguments[1], (bool)arguments[2]));
}
else if(arguments != null && arguments.Count > 0 && arguments[0] != null)
else if (arguments != null && arguments.Count > 0 && arguments[0] != null)
{
context.Write($"ERROR: Expected SwaggerParameter but got {arguments[0].GetType().FullName}");
}
@@ -243,8 +318,29 @@ namespace KubernetesWatchGenerator
return pathExpression;
}
static void GetApiVersion(RenderContext context, IList<object> arguments, IDictionary<string, object> options, RenderBlock fn, RenderBlock inverse)
{
if (arguments != null && arguments.Count > 0 && arguments[0] != null && arguments[0] is JsonSchema4)
{
context.Write(GetApiVersion(arguments[0] as JsonSchema4));
}
}
private static string GetApiVersion(JsonSchema4 definition)
{
var groupVersionKindElements = (object[])definition.ExtensionData["x-kubernetes-group-version-kind"];
var groupVersionKind = (Dictionary<string, object>)groupVersionKindElements[0];
return groupVersionKind["version"] as string;
}
private static string ToPascalCase(string name)
{
if (string.IsNullOrWhiteSpace(name))
{
return name;
}
return char.ToUpper(name[0]) + name.Substring(1);
}
}

36
src/KubernetesClient/IKubernetesObject.cs Normal file
View File

@@ -0,0 +1,36 @@
using Newtonsoft.Json;
namespace k8s
{
/// <summary>
/// Represents a generic Kubernetes object.
/// </summary>
/// <remarks>
/// You can use the <see cref="KubernetesObject"/> if you receive JSON from a Kubernetes API server but
/// are unsure which object the API server is about to return. You can parse the JSON as a <see cref="KubernetesObject"/>
/// and use the <see cref="ApiVersion"/> and <see cref="Kind"/> properties to get basic metadata about any Kubernetes object.
/// You can then
/// </remarks>
public interface IKubernetesObject
{
/// <summary>
/// Gets or sets aPIVersion defines the versioned schema of this
/// representation of an object. Servers should convert recognized
/// schemas to the latest internal value, and may reject unrecognized
/// values. More info:
/// https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
/// </summary>
[JsonProperty(PropertyName = "apiVersion")]
string ApiVersion { get; set; }
/// <summary>
/// Gets or sets kind is a string value representing the REST resource
/// this object represents. Servers may infer this from the endpoint
/// the client submits requests to. Cannot be updated. In CamelCase.
/// More info:
/// https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
/// </summary>
[JsonProperty(PropertyName = "kind")]
string Kind { get; set; }
}
}

2
src/KubernetesClient/KubernetesObject.cs
View File

@@ -11,7 +11,7 @@ namespace k8s
/// and use the <see cref="ApiVersion"/> and <see cref="Kind"/> properties to get basic metadata about any Kubernetes object.
/// You can then
/// </remarks>
public class KubernetesObject
public class KubernetesObject : IKubernetesObject
{
/// <summary>
/// Gets or sets aPIVersion defines the versioned schema of this

1018
src/KubernetesClient/generated/ModelExtensions.cs Normal file
View File

File diff suppressed because it is too large Load Diff