Merge pull request #680 from intersystems/v0.9.x-fix-export-static-files

fix: always export static files if existent

Author: isc-shuliu

CHANGELOG.md

@@ -5,10 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased - 0.9.2+snapshot]
 ### Fixed
 - #681 Convert specified namespaces to upper case for `enable` and `unmap` commands.
+- #680 Always export static files (README.md, LICENSE, requirements.txt) if existent
 
 ## [0.9.1] - 2024-12-18
 

src/cls/IPM/Lifecycle/Base.cls

@@ -1184,9 +1184,9 @@ Method %Export(ByRef pParams, ByRef pTargetDirectory As %String, Output pDepende
 		}
     /// Always keep these files
      Set staticFiles = $ListBuild(
-    //   "readme.md",
-    //   "license",
-    //   "requirements.txt",
+       "readme.md",
+       "license",
+       "requirements.txt",
     )
     Set tRes = ##class(%File).FileSetFunc(..Module.Root)
     While tRes.%Next() {

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

@@ -0,0 +1,29 @@
+Include %IPM.Common
+
+Class Test.PM.Integration.StaticFileExport Extends Test.PM.Integration.Base
+{
+
+Method TestWSGIApp()
+{
+  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" {
+      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.")
+  }
+}
+
+}

tests/integration_tests/Test/PM/Integration/_data/static-file-export-test/LICENSE

@@ -0,0 +1 @@
+This is a license

tests/integration_tests/Test/PM/Integration/_data/static-file-export-test/README.md

@@ -0,0 +1 @@
+This is a readme

tests/integration_tests/Test/PM/Integration/_data/static-file-export-test/module.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Export generator="Cache" version="25">
+  <Document name="static-file-export-test.ZPM">
+    <Module>
+      <Name>static-file-export-test</Name>
+      <Version>1.0.0</Version>
+      <Description>Test whether static files (readme.md, licence, requirements.txt) are properly exported</Description>
+      <Packaging>module</Packaging>
+      <AfterInstallMessage>Module installed successfully!</AfterInstallMessage>     
+    </Module>    
+  </Document>
+</Export>

tests/integration_tests/Test/PM/Integration/_data/static-file-export-test/requirements.txt

@@ -0,0 +1 @@
+requests