Load any Submit resources without mentioning kind types and api group/versions #3336 #3744

vaidikcode · 2024-10-17T16:48:04Z

#3336 As described I tried to follow your approach and created a method to load and submit resources and then passed it on to the Api handler
I don't know where to mention the use case example-

public static void main(String[] args) throws Exception {

String yamlContent = "apiVersion: v1\n"
        + "kind: Pod\n"
        + "metadata:\n"
        + "  name: my-pod\n";


Object createdResource = Yaml.loadAndSubmitResource(yamlContent);


System.out.println(createdResource);

linux-foundation-easycla · 2024-10-17T16:48:10Z

The committers listed above are authorized under a signed CLA.

✅ login: vaidikcode / name: Vaidik (b218eb4)

k8s-ci-robot · 2024-10-17T16:48:13Z

Welcome @vaidikcode!

It looks like this is your first PR to kubernetes-client/java 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/java has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

yue9944882 · 2024-10-17T17:18:19Z

@vaidikcode thank you for the contribution. the Yaml.java file where the change is proposed is designed/dedicated for yaml content [de]serialization. i think a better place to bring this enhancement in is the Kubectl related utilities under the dynamic package e.g.:

https://github.com/kubernetes-client/java/blob/master/util/src/main/java/io/kubernetes/client/util/generic/dynamic/Dynamics.java#L44-L54

We can add a short-cut util function under Dynamics probably named createFromYaml to achieve that functionality, wdyt?

vaidikcode · 2024-10-17T19:19:28Z

@yue9944882 Yes, I think it would be much better. Can you elaborate on how I can do this? Can you also tell me if I need to include an example code to use this method, and if yes, please tell me where to include the example code.

brendandburns · 2024-10-18T15:51:10Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

-import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
+import java.util.*;


Remove wildcard imports.

brendandburns · 2024-10-18T15:51:46Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

+   * @return An instantiation of the object.
+   * @throws IOException If an error occurs while reading the YAML.
+   */
+  public static Object loadAndSubmitResource(String content) throws Exception {


It's more flexible to load from a Reader rather than a String you can always create a StringReader

brendandburns · 2024-10-18T15:52:52Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

+    //loading yaml content as unstructured object
+    Object unstructuredObject = Yaml.load(new StringReader(content));
+
+    if (!(unstructuredObject instanceof Map)) {


fwiw, this will only work for single-instance YAML files, if people put multiple objects in a single file, it will fail. That's fine for a starting point, but you may want to document it somewhere.

brendandburns · 2024-10-18T15:53:19Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

+    Object unstructuredObject = Yaml.load(new StringReader(content));
+
+    if (!(unstructuredObject instanceof Map)) {
+      throw new IllegalArgumentException("Invalid YAML");


I think ParseException might be more appropriate? (here and below)

brendandburns · 2024-10-18T15:54:13Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

+    String version;
+
+    // If apiVersion contains '/', then it means there is a specified group for it and we need to get that else it is a default group
+    if (apiVersion.contains("/")) {


This code is already present here:

java/util/src/main/java/io/kubernetes/client/apimachinery/GroupVersion.java

Line 25 in f9c82f3

public static GroupVersion parse(String apiVersion) {

Let's re-use that instead of reimplementing.

brendandburns · 2024-10-18T15:55:26Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

+      version = apiVersion;
+    }
+
+    //creating resource plurals from kind


Consider using the Discovery class here instead

java/util/src/main/java/io/kubernetes/client/Discovery.java

Line 37 in f9c82f3

public class Discovery {

brendandburns · 2024-10-18T15:56:29Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

+    String resourcePlural = kind.toLowerCase(Locale.ROOT) + "s";  // Simplistic pluralization logic
+
+    //getting the strongly typed object from model mapper
+    Class<?> modelClass = ModelMapper.getApiTypeClass(group, version, kind);


I think you can say Class<? implements KubernetesObject> here?

brendandburns · 2024-10-18T15:57:24Z

Some style comments. Generally this code looks good to me.

Please add unit tests.

vaidikcode · 2024-10-21T06:21:12Z

@brendandburns I've made the changes to the code and added unit tests, just as you suggested.

brendandburns · 2024-10-22T16:11:29Z

@vaidikcode looks good to me. I agree with @yue9944882 that this is a better fit for KubectlCreate.java but otherwise ready to merge once you move it there.

brendandburns · 2024-10-22T16:12:52Z

Alternately, feel free to keep the loader code in Yaml.java but move the create code to KubectlCreate

brendandburns · 2024-10-23T23:08:08Z

extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlCreate.java

+    // Finding the resource in the discovery class
+    Set<Discovery.APIResource> resources = discovery.findAll();
+    Optional<Discovery.APIResource> apiResource = resources.stream()
+            .filter(r -> r.getKind().equalsIgnoreCase(kind))


You need to check group/version here also. There are a few Kinds which are duplicates in several different api groups :(

See #3668 (comment)

Core.V1Event vs Events.V1Event

brendandburns · 2024-10-23T23:12:44Z

util/src/main/java/io/kubernetes/client/util/Yaml.java

@@ -342,27 +342,27 @@ protected MappingNode representJavaBean(Set<Property> properties, Object javaBea
      node.setTag(Tag.MAP);
      // Sort the output of our map so that we put certain keys, such as apiVersion, first.
      Collections.sort(
-          node.getValue(),


I think these are all whitespace changes. please revert.

brendandburns · 2024-10-23T23:13:38Z

Thanks for the update. One change is required for places where kind is the same across multiple API types. Also request to revert whitespace only changes on yaml.java

Thanks for the patience!

k8s-ci-robot · 2024-10-24T01:15:39Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: vaidikcode

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot requested review from brendandburns and yue9944882 October 17, 2024 16:48

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 17, 2024

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 17, 2024

brendandburns reviewed Oct 18, 2024

View reviewed changes

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 19, 2024

brendandburns reviewed Oct 23, 2024

View reviewed changes

vaidikcode force-pushed the master branch 4 times, most recently from 4a0dde2 to b218eb4 Compare October 24, 2024 01:15

vaidikcode closed this Oct 24, 2024

vaidikcode force-pushed the master branch from b218eb4 to f9c82f3 Compare October 24, 2024 01:15

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load any Submit resources without mentioning kind types and api group/versions #3336 #3744

Load any Submit resources without mentioning kind types and api group/versions #3336 #3744

vaidikcode commented Oct 17, 2024

linux-foundation-easycla bot commented Oct 17, 2024 •

edited

Loading

k8s-ci-robot commented Oct 17, 2024

yue9944882 commented Oct 17, 2024

vaidikcode commented Oct 17, 2024

brendandburns Oct 18, 2024

brendandburns Oct 18, 2024

brendandburns Oct 18, 2024

brendandburns Oct 18, 2024

brendandburns Oct 18, 2024

brendandburns Oct 18, 2024

brendandburns Oct 18, 2024

brendandburns commented Oct 18, 2024

vaidikcode commented Oct 21, 2024

brendandburns commented Oct 22, 2024

brendandburns commented Oct 22, 2024

brendandburns Oct 23, 2024

brendandburns Oct 23, 2024

brendandburns Oct 23, 2024

brendandburns commented Oct 23, 2024

k8s-ci-robot commented Oct 24, 2024

Load any Submit resources without mentioning kind types and api group/versions #3336 #3744

Load any Submit resources without mentioning kind types and api group/versions #3336 #3744

Conversation

vaidikcode commented Oct 17, 2024

linux-foundation-easycla bot commented Oct 17, 2024 • edited Loading

k8s-ci-robot commented Oct 17, 2024

yue9944882 commented Oct 17, 2024

vaidikcode commented Oct 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brendandburns commented Oct 18, 2024

vaidikcode commented Oct 21, 2024

brendandburns commented Oct 22, 2024

brendandburns commented Oct 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brendandburns commented Oct 23, 2024

k8s-ci-robot commented Oct 24, 2024

linux-foundation-easycla bot commented Oct 17, 2024 •

edited

Loading