Added '${workspaceHash}'

src/drivers/driver.ts

@@ -215,14 +215,15 @@ export abstract class CMakeDriver implements vscode.Disposable {
 
     // Fill in default replacements
     const vars: expand.ExpansionVars = {
-      workspaceRoot: ws_root,
-      workspaceFolder: ws_root,
+      buildKit: this._kit ? this._kit.name : '__unknownkit__',
       buildType: this.currentBuildType,
-      workspaceRootFolderName: path.basename(ws_root),
-      workspaceFolderBasename: path.basename(ws_root),
       generator: this.generatorName || 'null',
+      workspaceFolder: ws_root,
+      workspaceFolderBasename: path.basename(ws_root),
+      workspaceHash: util.makeHashString(ws_root),
+      workspaceRoot: ws_root,
+      workspaceRootFolderName: path.basename(ws_root),
       userHome: paths.userHome,
-      buildKit: this._kit ? this._kit.name : '__unknownkit__',
       // DEPRECATED EXPANSION: Remove this in the future:
       projectName: 'ProjectName',
     };

src/expand.ts

@@ -23,13 +23,14 @@ const log = createLogger('expand');
  * variables are specified as properties on this interface.
  */
 export interface RequiredExpansionContextVars {
-  workspaceRoot: string;
-  workspaceFolder: string;
-  buildType: string;
   buildKit: string;
-  workspaceRootFolderName: string;
-  workspaceFolderBasename: string;
+  buildType: string;
   generator: string;
+  workspaceFolder: string;
+  workspaceFolderBasename: string;
+  workspaceHash: string;
+  workspaceRoot: string;
+  workspaceRootFolderName: string;
   userHome: string;
 }
 

src/kit.ts

@@ -1165,6 +1165,7 @@ async function expandKitVariables(kit: Kit): Promise<Kit> {
         userHome: paths.userHome,
         workspaceFolder: '${workspaceFolder}',
         workspaceFolderBasename: '${workspaceFolderBasename}',
+        workspaceHash: '${workspaceHash}',
         workspaceRoot: '${workspaceRoot}',
         workspaceRootFolderName: '${workspaceRootFolderName}'
       }

src/paths.ts

@@ -9,6 +9,7 @@ import * as which from 'which';
 import {vsInstallations} from './installs/visual-studio';
 import {expandString} from './expand';
 import {fs} from './pr';
+import * as util from '@cmt/util';
 
 interface VSCMakePaths {
   cmake?: string;
@@ -133,14 +134,15 @@ class Paths {
 
     const raw = await expandString(wsc.config.raw_cmakePath, {
       vars: {
-        workspaceRoot: wsc.folder.uri.fsPath,
-        workspaceFolder: wsc.folder.uri.fsPath,
-        userHome: this.userHome,
         buildKit: '',
         buildType: '',
         generator: '',
+        workspaceFolder: wsc.folder.uri.fsPath,
+        workspaceFolderBasename: path.basename(wsc.folder.uri.fsPath),
+        workspaceRoot: wsc.folder.uri.fsPath,
         workspaceRootFolderName: path.basename(wsc.folder.uri.fsPath),
-        workspaceFolderBasename: path.basename(wsc.folder.uri.fsPath)
+        workspaceHash: util.makeHashString(wsc.folder.uri.fsPath),
+        userHome: this.userHome,
       },
     });
 

src/util.ts

@@ -1,15 +1,16 @@
 import * as child_process from 'child_process';
 import * as chokidar from 'chokidar';
+import * as fs from 'fs';
 import * as path from 'path';
 import * as vscode from 'vscode';
-import * as fs from 'fs';
 
 import {EnvironmentVariables, execute} from './proc';
 import * as nls from 'vscode-nls';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
 
+
 /**
  * Escape a string so it can be used as a regular expression
  */
@@ -585,6 +586,13 @@ export function isString(x: any): x is string {
   return Object.prototype.toString.call(x) === "[object String]";
 }
 
+export function makeHashString(str: string): string {
+    const crypto = require('crypto');
+    const hash = crypto.createHash('sha256');
+    hash.update(str);
+    return hash.digest('hex');
+}
+
 export function isArray(x: any): x is any[] {
   return x instanceof Array;
 }

test/extension-tests/successful-build/test/variable-substitution.test.ts

@@ -2,7 +2,7 @@ import * as api from '@cmt/api';
 import {CMakeCache} from '@cmt/cache';
 import {CMakeTools, ConfigureTrigger} from '@cmt/cmake-tools';
 import paths from '@cmt/paths';
-import {objectPairs, platformNormalizePath} from '@cmt/util';
+import {objectPairs, platformNormalizePath, makeHashString} from '@cmt/util';
 import {clearExistingKitConfigurationFile, DefaultEnvironment, expect, getFirstSystemKit} from '@test/util';
 import * as path from 'path';
 
@@ -65,6 +65,25 @@ suite('[Variable Substitution]', async () => {
     expect(typeof cacheEntry.value).to.eq('string', '[workspaceFolder] unexpected cache entry value type');
   }).timeout(100000);
 
+
+  test('Check substitution for "workspaceHash"', async () => {
+    // Set fake settings
+    testEnv.config.updatePartial({configureSettings: {workspaceHash: '${workspaceHash}'}});
+
+    // Configure
+    expect(await cmt.configure()).to.be.eq(0, '[workspaceHash] configure failed');
+    expect(testEnv.projectFolder.buildDirectory.isCMakeCachePresent).to.eql(true, 'expected cache not present');
+    const cache = await CMakeCache.fromPath(await cmt.cachePath);
+
+    const cacheEntry = cache.get('workspaceHash') as api.CacheEntry;
+    expect(cacheEntry.type).to.eq(api.CacheEntryType.String, '[workspaceHash] unexpected cache entry type');
+    expect(cacheEntry.key)
+        .to.eq('workspaceHash', '[workspaceHash] unexpected cache entry key name');
+    expect(cacheEntry.as<string>())
+        .to.eq(makeHashString(testEnv.projectFolder.location), '[workspaceHash] substitution incorrect');
+    expect(typeof cacheEntry.value).to.eq('string', '[workspaceHash] unexpected cache entry value type');
+  }).timeout(100000);
+
   test('Check substitution for "buildType"', async () => {
     // Set fake settings
     testEnv.config.updatePartial({configureSettings: {buildType: '${buildType}'}});