fix: potential missing key.json file on windows

forcedotcom · Mar 26, 2019 · f94f127 · f94f127
1 parent 90c2300
commit f94f127
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 1 deletion.
diff --git a/src/keyChainImpl.ts b/src/keyChainImpl.ts
@@ -565,7 +565,22 @@ export class GenericUnixKeychainAccess extends GenericKeychainAccess {
 /**
  * @ignore
  */
-export class GenericWindowsKeychainAccess extends GenericKeychainAccess {}
+export class GenericWindowsKeychainAccess extends GenericKeychainAccess {
+  protected async isValidFileAccess(cb: (error: Nullable<Error>) => Promise<void>): Promise<void> {
+    const secretFile: string = path.join(
+      await ConfigFile.resolveRootFolder(true),
+      Global.STATE_FOLDER,
+      ensure(KeychainConfig.getDefaultOptions().filename)
+    );
+    await super.isValidFileAccess(async err => {
+      if (err != null) {
+        await cb(err);
+      } else {
+        await fs.access(path.join(secretFile, Global.STATE_FOLDER), fs.constants.R_OK | fs.constants.W_OK);
+      }
+    });
+  }
+}
 
 /**
  * @ignore

diff --git a/test/unit/keyChainTest.ts b/test/unit/keyChainTest.ts
@@ -4,11 +4,14 @@
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
+import { Nullable } from '@salesforce/ts-types';
 import { expect } from 'chai';
 import * as _ from 'lodash';
+import * as path from 'path';
 import { retrieveKeychain } from '../../src/keyChain';
 import { GenericUnixKeychainAccess, GenericWindowsKeychainAccess, keyChainImpl } from '../../src/keyChainImpl';
 import { testSetup } from '../../src/testSetup';
+import { fs } from '../../src/util/fs';
 
 // Setup the test environment.
 const $$ = testSetup();
@@ -68,4 +71,39 @@ describe('keyChain', () => {
     expect(windowsKeychain).to.be.instanceOf(GenericWindowsKeychainAccess);
     expect(win32Keychain).to.be.instanceOf(GenericWindowsKeychainAccess);
   });
+
+  it('no key.json file should result in a PasswordNotFoundError', async () => {
+    const TEST_PASSWORD = 'foo';
+    const windowsKeychain = await retrieveKeychain('windows');
+
+    const accessSpy = $$.SANDBOX.spy(fs, 'access');
+    const writeFileStub = $$.SANDBOX.stub(fs, 'writeFile').returns(Promise.resolve(null));
+    const mkdirpStub = $$.SANDBOX.stub(fs, 'mkdirp').returns(Promise.resolve());
+
+    const service = 'sfdx';
+    const account = 'local';
+
+    return windowsKeychain
+      .getPassword({ service, account }, (getPasswordError: Nullable<Error>) => {
+        expect(getPasswordError).have.property('name', 'PasswordNotFoundError');
+        expect(accessSpy.called).to.be.true;
+        const arg: string = accessSpy.args[0][0];
+        expect(arg.endsWith('.sfdx')).to.be.true;
+        accessSpy.resetHistory();
+      })
+      .then(() =>
+        windowsKeychain.setPassword(
+          { service, account, password: TEST_PASSWORD },
+          (setPasswordError: Nullable<Error>) => {
+            expect(setPasswordError).to.be.null;
+            expect(mkdirpStub.called).to.be.true;
+            expect(writeFileStub.called).to.be.true;
+            expect(writeFileStub.args).to.have.length(1);
+            expect(writeFileStub.args[0]).to.have.length(3);
+            expect(writeFileStub.args[0][0]).to.include(path.join('.sfdx', 'key.json'));
+            expect(writeFileStub.args[0][1]).to.include(TEST_PASSWORD);
+          }
+        )
+      );
+  });
 });