Integrate CSV-based testing framework for Index Advisor

[Copilot]

The Index Advisor testing framework now supports CSV-based batch testing with the required column format: Category, Test Case, Tags, Collection, Positive/Negative, Query, Expected Index Advisor Suggestion, Explanation, Current Index, Comment.

Changes

Type System (test/indexAdvisor/types.ts)

• Extended TestCase and TestResult interfaces with CSV-specific fields: tags, testType, explanation, currentIndex, comment

CSV Parser (test/indexAdvisor/utils.ts)

• Implemented case-insensitive column matching with flexible header variants
• Maintains backward compatibility with old CSV format via fallback column detection
• Updated output format to preserve all input columns alongside results

Test Execution (test/indexAdvisor/testRunner.ts, runIndexAdvisorTests.ts)

• Propagate CSV fields through execution pipeline to output
• Enhanced error handling to include all test case metadata

Configuration

• Migrated from clusterId to connectionString as primary connection method
• Example files updated with new format

Documentation

• Added comprehensive README covering CSV/directory modes, configuration, and usage patterns
• Created 6 representative test cases demonstrating the CSV format

Example

Input CSV:

Category,Test Case,Tags,Collection,Positive / Negative,Query,Expected Index Advisor Suggestion,Explanation,Current Index,Comment
Missing Index,Test 1,basic;single-field,users,Positive,db.users.find({user_id: 1234}),"db.getCollection('users').createIndex({'user_id':1},{})","No index exists",None,Single field test

Output includes all input columns plus: Suggested Indexes, If Matches Expected, Analysis, Execution Plans, Performance Metrics, Collection Stats, Index Stats, Model Used, Errors, Timestamp.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• update.code.visualstudio.com
  • Triggering command: node /home/REDACTED/work/vscode-documentdb/vscode-documentdb/node_modules/.bin/vscode-test test/indexAdvisor/csvParser.test.ts (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Integrate Testing Framework into Current Implementation</issue_title>
<issue_description>The Index Advisor has changed a little bit since the testing framework implemented. Update and integrate testing framework into current Index Advisor implementation to support testing for the newest version.

Note: You need to update and merge the code in testing framework branch: xingfan/testingframework into current branch: dev/xingfan/removesanitize

The key for this task is integrate the testing framework for current index advisor, so that we can use csv mode to run batch tests. Update the PR and prioritize to implement it

There should be one config file for csv testing, and it should contains the connection string of cluster and testing database name. All the test collection are in that database.

The input csv file to describe test cases with the following columns:
There should be one config file for csv testing, and it should contains the connection string of cluster and testing database name. All the test collection are in that database.

The input csv file to describe test cases with the following columns:
Category,Test Case,Tags,Collection,Positive / Negative,Query,Expected Index Advisor Suggestion,Explanation,Current Index,Comment

The testing framework should run the query from Query command on the collection from Collection column, and record the execution plan, and the suggested from Index advisor. And check if it is the same as expected suggestion from Expected Index Advisor Suggestion column. And record those data along with other fields in origin csv file in the output file.

The testing framework should run the query from Query command on the collection from Collection column, and record the execution plan, and the suggested from Index advisor. And check if it is the same as expected suggestion from Expected Index Advisor Suggestion column. And record those data along with other fields in origin csv file in the output file.</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Integrate Testing Framework into Current Implementation #351

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.