Use subdirectory inside zpm "package" path to avoid clashes and cleanup afterwards (#926)

* Use subdirectory inside package path to avoid clashes and cleanup afterwards

* Fix case where package path is empty

* Improve code clarity and error handling for %Package

* Wrap variable with $get

Author: isc-dchui

CHANGELOG.md

@@ -37,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #278: Modules will now be installed at a well-defined default location: `$System.Util.DataDirectory()/ipm/<packagename>/<version>/`
 - #374: A new System Expression `${ipmdir}` points to the module's default installation location: `$System.Util.DataDirectory()/ipm/<packagename>/<version>/`
 - #563: The `verify` phase will uninstall all modules after every integration test
+- #611, #686: If a path is supplied for `package`, it will now create a temporary subdirectory in that path to export the module into to avoid clashes with any existing files. This subdirectory will be deleted afterwards, leaving just the .tgz file.
 
 ## [0.10.3] - 2025-09-17
 

src/cls/IPM/Lifecycle/Module.cls

@@ -131,32 +131,38 @@ Method %Package(ByRef pParams) As %Status
     try {
         set tVerbose = $get(pParams("Verbose"))
         if ..Module.HaveToDeploy() {
-        $$$ThrowOnError(..MakeDeployed(.pParams))
+            $$$ThrowOnError(..MakeDeployed(.pParams))
         }
 
         set tExportDirectory = $get(pParams("Path"))
-        if (tExportDirectory'="") && ('##class(%File).DirectoryExists(tExportDirectory)) {
-            set tExportDirectory = ##class(%File).NormalizeDirectory(tExportDirectory)
-            if '##class(%File).CreateDirectoryChain(tExportDirectory,.tReturn) {
-                set tSC = $$$ERROR($$$GeneralError,$$$FormatText("Error creating directory chain %1: %2",tExportDirectory,tReturn))
+        if (tExportDirectory'="") {
+            // create temporary subdirectory to prevent clashes
+            set randomDir = $translate($system.Encryption.Base64Encode($system.Encryption.GenCryptRand(6)),"+/=")
+            set tExportSubDirectory = ##class(%Library.File).NormalizeDirectory(tExportDirectory) _ randomDir _ "/"
+            if '##class(%File).CreateDirectoryChain(tExportSubDirectory,.tReturn) {
+                set tSC = $$$ERROR($$$GeneralError,$$$FormatText("Error creating directory chain %1: %2",tExportSubDirectory,tReturn))
                 quit
             }
         }
 
-        set tSC = ..%Export(.pParams,.tExportDirectory)
+        set tSC = ..%Export(.pParams,.tExportSubDirectory)
         if $$$ISERR(tSC) {
             quit
         }
+        // If no path is specified, the above call to %Export will generate a temporary directory
+        if tExportDirectory="" {
+            set tExportDirectory = tExportSubDirectory
+        }
 
-        set tSC = ..OnBeforeArtifact(tExportDirectory,tExportDirectory,.pParams)
+        set tSC = ..OnBeforeArtifact(tExportSubDirectory,tExportSubDirectory,.pParams)
         if $$$ISERR(tSC) {
             quit
         }
 
-        write:tVerbose !,"Module exported to:",!,$char(9),tExportDirectory,!
+        write:tVerbose !,"Module contents exported to temporary directory:",!,$char(9),tExportSubDirectory,!
 
         set tTgzFile = $extract(tExportDirectory,1,*-1)_".tgz"
-        set tSC = ##class(%IPM.General.Archive).Create(tExportDirectory,tTgzFile,.tOutput)
+        set tSC = ##class(%IPM.General.Archive).Create(tExportSubDirectory,tTgzFile,.tOutput)
         if $$$ISERR(tSC) {
             quit
         }
@@ -179,10 +185,16 @@ Method %Package(ByRef pParams) As %Status
             quit
         }
         set pParams("PackageFile") = tTgzFile
+
     } catch e {
         set tSC = e.AsStatus()
     }
 
+    // Delete the temporary export directory
+    if ($get(tExportSubDirectory)'="") && ##class(%Library.File).DirectoryExists(tExportSubDirectory) {
+        set tSC = $$$ADDSC(tSC, ##class(%IPM.Utils.File).RemoveDirectoryTree(tExportSubDirectory))
+    }
+
     if '$get(pParams("Package","KeepNamespace")) {
         set tPackageDeployNamespace = $get(pParams("PackageDeployNamespace"))
         set tInitNamespace = $get(pParams("InitNamespace"))

tests/integration_tests/Test/PM/Integration/DeployedItems.cls

@@ -33,7 +33,7 @@ Method TestDeployedItems()
     do $$$AssertStatusOK(sc, "Successfully published module")
     do ..UninstallModule()
 
-    set sc = ##class(%IPM.Main).Shell("load -v "_tmpDir)
+    set sc = ##class(%IPM.Main).Shell("load -v "_tmpDir_".tgz")
     do $$$AssertStatusOK(sc, "Successfully loaded module with deployed items at "_tmpDir)
     do ..RunDeployedCode()
     do ..UninstallModule()

tests/integration_tests/Test/PM/Integration/StaticFileExport.cls

@@ -5,24 +5,30 @@ Class Test.PM.Integration.StaticFileExport Extends Test.PM.Integration.Base
 
 Method TestWSGIApp()
 {
-  Set tSC = $$$OK
-  Try {
-    Set tTestRoot = ##class(%File).NormalizeDirectory($Get(^UnitTestRoot))
+  set tSC = $$$OK
+  try {
+    set tTestRoot = ##class(%File).NormalizeDirectory($get(^UnitTestRoot))
     set tModuleDir = ##class(%File).NormalizeDirectory(##class(%File).GetDirectory(tTestRoot)_"/_data/static-file-export-test/")
-    Set tSC = ##class(%IPM.Main).Shell("load -verbose " _ tModuleDir)
-    Do $$$AssertStatusOK(tSC,"Module successfully. " _ tModuleDir)
-    Set exportDir = ##class(%File).NormalizeDirectory($$$FileTempDirSys)
-    Set tSC = ##class(%IPM.Main).Shell("static-file-export-test package -DPath="_exportDir)
-    Do $$$AssertStatusOK(tSC,"Exported to directory " _ exportDir _ " successfully.")
-    Do $$$AssertTrue(##class(%File).DirectoryExists(exportDir))
-    For file = "LICENSE","README.md","requirements.txt","CHANGELOG.md" {
-      Set tFile = ##class(%File).NormalizeFilename(file, exportDir)
-      If '$$$AssertTrue(##class(%File).Exists(tFile)) {
-        Do $$$LogMessage("File "_tFile_" does not exist.")
+    set tSC = ##class(%IPM.Main).Shell("load -verbose " _ tModuleDir)
+    do $$$AssertStatusOK(tSC,"Module successfully. " _ tModuleDir)
+    set exportDir = ##class(%File).NormalizeDirectory($$$FileTempDirSys)
+    set tSC = ##class(%IPM.Main).Shell("static-file-export-test package -verbose -DPath="_exportDir)
+    do $$$AssertStatusOK(tSC,"Exported to directory " _ exportDir _ " successfully.")
+    // Need to unpack the tgz file
+    do $$$AssertStatusOK(##class(%IPM.Utils.File).RemoveDirectoryTree(exportDir))
+    set tgzFile = $zstrip(exportDir,">","/\")_".tgz"
+    set tSC = ##class(%IPM.General.Archive).Extract(tgzFile,exportDir,.tOutput)
+    do $$$AssertStatusOK(tSC, "Unpackaged " _ tgzFile _ " to "_exportDir)
+
+    do $$$AssertTrue(##class(%File).DirectoryExists(exportDir))
+    for file = "LICENSE","README.md","requirements.txt","CHANGELOG.md" {
+      set tFile = ##class(%File).NormalizeFilename(file, exportDir)
+      if '$$$AssertTrue(##class(%File).Exists(tFile)) {
+        do $$$LogMessage("File "_tFile_" does not exist.")
       }
     }
-  } Catch e {
-    Do $$$AssertStatusOK(e.AsStatus(), "An exception occurred.")
+  } catch e {
+    do $$$AssertStatusOK(e.AsStatus(), "An exception occurred.")
   }
 }