Move Test Config to Jsonc by benrr101 · Pull Request #4297 · dotnet/SqlClient

benrr101 · 2026-05-20T03:44:51Z

Description

As a byproduct of the PR pipeline, I got annoyed with the red squigglies under the comments in the test config.json file. Technically speaking jsonc files support comments while json does not. So, this small PR does the following:

Changes the config.default.json file to config.default.jsonc
Rewrites the Config.Load logic so that it tries the environment variable path first, config.jsonc second, then config.json before failing.
Makes Config class #nullable
Sync'd the config.default.json file with the fields that actually exist (and removed unused fields).
Remove dependency on Newtonsoft.Json from TestUtilities and push it back to ManualTests.

🤖

Used 🤖 to find remaining references to config.json and replace with references to config.jsonc

Issues

N/A

Testing

Everything builds, but I want to validate with a PR run before taking it out of draft state.

benrr101 · 2026-05-20T03:45:11Z

-        public string DNSCachingConnString = null;
-        public string DNSCachingServerCR = null;  // this is for the control ring
-        public string DNSCachingServerTR = null;  // this is for the tenant ring
-        public bool IsAzureSynapse = false; // True for Azure Data Warehouse/Synapse


This was removed as it is not used.

benrr101 · 2026-05-20T03:45:54Z

-        public string AliasName = null;

-        public static Config Load(string configPath = @"config.json")
+        public static Config Load(string configPath)


This was added as an escape hatch for preserving the behavior of ExtUtilities project. I have plans to remove the ExtUtilities project, so this method will hopefully go away someday.

benrr101 · 2026-05-20T03:48:11Z

+    "WorkloadIdentityFederationServiceConnectionId": "",
+    "KerberosDomainPassword": "",
+    "KerberosDomainuser": "",
+    "IsManagedInstance": false


These fields exist in Config class, but did not in the json file.

benrr101 · 2026-05-20T03:48:28Z

    "SupportsIntegratedSecurity": true,
    "LocalDbAppName": "",
    "LocalDbSharedInstanceName": "",
-    "SupportsFileStream": false,


This field did not exist in the Config class.

benrr101 · 2026-05-20T03:48:48Z

    "DNSCachingServerTR": "",
    "IsDNSCachingSupportedCR": false,
    "IsDNSCachingSupportedTR": false,
-    "IsAzureSynapse": false,


This field existed in the Config class, but was removed since it's unused.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 4 comments.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 2 comments.


 ```bash
-MDS_TEST_CONFIG=/path/to/config.json dotnet build -t:TestSqlClientManual -p:TestSet=2
+MDS_TEST_CONFIG=/path/to/config.jsonc dotnet build -t:TestSqlClientManual -p:TestSet=2


+  <!-- Copy config file ================================================ -->
  <Target Name="CopyConfig" BeforeTargets="Compile">
-    <Copy SourceFiles="config.default.json" DestinationFiles="config.json" Condition="!Exists('config.json')" />
+    <Copy SourceFiles="config.default.jsonc" DestinationFiles="config.jsonc" Condition="!Exists('config.jsonc')" />


codecov · 2026-05-27T19:03:04Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.95%. Comparing base (c724554) to head (37b4f64).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4297      +/-   ##
==========================================
- Coverage   66.57%   65.95%   -0.63%     
==========================================
  Files         284      279       -5     
  Lines       43301    66219   +22918     
==========================================
+ Hits        28827    43673   +14846     
- Misses      14474    22546    +8072

Flag	Coverage Δ
CI-SqlClient	`?`
PR-SqlClient-Project	`65.95% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

paulmedynski

Looks great! I had updated VS Code to treat .json and .jsonc files as JSON with Comments, so I wasn't seeing any red squigglies :)

paulmedynski · 2026-05-29T10:17:34Z

    type: boolean
    default: false

  - name: SupportsFileStream


This parameter is no unused and can be removed.

benrr101 added 2 commits May 19, 2026 18:27

Sync config.cs and config.json

025d441

Move config file to jsonc, make config class nullable

2d1aa7e

Copilot AI review requested due to automatic review settings May 20, 2026 03:44

github-project-automation Bot added this to SqlClient Board May 20, 2026

github-project-automation Bot moved this to To triage in SqlClient Board May 20, 2026

Copilot started reviewing on behalf of benrr101 May 20, 2026 03:45 View session

benrr101 commented May 20, 2026

View reviewed changes

This comment was marked as outdated.

Sign in to view

🤖 updates to other references to config.json

0a0830b

edwardneal reviewed May 20, 2026

View reviewed changes

Comment thread src/Microsoft.Data.SqlClient/tests/tools/Microsoft.Data.SqlClient.TestUtilities/Config.cs Outdated

Replace newtonsoft with system.text.json

ffa9a9b

Copilot AI review requested due to automatic review settings May 20, 2026 17:15

Copilot started reviewing on behalf of benrr101 May 20, 2026 17:16 View session

Allow trailing commas and comments.

992fb31

benrr101 added this to the 7.1.0-preview2 milestone May 20, 2026

This comment was marked as outdated.

Sign in to view

Copilot AI review requested due to automatic review settings May 20, 2026 20:01

Copilot started reviewing on behalf of benrr101 May 20, 2026 20:01 View session

This comment was marked as outdated.

Sign in to view

Copilot AI review requested due to automatic review settings May 20, 2026 23:56

Copilot started reviewing on behalf of benrr101 May 20, 2026 23:57 View session

This comment was marked as outdated.

Sign in to view

benrr101 added 3 commits May 20, 2026 19:08

🤖 🌭

4474f38

Merge branch 'main' into dev/russellben/config-jsonc

5269fe9

Push newtonsoft reference back to manual tests

57e9b41

benrr101 force-pushed the dev/russellben/config-jsonc branch from 5885bb9 to 57e9b41 Compare May 21, 2026 00:09

Remove IsAzureSynapse from pipelines

ef6e8df

Copilot AI review requested due to automatic review settings May 21, 2026 15:51

Copilot started reviewing on behalf of benrr101 May 21, 2026 15:52 View session

Copilot AI reviewed May 21, 2026

View reviewed changes

Comment thread eng/pipelines/common/templates/steps/update-config-file-step.yml

Comment thread eng/pipelines/kerberos/sqlclient-kerberos.yml

Comment thread TESTGUIDE.md

Comment thread src/Microsoft.Data.SqlClient/tests/tools/Microsoft.Data.SqlClient.TestUtilities/Config.cs

Merge branch 'main' into dev/russellben/config-jsonc

37b4f64

benrr101 marked this pull request as ready for review May 27, 2026 17:52

benrr101 requested a review from a team as a code owner May 27, 2026 17:52

Copilot AI review requested due to automatic review settings May 27, 2026 17:52

Copilot started reviewing on behalf of benrr101 May 27, 2026 17:52 View session

Copilot AI reviewed May 27, 2026

View reviewed changes

benrr101 mentioned this pull request May 28, 2026

PR Pipeline - Part 1 #4308

Closed

paulmedynski moved this from To triage to In review in SqlClient Board May 29, 2026

paulmedynski added the Area\Tests Issues that are targeted to tests or test projects label May 29, 2026

paulmedynski self-assigned this May 29, 2026

paulmedynski requested changes May 29, 2026

View reviewed changes

github-project-automation Bot moved this from In review to Waiting for customer in SqlClient Board May 29, 2026

paulmedynski mentioned this pull request May 29, 2026

Replace Newtonsoft.Json with System.Text.Json in tests and samples #4323

Draft

4 tasks

Conversation

benrr101 commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

🤖

Issues

Testing

Uh oh!

benrr101 May 20, 2026

Choose a reason for hiding this comment

Uh oh!

benrr101 May 20, 2026

Choose a reason for hiding this comment

Uh oh!

benrr101 May 20, 2026

Choose a reason for hiding this comment

Uh oh!

benrr101 May 20, 2026

Choose a reason for hiding this comment

Uh oh!

benrr101 May 20, 2026

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

codecov Bot commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

paulmedynski left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

benrr101 commented May 20, 2026 •

edited

Loading

codecov Bot commented May 27, 2026 •

edited

Loading