wrap pipeline commands for submoduleForeach in quotes (#964)

jokreliable · jsoref · web-flow · commit bf085276cecd · 2022-11-15T21:51:19.000-05:00
* wrap pipeline commands for submoduleForeach in quotes

* Update src/git-auth-helper.ts

drop extraneous space.

Co-authored-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* Followed CONTRIBUTING.md instructions, updating dist/index.js

* fixed package-lock.json

* updating the pipeline so it runs from sh

Co-authored-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;
diff --git a/dist/index.js b/dist/index.js
@@ -7121,7 +7121,9 @@ class GitAuthHelper {
                 // Configure a placeholder value. This approach avoids the credential being captured
                 // by process creation audit events, which are commonly logged. For more information,
                 // refer to https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing
-                const output = yield this.git.submoduleForeach(`git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url`, this.settings.nestedSubmodules);
+                const output = yield this.git.submoduleForeach(
+                // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline
+                `sh -c "git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url"`, this.settings.nestedSubmodules);
                 // Replace the placeholder
                 const configPaths = output.match(/(?<=(^|\n)file:)[^\t]+(?=\tremote\.origin\.url)/g) || [];
                 for (const configPath of configPaths) {
@@ -7288,7 +7290,9 @@ class GitAuthHelper {
                 }
             }
             const pattern = regexpHelper.escape(configKey);
-            yield this.git.submoduleForeach(`git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' || :`, true);
+            yield this.git.submoduleForeach(
+            // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline
+            `sh -c "git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' || :"`, true);
         });
     }
 }
diff --git a/src/git-auth-helper.ts b/src/git-auth-helper.ts
@@ -157,7 +157,8 @@ class GitAuthHelper {
       // by process creation audit events, which are commonly logged. For more information,
       // refer to https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing
       const output = await this.git.submoduleForeach(
-        `git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url`,
+        // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline
+        `sh -c "git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url"`,
         this.settings.nestedSubmodules
       )
 
@@ -365,7 +366,8 @@ 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}' || :`,
+      // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline
+      `sh -c "git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' || :"`,
       true
     )
   }

Original file line number	Diff line number	Diff line change
`@@ -7121,7 +7121,9 @@ class GitAuthHelper {`
`7121`	`7121`	`// Configure a placeholder value. This approach avoids the credential being captured`
`7122`	`7122`	`// by process creation audit events, which are commonly logged. For more information,`
`7123`	`7123`	`// refer to https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing`
`7124`		- const output = yield this.git.submoduleForeach(`git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url`, this.settings.nestedSubmodules);
	`7124`	`+ const output = yield this.git.submoduleForeach(`
	`7125`	`+ // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline`
	`7126`	+ `sh -c "git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url"`, this.settings.nestedSubmodules);
`7125`	`7127`	`// Replace the placeholder`
`7126`	`7128`	`const configPaths = output.match(/(?<=(^\|\n)file:)[^\t]+(?=\tremote\.origin\.url)/g) \|\| [];`
`7127`	`7129`	`for (const configPath of configPaths) {`
`@@ -7288,7 +7290,9 @@ class GitAuthHelper {`
`7288`	`7290`	`}`
`7289`	`7291`	`}`
`7290`	`7292`	`const pattern = regexpHelper.escape(configKey);`
`7291`		- yield this.git.submoduleForeach(`git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' \|\| :`, true);
	`7293`	`+ yield this.git.submoduleForeach(`
	`7294`	`+ // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline`
	`7295`	+ `sh -c "git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' \|\| :"`, true);
`7292`	`7296`	`});`
`7293`	`7297`	`}`
`7294`	`7298`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,8 @@ class GitAuthHelper {`
`157`	`157`	`// by process creation audit events, which are commonly logged. For more information,`
`158`	`158`	`// refer to https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing`
`159`	`159`	`const output = await this.git.submoduleForeach(`
`160`		- `git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url`,
	`160`	`+ // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline`
	`161`	+ `sh -c "git config --local '${this.tokenConfigKey}' '${this.tokenPlaceholderConfigValue}' && git config --local --show-origin --name-only --get-regexp remote.origin.url"`,
`161`	`162`	`this.settings.nestedSubmodules`
`162`	`163`	`)`
`163`	`164`
`@@ -365,7 +366,8 @@ class GitAuthHelper {`
`365`	`366`
`366`	`367`	`const pattern = regexpHelper.escape(configKey)`
`367`	`368`	`await this.git.submoduleForeach(`
`368`		- `git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' \|\| :`,
	`369`	`+ // wrap the pipeline in quotes to make sure it's handled properly by submoduleForeach, rather than just the first part of the pipeline`
	`370`	+ `sh -c "git config --local --name-only --get-regexp '${pattern}' && git config --local --unset-all '${configKey}' \|\| :"`,
`369`	`371`	`true`
`370`	`372`	`)`
`371`	`373`	`}`