fix(codecatalyst): Failed to write SSH config #3395

* Fix regression with ssh config, from 6cfe24a
* Guard against inaccurate error messages

Author: JadenSimon

src/codecatalyst/tools.ts

@@ -254,7 +254,7 @@ async function verifySSHHost({
         const sshConfigPath = getSshConfigPath()
         try {
             await fs.ensureDir(path.dirname(path.dirname(sshConfigPath)), { mode: 0o755 })
-            await fs.mkdir(path.dirname(sshConfigPath), 0o700)
+            await fs.ensureDir(path.dirname(sshConfigPath), 0o700)
             await fs.appendFile(sshConfigPath, section, { mode: 0o600 })
         } catch (e) {
             const message = localize(

src/shared/errors.ts

@@ -464,7 +464,8 @@ export class PermissionsError extends ToolkitError {
         public readonly uri: vscode.Uri,
         public readonly stats: fs.Stats,
         public readonly userInfo: os.UserInfo<string>,
-        public readonly expected: PermissionsTriplet
+        public readonly expected: PermissionsTriplet,
+        source?: unknown
     ) {
         const mode = `${stats.isDirectory() ? 'd' : '-'}${modeToString(stats.mode)}`
         const owner = stats.uid === userInfo.uid ? userInfo.username : stats.uid
@@ -475,6 +476,13 @@ export class PermissionsError extends ToolkitError {
             .join('')
         const actualText = !isAmbiguous ? actual : `${mode.slice(-6, -3)} & ${mode.slice(-3)} (ambiguous)`
 
+        // Guard against surfacing confusing error messages. If the actual perms equal the resolved
+        // perms then odds are it wasn't really a permissions error. Some operating systems report EPERM
+        // in situations that aren't related to permissions at all.
+        if (actual === resolvedExpected && !isAmbiguous && source !== undefined) {
+            throw source
+        }
+
         super(`${uri.fsPath} has incorrect permissions. Expected ${resolvedExpected}, found ${actualText}.`, {
             code: 'InvalidPermissions',
             details: {

src/shared/systemUtilities.ts

@@ -36,7 +36,7 @@ export function createPermissionsErrorHandler(
             throw await createPermissionsErrorHandler(vscode.Uri.joinPath(uri, '..'), '*wx')(err2, depth + 1)
         })
 
-        throw new PermissionsError(uri, stats, userInfo, perms)
+        throw new PermissionsError(uri, stats, userInfo, perms, err)
     }
 }
 
@@ -126,7 +126,7 @@ export class SystemUtilities {
                     })
                     if ((stats.mode & fs.constants.S_IXUSR) === 0) {
                         const userInfo = os.userInfo({ encoding: 'utf-8' })
-                        throw new PermissionsError(dirUri, stats, userInfo, '*wx')
+                        throw new PermissionsError(dirUri, stats, userInfo, '*wx', err)
                     }
                 }
 

src/test/codecatalyst/tools.test.ts

@@ -4,6 +4,7 @@
  */
 
 import * as vscode from 'vscode'
+import * as sinon from 'sinon'
 import * as path from 'path'
 import * as http from 'http'
 import * as assert from 'assert'
@@ -18,8 +19,9 @@ import {
     getCodeCatalystSsmEnv,
     sshLogFileLocation,
 } from '../../codecatalyst/model'
-import { readFile, writeFile } from 'fs-extra'
+import { mkdir, readFile, writeFile } from 'fs-extra'
 import { StartDevEnvironmentSessionRequest } from 'aws-sdk/clients/codecatalyst'
+import { SystemUtilities } from '../../shared/systemUtilities'
 
 describe('SSH Agent', function () {
     it('can start the agent on windows', async function () {
@@ -130,4 +132,27 @@ describe('Connect Script', function () {
             assert.fail(`Connect script should exit with a zero status:\n${message}`)
         }
     })
+
+    describe('~/.ssh', function () {
+        let tmpDir: string
+
+        beforeEach(async function () {
+            tmpDir = await makeTemporaryToolkitFolder()
+            sinon.stub(SystemUtilities, 'getHomeDirectory').returns(tmpDir)
+        })
+
+        afterEach(async function () {
+            sinon.restore()
+            await SystemUtilities.delete(tmpDir, { recursive: true })
+        })
+
+        it('works if the .ssh directory is missing', async function () {
+            ;(await ensureConnectScript(context)).unwrap()
+        })
+
+        it('works if the .ssh directory exists but has different perms', async function () {
+            await mkdir(path.join(tmpDir, '.ssh'), 0o777)
+            ;(await ensureConnectScript(context)).unwrap()
+        })
+    })
 })