Add coverage to getUserHomeDir func

Author: cpinamtz

src/client/common/utils/platform.ts

@@ -60,10 +60,12 @@ export function getEnvironmentVariable(key: string): string | undefined {
  * Get the current user's home directory.
  *
  * The lookup is limited to environment variables.
+ *
+ * Note: It's used the `exports.getEnvironmentVariable` to allow proper testing of this function
  */
 export function getUserHomeDir(): string | undefined {
     if (getOSType() === OSType.Windows) {
-        return getEnvironmentVariable('USERPROFILE');
+        return exports.getEnvironmentVariable('USERPROFILE');
     }
-    return getEnvironmentVariable('HOME') || getEnvironmentVariable('HOMEPATH');
+    return exports.getEnvironmentVariable('HOME') || exports.getEnvironmentVariable('HOMEPATH');
 }

src/test/common/utils/platform.unit.test.ts

@@ -3,8 +3,70 @@
 
 'use strict';
 
+import * as sinon from 'sinon';
+
 import { expect } from 'chai';
-import { OSType, getOSType } from '../../../client/common/utils/platform';
+import * as platformApis from '../../../client/common/utils/platform';
+
+const { OSType, getOSType } = platformApis;
+
+suite('Utils for platform - getUserHomeDir function', () => {
+    let getEnvVarStub: sinon.SinonStub;
+    let getOSTypeStub: sinon.SinonStub;
+
+    setup(() => {
+        getEnvVarStub = sinon.stub(platformApis, 'getEnvironmentVariable');
+        getEnvVarStub.callsFake((envVarName) => {
+            if (envVarName === 'USERPROFILE') return 'my/home/dir/in/windows/os';
+            return 'my/home/dir/in/a/not/windows/os';
+        });
+    });
+
+    teardown(() => {
+        getEnvVarStub.restore();
+        getOSTypeStub.restore();
+    });
+
+    test('getUserHomeDir when platform is Linux', () => {
+        getOSTypeStub = sinon.stub(platformApis, 'getOSType').callsFake(() => platformApis.OSType.Linux);
+
+        const os = getOSTypeStub();
+        const homeDirEnvVar = platformApis.getUserHomeDir();
+
+        expect(homeDirEnvVar).equal('my/home/dir/in/a/not/windows/os');
+        expect(os).equal(platformApis.OSType.Linux);
+    });
+
+    test('getUserHomeDir when platform is OSX', () => {
+        getOSTypeStub = sinon.stub(platformApis, 'getOSType').callsFake(() => platformApis.OSType.OSX);
+
+        const os = getOSTypeStub();
+        const homeDirEnvVar = platformApis.getUserHomeDir();
+
+        expect(homeDirEnvVar).equal('my/home/dir/in/a/not/windows/os');
+        expect(os).equal(platformApis.OSType.OSX);
+    });
+
+    test('getUserHomeDir when platform is Unknown', () => {
+        getOSTypeStub = sinon.stub(platformApis, 'getOSType').callsFake(() => platformApis.OSType.Unknown);
+
+        const os = getOSTypeStub();
+        const homeDirEnvVar = platformApis.getUserHomeDir();
+
+        expect(homeDirEnvVar).equal('my/home/dir/in/a/not/windows/os');
+        expect(os).equal(platformApis.OSType.Unknown);
+    });
+
+    test('getUserHomeDir when platform is Windows', () => {
+        getOSTypeStub = sinon.stub(platformApis, 'getOSType').callsFake(() => platformApis.OSType.Windows);
+
+        const os = getOSTypeStub();
+        const homeDirEnvVar = platformApis.getUserHomeDir();
+
+        expect(homeDirEnvVar).equal('my/home/dir/in/a/not/windows/os');
+        expect(os).equal(platformApis.OSType.Windows);
+    });
+});
 
 suite('Utils for platform - getOSType function', () => {
     const testsData = [