Merge branch 'version/1.1' into release

Author: Zachary_Kniebel

app/plugins/completion_handlers/AWS_S3/s3-deploy-handler.js

@@ -45,10 +45,11 @@ const COMPLETIONHANDLER_ID = "AWS_S3";
  * Executes the completion handler with the given output directory path 
  * @param {string} outputDirectoryPath the path to the output directory
  * @param {object} configurationLoader the configuration loader module
+ * @param {object} metaball holds the metadata from the generation
  * @param {object} logger the logger
- * @param {Array<*>} params array of custom parameters
+ * @param {Array<*>} params custom parameters object
  */
-var _execute = function (outputDirectoryPath, configurationLoader, logger, params) {
+var _execute = function (outputDirectoryPath, configurationLoader, metaball, logger, params) {
     logger.info(`Executing AWS S3 Deployment Completion Handler on output path "${outputDirectoryPath}"`);
 
     const configuration = configurationLoader.getConfiguration();
@@ -59,16 +60,15 @@ var _execute = function (outputDirectoryPath, configurationLoader, logger, param
         async_concurrency = 250;
     }
 
-    var options = params[0];
-    if (!options || !(options.AccessKeyId && options.SecretAccessKey && options.S3BucketName && options.S3FolderPath)) {
-        logger.error("Error while executing the AWS S3 Deployment Completion Handler. A JSON argument must be passed with the AccessKeyId, SecretAccessKey, S3BucketName, and S3FolderPath properties set.");
+    if (!params || !(params.AccessKeyId && params.SecretAccessKey && params.S3BucketName && params.S3FolderPath)) {
+        logger.error("Error while executing the AWS S3 Deployment Completion Handler. A \"Params\" object must be passed with the AccessKeyId, SecretAccessKey, S3BucketName, and S3FolderPath properties set.");
         return;
     }
 
-    const accessKeyId = options.AccessKeyId;
-    const secretAccessKey = options.SecretAccessKey;
-    const s3BucketName = options.S3BucketName;
-    const s3FolderPath = options.S3FolderPath;
+    const accessKeyId = params.AccessKeyId;
+    const secretAccessKey = params.SecretAccessKey;
+    const s3BucketName = params.S3BucketName;
+    const s3FolderPath = params.S3FolderPath;
 
     // initialize S3 client
     const s3 = new AWS.S3({

app/plugins/completion_handlers/Azure_ABS/abs-deploy-handler.js

@@ -45,10 +45,11 @@ const COMPLETIONHANDLER_ID = "Azure_ABS";
  * Executes the completion handler with the given output directory path 
  * @param {string} outputDirectoryPath the path to the output directory
  * @param {object} configurationLoader the configuration loader module
+ * @param {object} metaball holds the metadata from the generation
  * @param {object} logger the logger
- * @param {Array<*>} params array of custom parameters
+ * @param {Array<*>} params custom parameters object
  */
-var _execute = function (outputDirectoryPath, configurationLoader, logger, params) {
+var _execute = function (outputDirectoryPath, configurationLoader, metaball, logger, params) {
     logger.info(`Executing Azure Blob Storage Deployment Completion Handler on output path "${outputDirectoryPath}"`);
 
     const configuration = configurationLoader.getConfiguration();
@@ -59,15 +60,14 @@ var _execute = function (outputDirectoryPath, configurationLoader, logger, param
         async_concurrency = 250;
     }
 
-    var options = params[0];
-    if (!options || !(options.AzureStorageAccountConnectionString && options.AzureStorageContainer)) {
-        logger.error("Error while executing the Azure Blob Storage Deployment Completion Handler. A JSON argument must be passed with the AzureStorageAccountConnectionString and AzureStorageContainer properties set.");
+    if (!params || !(params.AzureStorageAccountConnectionString && params.AzureStorageContainer)) {
+        logger.error("Error while executing the Azure Blob Storage Deployment Completion Handler. A \"Params\" object must be passed with the AzureStorageAccountConnectionString and AzureStorageContainer properties set.");
         return;
     }
 
-    const azureStorageAccountConnectionString = options.AzureStorageAccountConnectionString;
-    const azureStorageContainer = options.AzureStorageContainer;
-    const azureStorageTargetDirectory = options.AzureStorageTargetDirectory || "";
+    const azureStorageAccountConnectionString = params.AzureStorageAccountConnectionString;
+    const azureStorageContainer = params.AzureStorageContainer;
+    const azureStorageTargetDirectory = params.AzureStorageTargetDirectory || "";
 
     // initialize the retry policy    
     var retryOperations = new azure.LinearRetryPolicyFilter();

app/plugins/completion_handlers/Example/helloWorld.js

@@ -35,10 +35,11 @@ const COMPLETIONHANDLER_ID = "helloWorld!";
  * Executes the completion handler with the given output directory path 
  * @param {string} outputDirectoryPath the path to the output directory
  * @param {object} configurationLoader the configuration loader module
+ * @param {object} metaball holds the metadata from the generation
  * @param {object} logger the logger
- * @param {Array<*>} params array of custom parameters
+ * @param {Array<*>} params custom parameters object
  */
-var _execute = function (outputDirectoryPath, configurationLoader, logger, params) {
+var _execute = function (outputDirectoryPath, configurationLoader, metaball, logger, params) {
   logger.info(`hello World! Output path is: "${outputDirectoryPath}"`);
 
   // your logic here

app/plugins/completion_handlers/MSTeams_Notifier/msteams-notifier.js

@@ -40,7 +40,7 @@ const COMPLETIONHANDLER_ID = "MSTeams_Notifier";
  * @param {object} configurationLoader the configuration loader module
  * @param {object} metaball holds the metadata from the generation
  * @param {object} logger the logger
- * @param {Array<*>} params array of custom parameters
+ * @param {Array<*>} params custom parameters object
  */
 var _execute = function (outputDirectoryPath, configurationLoader, metaball, logger, params) {
     if (!params || !params.Url) {

app/plugins/completion_handlers/Slack_Notifier/slack-notifier.js

@@ -40,7 +40,7 @@ const COMPLETIONHANDLER_ID = "Slack_Notifier";
  * @param {object} configurationLoader the configuration loader module
  * @param {object} metaball holds the metadata from the generation
  * @param {object} logger the logger
- * @param {Array<*>} params array of custom parameters
+ * @param {Array<*>} params custom parameters object
  */
 var _execute = function (outputDirectoryPath, configurationLoader, metaball, logger, params) {
     if (!params || !params.Url) {

middlemen/RabbitMQ/SitecoreDXG__RabbitMQ_Middleman__TeamCity_MetaRunner.xml

@@ -6,7 +6,7 @@
       <param name="env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ConnectionString" value="" spec="text display='normal' description='The RabbitMQ connection string that you wish to use to connect to RabbitMQ (e.g. amqp://localhost)' label='RabbitMQ Connection String' validationMode='not_empty'" />
       <param name="env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.GenerationQueueName" value="" spec="text display='normal' description='The name of the generation queue that you want to submit the serialized architecture queue; by default, the queue that you choose determines the generation action that should occur; the available default queues are the generation_queue__documentation queue (generate HTML documentation) and the generation_queue__mdj queue (generate MDJ file only).' label='Generation Queue Name' validationMode='not_empty'" />
       <param name="env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ArchitectureGetUrl" value="" spec="text display='normal' description='SitecoreUML Service URL for getting the serialized template architecture of the host Sitecore solution (generally http://&lt;sitecore_url&gt;/sitecoreuml/sitecoredxg/GetTemplateArchitecture)' label='Architecture GET URL' validationMode='not_empty'" />
-      <param name="env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.CompletionHandlerData" value="" spec="text description='(Optional) JSON-formatted string array of the completion handler data objects with the handler ID and parameters; Should have the following syntax:  |'|[{\&quot;ID\&quot;:\&quot;MyHandler1\&quot;,\&quot;Params\&quot;:|[1,2,\&quot;foo\&quot;,\&quot;bar\&quot;|]},{\&quot;ID\&quot;:\&quot;MyHandler2\&quot;}|]|'' label='Completion Handler Data' validationMode='any' display='normal'" />
+      <param name="env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.OptionsData" value="" spec="text description='(Optional) JSON-formatted string array of the optional DocumentationConfiguration and CompletionHandlers data objects; completion handler objects must have the handler ID and parameters; Should have the following syntax:  |'{\&quot;DocumentationConfiguration\&quot;:{\&quot;CommitAuthor\&quot;:\&quot;...\&quot;,\&quot;CommitHash\&quot;:\&quot;...\&quot;,\&quot;EnvironmentName\&quot;:\&quot;UAT\&quot;,\&quot;ProjectName\&quot;:\&quot;...\&quot;,\&quot;DeployLink\&quot;:\&quot;http://...\&quot;},\&quot;CompletionHandlers\&quot;:|[{\&quot;ID\&quot;:\&quot;MyHandler1\&quot;,\&quot;Params\&quot;:{\&quot;foo\&quot;:\&quot;bar\&quot;},{\&quot;ID\&quot;:\&quot;MyHandler2\&quot;}|]|'' label='Completion Handler Data' validationMode='any' display='normal'" />
       <param name="env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ScriptPath" value="" spec="text display='normal' description='The path to the middleman script file on the TeamCity server (customizable for extensibility purposes)' label='Middleman Script Path' validationMode='not_empty'" />
     </parameters>
     <build-runners>
@@ -26,7 +26,7 @@ Write-Output "Dependencies installed"
 
 Write-Output "Calling SitecoreDXG Middleman..."
 
-node %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ScriptPath% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ConnectionString% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ArchitectureGetUrl% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.GenerationQueueName% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.CompletionHandlerData%
+node %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ScriptPath% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ConnectionString% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.ArchitectureGetUrl% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.GenerationQueueName% %env.SitecoreDXG.Middlemen.RabbitMQ_AMQP.OptionsData% true
 
 Write-Output "Finished calling SitecoreDXG Middleman..."]]></param>
           <param name="jetbrains_powershell_script_mode" value="CODE" />

middlemen/RabbitMQ/package.json

@@ -11,6 +11,7 @@
   "license": "ISC",
   "dependencies": {
     "amqplib": "^0.5.2",
+    "extend": "^3.0.2",
     "request": "^2.88.0"
   }
 }

middlemen/RabbitMQ/rabbitmq-amqp-middleman.js

@@ -19,6 +19,7 @@
 // third-party
 const amqp = require('amqplib/callback_api');
 const request = require('request');
+const extend = require("extend");
 
 /* EXECUTION */
 
@@ -64,7 +65,7 @@ amqp.connect(connectionString, function(err, conn) {
 
         request(jsonGetUrl, (err, res, data) => {
             if (err) { 
-                return console.error(err); 
+                console.error(err); 
                 _exitProgram(process, 1, conn);
             }
 
@@ -74,8 +75,21 @@ amqp.connect(connectionString, function(err, conn) {
                 _exitProgram(process, 1, conn);
             }            
             if (args.length > 3) {
-                var completionHandlers = args[3];
-                json.Data.CompletionHandlers = JSON.parse(completionHandlers);
+                var options = args[3];
+                // replace space codes with spaces (for powershell support)
+                options = args.length > 4 && args[4] == "true" 
+                    ? options.replace(" ", " ")
+                    : options;
+
+                var parsedOptions = JSON.parse(options);
+                if (parsedOptions.CompletionHandlers) {
+                    json.Data.CompletionHandlers = parsedOptions.CompletionHandlers;
+                } 
+                if (parsedOptions.DocumentationConfiguration) {
+                    json.Data.DocumentationConfiguration = 
+                        extend(true, json.Data.DocumentationConfiguration, parsedOptions.DocumentationConfiguration);
+                }
+
                 data = JSON.stringify(json);
             }