Add support for user-configurable ModuleRoot #1149
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| Class Test.PM.Integration.ModuleRoot Extends Test.PM.Integration.Base | ||
| { | ||
|
|
||
| Method OnBeforeAllTests() As %Status | ||
| { | ||
| set sc = ##class(%IPM.Main).Shell("repo -remote -n registry -url https://pm.community.intersystems.com/ -user """" -pass """"") | ||
| do $$$AssertStatusOK(sc, "Community registry configured.") | ||
| return sc | ||
| } | ||
|
|
||
| Method OnAfterAllTests() As %Status | ||
| { | ||
| set sc = ##class(%IPM.Main).Shell("uninstall objectscript-math -force") | ||
| set sc = ##class(%IPM.Main).Shell("repo -delete -n registry") | ||
| do $$$AssertStatusOK(sc, "Community registry removed.") | ||
| return sc | ||
| } | ||
|
|
||
| Method OnAfterOneTest(testname As %String) As %Status | ||
| { | ||
| set sc = ##class(%IPM.Repo.UniversalSettings).ResetToDefault(##class(%IPM.Repo.UniversalSettings).#ModuleRoot) | ||
| do $$$AssertStatusOK(sc, "ModuleRoot reset to default after test.") | ||
| for dir = "ipm-test-root-exists/","ipm-test-root-new/" { | ||
| set fullPath = ##class(%File).NormalizeDirectory(##class(%File).ManagerDirectory() _ dir) | ||
| if ##class(%File).DirectoryExists(fullPath) { | ||
| do ##class(%File).RemoveDirectoryTree(fullPath) | ||
| } | ||
| } | ||
| return sc | ||
| } | ||
|
|
||
| Method TestModuleRootDefault() | ||
| { | ||
| set sc = $$$OK | ||
| try { | ||
| set defaultRoot = ##class(%File).NormalizeDirectory(##class(%SYSTEM.Util).DataDirectory() _ "ipm/") | ||
|
|
||
| set moduleObj = ##class(%IPM.Storage.Module).NameOpen("objectscript-math") | ||
| if $isobject(moduleObj) { | ||
| do $$$AssertStatusOK(##class(%IPM.Main).Shell("uninstall objectscript-math"), "Uninstalled objectscript-math before test.") | ||
| } | ||
|
|
||
| do $$$AssertStatusOK(##class(%IPM.Main).Shell("install objectscript-math"), "Installed objectscript-math using default ModuleRoot.") | ||
|
|
||
| set moduleObj = ##class(%IPM.Storage.Module).NameOpen("objectscript-math") | ||
| set moduleRoot = ##class(%File).NormalizeDirectory($piece(moduleObj.Root, "objectscript-math")) | ||
| do $$$AssertEquals(moduleRoot, defaultRoot, "Module installed into default root.") | ||
| } catch ex { | ||
| do $$$AssertStatusOK(ex.AsStatus(), "Unexpected exception in TestModuleRootDefault.") | ||
| } | ||
| } | ||
|
|
||
| Method TestModuleRootCustomPathExists() | ||
| { | ||
| set sc = $$$OK | ||
| try { | ||
| set defaultRoot = ##class(%File).NormalizeDirectory(##class(%SYSTEM.Util).DataDirectory() _ "ipm/") | ||
| set customPath = ##class(%File).NormalizeDirectory(##class(%File).ManagerDirectory() _ "ipm-test-root-exists/") | ||
|
|
||
| do $$$AssertTrue(##class(%File).CreateDirectoryChain(customPath), "Created custom ModuleRoot directory.") | ||
|
Collaborator
There was a problem hiding this comment. Should this be done in the test or do you want to test this dir gets created by IPM? Perhaps testing both cases where the dir already exists vs doesn't exist would be nice. Also I'm not sure how you would test this but it would be interesting to test a case where the instance doesn't have permission to the directory
Collaborator
Author
There was a problem hiding this comment. Split the test into the two cases. For the permissions testing, I did some manual testing where I did If ipm_temp already exists, then this error results: |
||
|
|
||
| do $$$AssertStatusOK(##class(%IPM.Repo.UniversalSettings).UpdateOne("ModuleRoot", customPath), "Set ModuleRoot to existing custom path.") | ||
| do $$$AssertEquals(##class(%IPM.Repo.UniversalSettings).GetModuleRoot(), customPath, "ModuleRoot stored as normalized path.") | ||
|
|
||
| set moduleObj = ##class(%IPM.Storage.Module).NameOpen("objectscript-math") | ||
| if $isobject(moduleObj) { | ||
| do $$$AssertStatusOK(##class(%IPM.Main).Shell("uninstall objectscript-math"), "Uninstalled objectscript-math before relocation test.") | ||
| } | ||
|
|
||
| do $$$AssertStatusOK(##class(%IPM.Main).Shell("install objectscript-math"), "Installed objectscript-math using existing custom ModuleRoot.") | ||
|
|
||
| set moduleObj = ##class(%IPM.Storage.Module).NameOpen("objectscript-math") | ||
| set moduleRoot = ##class(%File).NormalizeDirectory($piece(moduleObj.Root, "objectscript-math")) | ||
| do $$$AssertTrue(moduleRoot '= defaultRoot, "Module is no longer in default root.") | ||
| do $$$AssertTrue(moduleRoot [ customPath, "Module is installed in custom root: " _ moduleRoot) | ||
| } catch ex { | ||
| do $$$AssertStatusOK(ex.AsStatus(), "Unexpected exception in TestModuleRootCustomPathExists.") | ||
| } | ||
| } | ||
|
|
||
| Method TestModuleRootCustomPathCreated() | ||
| { | ||
| set sc = $$$OK | ||
| try { | ||
| set defaultRoot = ##class(%File).NormalizeDirectory(##class(%SYSTEM.Util).DataDirectory() _ "ipm/") | ||
| set customPath = ##class(%File).NormalizeDirectory(##class(%File).ManagerDirectory() _ "ipm-test-root-new/") | ||
|
|
||
| // Remove the directory if it exists from a prior run | ||
| if ##class(%File).DirectoryExists(customPath) { | ||
| do ##class(%File).RemoveDirectoryTree(customPath) | ||
| } | ||
| do $$$AssertTrue('##class(%File).DirectoryExists(customPath), "Custom path does not exist before config set.") | ||
|
|
||
| do $$$AssertStatusOK(##class(%IPM.Repo.UniversalSettings).UpdateOne("ModuleRoot", customPath), "Set ModuleRoot to nonexistent path — should create it.") | ||
| do $$$AssertTrue(##class(%File).DirectoryExists(customPath), "Directory was created by config set.") | ||
|
|
||
| set moduleObj = ##class(%IPM.Storage.Module).NameOpen("objectscript-math") | ||
| if $isobject(moduleObj) { | ||
| do $$$AssertStatusOK(##class(%IPM.Main).Shell("uninstall objectscript-math"), "Uninstalled objectscript-math before relocation test.") | ||
| } | ||
|
|
||
| do $$$AssertStatusOK(##class(%IPM.Main).Shell("install objectscript-math"), "Installed objectscript-math into auto-created custom ModuleRoot.") | ||
|
|
||
| set moduleObj = ##class(%IPM.Storage.Module).NameOpen("objectscript-math") | ||
| set moduleRoot = ##class(%File).NormalizeDirectory($piece(moduleObj.Root, "objectscript-math")) | ||
| do $$$AssertTrue(moduleRoot '= defaultRoot, "Module is no longer in default root.") | ||
| do $$$AssertTrue(moduleRoot [ customPath, "Module is installed in auto-created root: " _ moduleRoot) | ||
| } catch ex { | ||
| do $$$AssertStatusOK(ex.AsStatus(), "Unexpected exception in TestModuleRootCustomPathCreated.") | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a side effect and should be documented and conveyed in the method name. The name sounds like its just checking. Not creating