Merge pull request #614 from intersystems/v1-next-fix-makedeployed

Fix: add makedeployed lifecycle method (HSIEO-11006)

CHANGELOG.md

@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #454: IPM 0.9.x+ uses different globals for storage vs. 0.7.0 and previous. Installation will automatically migrate data from the old globals to the new ones. The old globals are left around in case the user decides to revert to an earlier version.
 
 ### Fixed
+- HSIEO-11006: Fix conditions for marking code as deployed
 - HSIEO-9269, HSIEO-9402: % percent perforce directories are no longer necessary
 - HSIEO-9269, HSIEO-9404: Repo check should happen in the order to repo creation, not by repo name
 - HSIEO-9269, HSIEO-9411: Make sure can load and export xml Package-type resource

src/cls/IPM/Lifecycle/Base.cls

@@ -55,8 +55,11 @@ Method OnAfterResourceProcessing(pPhase As %String, ByRef pParams) As %Status
 
 Method %DispatchMethod(pMethod As %String, ByRef pParams, Args...) [ ServerOnly = 1 ]
 {
-	if $listfind(..#PHASES,pMethod)=0 do $zu(96,3,$$$ERNOMETHOD,1,"","method "_pMethod_" of class "_$classname())
-	quit ..Module.ExecutePhases(..Module.Name,$lb(pMethod),1,.pParams)
+	// Match method name with CamelCased lifecycle method
+	set convertedMethod = ..MatchSinglePhase(pMethod)
+
+	if $listfind(..#PHASES,convertedMethod)=0 do $zu(96,3,$$$ERNOMETHOD,1,"","method "_convertedMethod_" of class "_$classname())
+	quit ..Module.ExecutePhases(..Module.Name,$lb(convertedMethod),1,.pParams)
 }
 
 /// Merges default parameters into pParams
@@ -131,22 +134,48 @@ ClassMethod GetCompletePhases(pPhases As %List) As %List
 /// This method defines what a complete phase means for a given phase
 ClassMethod GetCompletePhasesForOne(pOnePhase As %String) As %List
 {
+	set pOnePhase = $ZCONVERT(pOnePhase, "L")
+
+	Quit $Case(pOnePhase,
+		"clean":		$ListBuild("Clean"),
+		"reload":		$ListBuild("Reload","*"),
+		"validate":		$ListBuild("Reload","*","Validate"),
+		"exportdata":	$ListBuild("ExportData"),
+		"compile":		$ListBuild("Reload","*","Validate","Compile"),
+		"activate":		$ListBuild("Reload","*","Validate","Compile","Activate"),
+		"document":		$ListBuild("Document"),
+		"makedeployed":	$ListBuild("MakeDeployed"),
+		"test":			$ListBuild("Reload","*","Validate","Compile","Activate","Test"),
+		"package":		$ListBuild("Reload","*","Validate","Compile","Activate","Package"),
+		"verify":		$ListBuild("Reload","*","Validate","Compile","Activate","Package","Verify"),
+		"register":		$ListBuild("Reload","*","Validate","Compile","Activate","Package","Register"),
+		"publish":		$ListBuild("Reload","*","Validate","Compile","Activate","Package","Register","Publish"),
+		"configure":	$ListBuild("Configure"),
+		"unconfigure":	$ListBuild("Unconfigure"),
+		:				""
+	)
+}
+
+/// Match single inputted phase to the correctly CamelCased lifecycle phase <br/>
+ClassMethod MatchSinglePhase(pOnePhase As %String) As %String
+{
+	set pOnePhase = $ZCONVERT(pOnePhase, "L")
 	Quit $Case(pOnePhase,
-		"Clean":		$ListBuild("Clean"),
-		"Reload":		$ListBuild("Reload","*"),
-		"Validate":		$ListBuild("Reload","*","Validate"),
-		"ExportData":	$ListBuild("ExportData"),
-		"Compile":		$ListBuild("Reload","*","Validate","Compile"),
-		"Activate":		$ListBuild("Reload","*","Validate","Compile","Activate"),
-		"Document":		$ListBuild("Document"),
-		"MakeDeployed":	$ListBuild("MakeDeployed"),
-		"Test":			$ListBuild("Reload","*","Validate","Compile","Activate","Test"),
-		"Package":		$ListBuild("Reload","*","Validate","Compile","Activate","Package"),
-		"Verify":		$ListBuild("Reload","*","Validate","Compile","Activate","Package","Verify"),
-		"Register":		$ListBuild("Reload","*","Validate","Compile","Activate","Package","Register"),
-		"Publish":		$ListBuild("Reload","*","Validate","Compile","Activate","Package","Register","Publish"),
-		"Configure":	$ListBuild("Configure"),
-		"Unconfigure":	$ListBuild("Unconfigure"),
+		"clean":		"Clean",
+		"reload":		"Reload",
+		"validate":		"Validate",
+		"exportdata":	"ExportData",
+		"compile":		"Compile",
+		"activate":		"Activate",
+		"document":		"Document",
+		"makedeployed":	"MakeDeployed",
+		"test":			"Test",
+		"package":		"Package",
+		"verify":		"Verify",
+		"register":		"Register",
+		"publish":		"Publish",
+		"configure":	"Configure",
+		"unconfigure":	"Unconfigure",
 		:				""
 	)
 }
@@ -1401,13 +1430,18 @@ Method %MakeDeployed(ByRef pParams) As %Status
 	Try {
 		Set tDev = ..Module.DeveloperMode
 		Set tVerbose = $Get(pParams("Verbose"))
+
+		// If the recurse parameter is set, then this lifecycle method should recursively deploy all of the 
+		// module's dependencies marked for deployment
+		Set tLockedDependencies = $Get(pParams("Recurse"),0) // Indicates whether entire dependency graph should be traversed and deployed
+
 		If tDev && tVerbose {
 		  Write !,"Module is in developer mode; will only report what WOULD be deployed unless packaging, in which case items WILL be deployed."
 		}
 
 		// Default implementation: see which resources are expicitly flagged with Deploy = true.
 		// Build an array of those, then mark them as deployed.
-		$$$ThrowOnError(..Module.GetResolvedReferences(.tResourceArray,1,..PhaseList,1,.pDependencyGraph))
+		$$$ThrowOnError(..Module.GetResolvedReferences(.tResourceArray,tLockedDependencies,..PhaseList,1,.pDependencyGraph))
 
 		Set tResourceKey = ""
 		For {

src/cls/IPM/Lifecycle/Module.cls

@@ -38,16 +38,6 @@ Method %Activate(ByRef pParams) As %Status
 
 		Set tSC = ..Configure(.pParams)
 		$$$ThrowOnError(tSC)
-
-		If '$ListFind(..PhaseList,"Package") {
-			// Code cannot be deployed if it is to be reexported and packaged.
-      Set tDevMode = $Get(pParams("DeveloperMode"), ..Module.DeveloperMode)
-      Set isKitBuild = $Get(pParams("IsKitBuild"),0)
-      If ('tDevMode && isKitBuild) {
-			  Set tSC = ..MakeDeployed(.pParams)
-			  $$$ThrowOnError(tSC)
-      		}
-		}
 
 		// Create Studio project for package if it is loaded in developer mode and no explicit statement to not create it
 		Set tNoStudioProject = $Get(pParams("NoStudioProject"), 0)

src/cls/IPM/Main.cls

@@ -7,7 +7,7 @@ Class %IPM.Main Extends %IPM.CLI
 
 Parameter DOMAIN = "ZPM";
 
-Parameter STANDARDPHASES = {$ListBuild("reload","compile","test","package","verify","publish")};
+Parameter STANDARDPHASES = {$ListBuild("reload","compile","test","package","verify","publish","makedeployed")};
 
 /// Description of commands to use for this CLI
 XData Commands [ XMLNamespace = "http://www.intersystems.com/PackageManager/CLI" ]
@@ -45,6 +45,7 @@ resources exported to the filesystem (and possible to source control) are consis
 with what is in the database.
 * compile: compiles all resources within the module.
 * activate: performs post-compilation installation/configuration steps.
+* makedeployed: deploys resources within the module for which deployment is enabled.
 * document: regenerates the API documentation for the module
 * test: runs any unit tests associated with the module, in the current namespace.
 * package: exports the module's resources and bundles them into a module artifact (.tgz file).
@@ -157,6 +158,18 @@ This command is an alias for `module-action module-name publish`
 <modifier name="verbose" aliases="v" dataAlias="Verbose" dataValue="1" description="Produces verbose output from the command." />
 </command>
 
+<command name="makedeployed">
+<description>
+This command is an alias for `module-action module-name makedeployed`
+</description>
+<parameter name="module" required="true" description="Name of module on which to perform reload action" />
+<modifier name="dev" dataAlias="DeveloperMode" dataValue="1" description="Sets the DeveloperMode flag for the module's lifecycle. Key consequences of this are that ^Sources will be configured for resources in the module, and installer methods will be called with the dev mode flag set." />
+<modifier name="only" aliases="o" description="Only runs the specified phase (makedeployed), rather than also running predecessors." />
+<modifier name="recurse" aliases="r" description="Runs the specified phase (makedeployed) on the module and all of its dependencies." />
+<modifier name="quiet" aliases="q" dataAlias="Verbose" dataValue="0" description="Produces minimal output from the command." />
+<modifier name="verbose" aliases="v" dataAlias="Verbose" dataValue="1" description="Produces verbose output from the command." />
+</command>
+
 <command name="unpublish">
 <description>
 Delete package from registry
@@ -2038,7 +2051,8 @@ ClassMethod RunOnePhase(ByRef pCommandInfo) [ Internal ]
 	Set tModName = $Get(pCommandInfo("parameters","module"))
 	Set tPhases = $ListBuild($ZConvert(pCommandInfo, "w"))
 	Set tIsComplete = '$$$HasModifier(pCommandInfo,"only")
-  Set tParams("cmd") = pCommandInfo
+  	Set tParams("Recurse") = $$$HasModifier(pCommandInfo,"recurse")
+	Set tParams("cmd") = pCommandInfo
 	Merge tParams = pCommandInfo("data")
 	$$$ThrowOnError(##class(%IPM.Storage.Module).ExecutePhases(tModName,tPhases,tIsComplete,.tParams))
 }

src/cls/IPM/Storage/Module.cls

@@ -257,7 +257,7 @@ ClassMethod ExecutePhases(pModuleName As %String, pPhases As %List, pIsComplete
 				Set tPhases = $ListBuild("PrepareDeploy") _ tPhases
 			}
 		} Else {
-			Set tPhases = pPhases
+			Set tPhases = $ListBuild(##class(%IPM.Lifecycle.Base).MatchSinglePhase($LISTTOSTRING(pPhases)))
 		}
 
 		// Lifecycle-provided default parameters
@@ -330,7 +330,7 @@ ClassMethod ExecutePhases(pModuleName As %String, pPhases As %List, pIsComplete
 						Quit
 					}
 					If $IsObject(tResource.Processor) {
-            Do tResource.Processor.SetParams(.pParams)
+            			Do tResource.Processor.SetParams(.pParams)
 						Set tSC = $Method(tResource.Processor,"OnBeforePhase",tOnePhase,.pParams)
 						$$$ThrowOnError(tSC)
 					}
@@ -503,6 +503,7 @@ Method GetDefaultParameters(Output pParams)
 	}
 }
 
+/// Returns whether pScope is in the list of pPhases <br />
 ClassMethod HasScope(pPhases As %List, pScope As %String) [ Private ]
 {
 	If (pScope = "") {
@@ -940,6 +941,13 @@ ClassMethod GetKnownDependencies(pModuleName As %String) As %List
 	Quit tKnownDependencyList
 }
 
+/// Builds a module's immediate dependency graph and array of resources.<br />
+/// Optionally loads uninstalled dependency modules and recurses over each module in the dependency graph.<br />
+/// @Argument	pReferenceArray		Array of all module's resources (including resources that compose a resource) that contain the appropriate phase scope.<br />
+/// @Argument	pLockedDependencies	Whether method should be recursively applied to the module's dependencies (true = yes).<br />
+/// @Argument	pPhases				List of IPM lifecycle phases to be applied to the current module.<br />
+/// @Argument	pSkipDependencies	Whether to skip loading uninstalled dependency modules.<br />
+/// @Argument	pDependencyGraph 	Tree of module's dependencies.<br />
 Method GetResolvedReferences(Output pReferenceArray, pLockedDependencies As %Boolean = 0, pPhases As %List = "", pSkipDependencies As %Boolean = 0, ByRef pDependencyGraph) As %Status
 {
 	Set tSC = $$$OK