Add @Generated annotation to generated classes (opensearch-project#…

…1029) Signed-off-by: Thomas Farr <tsfarr@amazon.com> (cherry picked from commit 767c313)
Xtansia · Aug 30, 2024 · 3111457 · 3111457
1 parent 0a5372b
commit 3111457
Show file tree

Hide file tree

Showing 20 changed files with 140 additions and 62 deletions.
diff --git a/java-codegen/build.gradle.kts b/java-codegen/build.gradle.kts
@@ -56,7 +56,7 @@ java {
 }
 
 application {
-    mainClass.set("org.opensearch.client.codegen.Main")
+    mainClass.set("org.opensearch.client.codegen.CodeGenerator")
     applicationDefaultJvmArgs = listOf(
         "--add-exports", "jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
         "--add-exports", "jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",

diff --git a/...a/org/opensearch/client/codegen/Main.java → ...nsearch/client/codegen/CodeGenerator.java b/...a/org/opensearch/client/codegen/Main.java → ...nsearch/client/codegen/CodeGenerator.java
@@ -31,7 +31,7 @@
 import org.opensearch.client.codegen.model.SpecTransformer;
 import org.opensearch.client.codegen.openapi.OpenApiSpecification;
 
-public class Main {
+public class CodeGenerator {
     private static final Logger LOGGER = LogManager.getLogger();
     private static final OperationGroup.Matcher OPERATION_MATCHER = OperationGroup.matcher();
 

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/ArrayShape.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/ArrayShape.java
@@ -14,8 +14,8 @@
 public class ArrayShape extends ObjectShape {
     private final Field valueBodyField;
 
-    public ArrayShape(Namespace parent, String className, Type arrayType, String typedefName) {
-        super(parent, className, typedefName);
+    public ArrayShape(Namespace parent, String className, Type arrayType, String typedefName, String description) {
+        super(parent, className, typedefName, description);
         this.valueBodyField = new Field("_value_body", arrayType, true, "Response value.", null);
     }
 

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/EnumShape.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/EnumShape.java
@@ -11,16 +11,32 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import org.opensearch.client.codegen.utils.JavaClassKind;
 import org.opensearch.client.codegen.utils.Strings;
 
 public class EnumShape extends Shape {
     private final List<Variant> variants;
 
-    public EnumShape(Namespace parent, String className, List<Variant> variants, String typedefName) {
-        super(parent, className, typedefName);
+    public EnumShape(Namespace parent, String className, List<Variant> variants, String typedefName, String description) {
+        super(parent, className, typedefName, description);
         this.variants = variants;
     }
 
+    @Override
+    public JavaClassKind getClassKind() {
+        return JavaClassKind.Enum;
+    }
+
+    @Override
+    public Collection<Type> getAnnotations() {
+        return List.of(Types.Client.Json.JsonpDeserializable);
+    }
+
+    @Override
+    public Collection<Type> getImplementsTypes() {
+        return List.of(Types.Client.Json.JsonEnum);
+    }
+
     public Collection<Variant> getVariants() {
         return Collections.unmodifiableCollection(variants);
     }

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/Namespace.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/Namespace.java
@@ -19,7 +19,8 @@
 import org.opensearch.client.codegen.utils.Lists;
 import org.opensearch.client.codegen.utils.Strings;
 
-public class Namespace extends Shape {
+public class Namespace {
+    private final Namespace parent;
     private final String name;
     private final Map<String, Namespace> children = new TreeMap<>();
     private final Map<String, RequestShape> operations = new TreeMap<>();
@@ -30,7 +31,7 @@ public Namespace() {
     }
 
     private Namespace(Namespace parent, String name) {
-        super(parent, null, null);
+        this.parent = parent;
         this.name = name;
     }
 
@@ -43,7 +44,6 @@ public void addShape(Shape shape) {
         shapes.add(shape);
     }
 
-    @Override
     public String getPackageName() {
         return parent != null ? parent.getPackageName() + "." + getPackageNamePart() : "org.opensearch.client.opensearch";
     }
@@ -66,7 +66,6 @@ public Namespace child(@Nullable String name) {
         return grandChildName == null ? child : child.child(grandChildName);
     }
 
-    @Override
     public void render(ShapeRenderingContext ctx) throws RenderException {
         for (Namespace child : children.values()) {
             child.render(ctx.forSubDir(child.getPackageNamePart()));
@@ -87,10 +86,15 @@ private static class Client extends Shape {
         private final boolean async;
 
         private Client(Namespace parent, boolean async) {
-            super(parent, "OpenSearch" + Strings.toPascalCase(parent.name) + (async ? "Async" : "") + "Client", null);
+            super(parent, "OpenSearch" + Strings.toPascalCase(parent.name) + (async ? "Async" : "") + "Client", null, null);
             this.async = async;
         }
 
+        @Override
+        public Type getExtendsType() {
+            return Types.Client.ApiClient(Types.Client.Transport.OpenSearchTransport, getType());
+        }
+
         public String getName() {
             return parent.name;
         }

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/ObjectShape.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/ObjectShape.java
@@ -19,8 +19,8 @@ public class ObjectShape extends Shape {
     protected final Map<String, Field> bodyFields = new TreeMap<>();
     protected Field additionalPropertiesField;
 
-    public ObjectShape(Namespace parent, String className, String typedefName) {
-        super(parent, className, typedefName);
+    public ObjectShape(Namespace parent, String className, String typedefName, String description) {
+        super(parent, className, typedefName, description);
     }
 
     public void addBodyField(Field field) {

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/RequestShape.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/RequestShape.java
@@ -25,8 +25,6 @@
 public class RequestShape extends ObjectShape {
     @Nonnull
     private final OperationGroup operationGroup;
-    @Nullable
-    private final String description;
     @Nonnull
     private final Set<String> httpMethods = new HashSet<>();
     @Nonnull
@@ -39,9 +37,8 @@ public class RequestShape extends ObjectShape {
     private final Map<String, Field> fields = new TreeMap<>();
 
     public RequestShape(@Nonnull Namespace parent, @Nonnull OperationGroup operationGroup, @Nullable String description) {
-        super(parent, requestClassName(operationGroup), operationGroup + ".Request");
+        super(parent, requestClassName(operationGroup), operationGroup + ".Request", description);
         this.operationGroup = operationGroup;
-        this.description = description;
     }
 
     @Nonnull
@@ -53,11 +50,6 @@ public String getId() {
         return operationGroup.getName();
     }
 
-    @Nullable
-    public String getDescription() {
-        return description;
-    }
-
     public String getHttpMethod() {
         return Streams.sortedBy(httpMethods.stream(), m -> {
             switch (m) {

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/Shape.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/Shape.java
@@ -8,32 +8,29 @@
 
 package org.opensearch.client.codegen.model;
 
+import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 import java.util.TreeSet;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.client.codegen.exceptions.RenderException;
+import org.opensearch.client.codegen.utils.JavaClassKind;
 
 public abstract class Shape {
     private static final Logger LOGGER = LogManager.getLogger();
     protected final Namespace parent;
     private final String className;
     private final Set<Type> referencedTypes = new HashSet<>();
     private final String typedefName;
+    private final String description;
 
-    public Shape(Namespace parent, String className, String typedefName) {
+    public Shape(Namespace parent, String className, String typedefName, String description) {
         this.parent = parent;
         this.className = className;
         this.typedefName = typedefName;
-    }
-
-    public Type getType() {
-        return Type.builder().pkg(getPackageName()).name(className).build();
-    }
-
-    public Namespace getParent() {
-        return this.parent;
+        this.description = description;
     }
 
     public String getPackageName() {
@@ -44,10 +41,38 @@ public String getClassName() {
         return this.className;
     }
 
+    public JavaClassKind getClassKind() {
+        return JavaClassKind.Class;
+    }
+
     public String getTypedefName() {
         return this.typedefName;
     }
 
+    public String getDescription() {
+        return this.description;
+    }
+
+    public Collection<Type> getAnnotations() {
+        return Collections.emptyList();
+    }
+
+    public Type getExtendsType() {
+        return null;
+    }
+
+    public Collection<Type> getImplementsTypes() {
+        return Collections.emptyList();
+    }
+
+    public Type getType() {
+        return Type.builder().pkg(getPackageName()).name(className).build();
+    }
+
+    public Namespace getParent() {
+        return this.parent;
+    }
+
     public void render(ShapeRenderingContext ctx) throws RenderException {
         var outFile = ctx.getOutputFile(className + ".java");
         LOGGER.info("Rendering: {}", outFile);

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/SpecTransformer.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/SpecTransformer.java
@@ -231,16 +231,24 @@ private void visit(Namespace parent, String className, String typedefName, OpenA
 
         Shape shape;
 
+        var description = schema.getDescription().orElse(null);
+
         if (schema.isArray()) {
-            shape = new ArrayShape(parent, className, mapType(schema), typedefName);
+            shape = new ArrayShape(parent, className, mapType(schema), typedefName, description);
         } else if (schema.isObject() || schema.hasAllOf() || schema.equals(OpenApiSchema.ANONYMOUS_OBJECT)) {
-            var objShape = new ObjectShape(parent, className, typedefName);
+            var objShape = new ObjectShape(parent, className, typedefName, description);
             visitInto(schema, objShape);
             shape = objShape;
         } else if (schema.isString() && schema.hasEnums()) {
-            shape = new EnumShape(parent, className, Lists.map(schema.getEnums().orElseThrow(), EnumShape.Variant::new), typedefName);
+            shape = new EnumShape(
+                parent,
+                className,
+                Lists.map(schema.getEnums().orElseThrow(), EnumShape.Variant::new),
+                typedefName,
+                description
+            );
         } else if (schema.hasOneOf()) {
-            var taggedUnion = new TaggedUnionShape(parent, className, typedefName);
+            var taggedUnion = new TaggedUnionShape(parent, className, typedefName, description);
             schema.getOneOf().orElseThrow().forEach(s -> {
                 var title = s.getTitle()
                     .orElseThrow(() -> new IllegalStateException("oneOf variant [" + s.getPointer() + "] is missing a `title` tag"));

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/TaggedUnionShape.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/TaggedUnionShape.java
@@ -16,8 +16,8 @@
 public class TaggedUnionShape extends ObjectShape {
     private final List<Variant> variants = new ArrayList<>();
 
-    public TaggedUnionShape(Namespace parent, String className, String typedefName) {
-        super(parent, className, typedefName);
+    public TaggedUnionShape(Namespace parent, String className, String typedefName, String description) {
+        super(parent, className, typedefName, description);
     }
 
     public void addVariant(String name, Type type) {

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/Types.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/Types.java
@@ -112,13 +112,18 @@ public static final class Javax {
 
         public static final class Annotation {
             public static final String PACKAGE = Javax.PACKAGE + ".annotation";
+            public static final Type Generated = Type.builder().pkg(PACKAGE).name("Generated").build();
             public static final Type Nullable = Type.builder().pkg(PACKAGE).name("Nullable").build();
         }
     }
 
     public static final class Client {
         public static final String PACKAGE = "org.opensearch.client";
 
+        public static Type ApiClient(Type transport, Type client) {
+            return ApiClient.withGenericArgs(transport, client);
+        }
+
         public static final Type ApiClient = Type.builder().pkg(PACKAGE).name("ApiClient").build();
 
         public static final class Json {

diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/utils/JavaClassKind.java b/java-codegen/src/main/java/org/opensearch/client/codegen/utils/JavaClassKind.java
@@ -0,0 +1,33 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.client.codegen.utils;
+
+import java.util.Map;
+import javax.annotation.Nonnull;
+
+public enum JavaClassKind {
+    Class,
+    Enum;
+
+    private static final Map<String, JavaClassKind> VALUES = Maps.createLookupOf(values(), JavaClassKind::toString);
+
+    @Nonnull
+    public static JavaClassKind from(@Nonnull String kind) {
+        var value = VALUES.get(Strings.requireNonBlank(kind, "kind must not be blank"));
+        if (value == null) {
+            throw new IllegalArgumentException("Unknown kind: " + kind);
+        }
+        return value;
+    }
+
+    @Override
+    public String toString() {
+        return name().toLowerCase();
+    }
+}
diff --git a/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ArrayShape.mustache b/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ArrayShape.mustache
@@ -1,4 +1,4 @@
-{{>ObjectShape/ClassDeclaration}} {
+{{>Partials/ClassDeclaration}} {
     {{>ObjectShape/Fields}}
 
     // ---------------------------------------------------------------------------------------------

diff --git a/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/Client.mustache b/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/Client.mustache
@@ -1,4 +1,4 @@
-public class {{className}} extends {{TYPES.Client.ApiClient}}<{{TYPES.Client.Transport.OpenSearchTransport}}, {{className}}> {
+{{>Partials/ClassDeclaration}} {
     public {{className}}({{TYPES.Client.Transport.OpenSearchTransport}} transport) {
         super(transport, null);
     }

diff --git a/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/EnumShape.mustache b/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/EnumShape.mustache
@@ -1,12 +1,4 @@
-// typedef: {{typedefName}}
-
-{{#description}}
-/**
- * {{.}}
- */
-{{/description}}
-@{{TYPES.Client.Json.JsonpDeserializable}}
-public enum {{className}} implements {{TYPES.Client.Json.JsonEnum}} {
+{{>Partials/ClassDeclaration}} {
     {{#variants}}
     {{name}}({{#quoted}}{{wireName}}{{/quoted}}){{^-last}},{{/-last}}
     {{/variants}}

diff --git a/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ObjectShape.mustache b/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ObjectShape.mustache
@@ -1,4 +1,4 @@
-{{>ObjectShape/ClassDeclaration}} {
+{{>Partials/ClassDeclaration}} {
     {{>ObjectShape/Fields}}
 
     // ---------------------------------------------------------------------------------------------

diff --git a/...n/resources/org/opensearch/client/codegen/templates/ObjectShape/ClassDeclaration.mustache b/...n/resources/org/opensearch/client/codegen/templates/ObjectShape/ClassDeclaration.mustache
diff --git a/...main/resources/org/opensearch/client/codegen/templates/Partials/ClassDeclaration.mustache b/...main/resources/org/opensearch/client/codegen/templates/Partials/ClassDeclaration.mustache
@@ -0,0 +1,14 @@
+{{#typedefName}}
+// typedef: {{.}}
+
+{{/typedefName}}
+{{#description}}
+/**
+* {{.}}
+*/
+{{/description}}
+{{#annotations}}
+@{{.}}
+{{/annotations}}
+@{{TYPES.Javax.Annotation.Generated}}("org.opensearch.client.codegen.CodeGenerator")
+public {{classKind}} {{className}}{{#extendsType}} extends {{.}}{{/extendsType}}{{#implementsTypes}}{{#-first}} implements{{/-first}} {{.}}{{^-last}},{{/-last}}{{/implementsTypes}}
diff --git a/...-codegen/src/main/resources/org/opensearch/client/codegen/templates/RequestShape.mustache b/...-codegen/src/main/resources/org/opensearch/client/codegen/templates/RequestShape.mustache
@@ -1,4 +1,4 @@
-{{>ObjectShape/ClassDeclaration}} {
+{{>Partials/ClassDeclaration}} {
     {{#canBeSingleton}}
     public {{className}}() {}