microsoft / reversedsc

Utility Library that Handles the Extraction of a DSC configuration script from an existing environment

As part of effort to isolate the ReverseDSC Core to allow the community to build additional projects around the module, this repository is now solely focused on managing the ReverseDSC Core.

reversedsc's Issues

Installing 2.0.0.0 from PowerShell gallery

Attempting to upgrade from 1.9.4.4 to 2.0.0.0 and not yet finding success using commands such as:

Update-Module -Name ReverseDSC -Force
also tried
Install-Module -Name ReverseDSC -AllowClobber -Force

Please advise to help resolve and thank you.

If Resource uses bool for boolean it will convert param to string.

If the DSC Resource uses [bool] as the param type it will set the value as a string.

ReverseDSC Deltas

We would like to use ReverseDSC to help newcomers to DSC get a leg up on setting up their service. Primary use case would be to run ReverseDSC on a new, unconfigured system with no reference DSC to get ALL of the configurations. Then the admin sets the system up in the 'old' way and re-runs ReverseDSC. Then I could take the 2 output files and find the deltas, which should contain the DSC specific to setting up their service with the settings they need, and gives them a way to start 85% to the finish line.

Parameters for the Get-DSCBlock function are missing -Indent $depth -AsFullConfigurationBlock -FriendlyBlockName "$($appPool.Name)". Is there some older version around that I can recover them?

Get-DSCBlock doesn't properly handle arrays of CIMInstance

If the parameter passed to the Get-DSCBlock function is an array of CIMInstance, the the output is just a sequential string of all instances. No @() and commas between. This is causing some issues to certain ReverseDSC Orchestrator Scripts (e.g. Web site bindings in the the xWebSite resource of the xWebAdministration Module).

Parameter "Value" of Function "Add-ConfigurationDataEntry" should not be of type "String"

In version "2.0.0.2", the function "Add-ConfigurationDataEntry" has its parameter "Value" stronly typed to "System.String". This makes it impossible to add in a System.Object[] array, which is a valid use case.

Proposed Resolution: Remove the parameter type

Get-DSCBlock: Remove entries with value $null from returned string

We are planning on modifying the Get-DSCBlock in a way that will remove the entries with a $null value from the returned string. This will be done in an effort to reduce the size of exported configurations.

Export-TargetResource is not exported?

Is it something I'm doing or is the Export-TargetResource cmdlet no longer available?

When I go back as far as 1.9.2.6 it is there but at some point it seems to have dropped off

CommandType Name Version Source

---

Function Add-ConfigurationDataEntry 2.0.0.4 ReverseDSC
Function Add-ReverseDSCUserName 2.0.0.4 ReverseDSC
Function Convert-DSCStringParamToVariable 2.0.0.4 ReverseDSC
Function Get-ConfigurationDataContent 2.0.0.4 ReverseDSC
Function Get-ConfigurationDataEntry 2.0.0.4 ReverseDSC
Function Get-Credentials 2.0.0.4 ReverseDSC
Function Get-DSCBlock 2.0.0.4 ReverseDSC
Function Get-DSCDependsOnBlock 2.0.0.4 ReverseDSC
Function Get-DSCFakeParameters 2.0.0.4 ReverseDSC
Function Get-DSCParamType 2.0.0.4 ReverseDSC
Function New-ConfigurationDataDocument 2.0.0.4 ReverseDSC
Function Resolve-Credentials 2.0.0.4 ReverseDSC
Function Save-Credentials 2.0.0.4 ReverseDSC
Function Test-Credentials 2.0.0.4 ReverseDSC

CommandType Name Version Source

---

Function Add-ConfigurationDataEntry 2.0.0.3 ReverseDSC
Function Add-ReverseDSCUserName 2.0.0.3 ReverseDSC
Function Convert-DSCStringParamToVariable 2.0.0.3 ReverseDSC
Function Get-ConfigurationDataContent 2.0.0.3 ReverseDSC
Function Get-ConfigurationDataEntry 2.0.0.3 ReverseDSC
Function Get-Credentials 2.0.0.3 ReverseDSC
Function Get-DSCBlock 2.0.0.3 ReverseDSC
Function Get-DSCDependsOnBlock 2.0.0.3 ReverseDSC
Function Get-DSCFakeParameters 2.0.0.3 ReverseDSC
Function Get-DSCParamType 2.0.0.3 ReverseDSC
Function New-ConfigurationDataDocument 2.0.0.3 ReverseDSC
Function Resolve-Credentials 2.0.0.3 ReverseDSC
Function Save-Credentials 2.0.0.3 ReverseDSC
Function Test-Credentials 2.0.0.3 ReverseDSC

CommandType Name Version Source

---

Function Add-ConfigurationDataEntry 1.9.2.6 ReverseDSC
Function Add-ReverseDSCUserName 1.9.2.6 ReverseDSC
Function Convert-DSCStringParamToVariable 1.9.2.6 ReverseDSC
Function Export-TargetResource 1.9.2.6 ReverseDSC
Function Get-ConfigurationDataContent 1.9.2.6 ReverseDSC
Function Get-ConfigurationDataEntry 1.9.2.6 ReverseDSC
Function Get-Credentials 1.9.2.6 ReverseDSC
Function Get-DSCBlock 1.9.2.6 ReverseDSC
Function Get-DSCDependsOnBlock 1.9.2.6 ReverseDSC
Function Get-DSCFakeParameters 1.9.2.6 ReverseDSC
Function Get-DSCParamType 1.9.2.6 ReverseDSC
Function Get-ResourceFriendlyName 1.9.2.6 ReverseDSC
Function New-ConfigurationDataDocument 1.9.2.6 ReverseDSC
Function Resolve-Credentials 1.9.2.6 ReverseDSC
Function Save-Credentials 1.9.2.6 ReverseDSC
Function Test-Credentials 1.9.2.6 ReverseDSC

Web Administration ReverseDSC repository is 404'ing

This link is currently going to a 404:
https://github.com/Microsoft/WebAdministrationDSC.Reverse

The resource is available through the gallery but not on the links from this site.

Get-DSCParamType can return an array instead of a string

Get-DSCParamType uses ForEach-Object loops. ForEach-Object doesn't break/end the function when return is called because it gets the next item from the pipeline. Under the right circumstances, an array will be returned. Subsequently, get-dscBlock will fail to work properly as the returned paramType won't match as intended.

How to reproduce:

$DSCModule = Get-Module -Name xWebAdministration -ListAvailable
$DSCPath = $DSCModule | Select-Object -ExpandProperty modulebase 
$modulePath = $DSCPath + "\DSCResources\MSFT_xWebsite\MSFT_xWebsite.psm1"

$paramType = Get-DSCParamType -ModulePath $ModulePath -ParamName "`$BindingInfo"

"Microsoft.Management.Infrastructure.CimInstance[]" -eq $paramType #Returns False 

"Microsoft.Management.Infrastructure.CimInstance[]" -eq $paramType[0] #Returns True 

#$paramType is an array which equals @("Microsoft.Management.Infrastructure.CimInstance[]", "")

To Resolve: (use foreach instead of foreach-object)

function Get-DSCParamType
{
    [CmdletBinding()]
    param(
        [parameter(Mandatory = $true)] [System.String] $ModulePath,
        [parameter(Mandatory = $true)] [System.String] $ParamName
    )

    $tokens = $null
    $errors = $null
    $ast = [System.Management.Automation.Language.Parser]::ParseFile($ModulePath, [ref] $tokens, [ref] $errors)
    $functions = $ast.FindAll( {$args[0] -is [System.Management.Automation.Language.FunctionDefinitionAst]}, $true)

    ForEach($function in $functions){
        if ($function.Name -eq "Set-TargetResource")
        {
            $functionAst = [System.Management.Automation.Language.Parser]::ParseInput($function.Body, [ref] $tokens, [ref] $errors)

            $parameters = $functionAst.FindAll( {$args[0] -is [System.Management.Automation.Language.ParameterAst]}, $true)
            ForEach($parameter in $parameters){
                if ($parameter.Name.Extent.Text -eq $ParamName)
                {
                    $attributes = $parameter.Attributes
                    ForEach($attribute in $attributes){
                        if ($attribute.TypeName.FullName -like "System.*")
                        {
                            return $attribute.TypeName.FullName
                        }
                        elseif ($attribute.TypeName.FullName.ToLower() -eq "microsoft.management.infrastructure.ciminstance")
                        {
                            return "System.Collections.Hashtable"
                        }
                        elseif ($attribute.TypeName.FullName.ToLower() -eq "string")
                        {
                            return "System.String"
                        }
                        elseif ($attribute.TypeName.FullName.ToLower() -eq "boolean")
                        {
                            return "System.Boolean"
                        }
                        elseif ($attribute.TypeName.FullName.ToLower() -eq "bool")
                        {
                            return "System.Boolean"
                        }
                        elseif ($attribute.TypeName.FullName.ToLower() -eq "string[]")
                        {
                            return "System.String[]"
                        }
                        elseif ($attribute.TypeName.FullName.ToLower() -eq "microsoft.management.infrastructure.ciminstance[]")
                        {
                            return "Microsoft.Management.Infrastructure.CimInstance[]"
                        }
                    }
                }
            }
        }
     }
 }

Convert-DSCStringParamToVariable: throws exception if `$ParameterName` not found in $DscBlock

Description of Problem

As an example, in Microsoft365DSC, resource PlannerTask, function Export-TargetResource, line 787:

$content = Convert-DSCStringParamToVariable -DSCBlock $content `
    -ParameterName 'Credential'

The function is called to ensure that quotes are removed around the values that are variables and not strings, i.e. instead of the following which does not work in quotes:

PlannerTask 7ad38863-ce48-4b8e-b169-f292222471e6
{
	...
	Credential = "$ConfigurationData.NonNodeData.Credential"
        ...
}

we remove the quote, so the variable sis actually resolved:

PlannerTask 7ad38863-ce48-4b8e-b169-f292222471e6
{
	...
	Credential = $ConfigurationData.NonNodeData.TenantId
        ...
}

However, the presence of Credential is dependent on if Credential was used to authenticate, so it may not exist - ApplicationId with CertificateThumbprint may for instance be used instead. If so, the function Convert-DSCStringParamToVariable throws an exception when looking for Credential on the line below # MY COMMENT:

$startPosition = -1
do
{
    $startPosition = $DSCBlock.IndexOf(' ' + $ParameterName + ' ', $startPosition + 1)
    # MY COMMENT: the lines below fails if $ParameterName is not found i.e. $startPosition is still -1, since you cannot start at position -1
    $testValidStartPositionEqual = $DSCBlock.IndexOf("=", $startPosition)
    $testValidStartPositionQuotes = $DSCBlock.IndexOf("`"", $startPosition)
   
} while ($testValidStartPositionEqual -gt $testValidStartPositionQuotes -and
    $startPosition -ne -1)

The exception:

System.Management.Automation.MethodInvocationException: Exception calling "IndexOf" with "2" argument(s): "Index was out of range. Must be non-negative and less than the size of the collection.
Parameter name: startIndex" ---> System.ArgumentOutOfRangeException: Index was out of range. Must be non-negative and less than the size of the collection.
Parameter name: startIndex
   at System.String.IndexOf(String value, Int32 startIndex, Int32 count, StringComparison comparisonType)
   at CallSite.Target(Closure , CallSite , String , String , Object )
   --- End of inner exception stack trace ---
   at System.Management.Automation.ExceptionHandlingOps.CheckActionPreference(FunctionContext funcContext, Exception exception)
   at Convert-DSCStringParamToVariable(Closure , FunctionContext )
   at System.Management.Automation.PSScriptCmdlet.RunClause(Action`1 clause, Object dollarUnderbar, Object inputToProcess)
   at System.Management.Automation.PSScriptCmdlet.DoEndProcessing()
   at System.Management.Automation.CommandProcessorBase.Complete()
"Error during Export:"
at Convert-DSCStringParamToVariable, C:\Modules\ReverseDSC\2.0.0.13\ReverseDSC.Core.psm1: line 688
at Export-TargetResource, C:\Modules\Microsoft365DSC\DSCResources\MSFT_PlannerTask\MSFT_PlannerTask.psm1: line 787
...

Suggested solution

If $ParameterName is not found, return the original $DSCBlock:

$startPosition = -1
do
{
    $startPosition = $DSCBlock.IndexOf(' ' + $ParameterName + ' ', $startPosition + 1)
    # If the ParameterName is not found, $startPosition is still -1, and .IndexOf($string, $startPosition) does not work, so skip
    if ($startPosition -ne -1)
    {
        $testValidStartPositionEqual = $DSCBlock.IndexOf("=", $startPosition)
        $testValidStartPositionQuotes = $DSCBlock.IndexOf("`"", $startPosition)
    }
} while ($testValidStartPositionEqual -gt $testValidStartPositionQuotes -and
    $startPosition -ne -1)

# If $ParameterName was not found i.e. $startPosition is still -1, skip this section as well. We 
# just want the original $DSCBlock to be returned without modification
if ($startPosition -ne -1) {
    $endOfLinePosition = $DSCBlock.IndexOf(";`r`n", $startPosition)
    
    if ($endOfLinePosition -eq -1)
    {
        $endOfLinePosition = $DSCBlock.Length
    }
    $startPosition = $DSCBlock.IndexOf("`"", $startPosition)
}

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request