Getting rid of "ci" command in place for "-from-lockfile" flag

Author: James Lechtner

CHANGELOG.md

@@ -11,7 +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
+- #962: Adding zpm -from-lockfile flag to install/load 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

src/cls/IPM/General/AbstractHistory.cls

@@ -66,11 +66,6 @@ ClassMethod InstallInit(Package As %IPM.DataType.ModuleName) As %IPM.General.Abs
     quit ..Init("install", Package)
 }
 
-ClassMethod CleanInstallInit(Package As %IPM.DataType.ModuleName) As %IPM.General.AbstractHistory
-{
-    quit ..Init("ci", Package)
-}
-
 ClassMethod LoadInit(Package As %IPM.DataType.ModuleName = "") As %IPM.General.AbstractHistory
 {
     // Package name may not known at this point, so use a placeholder

src/cls/IPM/General/LockFile.cls

@@ -123,7 +123,11 @@ ClassMethod InstallFromLockFile(
     set verbose = $get(params("Verbose"), 0)
 
     set lockFilePath = ##class(%File).NormalizeFilename("module-lock.json", directory)
-    set lockFileJSON = ##class(%DynamicObject).%FromJSONFile(lockFilePath)
+    try {
+        set lockFileJSON = ##class(%DynamicObject).%FromJSONFile(lockFilePath)
+    } catch {
+        $$$ThrowStatus($$$ERROR($$$GeneralError,$$$FormatText("Unable to parse lock file JSON at path: %1", lockFilePath)))
+    }
 
     set repositories = lockFileJSON.%Get("repositories", {})
     set dependencies = lockFileJSON.%Get("dependencies", {})
@@ -156,17 +160,15 @@ ClassMethod InstallFromLockFile(
         set version = depVals.version
         set repository = depVals.repository
 
-        // Call CleanInstall() on dependency modules but set flag "LockFileInstallStarted" so we don't try installing from the dependency module's lock file
-        set commandInfo = "ci"
+        // Call Install() on dependency modules but set flag "LockFileInstallStarted" so we don't try installing from the dependency module's lock file
+        set commandInfo = "install"
         set commandInfo("data", "Verbose") = verbose
         set commandInfo("parameters","module") = repository_"/"_depName
         set commandInfo("parameters", "version") = version
         set commandInfo("data", "LockFileInstallStarted") = 1
+        set commandInfo("data","FromLockFile") = 1
 
-        set commandInfo("data","cmd") = "ci"
-        set commandInfo("data","CleanInstall") = 1
-
-        do ##class(%IPM.Main).CleanInstall(.commandInfo)
+        do ##class(%IPM.Main).Install(.commandInfo)
     }
 }
 

src/cls/IPM/Main.cls

@@ -292,8 +292,8 @@ load C:\module\root\path -env C:\path\to\env1.json;C:\path\to\env2.json
 <modifier name="extra-pip-flags" dataAlias="ExtraPipFlags" value="true" description="Extra flags to pass to pip when installing python dependencies. Surround the flags (and values) with quotes if spaces are present. Default flags are &quot;--target &lt;target&gt; --python-version &lt;pyversion&gt; --only-binary=:all:&quot;." />
 <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." />
+<modifier name="create-lockfile" dataAlias="CreateLockFile" dataValue="1" description="Upon load, creates/updates the module's lock file." />
+<modifier name="from-lockfile" dataAlias="FromLockFile" 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" />
@@ -420,7 +420,8 @@ install -env /path/to/env1.json;/path/to/env2.json example-package
 <modifier name="extra-pip-flags" dataAlias="ExtraPipFlags" value="true" description="Extra flags to pass to pip when installing python dependencies. Surround the flags (and values) with quotes if spaces are present. Default flags are &quot;--target &lt;target&gt; --python-version &lt;pyversion&gt; --only-binary=:all:&quot;."/>
 <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 install a newer version of an existing module without running update steps." />
-<modifier name="create-lockfile" aliases="lock" dataAlias="CreateLockFile" dataValue="1" description="Upon install, creates/updates the module's lock file." />
+<modifier name="create-lockfile" dataAlias="CreateLockFile" dataValue="1" description="Upon install, creates/updates the module's lock file." />
+<modifier name="from-lockfile" dataAlias="FromLockFile" dataValue="1" description="Load the module from the lock file present at the path." />
 
 </command>
 
@@ -795,26 +796,6 @@ generate /my/path -export 00000,PacketName2,IgnorePacket2^00000,PacketName3,Igno
     <example description="Display the current history retention setting.">config get HistoryRetain</example>
 </command>
 
-<command name="ci">
-<summary>Installs a module from a lock file</summary>
-<description>
-    Installs a module from its lock file. Will first install all listed repositories followed by dependency modules and then the base module.
-</description>
-
-<!-- Examples -->
-<example description="Reads from the module-lock.json defined for mymodule and installs the repositories, module, and dependencies">
-    ci mymodule 3.0.0
-</example>
-
-<!-- Parameters -->
-<parameter name="module" required="true" description="Name of module on which to perform update actions" />
-<parameter name="version" description="Version (or version expression) of module to install; defaults to the latest available if unspecified." />
-
-<!-- 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>
 }
 
@@ -1103,8 +1084,6 @@ ClassMethod ShellInternal(
                 do ..Information(.tCommandInfo)
             } elseif (tCommandInfo = "history") {
                 do ..History(.tCommandInfo)
-            } elseif (tCommandInfo = "ci") {
-                do ..CleanInstall(.tCommandInfo)
             }
         } catch pException {
             if (pException.Code = $$$ERCTRLC) {
@@ -2401,7 +2380,7 @@ ClassMethod LoadInternal(
     }
 
     set tTargetDirectory = $get(tTargetDirectory, tDirectoryName)
-    if ($get(pCommandInfo("data", "LoadFromLockFile"))) {
+    if ($get(pCommandInfo("data", "FromLockFile"))) {
         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.
@@ -2542,35 +2521,6 @@ ClassMethod Install(
     $$$ThrowOnError(log.Finalize($$$OK, devMode))
 }
 
-ClassMethod CleanInstall(ByRef commandInfo) [ Internal ]
-{
-    set moduleName = $get(commandInfo("parameters","module"))
-    set version = $get(commandInfo("parameters","version"))
-    set verbose = $get(commandInfo("data","Verbose"))
-    set log = ##class(%IPM.General.HistoryTemp).CleanInstallInit(moduleName)
-
-    // TODO: Add "path"? (see Update() for more info of calling install v load)
-
-    if verbose {
-        write !, "Going to run a clean install on "_moduleName
-    }
-
-    // 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)
-
-    // 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 ]
 {
     // Overriding defaults in the "data" array:

src/cls/IPM/Utils/Module.cls

@@ -271,7 +271,7 @@ ClassMethod LoadModuleFromDirectory(
 {
     set tSC = $$$OK
     try {
-        if $get(pParams("CleanInstall"), 0) && '$get(pParams("LockFileInstallStarted"), 0) {
+        if $get(pParams("FromLockFile"), 0) && '$get(pParams("LockFileInstallStarted"), 0) {
             do ##class(%IPM.General.LockFile).InstallFromLockFile(pDirectory, .pParams)
         }
         set tVerbose = $get(pParams("Verbose"))
@@ -1252,8 +1252,8 @@ ClassMethod LoadNewModule(
         }
 
         // If installing from a lock file, don't need to load dependencies since dependencies will be installed in order anyways
-        if ('$get(params("CleanInstall"), 0)) {
-            do ..LoadDependencies(tModule, .params)
+        if ('$get(params("FromLockFile"), 0)) {
+            do ..LoadDependencies(tModule,,.params)
         }
 
 

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

@@ -535,41 +535,6 @@ 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

@@ -205,7 +205,7 @@ Method Test06ModuleMultipleVersions()
         do $$$AssertStatusOK(sc, "Uninstalled "_moduleName)
 
         // Install module from lock file
-        set sc = ##class(%IPM.Main).Shell("ci "_moduleName)
+        set sc = ##class(%IPM.Main).Shell("install -from-lockfile "_moduleName)
         do $$$AssertStatusOK(sc, "Able to install "_moduleName_" v"_latestVersion_" from the lock file")
 
         // Confirm classes and dependencies get installed as well
@@ -236,7 +236,7 @@ Method Test06ModuleMultipleVersions()
         do $$$AssertStatusOK(sc, "Uninstalled "_moduleName)
 
         // Install module from lock file
-        set sc = ##class(%IPM.Main).Shell("ci "_moduleName_" "_olderVersion)
+        set sc = ##class(%IPM.Main).Shell("install -from-lockfile "_moduleName_" "_olderVersion)
         do $$$AssertStatusOK(sc, "Able to install "_moduleName_" v"_olderVersion_" from the lock file")
 
         // Confirm classes and dependencies get installed as well
@@ -272,8 +272,8 @@ Method Test07ModuleNoLockFile()
         do $$$AssertStatusOK(sc, "Uninstalled "_moduleName)
 
         // This should fail due to no lock file
-        set sc = ##class(%IPM.Main).Shell("ci "_moduleName)
-        do $$$AssertStatusNotOK(sc, "zpm ""ci"" fails on module "_moduleName_"due to not having a lock file")
+        set sc = ##class(%IPM.Main).Shell("install -from-lockfile "_moduleName)
+        do $$$AssertStatusNotOK(sc, "Installing from a lock file fails on module "_moduleName_"due to not having a lock file")
     } catch e {
         do $$$AssertStatusOK(e.AsStatus(),"An exception occurred in Test07ModuleNoLockFile.")
     }
@@ -318,25 +318,14 @@ Method Test10InstallViaLoad()
         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.")
     }
 }
@@ -402,7 +391,7 @@ Method AssertInstallFromLockFileAsExpected(
 	moduleName As %String,
 	className As %String = "")
 {
-    set sc = ##class(%IPM.Main).Shell("ci "_moduleName)
+    set sc = ##class(%IPM.Main).Shell("install -from-lockfile "_moduleName)
     do $$$AssertStatusOK(sc, "Installed "_moduleName_" via the lock file successfully")
 
     set sc = $$$OK