CLI support for configuring SSH keys and clone/init

Author: isc-tleavitt

CHANGELOG.md

@@ -9,8 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Page to support deployment (git pull and run pull event handler) with verbose output
-- Support for git clone to initialize namespace via Settings page (#234, #237)
-- Support for automatically creating SSH keys for use as deploy keys (#33)
+- Support for git clone to initialize namespace via Settings page and `##class(SourceControl.Git.API).Configure()` (#234, #237)
+- Support for automatically creating SSH keys for use as deploy keys via Settings page and `Configure()` (#33)
 
 ### Fixed
 - Protect against Favorites links containing control characters (#254)

README.md

@@ -18,6 +18,7 @@
    ```
    d ##class(SourceControl.Git.API).Configure()
    ```
+   This will also allow you to generate an SSH key for use as (e.g.) a deploy key and to initialize or clone a git repo.
 3. If using VSCode: Set up `isfs` server-side editing. First, save your current workspace in which you have the code open. Then, open the `.code-workspace` file generated by VS Code and add the following to the list of folders: 
     ```
     {

cls/SourceControl/Git/Settings.cls

@@ -11,7 +11,7 @@ Property gitBinPath As %String(MAXLEN = "");
 /// Local git repo root folder
 Property namespaceTemp As %String(MAXLEN = "") [ InitialExpression = {##class(SourceControl.Git.Utils).TempFolder()}, Required ];
 
-/// Path to private key file (for ssh remotes)
+/// Path to private key file for SSH remotes; if file does not exist, later prompts will help set it up with proper ownership
 Property privateKeyFile As %String(MAXLEN = "") [ InitialExpression = {##class(SourceControl.Git.Utils).PrivateKeyFile()} ];
 
 /// Event handler class for git pull
@@ -104,8 +104,64 @@ ClassMethod Configure() As %Boolean [ CodeMode = objectgenerator ]
     }
     do %code.WriteLine(" $$$ThrowOnError(inst.%Save())")
     do %code.WriteLine(" write !,""Settings saved.""")
+    do %code.WriteLine(" do inst.OnAfterConfigure()")
     do %code.WriteLine(" quit 1")
 }
 
+Method OnAfterConfigure() As %Boolean
+{
+    set defaultPromptFlag = $$$DisableBackupCharMask + $$$TrapCtrlCMask + $$$EnableQuitCharMask + $$$DisableHelpCharMask + $$$DisableHelpContextCharMask + $$$TrapErrorMask
+    if (..privateKeyFile '= "") && '##class(%File).Exists(..privateKeyFile) {
+        set value = 1
+        set response = ##class(%Library.Prompt).GetYesNo("Do you wish to create a new SSH key pair?",.value,,defaultPromptFlag)
+        if (response '= $$$SuccessResponse) {
+            quit
+        }
+        if value {
+            #dim workMgr As %SYSTEM.AbstractWorkMgr
+            set workMgr = $System.WorkMgr.%New("")
+            $$$ThrowOnError(workMgr.Queue("##class(SourceControl.Git.Utils).GenerateSSHKeyPair"))
+            $$$ThrowOnError(workMgr.Sync())
+            set pubKeyName = ..privateKeyFile_".pub"
+            if ##class(%File).Exists(pubKeyName) {
+                set pubStream = ##class(%Stream.FileCharacter).%OpenId(pubKeyName,,.sc)
+                $$$ThrowOnError(sc)
+                Write !,"Public key (for use as ""deploy key"", etc.):",!
+                do pubStream.OutputToDevice()
+                Write !
+            }
+        }
+    }
+
+    set gitDir = ##class(%File).NormalizeDirectory(..namespaceTemp)_".git"
+    if '##class(%File).DirectoryExists(gitDir) {
+        set list(1) = "Initialize empty repo"
+        set list(2) = "Clone..."
+        set list(3) = "Do nothing"
+        set value = ""
+        while ('+$get(value)) {
+            set response = ##class(%Library.Prompt).GetMenu("No git repo exists in "_..namespaceTemp_". Choose an option:",.value,.list,,defaultPromptFlag + $$$InitialDisplayMask)
+            if (response '= $$$SuccessResponse) && (response '= $$$BackupResponse) {
+                return
+            }
+        }
+        if (value = 1) {
+            set workMgr = $System.WorkMgr.%New("")
+            $$$ThrowOnError(workMgr.Queue("##class(SourceControl.Git.Utils).Init"))
+            $$$ThrowOnError(workMgr.Sync())
+        } elseif (value = 2) {
+            set response = ##class(%Library.Prompt).GetString("Git remote URL (note: if authentication is required, use SSH, not HTTPS):",.remote,,,,defaultPromptFlag)
+            if (response '= $$$SuccessResponse) {
+                quit
+            }
+            if (remote = "") {
+                quit
+            }
+            set workMgr = $System.WorkMgr.%New("")
+            $$$ThrowOnError(workMgr.Queue("##class(SourceControl.Git.Utils).Clone",remote))
+            $$$ThrowOnError(workMgr.Sync())
+        }
+    }
 }
 
+}

cls/SourceControl/Git/Utils.cls

@@ -267,13 +267,14 @@ ClassMethod AfterUserAction(Type As %Integer, Name As %String, InternalName As %
     quit $$$OK
 }
 
-ClassMethod Init()
+ClassMethod Init() As %Status
 {
     do ..RunGitCommand("init",.errStream,.outStream)
     $$$NewLineIfNonEmptyStream(errStream)
     do errStream.OutputToDevice()
     $$$NewLineIfNonEmptyStream(outStream)
     do outStream.OutputToDevice()
+    quit $$$OK
 }
 
 ClassMethod Revert(InternalName As %String) As %Status
@@ -433,31 +434,39 @@ ClassMethod Pull(remote As %String = "origin", preview As %Boolean = 0) As %Stat
     quit event.OnPull()
 }
 
-ClassMethod Clone(remote As %String)
+ClassMethod Clone(remote As %String) As %Status
 {
     set settings = ##class(SourceControl.Git.Settings).%New()
+    // TODO: eventually use /ENV flag with GIT_TERMINAL_PROMPT=0. (This isn't doc'd yet and is only in really new versions.)
     set sc = ..RunGitWithArgs(.errStream, .outStream, "clone", remote, settings.namespaceTemp)
     $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
+    while 'errStream.AtEnd {
+        write errStream.ReadLine(),!
+    }
     $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
+    while 'outStream.AtEnd {
+        write outStream.ReadLine(),!
+    }
+    quit $$$OK
 }
 
-ClassMethod GenerateSSHKeyPair()
+ClassMethod GenerateSSHKeyPair() As %Status
 {
     set settings = ##class(SourceControl.Git.Settings).%New()
-    set dir = ##class(%File).GetDirectory(settings.privateKeyFile)
-    if ##class(%File).Exists(settings.privateKeyFile) {
-        Throw ##class(%Exception.General).%New("File "_settings.privateKeyFile_" already exists")
+    set filename = settings.privateKeyFile
+    set email = settings.gitUserEmail
+    set dir = ##class(%File).GetDirectory(filename)
+    if ##class(%File).Exists(filename) {
+        Throw ##class(%Exception.General).%New("File "_filename_" already exists")
     }
     do ##class(%File).CreateDirectoryChain(dir)
     set outLog = ##class(%Library.File).TempFilename()
     set errLog = ##class(%Library.File).TempFilename()
     do $zf(-100,"/SHELL /STDOUT="_$$$QUOTE(outLog)_" /STDERR="_$$$QUOTE(errLog),
         "ssh-keygen",
         "-t","ed25519",
-        "-C",settings.gitUserEmail,
-        "-f",settings.privateKeyFile,
+        "-C",email,
+        "-f",filename,
         "-N","")
 
     set errStream = ##class(%Stream.FileCharacter).%OpenId(errLog,,.sc)
@@ -468,6 +477,7 @@ ClassMethod GenerateSSHKeyPair()
     }
     do outStream.OutputToDevice()
     do errStream.OutputToDevice()
+    quit $$$OK
 }
 
 ClassMethod IsNamespaceInGit() As %Boolean [ CodeMode = expression ]
@@ -1973,4 +1983,3 @@ ClassMethod BuildCEInstallationPackage(ByRef destination As %String) As %Status
 }
 
 }
-