dsccommunity / dsccommunity/SqlServerDsc

SqlSetup: Error message is cryptic when Test-TargetResource returns false when called from Set-TargetResource

Open
#789 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
PowerShell
Stars
385
Forks
224
PR merge metrics
No merged PRs in 30d

Description

Details of the scenario you tried and the problem that is occurring:

This error message is kind of cryptic for users not familiar with the code.

Test-TargetResource returned false after calling Set-TargetResource. 

A more correct message could be:

Set-TargetResource tried to certify the configuration state with Test-TargetResource, but verification failed. Test-TargetResource returned false (not in desired state).

The DSC configuration that is using the resource (as detailed as possible):
Any xSQLServerSetup that fail configuration (for example setup.exe returns with an error).

Version of the Operating System, SQL Server and PowerShell the DSC Target Node is running:
n/a

What module (SqlServer or SQLPS) and which version of the module the DSC Target Node is running:
n/a

Version of the DSC module you're using, or 'dev' if you're using current dev branch:
Dev

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the SqlSetup resource code that emits "Test-TargetResource returned false after calling Set-TargetResource." Start by tracing the Set-TargetResource verification path and update the failure wording to explain that verification failed and the configuration is not in the desired state. Confirm the revised message covers failed xSQLServerSetup configurations.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
devops
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.