Merge pull request #58 from tinyspeck/BUILD-3103_envInject_default

BUILD-3103 add required properties with default values for EnvInjectBuildWrapper
tinyspeck · Dec 30, 2022 · 58412f4 · 58412f4
2 parents 1cb0b09 + a08c557
commit 58412f4
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 2 deletions.
diff --git a/src/main/java/com/adq/jenkins/xmljobtodsl/dsl/strategies/custom/DSLEnvInjectStrategy.java b/src/main/java/com/adq/jenkins/xmljobtodsl/dsl/strategies/custom/DSLEnvInjectStrategy.java
@@ -0,0 +1,77 @@
+package com.adq.jenkins.xmljobtodsl.dsl.strategies.custom;
+
+import com.adq.jenkins.xmljobtodsl.dsl.strategies.DSLObjectStrategy;
+import com.adq.jenkins.xmljobtodsl.parsers.PropertyDescriptor;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+public class DSLEnvInjectStrategy extends DSLObjectStrategy {
+    private final String name;
+
+    private HashMap<String, String> expectedProperties = new HashMap<String, String>(){{
+        put("propertiesFilePath", "");
+        put("scriptFilePath", "");
+        put("scriptContent", "");
+        put("loadFilesFromMaster", "false");
+        put("secureGroovyScript", "");
+    }};
+
+    public DSLEnvInjectStrategy(int tabs, PropertyDescriptor propertyDescriptor, String name) {
+        this(tabs, propertyDescriptor, name, true);
+        addMissingProperties(propertyDescriptor);
+    }
+
+    public DSLEnvInjectStrategy(int tabs, PropertyDescriptor propertyDescriptor, String name, boolean shouldInitChildren) {
+        super(tabs, propertyDescriptor, name, shouldInitChildren);
+        this.name = name;
+        addMissingProperties(propertyDescriptor);
+    }
+
+    private void addMissingProperties(PropertyDescriptor propertyDescriptor){
+        // Make a copy of the properties that we can iterate over and remove elements as we go.
+        List<PropertyDescriptor> properties = new ArrayList<>();
+        properties.addAll(propertyDescriptor.getProperties());
+
+        for (HashMap.Entry<String, String> expectedProp : expectedProperties.entrySet()) {
+            boolean foundProperty = false;
+            int indexToRemove = 0;
+
+            for(PropertyDescriptor existingProp : properties){
+                if(existingProp.getName() == expectedProp.getKey()){
+                    foundProperty = true;
+                    indexToRemove = properties.indexOf(existingProp);
+                    break;
+                }
+            }
+
+            if(foundProperty){
+                properties.remove(indexToRemove);
+            } else {
+                PropertyDescriptor newChild = new PropertyDescriptor(
+                        expectedProp.getKey(),
+                        propertyDescriptor.getParent(),
+                        expectedProp.getValue(),
+                        null
+                );
+
+                propertyDescriptor.getProperties().add(newChild);
+
+        }
+
+            initChildren(propertyDescriptor);
+        }
+    }
+
+    @Override
+    public String toDSL() {
+        String childrenDSL = getChildrenDSL();
+
+        if (name != null) {
+            return replaceTabs(String.format(getSyntax("syntax.object_with_name"), name, childrenDSL), getTabs());
+        } else {
+            return replaceTabs(String.format(getSyntax("syntax.object"), childrenDSL), getTabs());
+        }
+    }
+}
diff --git a/src/main/resources/translator.properties b/src/main/resources/translator.properties
@@ -826,7 +826,7 @@ EnvInjectBuildWrapper = envInjectBuildWrapper
 EnvInjectBuildWrapper.type = OBJECT
 
 EnvInjectBuildWrapper.info = info
-EnvInjectBuildWrapper.info.type = OBJECT
+EnvInjectBuildWrapper.info.type = com.adq.jenkins.xmljobtodsl.dsl.strategies.custom.DSLEnvInjectStrategy
 
 propertiesContent = propertiesContent
 EnvInjectPasswordWrapper = envInjectPasswordWrapper
@@ -858,6 +858,7 @@ secureGroovyScript = secureGroovyScript
 secureGroovyScript.type = OBJECT
 
 secureGroovyScript.script = script
+secureGroovyScript.script.type = com.adq.jenkins.xmljobtodsl.dsl.strategies.custom.DSLMandatoryStringStrategy
 sandbox = sandbox
 
 info = INNER
@@ -937,7 +938,10 @@ makeExecutable = makeExecutable
 
 useWorkspaceAsHome = useWorkspaceAsHome
 
-propertiesFilePath = propertiesFile
+propertiesFilePath = propertiesFilePath
+scriptFilePath = scriptFilePath
+scriptContent = scriptContent
+
 
 au.com.rayh.XCodeBuilder = it / 'builders' / 'au.com.rayh.XCodeBuilder'
 au.com.rayh.XCodeBuilder.type = CONFIGURE