Skip to content

Take global core.sshCommand into consideration #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 76 additions & 9 deletions __test__/git-auth-helper.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,41 @@ describe('git-auth-helper tests', () => {
)
})

const configureAuth_setsSshCommandWithCustomCommand =
'sets SSH command preseving custom command'
it(configureAuth_setsSshCommandWithCustomCommand, async () => {
// Arrange
await setup(configureAuth_setsSshCommandWithCustomCommand)
await fs.promises.writeFile(globalGitConfigPath, 'core.sshCommand fakeSsh')
expect(await git.configExists('core.sshCommand', true)).toBeTruthy() // sanity check
expect(await git.configGet('core.sshCommand', true)).toBe('fakeSsh') // sanity check

const authHelper = gitAuthHelper.createAuthHelper(git, settings)

// Act
await authHelper.configureAuth()
expect(git.configGet).toHaveBeenCalledWith('core.sshCommand', true)

// Assert git env var
const actualKeyPath = await getActualSshKeyPath()
const actualKnownHostsPath = await getActualSshKnownHostsPath()
const expectedSshCommand = `"fakeSsh" -i "$RUNNER_TEMP/${path.basename(
actualKeyPath
)}" -o StrictHostKeyChecking=yes -o CheckHostIP=no -o "UserKnownHostsFile=$RUNNER_TEMP/${path.basename(
actualKnownHostsPath
)}"`
expect(git.setEnvironmentVariable).toHaveBeenCalledWith(
'GIT_SSH_COMMAND',
expectedSshCommand
)

// Asserty git config
expect(git.config).toHaveBeenCalledWith(
'core.sshCommand',
expectedSshCommand
)
})

const configureAuth_writesExplicitKnownHosts = 'writes explicit known hosts'
it(configureAuth_writesExplicitKnownHosts, async () => {
if (!sshPath) {
Expand Down Expand Up @@ -739,15 +774,47 @@ async function setup(testName: string): Promise<void> {
),
configExists: jest.fn(
async (key: string, globalConfig?: boolean): Promise<boolean> => {
const configPath = globalConfig
? path.join(git.env['HOME'] || tempHomedir, '.gitconfig')
: localGitConfigPath
const content = await fs.promises.readFile(configPath)
const lines = content
.toString()
.split('\n')
.filter(x => x)
return lines.some(x => x.startsWith(key))
try {
const configPath = globalConfig
? path.join(git.env['HOME'] || tempHomedir, '.gitconfig')
: localGitConfigPath
const content = await fs.promises.readFile(configPath)
const lines = content
.toString()
.split('\n')
.filter(x => x)
return lines.some(x => x.startsWith(key))
} catch (error) {
if ((error as any)?.code === 'ENOENT') {
return false
}
throw error
}
}
),
configGet: jest.fn(
async (key: string, globalConfig?: boolean): Promise<string> => {
try {
const configPath = globalConfig
? path.join(git.env['HOME'] || tempHomedir, '.gitconfig')
: localGitConfigPath
const content = await fs.promises.readFile(configPath)
const lines = content
.toString()
.split('\n')
.filter(x => x)
.filter(x => x.startsWith(key))
if (lines.length) {
return lines[0].split(' ')[1]
} else {
return ''
}
} catch (error) {
if ((error as any)?.code === 'ENOENT') {
return ''
}
throw error
}
}
),
env: {},
Expand Down
1 change: 1 addition & 0 deletions __test__/git-directory-helper.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,7 @@ async function setup(testName: string): Promise<void> {
checkoutDetach: jest.fn(),
config: jest.fn(),
configExists: jest.fn(),
configGet: jest.fn(),
fetch: jest.fn(),
getDefaultBranch: jest.fn(),
getWorkingDirectory: jest.fn(() => repositoryPath),
Expand Down
14 changes: 13 additions & 1 deletion dist/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7253,7 +7253,9 @@ class GitAuthHelper {
stateHelper.setSshKnownHostsPath(this.sshKnownHostsPath);
yield fs.promises.writeFile(this.sshKnownHostsPath, knownHosts);
// Configure GIT_SSH_COMMAND
const sshPath = yield io.which('ssh', true);
const sshPath = (yield this.git.configExists(SSH_COMMAND_KEY, true))
? yield this.git.configGet(SSH_COMMAND_KEY, true)
: yield io.which('ssh', true);
this.sshCommand = `"${sshPath}" -i "$RUNNER_TEMP/${path.basename(this.sshKeyPath)}"`;
if (this.settings.sshStrict) {
this.sshCommand += ' -o StrictHostKeyChecking=yes -o CheckHostIP=no';
Expand Down Expand Up @@ -7533,6 +7535,16 @@ class GitCommandManager {
return output.exitCode === 0;
});
}
configGet(configKey, globalConfig) {
return __awaiter(this, void 0, void 0, function* () {
const output = yield this.execGit([
'config',
globalConfig ? '--global' : '--local',
configKey
]);
return output.stdout.trim();
});
}
fetch(refSpec, fetchDepth) {
return __awaiter(this, void 0, void 0, function* () {
const args = ['-c', 'protocol.version=2', 'fetch'];
Expand Down
4 changes: 3 additions & 1 deletion src/git-auth-helper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,9 @@ class GitAuthHelper {
await fs.promises.writeFile(this.sshKnownHostsPath, knownHosts)

// Configure GIT_SSH_COMMAND
const sshPath = await io.which('ssh', true)
const sshPath = (await this.git.configExists(SSH_COMMAND_KEY, true))
? await this.git.configGet(SSH_COMMAND_KEY, true)
: await io.which('ssh', true)
this.sshCommand = `"${sshPath}" -i "$RUNNER_TEMP/${path.basename(
this.sshKeyPath
)}"`
Expand Down
10 changes: 10 additions & 0 deletions src/git-command-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export interface IGitCommandManager {
): Promise<void>
configExists(configKey: string, globalConfig?: boolean): Promise<boolean>
fetch(refSpec: string[], fetchDepth?: number): Promise<void>
configGet(configKey: string, globalConfig?: boolean): Promise<string>
getDefaultBranch(repositoryUrl: string): Promise<string>
getWorkingDirectory(): string
init(): Promise<void>
Expand Down Expand Up @@ -201,6 +202,15 @@ class GitCommandManager {
return output.exitCode === 0
}

async configGet(configKey: string, globalConfig?: boolean): Promise<string> {
const output = await this.execGit([
'config',
globalConfig ? '--global' : '--local',
configKey
])
return output.stdout.trim()
}

async fetch(refSpec: string[], fetchDepth?: number): Promise<void> {
const args = ['-c', 'protocol.version=2', 'fetch']
if (!refSpec.some(x => x === refHelper.tagsRefSpec)) {
Expand Down