Feat: CPF Merge

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #582 Added functionality to optionally see time of last update and server version of each package
 - #609 Added support for `-export-deps` when running the "Package" phase of lifecycle
 - #541 Added support for ORAS repository
+- #702 Added a new lifecycle phase `Initialize` which supports merging the new `<CPF/>` resource.
 
 ### Changed
 - 

src/cls/IPM/Lifecycle/Base.cls

@@ -9,7 +9,7 @@ Property PhaseList As %List;
 
 /// $ListBuild list of phases in this lifecycle. <br />
 /// For each phase name, an instance method named "%<phase name>" must be defined in the class with a return type of %Status.
-Parameter PHASES = {$ListBuild("Clean","Reload","*","Validate","ExportData","Compile","Activate","Document","MakeDeployed","Test","Package","Verify", "Publish", "Configure","Unconfigure")};
+Parameter PHASES = {$ListBuild("Clean","Initialize", "Reload","*","Validate","ExportData","Compile","Activate","Document","MakeDeployed","Test","Package","Verify", "Publish", "Configure","Unconfigure")};
 
 Property Payload As %Stream.Object [ Private ];
 
@@ -138,18 +138,19 @@ ClassMethod GetCompletePhasesForOne(pOnePhase As %String) As %List
 
 	Quit $Case(pOnePhase,
 		"clean":		$ListBuild("Clean"),
-		"reload":		$ListBuild("Reload","*"),
-		"validate":		$ListBuild("Reload","*","Validate"),
+		"initialize":   $ListBuild("Initialize"),
+		"reload":		$ListBuild("Initialize","Reload","*"),
+		"validate":		$ListBuild("Initialize","Reload","*","Validate"),
 		"exportdata":	$ListBuild("ExportData"),
-		"compile":		$ListBuild("Reload","*","Validate","Compile"),
-		"activate":		$ListBuild("Reload","*","Validate","Compile","Activate"),
+		"compile":		$ListBuild("Initialize","Reload","*","Validate","Compile"),
+		"activate":		$ListBuild("Initialize","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"),
+		"test":			$ListBuild("Initialize","Reload","*","Validate","Compile","Activate","Test"),
+		"package":		$ListBuild("Initialize","Reload","*","Validate","Compile","Activate","Package"),
+		"verify":		$ListBuild("Initialize","Reload","*","Validate","Compile","Activate","Package","Verify"),
+		"register":		$ListBuild("Initialize","Reload","*","Validate","Compile","Activate","Package","Register"),
+		"publish":		$ListBuild("Initialize","Reload","*","Validate","Compile","Activate","Package","Register","Publish"),
 		"configure":	$ListBuild("Configure"),
 		"unconfigure":	$ListBuild("Unconfigure"),
 		:				""
@@ -162,6 +163,7 @@ ClassMethod MatchSinglePhase(pOnePhase As %String) As %String
 	Set phase = $ZCONVERT(pOnePhase, "L")
 	Quit $Case(phase,
 		"clean":		"Clean",
+		"initialize":	"Initialize",
 		"reload":		"Reload",
 		"validate":		"Validate",
 		"exportdata":	"ExportData",
@@ -501,6 +503,24 @@ Method %Unconfigure(ByRef pParams) As %Status
 	Quit tSC
 }
 
+Method %Initialize(ByRef pParams) As %Status
+{
+	Set tSC = $$$OK
+	Try {
+		Set tKey = ""
+		For {
+			Set tResource = ..Module.Resources.GetNext(.tKey)
+			Quit:tKey=""
+			If $IsObject(tResource.Processor) && ($CLASSNAME(tResource.Processor) = "%IPM.ResourceProcessor.CPF") {
+				Set tSC = $$$ADDSC(tSC,tResource.Processor.OnPhase("Initialize",.pParams))
+			}
+		}
+	} Catch ex {
+		Set tSC = ex.AsStatus()
+	}
+	Quit tSC
+}
+
 Method %Reload(ByRef pParams) As %Status
 {
 	Set tSC = $$$OK

src/cls/IPM/ResourceProcessor/CPF.cls

@@ -0,0 +1,51 @@
+Class %IPM.ResourceProcessor.CPF Extends %IPM.ResourceProcessor.Abstract
+{
+
+/// Comma-separated list of resource attribute names that this processor uses
+Parameter ATTRIBUTES As STRING = "Path";
+
+/// Description of resource processor class (shown in UI)
+Parameter DESCRIPTION As STRING = "Merges the specified CPF file in the ""Initialize"" lifecycle phase.";
+
+Property Path As %String(MAXLEN = "");
+
+/// Called as phase <var>pPhase</var> is executed for the resource. If <var>pResourceHandled</var> is set to true,
+/// then the default behavior for that resource will be bypassed in the current phase.
+/// Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses.
+/// TODO: Implement for standard database resources (.INC, .CLS, etc.)
+Method OnPhase(pPhase As %String, ByRef pParams, Output pResourceHandled As %Boolean = 0) As %Status
+{
+    Set verbose = $Get(pParams("Verbose"))
+    Set status = $$$OK
+    Try {
+        If pPhase '= "Initialize" {
+            Quit
+        }
+
+        If '$Data(pParams("RootDirectory"), root) {
+            $$$ThrowStatus($$$ERROR($$$GeneralError, "RootDirectory unspecified"))
+        }
+        // Use Construct first, rather than NormalizeFilename, so we don't have to deal with leading/trailing slashes
+        Set filename = ##class(%File).Construct(root, ..Path)  
+        Set filename = ##class(%File).NormalizeFilename(filename)
+
+        Set stream = ##class(%Stream.FileCharacter).%New()  
+        $$$ThrowOnError(stream.LinkToFile(filename))
+        If verbose {
+            Write !, "Merging CPF file: ", filename, !
+            While 'stream.AtEnd {
+                Write stream.Read()
+            }
+        }
+        // TODO actually merge the CPF file
+        // ...
+
+        Set pResourceHandled = 1
+    } Catch ex {
+        Set pResourceHandled = 0
+        Set status = ex.AsStatus()
+    }
+    Return status
+}
+
+}

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

@@ -0,0 +1,16 @@
+Class Test.PM.Integration.CPFMerge Extends Test.PM.Integration.Base
+{
+
+Parameter TargetModuleName As STRING = "cpf-merge";
+
+Method TestCPFMerge()
+{
+    Set tModuleDir = ..GetModuleDir(..#TargetModuleName)
+
+    Set tSC = ##class(%IPM.Main).Shell("load -v "_tModuleDir)
+    Do $$$AssertStatusOK(tSC, "Loaded module successfully")
+
+    // TODO - Add more tests here
+}
+
+}

tests/integration_tests/Test/PM/Integration/_data/cpf-merge/Merge.cpf

@@ -0,0 +1,3 @@
+[config]
+globals=0,0,150000,0,0,0
+gmheap=393,216

tests/integration_tests/Test/PM/Integration/_data/cpf-merge/module.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Export generator="Cache" version="25">
+  <Document name="cpf-merge.ZPM">
+    <Module>
+      <Name>cpf-merge</Name>
+      <Version>0.0.1</Version>
+      <Packaging>module</Packaging>
+      <CPF Path="/Merge.CPF"/>
+    </Module>
+  </Document>
+</Export>