Fix non-actionable error when Active Directory authentication provider is missing by apoorvdeshmukh · Pull Request #4035 · dotnet/SqlClient

apoorvdeshmukh · 2026-03-11T20:09:56Z

Description

Issues

Testing

Unit tests added (SqlUtilErrorMessageTests.cs) covering:
AD auth methods return the actionable message with package install instructions
Non-AD auth methods return the existing generic message
All 9 Active Directory authentication modes validated via parameterized test

Guidelines

Please review the contribution guidelines before submitting a pull request:

Copilot

Pull request overview

This PR improves the developer experience when Active Directory authentication is requested but the Azure authentication provider isn’t available, by throwing a more actionable error that includes package install guidance.

Changes:

Add a dedicated localized error message for missing Active Directory auth provider with NuGet install instructions.
Throw the new actionable exception for Active Directory authentication methods when no provider is registered.
Add unit tests validating the new message for AD auth methods and preserving the generic message for non-AD methods.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/SqlUtilErrorMessageTests.cs	Adds unit coverage for the new actionable AD-provider-missing error message vs. the generic message.
src/Microsoft.Data.SqlClient/src/Resources/Strings.resx	Introduces a new localized string resource for the AD-provider-missing scenario.
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs	Adds the generated strongly-typed accessor for the new resource string.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlUtil.cs	Adds a new `SQL.CannotFindActiveDirectoryAuthProvider(...)` exception factory.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Connection/SqlConnectionInternal.cs	Switches AD auth methods to throw the new actionable exception when the provider is missing.

Files not reviewed (1)

src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Language not supported

You can also share your feedback on Copilot code review. Take the survey.

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

...icrosoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/SqlUtilErrorMessageTests.cs

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

codecov · 2026-03-11T22:15:26Z

Codecov Report

❌ Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 65.04%. Comparing base (3f9246c) to head (cc10c1e).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...Data/SqlClient/Connection/SqlConnectionInternal.cs	0.00%	4 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (3f9246c) and HEAD (cc10c1e). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (3f9246c) HEAD (cc10c1e)

CI-SqlClient 1 0

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4035      +/-   ##
==========================================
- Coverage   72.87%   65.04%   -7.83%     
==========================================
  Files         287      282       -5     
  Lines       43134    66050   +22916     
==========================================
+ Hits        31432    42960   +11528     
- Misses      11702    23090   +11388

Flag	Coverage Δ
CI-SqlClient	`?`
PR-SqlClient-Project	`65.04% <42.85%> (?)`

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.

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-12T13:27:35Z

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing"
+  mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework
+  object]</value>


This PR includes unrelated whitespace/line-wrapping changes in Strings.resx (e.g., Icon1 and schema/resheader entries). These formatting-only edits add noise and increase merge-conflict risk without affecting the functional error-message change. Consider reverting the unrelated reformatting (or moving it to a dedicated PR).

Suggested change

<data name="Icon1" type="System.Drawing.Icon, System.Drawing"

mimetype="application/x-microsoft.net.object.bytearray.base64">

<value>[base64 mime encoded string representing a byte array form of the .NET Framework

object]</value>

<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">

<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>

Agreed - I'm not sure what auto-formatting you have enabled, but I would advise disabling it all except for trimming trailing whitespace.

Copilot · 2026-03-12T13:27:36Z

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Connection/SqlConnectionInternal.cs

+#pragma warning disable 0618 // ActiveDirectoryPassword is obsolete
+                if (ConnectionOptions.Authentication >= SqlAuthenticationMethod.ActiveDirectoryPassword
+                    && ConnectionOptions.Authentication <= SqlAuthenticationMethod.ActiveDirectoryWorkloadIdentity)
+#pragma warning restore 0618


The AD-auth detection relies on a numeric range comparison over SqlAuthenticationMethod values (>= ActiveDirectoryPassword and <= ActiveDirectoryWorkloadIdentity). This is brittle because it silently depends on enum value ordering/contiguity and could misclassify methods if the enum changes. Prefer an explicit switch/pattern match listing the AD methods (or a shared helper) so the intent stays correct if the enum evolves.

Agreed - just list each method explictily here to make it obvious.

Copilot · 2026-03-12T13:27:36Z

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

+  <data name="SQL_CannotFindActiveDirectoryAuthProvider" xml:space="preserve">
+    <value>Cannot find an authentication provider for '{0}'. The 'Microsoft.Data.SqlClient.Extensions.Azure' NuGet package provides default implementations for Active Directory (Entra ID) authentication methods.</value>


The new message claims the Azure extensions package "provides default implementations", but it doesn't actually give install instructions (e.g., "Install/Reference the Microsoft.Data.SqlClient.Extensions.Azure package" and/or a link/command). This seems inconsistent with the PR description's claim of "package install instructions" and may still be non-actionable for users.

Sure, maybe provide the URL to the nuget.org page for the package.

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

paulmedynski · 2026-03-12T13:37:19Z

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Connection/SqlConnectionInternal.cs

+#pragma warning disable 0618 // ActiveDirectoryPassword is obsolete
+                if (ConnectionOptions.Authentication >= SqlAuthenticationMethod.ActiveDirectoryPassword
+                    && ConnectionOptions.Authentication <= SqlAuthenticationMethod.ActiveDirectoryWorkloadIdentity)
+#pragma warning restore 0618


Agreed - just list each method explictily here to make it obvious.

paulmedynski · 2026-03-12T13:38:35Z

src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs

This diff is enormous. What happened?

Copilot added some formatting noise which it simply could not fix.
I manually reverted changes but it's taking too long.
Raised #4046 to clean up the changes.

paulmedynski · 2026-03-12T13:39:37Z

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing"
+  mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework
+  object]</value>


Agreed - I'm not sure what auto-formatting you have enabled, but I would advise disabling it all except for trimming trailing whitespace.

paulmedynski · 2026-03-12T13:40:52Z

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

+  <data name="SQL_CannotFindActiveDirectoryAuthProvider" xml:space="preserve">
+    <value>Cannot find an authentication provider for '{0}'. The 'Microsoft.Data.SqlClient.Extensions.Azure' NuGet package provides default implementations for Active Directory (Entra ID) authentication methods.</value>


Sure, maybe provide the URL to the nuget.org page for the package.

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx

benrr101 · 2026-03-12T18:01:05Z

...icrosoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/SqlUtilErrorMessageTests.cs

+
+namespace Microsoft.Data.SqlClient.UnitTests
+{
+    public class SqlUtilErrorMessageTests


Unit test files/classes should be the same as the class they are testing with "Tests" at the end. There is no SqlUtilErrorMessage class, so please update to correspond to the class that's actually being tested.

benrr101 · 2026-03-12T18:03:08Z

...icrosoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/SqlUtilErrorMessageTests.cs

+        [Fact]
+        public void CannotFindAuthProvider_ReturnsGenericMessage()
+        {
+            Exception exception = global::Microsoft.Data.SqlClient.SQL.CannotFindAuthProvider("SomeCustomAuth");


I'm not familiar with the global:: syntax here. Can we just have a using at the top of the file and access the method like we would in the code?

benrr101 · 2026-03-12T18:10:24Z

...icrosoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/SqlUtilErrorMessageTests.cs

+        [InlineData("ActiveDirectoryMSI")]
+        [InlineData("ActiveDirectoryDefault")]
+        [InlineData("ActiveDirectoryWorkloadIdentity")]
+        public void CannotFindActiveDirectoryAuthProvider_ContainsPackageGuidance(string authMethod)


Honestly, I'm not very sure of the value of these tests. They're really just testing whether the exception text returned by the exception helper is right. This doesn't really test the new behavior or the scenario that prompted the change in the first place.

Instead of testing the sqlutil class, test the SqlConnectionInternal class to make sure that if you don't have Azure package loaded, it will tell you to load Azure package. If that's not possible, consider moving the check into SqlUtil class and pass the auth method to it to decide. That could be tested via a unit test here.

Indeed - these tests apear to be trying to confirm that the SqlUtil functions return ArgumentException instances with some expected text based on the English (default?) strings resources.

I'm not sure if we have any existing tests for things like this.

I'm also not sure if they will pass when the tests are run using other languages.

apoorvdeshmukh · 2026-03-13T15:58:07Z

Closing as addressing this via #4046

apoorvdeshmukh added 2 commits March 12, 2026 01:29

Add actionable error message for missing Azure package

b6016d4

Merge remote-tracking branch 'origin/main' into dev/ad/3962

ad595d7

apoorvdeshmukh requested a review from a team as a code owner March 11, 2026 20:09

Copilot AI review requested due to automatic review settings March 11, 2026 20:09

github-project-automation bot added this to SqlClient Board Mar 11, 2026

github-project-automation bot moved this to To triage in SqlClient Board Mar 11, 2026

Copilot started reviewing on behalf of apoorvdeshmukh March 11, 2026 20:10 View session

apoorvdeshmukh added this to the 7.0.0 milestone Mar 11, 2026

Copilot AI reviewed Mar 11, 2026

View reviewed changes

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx Outdated Show resolved Hide resolved

...icrosoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/SqlUtilErrorMessageTests.cs Outdated Show resolved Hide resolved

mdaigle reviewed Mar 11, 2026

View reviewed changes

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx Outdated Show resolved Hide resolved

Update error message and unit test

196140a

apoorvdeshmukh requested review from a team and mdaigle March 11, 2026 20:45

ErikEJ reviewed Mar 12, 2026

View reviewed changes

src/Microsoft.Data.SqlClient/src/Resources/Strings.resx Outdated Show resolved Hide resolved

Remove VS specific nuget install command from error message

cc10c1e

Copilot AI review requested due to automatic review settings March 12, 2026 13:21

Copilot started reviewing on behalf of apoorvdeshmukh March 12, 2026 13:22 View session

Copilot AI reviewed Mar 12, 2026

View reviewed changes

paulmedynski self-assigned this Mar 12, 2026

paulmedynski requested changes Mar 12, 2026

View reviewed changes

github-project-automation bot moved this from To triage to In progress in SqlClient Board Mar 12, 2026

benrr101 requested changes Mar 12, 2026

View reviewed changes

apoorvdeshmukh closed this Mar 13, 2026

github-project-automation bot moved this from In progress to Done in SqlClient Board Mar 13, 2026

apoorvdeshmukh deleted the dev/ad/3962 branch March 13, 2026 15:58

		<data name="SQL_CannotFindActiveDirectoryAuthProvider" xml:space="preserve">
		<value>Cannot find an authentication provider for '{0}'. The 'Microsoft.Data.SqlClient.Extensions.Azure' NuGet package provides default implementations for Active Directory (Entra ID) authentication methods.</value>

Conversation

apoorvdeshmukh commented Mar 11, 2026

Description

Issues

Testing

Guidelines

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apoorvdeshmukh commented Mar 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Mar 11, 2026 •

edited

Loading