apn-app-manager 1.7.0 → 1.8.0

package/.idea/app-manager.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,20 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="DuplicateThrows" enabled="true" level="WARNING" enabled_by_default="true">
+      <scope name="Production" level="ERROR" enabled="true" />
+    </inspection_tool>
+    <inspection_tool class="LoggerInitializedWithForeignClass" enabled="false" level="WARNING" enabled_by_default="false">
+      <option name="loggerClassName" value="org.apache.log4j.Logger,org.slf4j.LoggerFactory,org.apache.commons.logging.LogFactory,java.util.logging.Logger" />
+      <option name="loggerFactoryMethodName" value="getLogger,getLogger,getLog,getLogger" />
+    </inspection_tool>
+    <inspection_tool class="OnDemandImport" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="RedundantThrows" enabled="true" level="WARNING" enabled_by_default="true">
+      <scope name="Production" level="ERROR" enabled="true" />
+    </inspection_tool>
+    <inspection_tool class="RedundantThrowsDeclaration" enabled="true" level="WARNING" enabled_by_default="true">
+      <scope name="Production" level="ERROR" enabled="true" />
+    </inspection_tool>
+    <inspection_tool class="UNUSED_IMPORT" enabled="true" level="ERROR" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/libraries/all_apps.xml

@@ -0,0 +1,9 @@
+<component name="libraryTable">
+  <library name="all apps">
+    <CLASSES>
+      <root url="jar://$PROJECT_DIR$/out/all apps.zip!/" />
+    </CLASSES>
+    <JAVADOC />
+    <SOURCES />
+  </library>
+</component>

package/.idea/libraries/app_manager.xml

@@ -0,0 +1,11 @@
+<component name="libraryTable">
+  <library name="app-manager">
+    <CLASSES>
+      <root url="jar://$PROJECT_DIR$/all apps.zip!/" />
+      <root url="jar://$PROJECT_DIR$/CT APP Clone Tester.zip!/" />
+      <root url="jar://$PROJECT_DIR$/IT i18n tobias.zip!/" />
+    </CLASSES>
+    <JAVADOC />
+    <SOURCES />
+  </library>
+</component>

package/.idea/libraries/appian_adm_import_client_2_5_17.xml

@@ -0,0 +1,9 @@
+<component name="libraryTable">
+  <library name="appian-adm-import-client-2.5.17">
+    <CLASSES>
+      <root url="jar://$PROJECT_DIR$/lib/aim/lib/appian-adm-import-client-2.5.17.jar!/" />
+    </CLASSES>
+    <JAVADOC />
+    <SOURCES />
+  </library>
+</component>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" project-jdk-name="temurin-1.8" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/app-manager.iml" filepath="$PROJECT_DIR$/.idea/app-manager.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/../.." vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -2,6 +2,8 @@
 
 `apn-app-manager` is a command line tool that ingests an Appian application zip file, makes changes to the underlying XML files, and outputs a new Appian application zip file. It currently supports cloning an application.
 
+Test beta version
+
 ## Why?
 
 When app building you may want to do things in bulk that are easiest to do via an application's exported XML files and a re-import. This tool helps to automate some of those tasks.
@@ -40,18 +42,21 @@ Used to duplicate all objects of an application, which replaces the namespace of
 1. Select `clone` for "What would you like to do?".
 1. Select your application zip.
 1. Select your import customization properties file, if you have one.
-1. Enter your current namespace.
-   - For example, an application with objects such as `SMP APP Artifacts` and `SMP_APP_displayUser` would have a namespace of `SMP_APP`
-1. Enter your new namespace.
-1. Do advanced options if necessary.
+1. Choose advanced options or not:
+   - Regular options:
+     1. Enter your current namespace.
+     1. Enter your new namespace.
+        - For example, an application with objects such as `SMP APP Artifacts` and `SMP_APP_displayUser` would have a namespace of `SMP_APP`
+        - Note that this tool can only clone objects of one namepsace at a time with regular options.
+   - Advanced options:
+     1. The tool will search through all object files and attempt to find every unique namespace, allowing you to specify cloning logic for each namepsace.
+     1. Database tables can be skipped during cloning.
 1. Access your cloned application in the generated `/out/` folder.
 
 #### Notes
 
 1. Always inspect your cloned zip before importing to verify that what will be imported matches what you'd expect.
 1. The cloning tool is idempotent meaning it will always return the same output zip run against the same input. This also means you can develop an application, clone it, then enhance the original application, re-clone it, and that second clone will deploy over the first clone with objects being recognized as "Changed" as if you had just modified the clone directly.
-1. It is recommended that all objects in your application have the same namespace (including objects that generally aren't prefixed such as applications, groups, process models, etc). Objects that do not match your entered namespace will not be cloned.
-   - If you have multiple namespaces across your objects, you can run the cloner tool recursively against the output package to account for each namespace.
 1. SQL files for your application are not supported for cloning at this time. SQL scripts will have to be adjusted manually to align with the cloned objects (i.e. changing table name references).
 1. There are two other document generated in the `/out/` folder after cloning:
    - `objects.json` - This contains every attribute of collected metadata from every object in the package, including its current value and new value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apn-app-manager",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Appian App Manager",
   "license": "Apache-2.0",
   "preferGlobal": true,

package/src/actions/cloneAction.js

@@ -19,55 +19,70 @@ const options = {
   renameDbTables: true,
 };
 
+const objectMaps = {};
+const uuidCollector = { uuids: [] };
+const namespaceCollector = {};
+
 // Entry-point
 function main(callback) {
   util.delFile(cons.outDir);
   fileSelect.getAppPackage(function (appZipPath) {
     util.unzipDir(appZipPath, cons.tempDir);
     fileSelect.selectSingleFile("Select import customization properties file", ["properties"], true, function (icfPath) {
-      promptNamespace("What is your current namespace?", function (curNamespace) {
-        promptNamespace("What is your new namespace?", function (newNamespace) {
-          const namespaceMap = {};
-          namespaceMap[curNamespace] = { newNamespace: newNamespace };
-          prompt.promptList("Advanced options?", ["No", "Yes"], function (enhancedOptions) {
-            if (enhancedOptions == "Yes") {
-              prompt.promptList("Rename database tables?", ["Yes", "No"], function (renameDbTables) {
-                options["renameDbTables"] = renameDbTables == "Yes";
-                executeClone(appZipPath, icfPath, namespaceMap, options, callback);
-              });
-            } else {
-              executeClone(appZipPath, icfPath, namespaceMap, options, callback);
-            }
+      prompt.promptList("Advanced options?", ["No", "Yes"], function (enhancedOptions) {
+        if (enhancedOptions == "Yes") {
+          promptAdvancedOptions(appZipPath, icfPath, executeClone(appZipPath, icfPath, callback));
+        } else {
+          promptNamespace("What is your current namespace?", function (curNamespace) {
+            promptNamespace("What is your new namespace?", function (newNamespace) {
+              namespaceCollector[curNamespace] = { newNamespace: newNamespace };
+              executeClone(appZipPath, icfPath, callback);
+            });
           });
-        });
+        }
       });
     });
   });
 }
 
+// Handles the advanced options menu
+function promptAdvancedOptions(appZipPath, icfPath, callback) {
+  // Extract the metadata including the namespace from each object file
+  util.print(`Collecting all metadata from the objects...`);
+  obExtract.buildObjectMaps(objectMaps, uuidCollector, namespaceCollector, cons.tempDir, obProps.usageTypes.CLONE);
+
+  // Have the user map each namespace to its proper behavior
+  mapNamespaces(function () {
+    prompt.promptList("Rename database tables?", ["Yes", "No"], function (renameDbTables) {
+      options["renameDbTables"] = renameDbTables == "Yes";
+      executeClone(appZipPath, icfPath, callback);
+    });
+  });
+}
+
 // Executes all the steps of the clone
-function executeClone(appZipPath, icfPath, namespaceMap, options, callback) {
+function executeClone(appZipPath, icfPath, callback) {
   // Initialize output variables
   const outZipPath = path.resolve(cons.outDir, path.basename(appZipPath));
   const outIcfPath = icfPath ? path.resolve(cons.outDir, path.basename(icfPath)) : null;
 
   // Extract the metadata including the namespace from each object file
-  const objectMaps = {};
-  const uuidCollector = { uuids: [] };
-  util.print(`Collecting all metadata from the objects...`);
-  obExtract.buildObjectMaps(objectMaps, uuidCollector, cons.tempDir, obProps.usageTypes.CLONE);
-  let nonMatchingObjectCount =
-    obExtract.retrieveObjectMapCount(objectMaps) - obExtract.retrieveObjectMapCount(objectMaps, Object.keys(namespaceMap));
-  if (nonMatchingObjectCount > 0) {
-    util.printWarning(
-      `${nonMatchingObjectCount} objects found not matching namespace ${Object.keys(namespaceMap)}, these objects won't be cloned`
-    );
-    util.printGap();
+  if (Object.keys(objectMaps).length == 0) {
+    util.print(`Collecting all metadata from the objects...`);
+    obExtract.buildObjectMaps(objectMaps, uuidCollector, null, cons.tempDir, obProps.usageTypes.CLONE);
+    let nonMatchingObjectCount =
+      obExtract.retrieveObjectMapCount(objectMaps) - obExtract.retrieveObjectMapCount(objectMaps, Object.keys(namespaceCollector));
+    if (nonMatchingObjectCount > 0) {
+      util.printWarning(
+        `${nonMatchingObjectCount} objects found not matching namespace ${Object.keys(namespaceCollector)}, these objects won't be cloned`
+      );
+      util.printGap();
+    }
   }
 
   // Update the object maps we are cloning based on the application prefix
   util.print(`Cloning the objects files...`);
-  obMapsUpdates.renameObjectMaps(objectMaps, uuidCollector, namespaceMap, options, obProps.usageTypes.CLONE);
+  obMapsUpdates.renameObjectMaps(objectMaps, uuidCollector, namespaceCollector, options, obProps.usageTypes.CLONE);
 
   // These output files are helpful for debugging
   util.writeJson(path.resolve(cons.outDir, `objects.json`), objectMaps);
@@ -102,6 +117,62 @@ function promptNamespace(message, onAnswer) {
   });
 }
 
+// Prompts the user to select a namespace
+function mapNamespaces(onComplete) {
+  let namespacesToChooseFrom = lodash.filter(obExtract.sortNamespaces(namespaceCollector), function (namespace) {
+    return namespaceCollector[namespace]["newNamespace"] == null;
+  });
+  let isFirstIteration = namespacesToChooseFrom.length == Object.keys(namespaceCollector).length;
+  if (namespacesToChooseFrom.length > 0) {
+    let message;
+    if (isFirstIteration) {
+      message = `After analyzing the objects, ${
+        Object.keys(namespaceCollector).length
+      } potential unique namespaces were found. For each namespace, select what behavior you would like (clone or keep as-is). There may be overlap with sub-prefixes, in which case selecting a shorter namespace that matches ones with more prefixes will result in that behavior applying to all longer matching namespaces. For objects without a namespace, a prefix will automatically be added if they will be cloned. All namespaces with more than 1 prefix are represented with '_' delimiters, although the proper delimiter will automatically be determined by the object type.`;
+    } else {
+      message = `Select another namespace`;
+    }
+    let namespacesToChooseFromMap = {};
+    namespacesToChooseFrom.forEach(namespace => {
+      let subNamespaceCount =
+        lodash.filter(namespacesToChooseFrom, function (otherNamespace) {
+          return otherNamespace.startsWith(namespace);
+        }).length - 1;
+      let formattedNamespace =
+        namespace == cons.noNamespace
+          ? namespace
+          : `${" ".repeat(namespace.split("_").length)}${namespace}  [including ${subNamespaceCount} matching sub-namespace(s)]`;
+      namespacesToChooseFromMap[formattedNamespace] = namespace;
+    });
+    prompt.promptList(message, Object.keys(namespacesToChooseFromMap), function (answer) {
+      let chosenNamespace = namespacesToChooseFromMap[answer];
+      promptNamespace(
+        `Namespace: ${chosenNamespace}. Enter a new namespace to clone these objects. Enter nothing to keep them as-is.`,
+        function (answer) {
+          Object.keys(namespaceCollector).forEach(namespace => {
+            if (namespaceCollector[namespace]["newNamespace"] == null) {
+              if (namespace.startsWith(chosenNamespace)) {
+                if (namespace == chosenNamespace) {
+                  namespaceCollector[namespace]["newNamespace"] = answer;
+                } else {
+                  delete namespaceCollector[namespace];
+                }
+              }
+            }
+          });
+          mapNamespaces(onComplete);
+        }
+      );
+    });
+  } else {
+    util.print(`All namespaces accounted for. See details below.`);
+    obExtract.sortNamespaces(namespaceCollector).forEach(namespace => {
+      util.print(`   ${namespace} -> ${util.replaceBlank(namespaceCollector[namespace]["newNamespace"], `Will not clone`)}`, true);
+    });
+    onComplete();
+  }
+}
+
 // Utility function to differenciate between debug logging and real logging
 function debug(input) {
   console.log(input);

package/src/handlers/objectExtractHandler.js

@@ -11,12 +11,12 @@ const { split } = require("lodash");
 // Exports
 module.exports = {
   // Builds the objectMaps object from the application
-  buildObjectMaps: function (objectMaps, uuidCollector, appDir, usageType) {
+  buildObjectMaps: function (objectMaps, uuidCollector, namespaceCollector, appDir, usageType) {
     let fileCount = { count: 0 };
     initObjectMaps(objectMaps);
     // Extract the name, uuid, etc. from each object file
     util.handleDirFiles(appDir, ["xml", "xsd"], 2, 2, function (obPath) {
-      extractObProps(objectMaps, uuidCollector, fileCount, obPath, usageType);
+      extractObProps(objectMaps, uuidCollector, namespaceCollector, fileCount, obPath, usageType);
     });
     // Set the datatype UUIDs from their name & namespace
     updateDatatypeUuids(objectMaps);
@@ -30,6 +30,16 @@ module.exports = {
 
   // Returns the count of all objects in the objectMap
   retrieveObjectMapCount: retrieveObjectMapCount,
+
+  // Sorts the namespaces by their relative lengths
+  sortNamespaces: function (namespaceCollector) {
+    return lodash.flatten([
+      Object.keys(namespaceCollector).indexOf(cons.noNamespace) >= 0 ? cons.noNamespace : [],
+      lodash.sortBy(lodash.difference(Object.keys(namespaceCollector), [cons.noNamespace]).sort(), function (namespace) {
+        return namespace.split("_").length;
+      }),
+    ]);
+  },
 };
 
 // ---------------------------------------------------
@@ -44,7 +54,7 @@ function initObjectMaps(objectMaps) {
 }
 
 // Extracts the name, uuid, etc. from a single object file
-function extractObProps(objectMaps, uuidCollector, fileCount, obPath, usageType) {
+function extractObProps(objectMaps, uuidCollector, namespaceCollector, fileCount, obPath, usageType) {
   fileCount.count = fileCount.count + 1;
   const obType = util.getFolderName(obPath);
   let isParsed = false;
@@ -85,6 +95,15 @@ function extractObProps(objectMaps, uuidCollector, fileCount, obPath, usageType)
         }
       });
 
+      // Get the namespace of the object
+      if (!util.isBlank(namespaceCollector)) {
+        let objectName = builder[obProps.fieldNames.NAME];
+        let objectNamespace = extractObjectNamespace(objectName);
+        if (Object.keys(namespaceCollector).indexOf(objectNamespace) == -1) {
+          namespaceCollector[objectNamespace] = { newNamespace: null };
+        }
+      }
+
       // Set the object metadata in the objectMaps
       objectMaps[haulType.haulName].push({ current: builder });
       isParsed = true;
@@ -93,7 +112,7 @@ function extractObProps(objectMaps, uuidCollector, fileCount, obPath, usageType)
 
   // Unknown file type
   if (!isParsed) {
-    util.printWarning(`Unknown object type in package: ${obType}/${path.basename(obPath)}`);
+    util.printWarning(`WARNING: Unknown object type in package: ${obType}/${path.basename(obPath)}`);
   }
 }
 
@@ -140,6 +159,18 @@ function retrieveObjectMapCount(objectMaps, namespacesFilter) {
   return count;
 }
 
+// Returns the namespace from an object name
+function extractObjectNamespace(objectName) {
+  // See regex here with test cases: https://regexr.com/6trnd
+  let namespaceRegex = new RegExp(`^(?:[A-Z0-9]*${cons.namespaceDelimiterRegex}?){0,3}(?=${cons.namespaceDelimiterRegex})`, "g");
+  let namespaceMatch = util.firstMatch(objectName, namespaceRegex, null);
+  if (namespaceMatch) {
+    return namespaceMatch.replace(new RegExp(cons.namespaceDelimiterRegex, "g"), "_");
+  } else {
+    return cons.noNamespace;
+  }
+}
+
 // Utility function to differenciate between debug logging and real logging
 function debug(input) {
   console.log(input);

package/src/handlers/objectMapsUpdateHandler.js

@@ -26,7 +26,14 @@ function renameObjectMaps(objectMaps, uuidCollector, namespaceMap, options, usag
   obProps.haulTypes.forEach(haulType => {
     objectMaps[haulType.haulName].forEach(function (objectMap, objectMapIndex) {
       let curNamespaceForObject = findNamespaceForObject(objectMap, namespaceMap, haulType, objectMaps);
-      if (Object.keys(namespaceMap).indexOf(curNamespaceForObject) < 0) {
+      let newNamespaceForObject;
+      // Logic to determine if the object will be skipped, either not in the namespaceMap, or the newNamespace is null
+      let objectWillNotBeCloned = Object.keys(namespaceMap).indexOf(curNamespaceForObject) < 0;
+      if (!objectWillNotBeCloned) {
+        newNamespaceForObject = namespaceMap[curNamespaceForObject]["newNamespace"];
+        objectWillNotBeCloned = util.isBlank(newNamespaceForObject);
+      }
+      if (objectWillNotBeCloned) {
         // Object will not be cloned
         objectMaps[haulType.haulName][objectMapIndex]["new"] = objectMap["current"];
         haulType.fields.forEach(haulField => {
@@ -37,7 +44,6 @@ function renameObjectMaps(objectMaps, uuidCollector, namespaceMap, options, usag
         });
       } else {
         // Object will be cloned
-        let newNamespaceForObject = namespaceMap[curNamespaceForObject]["newNamespace"];
         objectMaps[haulType.haulName][objectMapIndex]["new"] = {};
         haulType.fields.forEach(haulField => {
           if (lodash.includes(haulField.usage, usageType)) {

package/src/util.js

@@ -57,9 +57,7 @@ module.exports = {
 
   // Validates the new namespace is only letters and numbers with no whitespace
   validateNamespace: function (namespace) {
-    if (isBlank(namespace)) {
-      return `Namespace cannot be null`;
-    } else if (!namespace.match(/^\b(?:[A-Za-z0-9]+_?)+\b$/g) && !isBlank(namespace)) {
+    if (!namespace.match(/^\b(?:[A-Za-z0-9]+_?)+\b$/g) && !isBlank(namespace)) {
       return `Namespace can only be sets of uppercase letters and numbers separated by underscores`;
     } else {
       return true;