Savepoint of current progress before I nuke the "ci" command

Author: James Lechtner

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #992: Implement automatic history purge logic
 - #973: Enables CORS and JWT configuration for WebApplications in module.xml
 - #1110: Add `iriscli` and `ipm` container utility scripts that are auto-installed to `~/.local/bin/` and `~/bin/` so they work both inside and outside of containers (Unix/Linux only)
+- #962: Adding zpm "ci" command to install from a lock file
 
 ### Fixed
 - #1001: The `unmap` and `enable` commands will now only activate CPF merge once after all namespaces have been configured instead after every namespace
@@ -26,7 +27,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - #1024: Added flag -export-python-deps to publish command
-- #962: Adding zpm "ci" command to install from a lock file
 
 ### Fixed
 - #996: Ensure COS commands execute in exec under a dedicated, isolated context

src/cls/IPM/General/LockFile.cls

@@ -136,8 +136,7 @@ ClassMethod InstallFromLockFile(
                 write !, "Repo: "_repoName_" already exists, skipping creating new one from lock file"
             }
             continue
-        }
-        elseif (verbose) {
+        } elseif (verbose) {
             write !, "Creating repo: "_repoName_" from lock file"
         }
         do ##class(%IPM.Repo.Definition).CollectServerTypes(.types)
@@ -163,6 +162,10 @@ ClassMethod InstallFromLockFile(
         set commandInfo("parameters","module") = repository_"/"_depName
         set commandInfo("parameters", "version") = version
         set commandInfo("data", "LockFileInstallStarted") = 1
+
+        set commandInfo("data","cmd") = "ci"
+        set commandInfo("data","CleanInstall") = 1
+
         do ##class(%IPM.Main).CleanInstall(.commandInfo)
     }
 }

src/cls/IPM/Main.cls

@@ -293,6 +293,7 @@ load C:\module\root\path -env C:\path\to\env1.json;C:\path\to\env2.json
 <modifier name="synchronous" value="false" deprecated="true" description="DEPRECATED. Dependencies are now always loaded synchronously with independent lifecycle phases doing their own multi-threading as needed." />
 <modifier name="force" aliases="f" value="false" description="Allows the user to load a newer version of an existing module without running update steps." />
 <modifier name="create-lockfile" aliases="lock" dataAlias="CreateLockFile" dataValue="1" description="Upon load, creates/updates the module's lock file." />
+<modifier name="from-lockfile" aliases="ci" dataAlias="LoadFromLockFile" dataValue="1" description="Load the module from the lock file present at the path." />
 
 <!-- Parameters -->
 <parameter name="path" required="true" description="Directory on the local filesystem, containing a file named module.xml" />
@@ -811,6 +812,7 @@ generate /my/path -export 00000,PacketName2,IgnorePacket2^00000,PacketName3,Igno
 
 <!-- Modifiers -->
 <modifier name="verbose" aliases="v" dataAlias="Verbose" dataValue="1" description="Produces verbose output from the command." />
+<modifier name="path" aliases="p" value="true" description="Location of local tarball containing the updated version of the module. Overrides 'version' parameter if present." />
 </command>
 
 </commands>
@@ -2398,14 +2400,18 @@ ClassMethod LoadInternal(
         }
     }
 
-    // When loading a module from a local folder, there might be a <mod root>/.modules/ folder containining dependencies.
-    // It's easier to configure a temporary repository than to handle this case in the dependency resolution code.
     set tTargetDirectory = $get(tTargetDirectory, tDirectoryName)
-    set dotModules = ##class(%File).NormalizeDirectory(".modules", tTargetDirectory)
-    set tmpRepoMgr = ##class(%IPM.General.TempLocalRepoManager).%New(dotModules, 1)
-    set tSC = ##class(%IPM.Utils.Module).LoadNewModule(tTargetDirectory, .tParams, , pLog)
-    set tSC = $$$ADDSC(tSC, tmpRepoMgr.CleanUp())
-    $$$ThrowOnError(tSC)
+    if ($get(pCommandInfo("data", "LoadFromLockFile"))) {
+        do ##class(%IPM.General.LockFile).InstallFromLockFile(tTargetDirectory, .tParams)
+    } else {
+        // When loading a module from a local folder, there might be a <mod root>/.modules/ folder containining dependencies.
+        // It's easier to configure a temporary repository than to handle this case in the dependency resolution code.
+        set dotModules = ##class(%File).NormalizeDirectory(".modules", tTargetDirectory)
+        set tmpRepoMgr = ##class(%IPM.General.TempLocalRepoManager).%New(dotModules, 1)
+        set tSC = ##class(%IPM.Utils.Module).LoadNewModule(tTargetDirectory, .tParams, , pLog)
+        set tSC = $$$ADDSC(tSC, tmpRepoMgr.CleanUp())
+        $$$ThrowOnError(tSC)
+    }
 }
 
 ClassMethod CheckModuleNamespace() As %Status
@@ -2552,10 +2558,17 @@ ClassMethod CleanInstall(ByRef commandInfo) [ Internal ]
     // Indicating to commandInfo that this is a clean install command, not an install or load command. commandInfo will be passed to either Install() or Load() to continue performing the update.
     set commandInfo("data","cmd") = "ci"
     set commandInfo("data","CleanInstall") = 1
-    set log = ##class(%IPM.General.HistoryTemp).UpdateInit(moduleName)
+    //set log = ##class(%IPM.General.HistoryTemp).UpdateInit(moduleName)
 
-    // Forward execution to install
-    do ..Install(.commandInfo, log)
+    // A path to a tarball is specified. Call ..Load() in order to load the newer version of the module.
+    set path = $$$GetModifier(pCommandInfo,"path")
+    if (path) {
+        set pCommandInfo("parameters","path") = path
+        do ..Load(.pCommandInfo, log)
+    } else {
+        // Forward execution to install
+        do ..Install(.commandInfo, log)
+    }
 }
 
 ClassMethod Reinstall(ByRef pCommandInfo) [ Internal ]

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

@@ -535,6 +535,41 @@ Method TestUpdate()
     }
 }
 
+Method TestCleanInstall()
+{
+    // Setup repo for "ci" test
+    set repoName = "lock-file-base"
+    do ##class(%IPM.Main).Shell("repo -n " _ repoName _ " -fs -path /home/irisowner/zpm/tests/integration_tests/Test/PM/Integration/_data/lock-test/mods-base-cases/")
+
+    // Call zpm "ci" on a simple module
+    set moduleName = "lock-mod-a-no-deps"
+    set command = "ci " _ moduleName
+    set sc = ##class(%IPM.Main).Shell(command)
+    do $$$AssertStatusOK(sc, "Successfully installed " _ moduleName _ " from lock file")
+
+    // get history
+    set rs = ##class(%IPM.General.History).GetHistory(,,1)
+    while rs.%Next() {
+        do $$$AssertTrue(rs.%Get("ID") '= "")
+        do $$$AssertEquals(rs.%Get("Action"), "ci")
+        do $$$AssertEquals(rs.%Get("Package"), moduleName)
+        do $$$AssertEquals(rs.%Get("Version_Major"), "1")
+        do $$$AssertEquals(rs.%Get("Version_Minor"), "0")
+        do $$$AssertEquals(rs.%Get("Version_Patch"), "0")
+        do $$$AssertEquals(rs.%Get("UserName"), "irisowner")
+        do $$$AssertTrue(rs.%Get("TimeStart") '= "")
+        do $$$AssertTrue(rs.%Get("TimeEnd") '= "")
+        do $$$AssertEquals(rs.%Get("Success"),1)
+        do $$$AssertEquals(rs.%Get("Committed"),1)
+        do $$$AssertEquals(rs.%Get("CommandString"), command)
+        do $$$AssertEquals(rs.%Get("SourceMoniker"), "filesystem")
+        do $$$AssertEquals(rs.%Get("SourceName"), repoName)
+    }
+
+    // Remove this test's repo now that the test is over
+    do ##class(%IPM.Main).Shell("repo -n " _ repoName _ " -fs -path /home/irisowner/zpm/tests/integration_tests/Test/PM/Integration/_data/lock-test/mods-base-cases/")
+}
+
 /// Tests that history entries correctly record all phases of module operations.
 /// Verifies that:
 /// - Load and install operations record 5 phases: Initialize, Reload, Validate, Compile, Activate

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

@@ -286,7 +286,7 @@ Method Test08Module2DependenciesSameTransient()
     try {
         do ..ExecuteGenericLockFileTest(..#ModuleK)
     } catch e {
-        do $$$AssertStatusOK(e.AsStatus(),"An exception occurred in Test09Module2DependenciesSameTransient.")
+        do $$$AssertStatusOK(e.AsStatus(),"An exception occurred in Test08Module2DependenciesSameTransient.")
     }
 }
 
@@ -297,7 +297,47 @@ Method Test09ComplexNestedDependencies()
     try {
         do ..ExecuteGenericLockFileTest(..#ModuleL)
     } catch e {
-        do $$$AssertStatusOK(e.AsStatus(),"An exception occurred in Test10ComplexNestedDependencies.")
+        do $$$AssertStatusOK(e.AsStatus(),"An exception occurred in Test09ComplexNestedDependencies.")
+    }
+}
+
+/// Installing from lock file by loading from a packaged tarball
+/// Uses Module K
+Method Test10InstallViaLoad()
+{
+    try {
+        set moduleName = ..#ModuleK
+
+        set sc = ##class(%IPM.Main).Shell("install " _ moduleName)
+        do $$$AssertStatusOK(sc, "Successfully installed " _ moduleName)
+
+        set packagePath = "/home/irisowner/zpm/tests/integration_tests/Test/PM/Integration/_data/lock-test/package/pack"
+        set sc = ##class(%IPM.Main).Shell("package " _ moduleName _ " -path " _ packagePath)
+        do $$$AssertStatusOK(sc, "Successfully packaged " _ moduleName)
+
+        set sc = ##class(%IPM.Main).Shell("uninstall -r " _ moduleName)
+        do $$$AssertStatusOK(sc, "Successfully packaged " _ moduleName _ " and dependencies prior to load")
+
+        do $$$LogMessage("GOING TO repo -list")
+        zpm "repo -list"
+
+        set sc = ##class(%IPM.Main).Shell("repo -delete -name lock-file-base")
+        do $$$AssertStatusOK(sc, "Successfully removed repo lock-file-base prior to load")
+        set sc = ##class(%IPM.Main).Shell("repo -delete -name lock-file-edge")
+        do $$$AssertStatusOK(sc, "Successfully removed repo lock-file-edge prior to load")
+
+        do $$$LogMessage("GOING TO repo -list")
+        zpm "repo -list"
+
+        set sc = ##class(%IPM.Main).Shell("load -from-lockfile " _ packagePath _ ".tgz")
+        do $$$AssertStatusOK(sc, "Successfully loaded packaged module from its lock file")
+
+        do $$$LogMessage("GOING TO repo -list")
+        zpm "repo -list"
+    } catch e {
+        do $$$LogMessage("GOING TO repo -list")
+        zpm "repo -list"
+        do $$$AssertStatusOK(e.AsStatus(),"An exception occurred in Test10InstallViaLoad.")
     }
 }