added field with check box to delete temp folder generated while running packer build task. (#21029)

v-dko · web-flow · commit cbcb23cb9913 · 2025-05-22T11:18:36.000+05:30
* initialchanges

* modified changes in custom templates

* cleaned up the code

* modified code as per suggestions

* modified delete temp folder variable name

* fixed space issue

* fixed white space issue
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/custom.linux.template.json b/Tasks/PackerBuildV1/DefaultTemplates/custom.linux.template.json
@@ -15,7 +15,8 @@
     "package_path": "{{env `package_path`}}",
     "package_name": "{{env `package_name`}}",
     "capture_name_prefix": "{{env `capture_name_prefix`}}",
-    "skip_clean": "{{env `skip_clean`}}"
+    "skip_clean": "{{env `skip_clean`}}",
+    "delete_temp_folder": "{{env `delete_temp_folder`}}"
   },
   "builders": [{
         "type": "azure-arm",
@@ -60,6 +61,17 @@
             "/deployTemp/{{user `package_name`}}/{{user `script_relative_path`}} {{user `script_arguments`}}"
         ]
     },
+    {
+        "type": "shell",
+        "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
+        "inline": [
+          "echo delete_temp_folder: {{user `delete_temp_folder`}}",
+          "if [ \"{{user `delete_temp_folder`}}\" = \"true\" ]; then",
+          "  echo 'Removing /deployTemp if exists...'",
+          "  rm -rf /deployTemp && echo '/deployTemp deleted'",
+          "fi"
+        ]
+      },
     {
         "type": "shell",
         "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/custom.managed.linux.template.json b/Tasks/PackerBuildV1/DefaultTemplates/custom.managed.linux.template.json
@@ -16,7 +16,8 @@
     "package_name": "{{env `package_name`}}",
     "capture_name_prefix": "{{env `capture_name_prefix`}}",
     "skip_clean": "{{env `skip_clean`}}",
-    "managed_image_name":  "{{env `managed_image_name`}}"
+    "managed_image_name":  "{{env `managed_image_name`}}",
+    "delete_temp_folder":  "{{env `delete_temp_folder`}}"
   },
   "builders": [{
         "type": "azure-arm",
@@ -58,7 +59,17 @@
             "chmod +x /deployTemp/{{user `package_name`}}/{{user `script_relative_path`}}",
             "/deployTemp/{{user `package_name`}}/{{user `script_relative_path`}} {{user `script_arguments`}}"
         ]
-    },
+    },{
+        "type": "shell",
+        "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
+        "inline": [
+          "echo delete_temp_folder: {{user `delete_temp_folder`}}",
+          "if [ \"{{user `delete_temp_folder`}}\" = \"true\" ]; then",
+          "  echo 'Removing /deployTemp if exists...'",
+          "  rm -rf /deployTemp && echo '/deployTemp deleted'",
+          "fi"
+        ]
+      },
     {
         "type": "shell",
         "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/custom.managed.windows.template.json b/Tasks/PackerBuildV1/DefaultTemplates/custom.managed.windows.template.json
@@ -15,7 +15,8 @@
     "package_path": "{{env `package_path`}}",
     "package_name": "{{env `package_name`}}",
     "capture_name_prefix": "{{env `capture_name_prefix`}}",
-    "managed_image_name":  "{{env `managed_image_name`}}"
+    "managed_image_name":  "{{env `managed_image_name`}}",
+    "delete_temp_folder":  "{{env `delete_temp_folder`}}"
   },
   "builders": [{
         "type": "azure-arm",
@@ -60,6 +61,13 @@
                 "C:\\DeployTemp\\{{user `package_name`}}\\{{user `script_relative_path`}} {{user `script_arguments`}}"
             ]
         },
+        {
+            "type": "windows-shell",
+            "inline": [
+             "cmd /c \"echo run_deploy_script: {{user `delete_temp_folder`}}\"",      
+             "cmd /c  \" if '{{user `delete_temp_folder`}}' == 'true' if exist c:\\\\DeployTemp rd /s /q c:\\\\DeployTemp\""
+            ]
+          },
         {
             "type": "powershell",
             "inline": [
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/custom.windows.template.json b/Tasks/PackerBuildV1/DefaultTemplates/custom.windows.template.json
@@ -14,7 +14,8 @@
     "script_arguments": "{{env `script_arguments`}}",
     "package_path": "{{env `package_path`}}",
     "package_name": "{{env `package_name`}}",
-    "capture_name_prefix": "{{env `capture_name_prefix`}}"
+    "capture_name_prefix": "{{env `capture_name_prefix`}}",
+    "delete_temp_folder": "{{env `delete_temp_folder`}}"
   },
   "builders": [{
         "type": "azure-arm",
@@ -61,6 +62,13 @@
                 "C:\\DeployTemp\\{{user `package_name`}}\\{{user `script_relative_path`}} {{user `script_arguments`}}"
             ]
         },
+        {
+            "type": "windows-shell",
+            "inline": [
+             "cmd /c \"echo run_deploy_script: {{user `delete_temp_folder`}}\"",      
+             "cmd /c  \" if '{{user `delete_temp_folder`}}' == 'true' if exist c:\\\\DeployTemp rd /s /q c:\\\\DeployTemp\""
+            ]
+          },
         {
             "type": "powershell",
             "inline": [
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/default.linux.template.json b/Tasks/PackerBuildV1/DefaultTemplates/default.linux.template.json
@@ -17,7 +17,8 @@
     "package_path": "",
     "package_name": "",
     "capture_name_prefix": "",
-    "skip_clean":""
+    "skip_clean":"",
+    "delete_temp_folder": ""
   },
   "builders": [{
         "type": "azure-arm",
@@ -64,6 +65,17 @@
             "/deployTemp/{{user `package_name`}}/{{user `script_relative_path`}} {{user `script_arguments`}}"
         ]
     },
+    {
+        "type": "shell",
+        "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
+        "inline": [
+          "echo delete_temp_folder: {{user `delete_temp_folder`}}",
+          "if [ \"{{user `delete_temp_folder`}}\" = \"true\" ]; then",
+          "  echo 'Removing /deployTemp if exists...'",
+          "  rm -rf /deployTemp && echo '/deployTemp deleted'",
+           "fi"
+        ]
+      },
     {
         "type": "shell",
         "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/default.managed.linux.template.json b/Tasks/PackerBuildV1/DefaultTemplates/default.managed.linux.template.json
@@ -18,7 +18,8 @@
     "package_name": "",
     "capture_name_prefix": "",
     "skip_clean": "",
-    "managed_image_name": ""
+    "managed_image_name": "",
+    "delete_temp_folder": ""
   },
   "builders": [{
         "type": "azure-arm",
@@ -60,7 +61,17 @@
             "chmod +x /deployTemp/{{user `package_name`}}/{{user `script_relative_path`}}",
             "/deployTemp/{{user `package_name`}}/{{user `script_relative_path`}} {{user `script_arguments`}}"
         ]
-    },
+    },{
+        "type": "shell",
+        "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
+        "inline": [
+          "echo delete_temp_folder: {{user `delete_temp_folder`}}",
+          "if [ \"{{user `delete_temp_folder`}}\" = \"true\" ]; then",
+          "  echo 'Removing /deployTemp if exists...'",
+          "  rm -rf /deployTemp && echo '/deployTemp deleted'",
+          "fi"
+        ]
+      },
     {
         "type": "shell",
         "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo -E sh '{{ .Path }}'",
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/default.managed.windows.template.json b/Tasks/PackerBuildV1/DefaultTemplates/default.managed.windows.template.json
@@ -17,7 +17,8 @@
     "package_path": "",
     "package_name": "",
     "capture_name_prefix": "",
-    "managed_image_name": ""
+    "managed_image_name": "",
+    "delete_temp_folder": ""
   },
   "builders": [{
         "type": "azure-arm",
@@ -61,6 +62,13 @@
                 "C:\\DeployTemp\\{{user `package_name`}}\\{{user `script_relative_path`}} {{user `script_arguments`}}"
             ]
         },
+        {
+            "type": "windows-shell",
+            "inline": [
+             "cmd /c \"echo run_deploy_script: {{user `delete_temp_folder`}}\"",      
+             "cmd /c  \" if '{{user `delete_temp_folder`}}' == 'true' if exist c:\\\\DeployTemp rd /s /q c:\\\\DeployTemp\""
+            ]
+          },
         {
             "type": "powershell",
             "inline": [
diff --git a/Tasks/PackerBuildV1/DefaultTemplates/default.windows.template.json b/Tasks/PackerBuildV1/DefaultTemplates/default.windows.template.json
@@ -16,7 +16,8 @@
     "script_arguments": "",
     "package_path": "",
     "package_name": "",
-    "capture_name_prefix": ""
+    "capture_name_prefix": "",
+    "delete_temp_folder": ""
   },
   "builders": [{
         "type": "azure-arm",
@@ -65,6 +66,13 @@
                 "C:\\DeployTemp\\{{user `package_name`}}\\{{user `script_relative_path`}} {{user `script_arguments`}}"
             ]
         },
+        {
+            "type": "windows-shell",
+            "inline": [
+             "cmd /c \"echo run_deploy_script: {{user `delete_temp_folder`}}\"",      
+             "cmd /c  \" if '{{user `delete_temp_folder`}}' == 'true' if exist c:\\\\DeployTemp rd /s /q c:\\\\DeployTemp\""
+            ]
+          },
         {
             "type": "powershell",
             "inline": [
diff --git a/Tasks/PackerBuildV1/Strings/resources.resjson/en-US/resources.resjson b/Tasks/PackerBuildV1/Strings/resources.resjson/en-US/resources.resjson
@@ -39,6 +39,8 @@
   "loc.input.help.deployScriptPath": "Specify the relative path to powershell script(for Windows) or shell script(for Linux) which deploys the package. This script should be contained in the package path selected above. Supports minimatch pattern. Example path: deploy/**/scripts/windows/deploy.ps1",
   "loc.input.label.deployScriptArguments": "Deployment script arguments",
   "loc.input.help.deployScriptArguments": "Specify the arguments to be passed to deployment script.",
+  "loc.input.label.canDeleteTempFolder": "Delete temp folder",
+  "loc.input.help.canDeleteTempFolder": "This option allows you to remove temporary folder",
   "loc.input.label.additionalBuilderParameters": "Additional Builder parameters",
   "loc.input.help.additionalBuilderParameters": "In auto generated Packer template mode the task creates a Packer template with an Azure builder. This builder is used to generate a machine image. You can add keys to the Azure builder to customize the generated Packer template. For example setting ssh_tty=true in case you are using a CentOS base image and you need to have a tty to run sudo.<br/>To view/edit the additional parameters in a grid, click on “…” next to text box.",
   "loc.input.label.skipTempFileCleanupDuringVMDeprovision": "Skip temporary file cleanup during deprovision",
diff --git a/Tasks/PackerBuildV1/src/constants.ts b/Tasks/PackerBuildV1/src/constants.ts
@@ -17,6 +17,7 @@ export var BuiltinBaseImageInputName = "baseImage";
 export var CustomImageUrlInputName = "customImageUrl";
 export var CustomImageOsTypeInputName = "customImageOSType";
 export var ManagedImageInputName = "isManagedImage";
+export var canDeleteTempFolderInputName = "canDeleteTempFolder";
 export var ManagedImageNameInputName = "managedImageName";
 export var ImagePublisherInputName = "imagePublisher";
 export var ImageOfferInputName = "imageOffer";
@@ -41,6 +42,7 @@ export var TemplateVariableCapturePrefixName = "capture_name_prefix";
 export var TemplateVariableScriptRelativePathName = "script_relative_path";
 export var TemplateVariableScriptArgumentsName = "script_arguments";
 export var TemplateVariablePackagePathName = "package_path";
+export var TemplateVariableDeleteFolderName = "delete_temp_folder";
 export var TemplateVariablePackageName = "package_name";
 export var TemplateVariableSubscriptionIdName = "subscription_id";
 export var TemplateVariableClientIdName = "client_id";
diff --git a/Tasks/PackerBuildV1/src/taskInputTemplateVariablesProvider.ts b/Tasks/PackerBuildV1/src/taskInputTemplateVariablesProvider.ts
@@ -43,6 +43,9 @@ export default class TaskInputTemplateVariablesProvider implements definitions.I
         if(taskParameters.isManagedImage){
             this._templateVariables.set(constants.TemplateVariableManagedImageName, taskParameters.managedImageName) 
         }
+        if(taskParameters.canDeleteTempFolder){
+            this._templateVariables.set(constants.canDeleteTempFolderInputName, taskParameters.canDeleteTempFolderInputName); 
+        }
 
         if(taskParameters.baseImageSource === constants.BaseImageSourceCustomVhd) {
             this._templateVariables.set(constants.TemplateVariableImageUrlName, taskParameters.customBaseImageUrl);
@@ -61,8 +64,10 @@ export default class TaskInputTemplateVariablesProvider implements definitions.I
         // user deployment script specific variables
         var deployScriptPath = taskParameters.deployScriptPath;
         var packagePath = taskParameters.packagePath;
+        var deletefoldername = taskParameters.canDeleteTempFolderInputName;
         this._templateVariables.set(constants.TemplateVariableScriptRelativePathName, deployScriptPath);
         this._templateVariables.set(constants.TemplateVariablePackagePathName, packagePath);
+        this._templateVariables.set(constants.TemplateVariableDeleteFolderName, deletefoldername);
         this._templateVariables.set(constants.TemplateVariablePackageName, path.basename(packagePath));
         if(!utils.IsNullOrEmpty(taskParameters.deployScriptArguments)) {
             this._templateVariables.set(constants.TemplateVariableScriptArgumentsName, taskParameters.deployScriptArguments);
diff --git a/Tasks/PackerBuildV1/src/taskParameters.ts b/Tasks/PackerBuildV1/src/taskParameters.ts
@@ -20,7 +20,9 @@ export default class TaskParameters {
     public builtinBaseImage: string;
     public customBaseImageUrl: string;
     public isManagedImage: boolean;
+    public canDeleteTempFolder: boolean;
     public managedImageName: string;
+    public canDeleteTempFolderInputName: string;
     public imagePublisher: string;
     public imageOffer: string;
     public imageSku: string;
@@ -55,10 +57,13 @@ export default class TaskParameters {
                 this.storageAccount = tl.getInput(constants.StorageAccountInputName, true);
                 this.location = tl.getInput(constants.LocationInputName, true);
                 this.isManagedImage = tl.getBoolInput(constants.ManagedImageInputName, false);
-
+                this.canDeleteTempFolder = tl.getBoolInput(constants.canDeleteTempFolderInputName, false);
                 if (this.isManagedImage) {
                     this.managedImageName = tl.getInput(constants.ManagedImageNameInputName, true);
                 }
+                if (this.canDeleteTempFolder) {
+                    this.canDeleteTempFolderInputName = tl.getInput(constants.canDeleteTempFolderInputName, true);
+                }
 
                 this.baseImageSource = tl.getInput(constants.BaseImageSourceInputName, true);
                 if (this.baseImageSource === constants.BaseImageSourceDefault) {
@@ -135,4 +140,4 @@ export default class TaskParameters {
         const endpoint =  await new AzureRMEndpoint(connectedService).getEndpoint();
         return endpoint;
     }
-}
+}
diff --git a/Tasks/PackerBuildV1/task.json b/Tasks/PackerBuildV1/task.json
@@ -14,7 +14,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 1,
-    "Minor": 255,
+    "Minor": 257,
     "Patch": 0
   },
   "demands": [],
@@ -93,6 +93,7 @@
       "defaultValue": true,
       "groupName": "AzureDetails"
     },
+   
     {
       "name": "managedImageName",
       "type": "string",
@@ -216,6 +217,14 @@
       "defaultValue": "",
       "helpMarkDown": "Specify the arguments to be passed to deployment script.",
       "groupName": "DeploymentInputs"
+    }, {
+      "name": "canDeleteTempFolder",
+      "type": "boolean",
+      "label": "Delete temp folder",
+      "required": true,
+      "helpMarkDown": "This option allows you to remove temporary folder",
+      "defaultValue": false,
+      "groupName": "DeploymentInputs"
     },
     {
       "name": "additionalBuilderParameters",
diff --git a/Tasks/PackerBuildV1/task.loc.json b/Tasks/PackerBuildV1/task.loc.json
@@ -14,7 +14,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 1,
-    "Minor": 255,
+    "Minor": 257,
     "Patch": 0
   },
   "demands": [],
@@ -217,6 +217,15 @@
       "helpMarkDown": "ms-resource:loc.input.help.deployScriptArguments",
       "groupName": "DeploymentInputs"
     },
+    {
+      "name": "canDeleteTempFolder",
+      "type": "boolean",
+      "label": "ms-resource:loc.input.label.canDeleteTempFolder",
+      "required": true,
+      "helpMarkDown": "ms-resource:loc.input.help.canDeleteTempFolder",
+      "defaultValue": false,
+      "groupName": "DeploymentInputs"
+    },
     {
       "name": "additionalBuilderParameters",
       "type": "multiLine",
