mirror of https://github.com/actions/checkout.git
This commit is contained in:
parent
317d15a1e8
commit
013dcb49b4
|
@ -769,19 +769,43 @@ describe('git-auth-helper tests', () => {
|
||||||
// Arrange
|
// Arrange
|
||||||
await setup(testCredentialsConfigPath_matchesCredentialsConfigPaths)
|
await setup(testCredentialsConfigPath_matchesCredentialsConfigPaths)
|
||||||
const authHelper = gitAuthHelper.createAuthHelper(git, settings)
|
const authHelper = gitAuthHelper.createAuthHelper(git, settings)
|
||||||
|
|
||||||
// Get a real credentials config path
|
// Get a real credentials config path
|
||||||
const credentialsConfigPath = await (authHelper as any).getCredentialsConfigPath()
|
const credentialsConfigPath = await (
|
||||||
|
authHelper as any
|
||||||
|
).getCredentialsConfigPath()
|
||||||
|
|
||||||
// Act & Assert
|
// Act & Assert
|
||||||
expect((authHelper as any).testCredentialsConfigPath(credentialsConfigPath)).toBe(true)
|
expect(
|
||||||
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-12345678-abcd-1234-5678-123456789012.config')).toBe(true)
|
(authHelper as any).testCredentialsConfigPath(credentialsConfigPath)
|
||||||
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-abcdef12-3456-7890-abcd-ef1234567890.config')).toBe(true)
|
).toBe(true)
|
||||||
|
expect(
|
||||||
|
(authHelper as any).testCredentialsConfigPath(
|
||||||
|
'/some/path/git-credentials-12345678-abcd-1234-5678-123456789012.config'
|
||||||
|
)
|
||||||
|
).toBe(true)
|
||||||
|
expect(
|
||||||
|
(authHelper as any).testCredentialsConfigPath(
|
||||||
|
'/some/path/git-credentials-abcdef12-3456-7890-abcd-ef1234567890.config'
|
||||||
|
)
|
||||||
|
).toBe(true)
|
||||||
|
|
||||||
// Test invalid paths
|
// Test invalid paths
|
||||||
expect((authHelper as any).testCredentialsConfigPath('/some/path/other-config.config')).toBe(false)
|
expect(
|
||||||
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-invalid.config')).toBe(false)
|
(authHelper as any).testCredentialsConfigPath(
|
||||||
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-.config')).toBe(false)
|
'/some/path/other-config.config'
|
||||||
|
)
|
||||||
|
).toBe(false)
|
||||||
|
expect(
|
||||||
|
(authHelper as any).testCredentialsConfigPath(
|
||||||
|
'/some/path/git-credentials-invalid.config'
|
||||||
|
)
|
||||||
|
).toBe(false)
|
||||||
|
expect(
|
||||||
|
(authHelper as any).testCredentialsConfigPath(
|
||||||
|
'/some/path/git-credentials-.config'
|
||||||
|
)
|
||||||
|
).toBe(false)
|
||||||
expect((authHelper as any).testCredentialsConfigPath('')).toBe(false)
|
expect((authHelper as any).testCredentialsConfigPath('')).toBe(false)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
@ -890,7 +914,11 @@ async function setup(testName: string): Promise<void> {
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
tryConfigUnsetValue: jest.fn(
|
tryConfigUnsetValue: jest.fn(
|
||||||
async (key: string, value: string, globalConfig?: boolean): Promise<boolean> => {
|
async (
|
||||||
|
key: string,
|
||||||
|
value: string,
|
||||||
|
globalConfig?: boolean
|
||||||
|
): Promise<boolean> => {
|
||||||
const configPath = globalConfig
|
const configPath = globalConfig
|
||||||
? path.join(git.env['HOME'] || tempHomedir, '.gitconfig')
|
? path.join(git.env['HOME'] || tempHomedir, '.gitconfig')
|
||||||
: localGitConfigPath
|
: localGitConfigPath
|
||||||
|
|
|
@ -472,7 +472,7 @@ class GitAuthHelper {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// SSH command
|
// SSH command
|
||||||
core.info("Removing SSH command configuration");
|
core.info('Removing SSH command configuration');
|
||||||
yield this.removeGitConfig(SSH_COMMAND_KEY);
|
yield this.removeGitConfig(SSH_COMMAND_KEY);
|
||||||
yield this.removeSubmoduleGitConfig(SSH_COMMAND_KEY);
|
yield this.removeSubmoduleGitConfig(SSH_COMMAND_KEY);
|
||||||
});
|
});
|
||||||
|
@ -485,13 +485,13 @@ class GitAuthHelper {
|
||||||
return __awaiter(this, void 0, void 0, function* () {
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
var _a;
|
var _a;
|
||||||
// Remove HTTP extra header
|
// Remove HTTP extra header
|
||||||
core.info("Removing HTTP extra header");
|
core.info('Removing HTTP extra header');
|
||||||
yield this.removeGitConfig(this.tokenConfigKey);
|
yield this.removeGitConfig(this.tokenConfigKey);
|
||||||
yield this.removeSubmoduleGitConfig(this.tokenConfigKey);
|
yield this.removeSubmoduleGitConfig(this.tokenConfigKey);
|
||||||
// Collect credentials config paths that need to be removed
|
// Collect credentials config paths that need to be removed
|
||||||
const credentialsPaths = new Set();
|
const credentialsPaths = new Set();
|
||||||
// Remove includeIf entries that point to git-credentials-*.config files
|
// Remove includeIf entries that point to git-credentials-*.config files
|
||||||
core.info("Removing includeIf entries pointing to credentials config files");
|
core.info('Removing includeIf entries pointing to credentials config files');
|
||||||
const mainCredentialsPaths = yield this.removeIncludeIfCredentials();
|
const mainCredentialsPaths = yield this.removeIncludeIfCredentials();
|
||||||
mainCredentialsPaths.forEach(path => credentialsPaths.add(path));
|
mainCredentialsPaths.forEach(path => credentialsPaths.add(path));
|
||||||
// Remove submodule includeIf entries that point to git-credentials-*.config files
|
// Remove submodule includeIf entries that point to git-credentials-*.config files
|
||||||
|
@ -1060,7 +1060,10 @@ class GitCommandManager {
|
||||||
if (output.exitCode !== 0) {
|
if (output.exitCode !== 0) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
return output.stdout.trim().split('\n').filter(value => value.trim());
|
return output.stdout
|
||||||
|
.trim()
|
||||||
|
.split('\n')
|
||||||
|
.filter(value => value.trim());
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
tryGetConfigKeys(pattern, globalConfig, configFile) {
|
tryGetConfigKeys(pattern, globalConfig, configFile) {
|
||||||
|
@ -1077,7 +1080,10 @@ class GitCommandManager {
|
||||||
if (output.exitCode !== 0) {
|
if (output.exitCode !== 0) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
return output.stdout.trim().split('\n').filter(key => key.trim());
|
return output.stdout
|
||||||
|
.trim()
|
||||||
|
.split('\n')
|
||||||
|
.filter(key => key.trim());
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
tryReset() {
|
tryReset() {
|
||||||
|
|
|
@ -348,7 +348,9 @@ class GitAuthHelper {
|
||||||
placeholderIndex < 0 ||
|
placeholderIndex < 0 ||
|
||||||
placeholderIndex != content.lastIndexOf(this.tokenPlaceholderConfigValue)
|
placeholderIndex != content.lastIndexOf(this.tokenPlaceholderConfigValue)
|
||||||
) {
|
) {
|
||||||
throw new Error(`Unable to replace auth placeholder in ${credentialsConfigPath}`)
|
throw new Error(
|
||||||
|
`Unable to replace auth placeholder in ${credentialsConfigPath}`
|
||||||
|
)
|
||||||
}
|
}
|
||||||
assert.ok(this.tokenConfigValue, 'tokenConfigValue is not defined')
|
assert.ok(this.tokenConfigValue, 'tokenConfigValue is not defined')
|
||||||
content = content.replace(
|
content = content.replace(
|
||||||
|
@ -445,7 +447,7 @@ class GitAuthHelper {
|
||||||
}
|
}
|
||||||
|
|
||||||
// SSH command
|
// SSH command
|
||||||
core.info("Removing SSH command configuration")
|
core.info('Removing SSH command configuration')
|
||||||
await this.removeGitConfig(SSH_COMMAND_KEY)
|
await this.removeGitConfig(SSH_COMMAND_KEY)
|
||||||
await this.removeSubmoduleGitConfig(SSH_COMMAND_KEY)
|
await this.removeSubmoduleGitConfig(SSH_COMMAND_KEY)
|
||||||
}
|
}
|
||||||
|
@ -456,7 +458,7 @@ class GitAuthHelper {
|
||||||
*/
|
*/
|
||||||
private async removeToken(): Promise<void> {
|
private async removeToken(): Promise<void> {
|
||||||
// Remove HTTP extra header
|
// Remove HTTP extra header
|
||||||
core.info("Removing HTTP extra header")
|
core.info('Removing HTTP extra header')
|
||||||
await this.removeGitConfig(this.tokenConfigKey)
|
await this.removeGitConfig(this.tokenConfigKey)
|
||||||
await this.removeSubmoduleGitConfig(this.tokenConfigKey)
|
await this.removeSubmoduleGitConfig(this.tokenConfigKey)
|
||||||
|
|
||||||
|
@ -464,14 +466,15 @@ class GitAuthHelper {
|
||||||
const credentialsPaths = new Set<string>()
|
const credentialsPaths = new Set<string>()
|
||||||
|
|
||||||
// Remove includeIf entries that point to git-credentials-*.config files
|
// Remove includeIf entries that point to git-credentials-*.config files
|
||||||
core.info("Removing includeIf entries pointing to credentials config files")
|
core.info('Removing includeIf entries pointing to credentials config files')
|
||||||
const mainCredentialsPaths = await this.removeIncludeIfCredentials()
|
const mainCredentialsPaths = await this.removeIncludeIfCredentials()
|
||||||
mainCredentialsPaths.forEach(path => credentialsPaths.add(path))
|
mainCredentialsPaths.forEach(path => credentialsPaths.add(path))
|
||||||
|
|
||||||
// Remove submodule includeIf entries that point to git-credentials-*.config files
|
// Remove submodule includeIf entries that point to git-credentials-*.config files
|
||||||
const submoduleConfigPaths = await this.git.getSubmoduleConfigPaths(true)
|
const submoduleConfigPaths = await this.git.getSubmoduleConfigPaths(true)
|
||||||
for (const configPath of submoduleConfigPaths) {
|
for (const configPath of submoduleConfigPaths) {
|
||||||
const submoduleCredentialsPaths = await this.removeIncludeIfCredentials(configPath)
|
const submoduleCredentialsPaths =
|
||||||
|
await this.removeIncludeIfCredentials(configPath)
|
||||||
submoduleCredentialsPaths.forEach(path => credentialsPaths.add(path))
|
submoduleCredentialsPaths.forEach(path => credentialsPaths.add(path))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -491,7 +494,9 @@ class GitAuthHelper {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
core.debug(`Skipping removal of credentials config '${credentialsPath}' - not under RUNNER_TEMP`)
|
core.debug(
|
||||||
|
`Skipping removal of credentials config '${credentialsPath}' - not under RUNNER_TEMP`
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -528,13 +533,19 @@ class GitAuthHelper {
|
||||||
* @param configPath Optional path to a specific git config file to operate on
|
* @param configPath Optional path to a specific git config file to operate on
|
||||||
* @returns Array of unique credentials config file paths that were found and removed
|
* @returns Array of unique credentials config file paths that were found and removed
|
||||||
*/
|
*/
|
||||||
private async removeIncludeIfCredentials(configPath?: string): Promise<string[]> {
|
private async removeIncludeIfCredentials(
|
||||||
|
configPath?: string
|
||||||
|
): Promise<string[]> {
|
||||||
const credentialsPaths = new Set<string>()
|
const credentialsPaths = new Set<string>()
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// Get all includeIf.gitdir keys
|
// Get all includeIf.gitdir keys
|
||||||
const keys = await this.git.tryGetConfigKeys('^includeIf\\.gitdir:', false, configPath)
|
const keys = await this.git.tryGetConfigKeys(
|
||||||
|
'^includeIf\\.gitdir:',
|
||||||
|
false,
|
||||||
|
configPath
|
||||||
|
)
|
||||||
|
|
||||||
for (const key of keys) {
|
for (const key of keys) {
|
||||||
// Get all values for this key
|
// Get all values for this key
|
||||||
const values = await this.git.tryGetConfigValues(key, false, configPath)
|
const values = await this.git.tryGetConfigValues(key, false, configPath)
|
||||||
|
@ -556,7 +567,7 @@ class GitAuthHelper {
|
||||||
core.debug(`Error during includeIf cleanup: ${err}`)
|
core.debug(`Error during includeIf cleanup: ${err}`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return Array.from(credentialsPaths)
|
return Array.from(credentialsPaths)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -61,11 +61,24 @@ export interface IGitCommandManager {
|
||||||
tagExists(pattern: string): Promise<boolean>
|
tagExists(pattern: string): Promise<boolean>
|
||||||
tryClean(): Promise<boolean>
|
tryClean(): Promise<boolean>
|
||||||
tryConfigUnset(configKey: string, globalConfig?: boolean): Promise<boolean>
|
tryConfigUnset(configKey: string, globalConfig?: boolean): Promise<boolean>
|
||||||
tryConfigUnsetValue(configKey: string, configValue: string, globalConfig?: boolean, configFile?: string): Promise<boolean>
|
tryConfigUnsetValue(
|
||||||
|
configKey: string,
|
||||||
|
configValue: string,
|
||||||
|
globalConfig?: boolean,
|
||||||
|
configFile?: string
|
||||||
|
): Promise<boolean>
|
||||||
tryDisableAutomaticGarbageCollection(): Promise<boolean>
|
tryDisableAutomaticGarbageCollection(): Promise<boolean>
|
||||||
tryGetFetchUrl(): Promise<string>
|
tryGetFetchUrl(): Promise<string>
|
||||||
tryGetConfigValues(configKey: string, globalConfig?: boolean, configFile?: string): Promise<string[]>
|
tryGetConfigValues(
|
||||||
tryGetConfigKeys(pattern: string, globalConfig?: boolean, configFile?: string): Promise<string[]>
|
configKey: string,
|
||||||
|
globalConfig?: boolean,
|
||||||
|
configFile?: string
|
||||||
|
): Promise<string[]>
|
||||||
|
tryGetConfigKeys(
|
||||||
|
pattern: string,
|
||||||
|
globalConfig?: boolean,
|
||||||
|
configFile?: string
|
||||||
|
): Promise<string[]>
|
||||||
tryReset(): Promise<boolean>
|
tryReset(): Promise<boolean>
|
||||||
version(): Promise<GitVersion>
|
version(): Promise<GitVersion>
|
||||||
}
|
}
|
||||||
|
@ -494,7 +507,7 @@ class GitCommandManager {
|
||||||
args.push(globalConfig ? '--global' : '--local')
|
args.push(globalConfig ? '--global' : '--local')
|
||||||
}
|
}
|
||||||
args.push('--unset', configKey, configValue)
|
args.push('--unset', configKey, configValue)
|
||||||
|
|
||||||
const output = await this.execGit(args, true)
|
const output = await this.execGit(args, true)
|
||||||
return output.exitCode === 0
|
return output.exitCode === 0
|
||||||
}
|
}
|
||||||
|
@ -537,14 +550,17 @@ class GitCommandManager {
|
||||||
args.push(globalConfig ? '--global' : '--local')
|
args.push(globalConfig ? '--global' : '--local')
|
||||||
}
|
}
|
||||||
args.push('--get-all', configKey)
|
args.push('--get-all', configKey)
|
||||||
|
|
||||||
const output = await this.execGit(args, true)
|
const output = await this.execGit(args, true)
|
||||||
|
|
||||||
if (output.exitCode !== 0) {
|
if (output.exitCode !== 0) {
|
||||||
return []
|
return []
|
||||||
}
|
}
|
||||||
|
|
||||||
return output.stdout.trim().split('\n').filter(value => value.trim())
|
return output.stdout
|
||||||
|
.trim()
|
||||||
|
.split('\n')
|
||||||
|
.filter(value => value.trim())
|
||||||
}
|
}
|
||||||
|
|
||||||
async tryGetConfigKeys(
|
async tryGetConfigKeys(
|
||||||
|
@ -559,14 +575,17 @@ class GitCommandManager {
|
||||||
args.push(globalConfig ? '--global' : '--local')
|
args.push(globalConfig ? '--global' : '--local')
|
||||||
}
|
}
|
||||||
args.push('--name-only', '--get-regexp', pattern)
|
args.push('--name-only', '--get-regexp', pattern)
|
||||||
|
|
||||||
const output = await this.execGit(args, true)
|
const output = await this.execGit(args, true)
|
||||||
|
|
||||||
if (output.exitCode !== 0) {
|
if (output.exitCode !== 0) {
|
||||||
return []
|
return []
|
||||||
}
|
}
|
||||||
|
|
||||||
return output.stdout.trim().split('\n').filter(key => key.trim())
|
return output.stdout
|
||||||
|
.trim()
|
||||||
|
.split('\n')
|
||||||
|
.filter(key => key.trim())
|
||||||
}
|
}
|
||||||
|
|
||||||
async tryReset(): Promise<boolean> {
|
async tryReset(): Promise<boolean> {
|
||||||
|
|
Loading…
Reference in New Issue