@zzzen/pyright-internal 1.2.0-dev.20221009 → 1.2.0-dev.20221127

package/dist/tests/harness/fourslash/testState.js

@@ -1,12 +1,4 @@
 "use strict";
-/*
- * testState.ts
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT license.
- *
- * TestState wraps currently test states and provides a way to query and manipulate
- * the test states.
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
@@ -30,9 +22,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createVfsInfoFromFourSlashData = exports.getNodeAtMarker = exports.getNodeForRange = exports.parseAndGetTestState = exports.TestState = void 0;
+exports.getMarkerNames = exports.getMarkerByName = exports.getMarkerName = exports.createVfsInfoFromFourSlashData = exports.getNodeAtMarker = exports.getNodeForRange = exports.parseAndGetTestState = exports.TestState = void 0;
+/*
+ * testState.ts
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT license.
+ *
+ * TestState wraps currently test states and provides a way to query and manipulate
+ * the test states.
+ */
 const assert_1 = __importDefault(require("assert"));
 const JSONC = __importStar(require("jsonc-parser"));
+const path = __importStar(require("path"));
 const vscode_languageserver_1 = require("vscode-languageserver");
 const parseTreeUtils_1 = require("../../../analyzer/parseTreeUtils");
 const service_1 = require("../../../analyzer/service");
@@ -60,6 +61,7 @@ const vfs = __importStar(require("../vfs/filesystem"));
 const fourSlashParser_1 = require("./fourSlashParser");
 const fourSlashTypes_1 = require("./fourSlashTypes");
 const testLanguageService_1 = require("./testLanguageService");
+const workspaceEditTestUtils_1 = require("./workspaceEditTestUtils");
 const testAccessHost = new testAccessHost_1.TestAccessHost(vfs.MODULE_PATH, [factory_1.libFolder, factory_1.distlibFolder]);
 class TestState {
     constructor(projectRoot, testData, mountPaths, hostSpecificFeatures) {
@@ -84,7 +86,7 @@ class TestState {
             configOptions.initializeFromJson(this.rawConfigJson, 'basic', this.console, this.fs, testAccessHost);
             this._applyTestConfigOptions(configOptions);
         }
-        const service = this._createAnalysisService(this.console, this._hostSpecificFeatures.importResolverFactory, configOptions);
+        const service = this._createAnalysisService(this.console, this._hostSpecificFeatures.importResolverFactory, this._hostSpecificFeatures.backgroundAnalysisProgramFactory, configOptions);
         this.workspace = {
             workspaceName: 'test workspace',
             rootPath: vfsInfo.projectRoot,
@@ -97,7 +99,6 @@ class TestState {
             disableWorkspaceSymbol: false,
             isInitialized: (0, deferred_1.createDeferred)(),
             searchPathsToWatch: [],
-            owns: (f) => true,
         };
         const indexer = (0, core_1.toBoolean)(testData.globalOptions["indexer" /* indexer */]);
         const indexerWithoutStdLib = (0, core_1.toBoolean)(testData.globalOptions["indexerwithoutstdlib" /* indexerWithoutStdLib */]);
@@ -126,6 +127,9 @@ class TestState {
     get program() {
         return this.workspace.serviceInstance.test_program;
     }
+    dispose() {
+        this.workspace.serviceInstance.dispose();
+    }
     cwd() {
         return this.testFS.cwd();
     }
@@ -155,32 +159,17 @@ class TestState {
         return this.fs.getMappedFilePath(path);
     }
     getMarkerName(m) {
-        let found;
-        this.testData.markerPositions.forEach((marker, name) => {
-            if (marker === m) {
-                found = name;
-            }
-        });
-        assert_1.default.ok(found);
-        return found;
+        return getMarkerName(this.testData, m);
     }
     getMarkerByName(markerName) {
-        const markerPos = this.testData.markerPositions.get(markerName);
-        if (markerPos === undefined) {
-            throw new Error(`Unknown marker "${markerName}" Available markers: ${this.getMarkerNames()
-                .map((m) => '"' + m + '"')
-                .join(', ')}`);
-        }
-        else {
-            return markerPos;
-        }
+        return getMarkerByName(this.testData, markerName);
     }
     getMarkers() {
         //  Return a copy of the list
         return this.testData.markers.slice(0);
     }
     getMarkerNames() {
-        return [...this.testData.markerPositions.keys()];
+        return getMarkerNames(this.testData);
     }
     getPositionRange(markerString) {
         const marker = this.getMarkerByName(markerString);
@@ -214,6 +203,9 @@ class TestState {
     getDirectoryPath(path) {
         return (0, pathUtils_1.getDirectoryPath)(path);
     }
+    getPathSep() {
+        return path.sep;
+    }
     goToPosition(positionOrLineAndColumn) {
         const pos = (0, core_1.isNumber)(positionOrLineAndColumn)
             ? positionOrLineAndColumn
@@ -377,7 +369,7 @@ class TestState {
         this._checkPostEditInvariants();
     }
     verifyDiagnostics(map) {
-        this._analyze();
+        this.analyze();
         // organize things per file
         const resultPerFile = this._getDiagnosticsPerFile();
         const rangePerFile = this.createMultiMap(this.getRanges(), (r) => r.fileName);
@@ -412,8 +404,12 @@ class TestState {
                         ? result.warnings
                         : category === 'information'
                             ? result.information
-                            : this.raiseError(`unexpected category ${category}`);
-                if (expected.length !== actual.length) {
+                            : category === 'unused'
+                                ? result.unused
+                                : category === 'none'
+                                    ? []
+                                    : this.raiseError(`unexpected category ${category}`);
+                if (expected.length !== actual.length && category !== 'none') {
                     this.raiseError(`contains unexpected result - expected: ${(0, utils_1.stringify)(expected)}, actual: ${(0, utils_1.stringify)(actual)}`);
                 }
                 for (const range of expected) {
@@ -422,13 +418,19 @@ class TestState {
                         const diagnosticSpan = textRange_1.TextRange.fromBounds((0, positionUtils_1.convertPositionToOffset)(d.range.start, lines), (0, positionUtils_1.convertPositionToOffset)(d.range.end, lines));
                         return this._deepEqual(diagnosticSpan, rangeSpan);
                     });
-                    if (matches.length === 0) {
+                    // If the map is provided, it might say
+                    // a marker should have none.
+                    const name = map ? this.getMarkerName(range.marker) : '';
+                    const message = map ? map[name].message : undefined;
+                    const expectMatches = !!message;
+                    if (expectMatches && matches.length === 0) {
                         this.raiseError(`doesn't contain expected range: ${(0, utils_1.stringify)(range)}`);
                     }
+                    else if (!expectMatches && matches.length !== 0) {
+                        this.raiseError(`${name} should not contain any matches`);
+                    }
                     // if map is provided, check message as well
-                    if (map) {
-                        const name = this.getMarkerName(range.marker);
-                        const message = map[name].message;
+                    if (message) {
                         if (matches.filter((d) => message === d.message).length !== 1) {
                             this.raiseError(`message doesn't match: ${message} of ${name} - ${(0, utils_1.stringify)(range)}, actual: ${(0, utils_1.stringify)(matches)}`);
                         }
@@ -451,7 +453,7 @@ class TestState {
     async verifyCodeActions(map, verifyCodeActionCount) {
         // make sure we don't use cache built from other tests
         this.workspace.serviceInstance.invalidateAndForceReanalysis();
-        this._analyze();
+        this.analyze();
         for (const range of this.getRanges()) {
             const name = this.getMarkerName(range.marker);
             if (!map[name]) {
@@ -501,7 +503,7 @@ class TestState {
         }
     }
     async verifyCommand(command, files) {
-        this._analyze();
+        this.analyze();
         const commandResult = await this._hostSpecificFeatures.execute(new testLanguageService_1.TestLanguageService(this.workspace, this.console, this.fs), { command: command.command, arguments: command.arguments || [] }, vscode_languageserver_1.CancellationToken.None);
         if (command.command === 'pyright.createtypestub') {
             await this._verifyFiles(files);
@@ -521,123 +523,11 @@ class TestState {
         return commandResult;
     }
     verifyWorkspaceEdit(expected, actual) {
-        if (actual.changes) {
-            this._verifyTextEditMap(expected.changes, actual.changes);
-        }
-        else {
-            (0, assert_1.default)(!expected.changes);
-        }
-        if (actual.documentChanges) {
-            this._verifyDocumentEdits(expected.documentChanges, actual.documentChanges);
-        }
-        else {
-            (0, assert_1.default)(!expected.documentChanges);
-        }
-        if (actual.changeAnnotations) {
-            this._verifyChangeAnnotations(expected.changeAnnotations, actual.changeAnnotations);
-        }
-        else {
-            (0, assert_1.default)(!expected.changeAnnotations);
-        }
-    }
-    _verifyChangeAnnotations(expected, actual) {
-        assert_1.default.strictEqual(Object.entries(expected).length, Object.entries(actual).length);
-        for (const key of Object.keys(expected)) {
-            const expectedAnnotation = expected[key];
-            const actualAnnotation = actual[key];
-            // We need to improve it to test localized strings.
-            assert_1.default.strictEqual(expectedAnnotation.label, actualAnnotation.label);
-            assert_1.default.strictEqual(expectedAnnotation.description, actualAnnotation.description);
-            assert_1.default.strictEqual(expectedAnnotation.needsConfirmation, actualAnnotation.needsConfirmation);
-        }
-    }
-    _textDocumentAreSame(expected, actual) {
-        return expected.version === actual.version && expected.uri === actual.uri;
-    }
-    _verifyDocumentEdits(expected, actual) {
-        assert_1.default.strictEqual(expected.length, actual.length);
-        for (const op of expected) {
-            (0, assert_1.default)(actual.some((a) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-                const expectedKind = vscode_languageserver_1.TextDocumentEdit.is(op) ? 'edit' : op.kind;
-                const actualKind = vscode_languageserver_1.TextDocumentEdit.is(a) ? 'edit' : a.kind;
-                if (expectedKind !== actualKind) {
-                    return false;
-                }
-                switch (expectedKind) {
-                    case 'edit': {
-                        const expectedEdit = op;
-                        const actualEdit = a;
-                        if (!this._textDocumentAreSame(expectedEdit.textDocument, actualEdit.textDocument)) {
-                            return false;
-                        }
-                        return this._textEditsAreSame(expectedEdit.edits, actualEdit.edits);
-                    }
-                    case 'create': {
-                        const expectedOp = op;
-                        const actualOp = a;
-                        return (expectedOp.kind === actualOp.kind &&
-                            expectedOp.annotationId === actualOp.annotationId &&
-                            expectedOp.uri === actualOp.uri &&
-                            ((_a = expectedOp.options) === null || _a === void 0 ? void 0 : _a.ignoreIfExists) === ((_b = actualOp.options) === null || _b === void 0 ? void 0 : _b.ignoreIfExists) &&
-                            ((_c = expectedOp.options) === null || _c === void 0 ? void 0 : _c.overwrite) === ((_d = actualOp.options) === null || _d === void 0 ? void 0 : _d.overwrite));
-                    }
-                    case 'rename': {
-                        const expectedOp = op;
-                        const actualOp = a;
-                        return (expectedOp.kind === actualOp.kind &&
-                            expectedOp.annotationId === actualOp.annotationId &&
-                            expectedOp.oldUri === actualOp.oldUri &&
-                            expectedOp.newUri === actualOp.newUri &&
-                            ((_e = expectedOp.options) === null || _e === void 0 ? void 0 : _e.ignoreIfExists) === ((_f = actualOp.options) === null || _f === void 0 ? void 0 : _f.ignoreIfExists) &&
-                            ((_g = expectedOp.options) === null || _g === void 0 ? void 0 : _g.overwrite) === ((_h = actualOp.options) === null || _h === void 0 ? void 0 : _h.overwrite));
-                    }
-                    case 'delete': {
-                        const expectedOp = op;
-                        const actualOp = a;
-                        return (expectedOp.annotationId === actualOp.annotationId &&
-                            expectedOp.kind === actualOp.kind &&
-                            expectedOp.uri === actualOp.uri &&
-                            ((_j = expectedOp.options) === null || _j === void 0 ? void 0 : _j.ignoreIfNotExists) === ((_k = actualOp.options) === null || _k === void 0 ? void 0 : _k.ignoreIfNotExists) &&
-                            ((_l = expectedOp.options) === null || _l === void 0 ? void 0 : _l.recursive) === ((_m = actualOp.options) === null || _m === void 0 ? void 0 : _m.recursive));
-                    }
-                    default:
-                        debug.assertNever(expectedKind);
-                }
-            }));
-        }
-    }
-    _verifyTextEditMap(expected, actual) {
-        assert_1.default.strictEqual(Object.entries(expected).length, Object.entries(actual).length);
-        for (const key of Object.keys(expected)) {
-            (0, assert_1.default)(this._textEditsAreSame(expected[key], actual[key]));
-        }
-    }
-    _textEditsAreSame(expectedEdits, actualEdits) {
-        if (expectedEdits.length !== actualEdits.length) {
-            return false;
-        }
-        for (const edit of expectedEdits) {
-            if (!actualEdits.some((a) => this._textEditAreSame(edit, a))) {
-                return false;
-            }
-        }
-        return true;
-    }
-    _textEditAreSame(expected, actual) {
-        if (!(0, textRange_1.rangesAreEqual)(expected.range, actual.range)) {
-            return false;
-        }
-        if (expected.newText !== actual.newText) {
-            return false;
-        }
-        const expectedAnnotation = vscode_languageserver_1.AnnotatedTextEdit.is(expected) ? expected.annotationId : '';
-        const actualAnnotation = vscode_languageserver_1.AnnotatedTextEdit.is(actual) ? actual.annotationId : '';
-        return expectedAnnotation === actualAnnotation;
+        return (0, workspaceEditTestUtils_1.verifyWorkspaceEdit)(expected, actual);
     }
     async verifyInvokeCodeAction(map, verifyCodeActionCount) {
         var _a;
-        this._analyze();
+        this.analyze();
         for (const range of this.getRanges()) {
             const name = this.getMarkerName(range.marker);
             if (!map[name]) {
@@ -730,7 +620,7 @@ class TestState {
     }
     async verifyCompletion(verifyMode, docFormat, map, abbrMap) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-        this._analyze();
+        this.analyze();
         for (const marker of this.getMarkers()) {
             const markerName = this.getMarkerName(marker);
             if (!map[markerName]) {
@@ -822,7 +712,7 @@ class TestState {
         }
     }
     verifySignature(docFormat, map) {
-        this._analyze();
+        this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
             const name = this.getMarkerName(marker);
@@ -867,7 +757,7 @@ class TestState {
     }
     verifyFindAllReferences(map) {
         var _a;
-        this._analyze();
+        this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
             const name = this.getMarkerName(marker);
@@ -899,7 +789,7 @@ class TestState {
     }
     verifyHighlightReferences(map) {
         var _a;
-        this._analyze();
+        this.analyze();
         for (const name of Object.keys(map)) {
             const marker = this.getMarkerByName(name);
             const fileName = marker.fileName;
@@ -918,7 +808,7 @@ class TestState {
     }
     verifyFindDefinitions(map, filter = definitionProvider_1.DefinitionFilter.All) {
         var _a;
-        this._analyze();
+        this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
             const name = this.getMarkerName(marker);
@@ -936,7 +826,7 @@ class TestState {
     }
     verifyFindTypeDefinitions(map) {
         var _a;
-        this._analyze();
+        this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
             const name = this.getMarkerName(marker);
@@ -954,7 +844,7 @@ class TestState {
     }
     verifyRename(map) {
         var _a;
-        this._analyze();
+        this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
             const name = this.getMarkerName(marker);
@@ -1219,7 +1109,7 @@ class TestState {
         // If inside the edit, return -1 to mark as invalid
         return position <= editStart ? position : position < editEnd ? -1 : position + length - +(editEnd - editStart);
     }
-    _analyze() {
+    analyze() {
         while (this.program.analyze()) {
             // Continue to call analyze until it completes. Since we're not
             // specifying a timeout, it should complete the first time.
@@ -1237,6 +1127,7 @@ class TestState {
                     errors: diagnostics.filter((diag) => diag.category === 0 /* Error */),
                     warnings: diagnostics.filter((diag) => diag.category === 1 /* Warning */),
                     information: diagnostics.filter((diag) => diag.category === 2 /* Information */),
+                    unused: diagnostics.filter((diag) => diag.category === 3 /* UnusedCode */),
                 };
                 return [filePath, value];
             }
@@ -1246,12 +1137,13 @@ class TestState {
         });
         return new Map(results);
     }
-    _createAnalysisService(nullConsole, importResolverFactory, configOptions) {
+    _createAnalysisService(nullConsole, importResolverFactory, backgroundAnalysisProgramFactory, configOptions) {
         // we do not initiate automatic analysis or file watcher in test.
         const service = new service_1.AnalyzerService('test service', this.fs, {
             console: nullConsole,
             hostFactory: () => testAccessHost,
             importResolverFactory,
+            backgroundAnalysisProgramFactory,
             configOptions,
         });
         // directly set files to track rather than using fileSpec from config
@@ -1408,6 +1300,33 @@ function createVfsInfoFromFourSlashData(projectRoot, testData) {
     return { files, sourceFileNames, projectRoot, ignoreCase, rawConfigJson };
 }
 exports.createVfsInfoFromFourSlashData = createVfsInfoFromFourSlashData;
+function getMarkerName(testData, markerToFind) {
+    let found;
+    testData.markerPositions.forEach((marker, name) => {
+        if (marker === markerToFind) {
+            found = name;
+        }
+    });
+    assert_1.default.ok(found);
+    return found;
+}
+exports.getMarkerName = getMarkerName;
+function getMarkerByName(testData, markerName) {
+    const markerPos = testData.markerPositions.get(markerName);
+    if (markerPos === undefined) {
+        throw new Error(`Unknown marker "${markerName}" Available markers: ${getMarkerNames(testData)
+            .map((m) => '"' + m + '"')
+            .join(', ')}`);
+    }
+    else {
+        return markerPos;
+    }
+}
+exports.getMarkerByName = getMarkerByName;
+function getMarkerNames(testData) {
+    return [...testData.markerPositions.keys()];
+}
+exports.getMarkerNames = getMarkerNames;
 function isConfig(file, ignoreCase) {
     const comparer = (0, stringUtils_1.getStringComparer)(ignoreCase);
     return service_1.configFileNames.some((f) => comparer((0, pathUtils_1.getBaseFileName)(file.fileName), f) === 0 /* EqualTo */);