GH#354 Disabled auth submodules config when related setting is false

This should help with actions#354. The problem is that I have no idea whether such auth submodules configuration is required even when settings.submodules is false.
cosimo · Jan 13, 2021 · 66145e6 · 66145e6
1 parent 5a4ac90
commit 66145e6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/__test__/git-auth-helper.test.ts b/__test__/git-auth-helper.test.ts
@@ -450,6 +450,7 @@ describe('git-auth-helper tests', () => {
       )
       settings.persistCredentials = false
       settings.sshKey = ''
+      settings.submodules = true
       const authHelper = gitAuthHelper.createAuthHelper(git, settings)
       await authHelper.configureAuth()
       const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
@@ -483,6 +484,7 @@ describe('git-auth-helper tests', () => {
         configureSubmoduleAuth_configuresSubmodulesWhenPersistCredentialsFalseAndSshKeySet
       )
       settings.persistCredentials = false
+      settings.submodules = true
       const authHelper = gitAuthHelper.createAuthHelper(git, settings)
       await authHelper.configureAuth()
       const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
@@ -509,6 +511,7 @@ describe('git-auth-helper tests', () => {
         configureSubmoduleAuth_configuresSubmodulesWhenPersistCredentialsTrueAndSshKeyNotSet
       )
       settings.sshKey = ''
+      settings.submodules = true
       const authHelper = gitAuthHelper.createAuthHelper(git, settings)
       await authHelper.configureAuth()
       const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>
@@ -543,6 +546,7 @@ describe('git-auth-helper tests', () => {
       await setup(
         configureSubmoduleAuth_configuresSubmodulesWhenPersistCredentialsTrueAndSshKeySet
       )
+      settings.submodules = true
       const authHelper = gitAuthHelper.createAuthHelper(git, settings)
       await authHelper.configureAuth()
       const mockSubmoduleForeach = git.submoduleForeach as jest.Mock<any, any>

diff --git a/src/git-auth-helper.ts b/src/git-auth-helper.ts
@@ -341,10 +341,12 @@ class GitAuthHelper {
       }
     }
 
-    const pattern = regexpHelper.escape(configKey)
-    await this.git.submoduleForeach(
-      `git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' || :`,
-      true
-    )
+    if (this.settings.submodules) {
+      const pattern = regexpHelper.escape(configKey)
+      await this.git.submoduleForeach(
+        `git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' || :`,
+        true
+      )
+    }
   }
 }