fix: Make tests more robust & fix path bug

Author: varungandhi-src

.gitignore

@@ -6,6 +6,9 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 
+# Editor files
+.idea/
+
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

packages/pyright-internal/src/analyzer/program.ts

@@ -331,7 +331,15 @@ export class Program {
 
     addTrackedFile(filePath: string, isThirdPartyImport = false, isInPyTypedPackage = false): SourceFile {
         let sourceFileInfo = this.getSourceFileInfo(filePath);
-        const importName = this._getImportNameForFile(filePath);
+        let importName = this._getImportNameForFile(filePath);
+        // HACK(scip-python): When adding tracked files for imports, we end up passing
+        // normalized paths as the argument. However, _getImportNameForFile seemingly
+        // needs a non-normalized path, which cannot be recovered directly from a
+        // normalized path. However, in practice, the non-normalized path seems to
+        // be stored on the sourceFileInfo, so attempt to use that instead.
+        if (importName === '' && sourceFileInfo) {
+            importName = this._getImportNameForFile(sourceFileInfo.sourceFile.getFilePath());
+        }
 
         if (sourceFileInfo) {
             // The module name may have changed based on updates to the

packages/pyright-scip/CONTRIBUTING.md

@@ -73,9 +73,32 @@ node ./index.js <other args>
 npm run check-snapshots
 ```
 
+#### Filter specific snapshot tests
+
+Use the `--filter-tests` flag to run only specific snapshot tests:
+```bash
+# Using npm scripts (note the -- to pass arguments)
+npm run check-snapshots -- --filter-tests test1,test2,test3
+```
+
+Available snapshot tests can be found in `snapshots/input/`.
+
 Using a different Python version other than the one specified
 in `.tool-versions` may also lead to errors.
 
+## Making changes to Pyright internals
+
+When modifying code in the `pyright-internal` package:
+
+1. Keep changes minimal: Every change introduces a risk of
+   merge conflicts. Adding doc comments is fine, but avoid
+   changing functionality if possible. Instead of changing
+   access modifiers, prefer copying small functions into
+   scip-pyright logic.
+2. Use a `NOTE(scip-python):` prefix when adding comments to
+   make it clearer which comments were added by upstream
+   maintainers vs us.
+
 ## Publishing releases
 
 1. Change the version in `packages/pyright-scip/package.json`

packages/pyright-scip/snapshots/output/nested_items/src/long_importer.py

@@ -1,10 +1,10 @@
 # < definition scip-python python snapshot-util 0.1 `src.long_importer`/__init__:
 
 import foo.bar.baz.mod
-#      ^^^^^^^^^^^^^^^ reference  snapshot-util 0.1 `foo.bar.baz.mod`/__init__:
+#      ^^^^^^^^^^^^^^^ reference local 0
 
 print(foo.bar.baz.mod.SuchNestedMuchWow)
 #^^^^ reference  python-stdlib 3.11 builtins/print().
-#     ^^^^^^^^^^^^^^^ reference  snapshot-util 0.1 `foo.bar.baz.mod`/__init__:
+#     ^^^ reference local 0
 #                     ^^^^^^^^^^^^^^^^^ reference  snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow#
 

packages/pyright-scip/src/indexer.ts

@@ -123,9 +123,9 @@ export class Indexer {
         this.importResolver = new ImportResolver(fs, this.pyrightConfig, host);
 
         this.program = new Program(this.importResolver, this.pyrightConfig);
-        // Normalize paths to ensure consistency with other code paths.
-        const normalizedProjectFiles = [...this.projectFiles].map((path: string) => normalizePathCase(fs, path));
-        this.program.setTrackedFiles(normalizedProjectFiles);
+        // setTrackedFiles internally handles path normalization, so we don't normalize
+        // paths here.
+        this.program.setTrackedFiles([...this.projectFiles]);
 
         if (scipConfig.projectNamespace) {
             setProjectNamespace(scipConfig.projectName, this.scipConfig.projectNamespace!);
@@ -194,7 +194,9 @@ export class Indexer {
         let projectSourceFiles: SourceFile[] = [];
         withStatus('Index workspace and track project files', () => {
             this.program.indexWorkspace((filepath: string) => {
-                // Filter out filepaths not part of this project
+                // Do not index files outside the project because SCIP doesn't support it.
+                //
+                // Both filepath and this.scipConfig.projectRoot are NOT normalized.
                 if (filepath.indexOf(this.scipConfig.projectRoot) != 0) {
                     return;
                 }
@@ -204,6 +206,7 @@ export class Indexer {
 
                 let requestsImport = sourceFile.getImports();
                 requestsImport.forEach((entry) =>
+                    // entry.resolvedPaths are all normalized.
                     entry.resolvedPaths.forEach((value) => {
                         this.program.addTrackedFile(value, true, false);
                     })

packages/pyright-scip/src/lib.ts

@@ -310,10 +310,10 @@ export function writeSnapshot(outputPath: string, obtained: string): void {
     fs.writeFileSync(outputPath, obtained, { flag: 'w' });
 }
 
-export function diffSnapshot(outputPath: string, obtained: string): void {
+export function diffSnapshot(outputPath: string, obtained: string): 'equal' | 'different' {
     let existing = fs.readFileSync(outputPath, { encoding: 'utf8' });
     if (obtained === existing) {
-        return;
+        return 'equal';
     }
 
     console.error(
@@ -326,9 +326,13 @@ export function diffSnapshot(outputPath: string, obtained: string): void {
             '(what the current code produces). Run the command "npm run update-snapshots" to accept the new behavior.'
         )
     );
-    exit(1);
+    return 'different';
 }
 
+
+
+
+
 function occurrencesByLine(a: scip.Occurrence, b: scip.Occurrence): number {
     return Range.fromLsif(a.range).compare(Range.fromLsif(b.range));
 }

packages/pyright-scip/src/main-impl.ts

@@ -9,8 +9,13 @@ import { IndexOptions, SnapshotOptions, mainCommand } from './MainCommand';
 import { sendStatus, setQuiet, setShowProgressRateLimit } from './status';
 import { Indexer } from './indexer';
 import { exit } from 'process';
+import { TestFailure, TestError, ValidationResults } from './test-runner';
 
-function indexAction(options: IndexOptions): void {
+
+
+
+
+export function indexAction(options: IndexOptions): void {
     setQuiet(options.quiet);
     if (options.showProgressRateLimit !== undefined) {
         setShowProgressRateLimit(options.showProgressRateLimit);
@@ -59,21 +64,32 @@ function indexAction(options: IndexOptions): void {
     process.chdir(originalWorkdir);
 }
 
+
+
+
+
+
+
+
+
+// Simplified snapshot action - processes tests without orchestration
 function snapshotAction(snapshotRoot: string, options: SnapshotOptions): void {
-    const subdir: string = options.only;
     const inputDirectory = path.resolve(join(snapshotRoot, 'input'));
     const outputDirectory = path.resolve(join(snapshotRoot, 'output'));
-
+    
+    // Get all test directories
     let snapshotDirectories = fs.readdirSync(inputDirectory);
-    if (subdir) {
-        console.assert(snapshotDirectories.find((val) => val === subdir) !== undefined);
-        snapshotDirectories = [subdir];
+    
+    // Handle --only flag for single test processing
+    if (options.only) {
+        console.assert(snapshotDirectories.find((val) => val === options.only) !== undefined);
+        snapshotDirectories = [options.only];
     }
-
+    
+    // For each test directory, run the original simple processing
     for (const snapshotDir of snapshotDirectories) {
         let projectRoot = join(inputDirectory, snapshotDir);
         console.assert(fs.lstatSync(projectRoot).isDirectory());
-        console.log(`Output path = ${options.output}`);
 
         indexAction({
             projectName: options.projectName,
@@ -91,6 +107,7 @@ function snapshotAction(snapshotRoot: string, options: SnapshotOptions): void {
 
         const scipIndexPath = path.join(projectRoot, options.output);
         const scipIndex = scip.Index.deserializeBinary(fs.readFileSync(scipIndexPath));
+        
         for (const doc of scipIndex.documents) {
             if (doc.relative_path.startsWith('..')) {
                 continue;
@@ -103,7 +120,10 @@ function snapshotAction(snapshotRoot: string, options: SnapshotOptions): void {
             const outputPath = path.resolve(outputDirectory, snapshotDir, relativeToInputDirectory);
 
             if (options.check) {
-                diffSnapshot(outputPath, obtained);
+                const diffResult = diffSnapshot(outputPath, obtained);
+                if (diffResult === 'different') {
+                    exit(1);
+                }
             } else {
                 writeSnapshot(outputPath, obtained);
             }