Schema Generation for nested yml configurations

plugin/src/main/java/io/jenkins/plugins/casc/Attribute.java

@@ -61,6 +61,7 @@ public class Attribute<Owner, Type> {
     private Setter<Owner, Type> setter;
     private Getter<Owner, Type> getter;
     private boolean secret;
+    private boolean isJsonSchema;
 
     private boolean deprecated;
 
@@ -111,6 +112,14 @@ public Class<? extends AccessRestriction>[] getRestrictions() {
         return restrictions != null ? restrictions : EMPTY;
     }
 
+    /**
+     * Set jsonSchema is used to tell the describe function to call the describe structure
+     * so that it supports and returns a nested structure
+     */
+    public void setJsonSchema(boolean jsonSchema) {
+        isJsonSchema = jsonSchema;
+    }
+
     public boolean isRestricted() {
         return restrictions != null && restrictions.length > 0;
     }
@@ -225,18 +234,29 @@ public CNode describe(Owner instance, ConfigurationContext context) throws Confi
                     ": No configurator found for type " + type);
         }
         try {
-            Object o = getValue(instance);
-            if (o == null) {
-                return null;
+            Object o;
+            if(isJsonSchema) {
+                 o = getType();
+                if (o == null) {
+                    return null;
+                }
+            } else {
+                 o = getValue(instance);
+                if (o == null) {
+                    return null;
+                }
             }
 
             // In Export we sensitive only those values which do not get rendered as secrets
             boolean shouldBeMasked = isSecret(instance);
             if (multiple) {
                 Sequence seq = new Sequence();
                 if (o.getClass().isArray()) o = Arrays.asList((Object[]) o);
-                for (Object value : (Iterable) o) {
-                    seq.add(_describe(c, context, value, shouldBeMasked));
+                if(o instanceof Iterable) {
+                    System.out.println("This is iterable");
+                    for (Object value : (Iterable) o) {
+                        seq.add(_describe(c, context, value, shouldBeMasked));
+                    }
                 }
                 return seq;
             }
@@ -249,6 +269,51 @@ public CNode describe(Owner instance, ConfigurationContext context) throws Confi
         }
     }
 
+
+    /**
+     * This function is for the JSONSchemaGeneration
+     * @param instance
+     * @param context
+     * @return
+     */
+    public CNode describeStructure(Owner instance, ConfigurationContext context) {
+
+        final Configurator c = context.lookup(type);
+        if (c == null) {
+            return new Scalar("FAILED TO EXPORT\n" + instance.getClass().getName()+"#"+name +
+                ": No configurator found for type " + type);
+        }
+        try {
+            Object o = new Object();
+            if(isJsonSchema) {
+                o = getType();
+                if (o == null) {
+                    return null;
+                }
+            }
+
+            // In Export we sensitive only those values which do not get rendered as secrets
+            boolean shouldBeMasked = isSecret(instance);
+            if (multiple) {
+                Sequence seq = new Sequence();
+                if (o.getClass().isArray()) o = Arrays.asList((Object[]) o);
+                if(o instanceof Iterable) {
+                    for (Object value : (Iterable) o) {
+                        seq.add(_describe(c, context, value, shouldBeMasked));
+                    }
+                }
+                return seq;
+            }
+            return _describe(c, context, o, shouldBeMasked);
+        } catch (Exception | /* Jenkins.getDescriptorOrDie */AssertionError e) {
+            // Don't fail the whole export, prefer logging this error
+            LOGGER.log(Level.WARNING, "Failed to export", e);
+            return new Scalar("FAILED TO EXPORT\n" + instance.getClass().getName() + "#" + name + ": "
+                + printThrowable(e));
+        }
+    }
+
+
     /**
      * Describes a node.
      * @param c Configurator
@@ -261,7 +326,12 @@ public CNode describe(Owner instance, ConfigurationContext context) throws Confi
      */
     private CNode _describe(Configurator c, ConfigurationContext context, Object value, boolean shouldBeMasked)
             throws Exception {
-        CNode node = c.describe(value, context);
+        CNode node;
+        if(isJsonSchema) {
+            node = c.describeStructure(value, context);
+        } else {
+            node = c.describe(value, context);
+        }
         if (shouldBeMasked && node instanceof Scalar) {
             ((Scalar)node).sensitive(true);
         }

plugin/src/main/java/io/jenkins/plugins/casc/ConfigurationContext.java

@@ -30,6 +30,8 @@ public class ConfigurationContext implements ConfiguratorRegistry {
 
     private transient final ConfiguratorRegistry registry;
 
+    private String mode;
+
     public ConfigurationContext(ConfiguratorRegistry registry) {
         this.registry = registry;
     }
@@ -62,6 +64,15 @@ public void setUnknown(Unknown unknown) {
         this.unknown = unknown;
     }
 
+    public String getMode() {
+        return mode;
+    }
+
+    public void setMode(String mode) {
+        this.mode = mode;
+    }
+
+
 
     // --- delegate methods for ConfigurationContext
 

plugin/src/main/java/io/jenkins/plugins/casc/Configurator.java

@@ -34,6 +34,7 @@
 import org.apache.commons.lang.StringUtils;
 import org.jenkinsci.Symbol;
 
+
 /**
  * Define a {@link Configurator} which handles a configuration element, identified by name.
  * @author <a href="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
@@ -167,4 +168,20 @@ default CNode describe(T instance, ConfigurationContext context) throws Exceptio
         return mapping;
     }
 
+    @CheckForNull
+    default CNode describeStructure(T instance, ConfigurationContext context)
+        throws Exception {
+        Mapping mapping = new Mapping();
+        for (Attribute attribute : getAttributes()) {
+            if(context.getMode().equals("JSONSchema")) {
+                attribute.setJsonSchema(true);
+            }
+            CNode value = attribute.describeStructure(instance, context);
+            if (value != null) {
+                mapping.put(attribute.getName(), attribute.getType().getSimpleName());
+            }
+        }
+        return mapping;
+    }
+
 }

plugin/src/main/java/io/jenkins/plugins/casc/SchemaGeneration.java

@@ -4,7 +4,11 @@
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
+import io.jenkins.plugins.casc.impl.DefaultConfiguratorRegistry;
+import io.jenkins.plugins.casc.impl.configurators.DataBoundConfigurator;
 import io.jenkins.plugins.casc.impl.configurators.HeteroDescribableConfigurator;
+import io.jenkins.plugins.casc.model.CNode;
+import io.jenkins.plugins.casc.model.Mapping;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.LinkedHashSet;
@@ -36,14 +40,15 @@ public static JSONObject generateSchema() {
          * Iterates over the base configurators and adds them to the schema.
          */
         JSONObject schemaConfiguratorObjects = new JSONObject();
-        ConfigurationAsCode configurationAsCode = ConfigurationAsCode.get();
-        for (Object configuratorObject : configurationAsCode.getConfigurators()) {
+        ConfigurationAsCode configurationAsCodeObject = ConfigurationAsCode.get();
+        for (Object configuratorObject : configurationAsCodeObject.getConfigurators()) {
             if (configuratorObject instanceof BaseConfigurator) {
                 BaseConfigurator baseConfigurator = (BaseConfigurator) configuratorObject;
                 List<Attribute> baseConfigAttributeList = baseConfigurator.getAttributes();
+
                 if (baseConfigAttributeList.size() == 0) {
                     schemaConfiguratorObjects
-                        .put(((BaseConfigurator) configuratorObject).getTarget().getSimpleName().toLowerCase(),
+                        .put(baseConfigurator.getName().toLowerCase(),
                             new JSONObject()
                                 .put("type", "object")
                                 .put("properties", new JSONObject()));
@@ -132,6 +137,10 @@ private static JSONObject generateNonEnumAttributeObject(Attribute attribute) {
                 attributeType.put("type", "integer");
                 break;
 
+            case "hudson.Secret":
+                attributeType.put("type", "string");
+                break;
+
             case "java.lang.Long":
                 attributeType.put("type", "integer");
                 break;
@@ -154,6 +163,7 @@ private static JSONObject generateRootConfiguratorObject() {
             RootElementConfigurator rootElementConfigurator = i.next();
             rootConfiguratorObject
                 .put(rootElementConfigurator.getName(), new JSONObject().put("type", "object"));
+            System.out.println("root Name" + rootElementConfigurator.getName());
         }
         return rootConfiguratorObject;
     }
@@ -187,5 +197,50 @@ private static void generateEnumAttributeSchema(JSONObject attributeSchemaTempla
                     .put("enum", new JSONArray(attributeList)));
         }
     }
+
+    public static void rootConfigGeneration() throws Exception {
+        DefaultConfiguratorRegistry registry = new DefaultConfiguratorRegistry();
+        final ConfigurationContext context = new ConfigurationContext(registry);
+        context.setMode("JSONSchema");
+        for (RootElementConfigurator root : RootElementConfigurator.all()) {
+            final CNode config = root.describeStructure(root.getTargetComponent(context), context);
+            final Mapping mapping = config.asMapping();
+            final List<Map.Entry<String, CNode>> entries = new ArrayList<>(mapping.entrySet());
+            for (Map.Entry<String, CNode> entry : entries) {
+                System.out.println(entry.getKey());
+            }
+            System.out.println("End of an iteration of configurators");
+        }
+    }
+
+    public static void storeConfiguratorNames() {
+        ConfigurationAsCode configurationAsCodeObject = ConfigurationAsCode.get();
+        for (Object configuratorObject : configurationAsCodeObject.getConfigurators()) {
+            if (configuratorObject instanceof BaseConfigurator) {
+                BaseConfigurator baseConfigurator = (BaseConfigurator) configuratorObject;
+                List<Attribute> baseConfigAttributeList = baseConfigurator.getAttributes();
+                for (Attribute attribute : baseConfigAttributeList) {
+                    if (attribute.multiple) {
+                        System.out.println(
+                            "This is a multiple attribute " + attribute.getType() + " " + attribute
+                                .getName());
+                    } else {
+                        if (attribute.type.isEnum()) {
+                            System.out.println("This is an enumeration attribute: ");
+                            if (attribute.type.getEnumConstants().length != 0) {
+                                System.out.println("Printing Enumeration constants for: " + attribute.getName());
+                                for (Object obj : attribute.type.getEnumConstants()) {
+                                    System.out.println("EConstant : " + obj.toString());
+                                }
+                            }
+                        }
+                    }
+                }
+            } else if (configuratorObject instanceof HeteroDescribableConfigurator) {
+                System.out.println("Instance of HeteroDescribable Configurator");
+            }
+        }
+    }
+
 }
 

plugin/src/main/java/io/jenkins/plugins/casc/impl/configurators/HeteroDescribableConfigurator.java

@@ -117,6 +117,7 @@ public CNode describe(T instance, ConfigurationContext context) {
                 }).getOrNull();
     }
 
+
     @SuppressWarnings("unused")
     public Map<String, Class<T>> getImplementors() {
         return getDescriptors()

plugin/src/main/java/io/jenkins/plugins/casc/impl/configurators/PrimitiveConfigurator.java

@@ -67,6 +67,7 @@ public CNode describe(Object instance, ConfigurationContext context) {
             return new Scalar(((Secret) instance).getEncryptedValue()).encrypted(true);
         }
         if (target.isEnum()) {
+            System.out.println(instance.getClass().getSimpleName());
             return new Scalar((Enum) instance);
         }