Mike F Robbins

Using the AST to Find Module Dependencies in PowerShell Functions and Scripts

Mike F Robbins May 17, 2019May 17, 2019 0

Earlier this week, Chris Gardner presented a session on "Managing dependencies in PowerShell" for the Mississippi PowerShell User Group. I mentioned that I had written a function to retrieve PowerShell module dependencies that's part of my ModuleBuildTools module. Get-MrAST is one of the primary functions that numerous other functions in the module are built on.

#Requires -Version 3.0
function Get-MrAst {
<#
.SYNOPSIS
    Explores the Abstract Syntax Tree (AST).
.DESCRIPTION
    Get-MrAST is an advanced function that provides a mechanism for exploring the Abstract Syntax Tree (AST).
 .PARAMETER Path
    Specifies a path to one or more locations. Wildcards are permitted. The default location is the current directory.
.PARAMETER Code
    The code to view the AST for. If Get-Content is being used to obtain the code, use its -Raw parameter otherwise
    the formating of the code will be lost.
.PARAMETER ScriptBlock
    An instance of System.Management.Automation.ScriptBlock Microsoft .NET Framework type to view the AST for.
.PARAMETER AstType
    The type of object to view the AST for. If this parameter is ommited, only the top level ScriptBlockAst is returned.
.EXAMPLE
     Get-MrAST -Path 'C:\Scripts' -AstType FunctionDefinition
.EXAMPLE
     Get-MrAST -Code 'function Get-PowerShellProcess {Get-Process -Name PowerShell}'
.EXAMPLE
     Get-MrAST -ScriptBlock ([scriptblock]::Create('function Get-PowerShellProcess {Get-Process -Name PowerShell}'))
.NOTES
    Author:  Mike F Robbins
    Website: http://mikefrobbins.com
    Twitter: @mikefrobbins
#>
    [CmdletBinding(DefaultParameterSetName='Path')]
    param(
        [Parameter(ValueFromPipeline,
                   ValueFromPipelineByPropertyName,
                   ValueFromRemainingArguments,
                   ParameterSetName = 'Path',
                   Position = 1)]
        [ValidateNotNull()]
        [Alias('FilePath')]
        [string[]]$Path = ('.\*.ps1', '.\*.psm1'),
        [Parameter(Mandatory,
                   ValueFromPipelineByPropertyName,
                   ValueFromRemainingArguments,
                   ParameterSetName = 'Code')]
        [string[]]$Code,
        [Parameter(Mandatory,
                   ValueFromPipelineByPropertyName,
                   ValueFromRemainingArguments,
                   ParameterSetName = 'ScriptBlock')]
        [scriptblock[]]$ScriptBlock
    )
    DynamicParam {
        $ParameterAttribute = New-Object -TypeName System.Management.Automation.ParameterAttribute
        $ParameterAttribute.Position = 0
        $ValidationValues = Get-MrAstType
        $ValidateSetAttribute = New-Object -TypeName System.Management.Automation.ValidateSetAttribute($ValidationValues)
        $AttributeCollection = New-Object -TypeName System.Collections.ObjectModel.Collection[System.Attribute]
        $AttributeCollection.Add($ParameterAttribute)
        $AttributeCollection.Add($ValidateSetAttribute)
        $ParameterName = 'AstType'
        $RuntimeParameter = New-Object -TypeName System.Management.Automation.RuntimeDefinedParameter($ParameterName, [string], $AttributeCollection)
        $RuntimeParameterDictionary = New-Object -TypeName System.Management.Automation.RuntimeDefinedParameterDictionary
        $RuntimeParameterDictionary.Add($ParameterName, $RuntimeParameter)
        $RuntimeParameterDictionary
    }
    BEGIN {
        $AstType = $PsBoundParameters[$ParameterName]
    }
    PROCESS {
        switch ($PSCmdlet.ParameterSetName) {
            'Path' {
                Write-Verbose -Message 'Path Parameter Set Selected'
                Write-Verbose "Path contains $Path"
                $Files = Get-ChildItem -Path $Path -Exclude *tests.ps1, *profile.ps1 |
                         Select-Object -ExpandProperty FullName
                if (-not ($Files)) {
                    Write-Warning -Message 'No valid files found.'
                    Return
                }
                $AST = foreach ($File in $Files) {
                    [System.Management.Automation.Language.Parser]::ParseFile($File, [ref]$null, [ref]$null)
                }
                break
            }
            'Code' {
                Write-Verbose -Message 'Code Parameter Set Selected'
                $AST = foreach ($c in $Code) {
                    [System.Management.Automation.Language.Parser]::ParseInput($c, [ref]$null, [ref]$null)
                }
                break
            }
            'ScriptBlock' {
                Write-Verbose -Message 'ScriptBlock Parameter Set Selected'
                $AST = $ScriptBlock.Ast
                break
            }
            default {
                Write-Warning -Message 'An unexpected error has occurred'
            }
        }
        if ($PsBoundParameters.AstType) {
            Write-Verbose -Message 'AstType Parameter Entered'
            $AST = $AST.FindAll({$args[0].GetType().Name -like "$($ASTType)Ast"}, $true)
        }
        Write-Output $AST
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

#Requires -Version 3.0

function Get-MrAst {

.SYNOPSIS

Explores the Abstract Syntax Tree (AST).

.DESCRIPTION

Get-MrAST is an advanced function that provides a mechanism for exploring the Abstract Syntax Tree (AST).

.PARAMETER Path

Specifies a path to one or more locations. Wildcards are permitted. The default location is the current directory.

.PARAMETER Code

The code to view the AST for. If Get-Content is being used to obtain the code, use its -Raw parameter otherwise

the formating of the code will be lost.

.PARAMETER ScriptBlock

An instance of System.Management.Automation.ScriptBlock Microsoft .NET Framework type to view the AST for.

.PARAMETER AstType

The type of object to view the AST for. If this parameter is ommited, only the top level ScriptBlockAst is returned.

.EXAMPLE

Get-MrAST -Path 'C:\Scripts' -AstType FunctionDefinition

.EXAMPLE

Get-MrAST -Code 'function Get-PowerShellProcess {Get-Process -Name PowerShell}'

.EXAMPLE

Get-MrAST -ScriptBlock ([scriptblock]::Create('function Get-PowerShellProcess {Get-Process -Name PowerShell}'))

.NOTES

Author: Mike F Robbins

Website: http://mikefrobbins.com

Twitter: @mikefrobbins

[CmdletBinding(DefaultParameterSetName='Path')]

param(

[Parameter(ValueFromPipeline,

ValueFromPipelineByPropertyName,

ValueFromRemainingArguments,

ParameterSetName = 'Path',

Position = 1)]

[ValidateNotNull()]

[Alias('FilePath')]

[string[]]$Path = ('.\*.ps1', '.\*.psm1'),

[Parameter(Mandatory,

ValueFromPipelineByPropertyName,

ValueFromRemainingArguments,

ParameterSetName = 'Code')]

[string[]]$Code,

[Parameter(Mandatory,

ValueFromPipelineByPropertyName,

ValueFromRemainingArguments,

ParameterSetName = 'ScriptBlock')]

[scriptblock[]]$ScriptBlock

)

DynamicParam {

$ParameterAttribute = New-Object -TypeName System.Management.Automation.ParameterAttribute

$ParameterAttribute.Position = 0

$ValidationValues = Get-MrAstType

$ValidateSetAttribute = New-Object -TypeName System.Management.Automation.ValidateSetAttribute($ValidationValues)

$AttributeCollection = New-Object -TypeName System.Collections.ObjectModel.Collection[System.Attribute]

$AttributeCollection.Add($ParameterAttribute)

$AttributeCollection.Add($ValidateSetAttribute)

$ParameterName = 'AstType'

$RuntimeParameter = New-Object -TypeName System.Management.Automation.RuntimeDefinedParameter($ParameterName, [string], $AttributeCollection)

$RuntimeParameterDictionary = New-Object -TypeName System.Management.Automation.RuntimeDefinedParameterDictionary

$RuntimeParameterDictionary.Add($ParameterName, $RuntimeParameter)

$RuntimeParameterDictionary

}

BEGIN {

$AstType = $PsBoundParameters[$ParameterName]

}

PROCESS {

switch ($PSCmdlet.ParameterSetName) {

'Path' {

Write-Verbose -Message 'Path Parameter Set Selected'

Write-Verbose "Path contains $Path"

$Files = Get-ChildItem -Path $Path -Exclude *tests.ps1, *profile.ps1 |

Select-Object -ExpandProperty FullName

if (-not ($Files)) {

Write-Warning -Message 'No valid files found.'

Return

}

$AST = foreach ($File in $Files) {

[System.Management.Automation.Language.Parser]::ParseFile($File, [ref]$null, [ref]$null)

}

break

}

'Code' {

Write-Verbose -Message 'Code Parameter Set Selected'

$AST = foreach ($c in $Code) {

[System.Management.Automation.Language.Parser]::ParseInput($c, [ref]$null, [ref]$null)

}

break

}

'ScriptBlock' {

Write-Verbose -Message 'ScriptBlock Parameter Set Selected'

$AST = $ScriptBlock.Ast

break

}

default {

Write-Warning -Message 'An unexpected error has occurred'

}

if ($PsBoundParameters.AstType) {

Write-Verbose -Message 'AstType Parameter Entered'

$AST = $AST.FindAll({$args[0].GetType().Name -like "$($ASTType)Ast"}, $true)

}

Write-Output $AST

}

It retrieves the AST from one or more PS1 and/or PSM1 files, script blocks, or random arbitrary code.

Get-MrAst -Path .\Hyper-V\MrHyperV\public\

1	Get-MrAst -Path .\Hyper-V\MrHyperV\public\

It Read more [...]

Categories PowerShell Tags PowerShell

Sort PowerShell Results in both Ascending and Descending Order

Mike F Robbins May 9, 2019May 9, 2019 0

A few weeks ago I was trying to figure out how to sort something in PowerShell with one property sorted descending and another one ascending. How to accomplish this was hiding in plain sight in the help examples for Sort-Object, but I thought I would documented it here for future reference. Use the Property parameter with a hash table to specify the property names and their sort orders.

Get-Service -Name Win* |
Sort-Object -Property @{
    expression = 'Status'
    descending = $true
}, @{
    expression = 'DisplayName'
    descending = $false
}

Get-Service -Name Win* |

Sort-Object -Property @{

expression = 'Status'

descending = $true

}, @{

expression = 'DisplayName'

descending = $false

}

This same command can be written on one line.

Get-Service -Name Win* | Sort-Object -Property @{expression = 'Status';descending = $true}, @{expression = 'DisplayName';descending = $false}

1	Get-Service -Name Win* \| Sort-Object -Property @{expression = 'Status';descending = $true}, @{expression = 'DisplayName';descending = $false}

It Read more [...]

Categories PowerShell Tags PowerShell

Use PowerShell to Identify the Process ID for SQL Server Services

Mike F Robbins April 25, 2019April 25, 2019 0

I recently saw a blog article on "How to Identify Process ID for SQL Server Services? – Interview Question of the Week #185" written by Pinal Dave. While his answer is simple with TSQL, what if you're not a SQL guy? You can also retrieve this information with PowerShell from Windows itself. When it comes to retrieving information about Windows services with PowerShell, the first command that comes to mind is Get-Service. Unfortunately, Get-Service doesn't return the process id for services. Read more [...]

Categories PowerShell, SQL Server Tags PowerShell, SQL Server

Enable Tab Completion in VSCode for a PowerShell ISE like Experience

Mike F Robbins April 16, 2019April 16, 2019 2

I'm using VSCode for all of my PowerShell development at this point. I reloaded my system from scratch on March 13th of this year. Yesterday was the first time I've opened the PowerShell ISE since then and it was only to determine if something worked differently between the two (I tweeted this out yesterday). One of the common problems I hear about and have experienced myself with VSCode (Visual Studio Code) is that tabbed expansion of command and parameter names doesn't work like it does in the Read more [...]

Categories PowerShell, VSCode Tags PowerShell, VSCode

Run SQL Server PowerShell Cmdlets as a Different User

Mike F Robbins April 11, 2019April 11, 2019 2

One of the ways I practice the principal of least privilege is by logging into my computer as a domain user who is also a standard local user. I typically run PowerShell as a domain user who is a local admin and elevate on a per command basis using a domain account with more access only when absolutely necessary. The problem I've run into is neither the account I'm logged into my computer as or the one I'm running PowerShell as has the ability to execute SQL queries that I need to run against various Read more [...]

Categories PowerShell, SQL Server Tags PowerShell, SQL Server

Audit Membership of the Local Admins Group with PowerShell

Mike F Robbins April 4, 2019April 4, 2019 1

Recently, I needed to make sure that specific accounts were members of the local administrators group on several servers along with making sure that no other users were members of it. PowerShell version 5.1 introduced a module named Microsoft.PowerShell.LocalAccounts that contains the following commands for managing local users and groups.

Get-Command -Module Microsoft.PowerShell.LocalAccounts

1	Get-Command -Module Microsoft.PowerShell.LocalAccounts

Checking the group membership is as easy as running Get-LocalGroupMember within the script block of Invoke-Command and Read more [...]

Categories PowerShell Tags PowerShell

Backup and Synchronize VSCode Settings with a GitHub Gist

Mike F Robbins March 21, 2019March 21, 2019 0

Earlier this year, I watched a recording of the January 2019 Arizona PowerShell User Group meeting where Tim Warner presented a session on "Easing your transition from the PowerShell ISE to Visual Studio Code". One of the things Tim demonstrated was a VSCode extension named "Settings Sync" where you can synchronize your VSCode settings to and from a GitHub Gist. While it seems to be designed to synchronize your settings between multiple computers, I recently found out that it can also be a lifesaver Read more [...]

Categories PowerShell, VSCode Tags PowerShell, VSCode

The Noobs Guide to Installing Docker Desktop for Windows

Mike F Robbins February 28, 2019February 28, 2019 2

I recently came across an article on "Running PowerShell Core in a Container". This article tweaked my interest because it was a simple way to run PowerShell in a clean and isolated environment that could be used for testing without the need to spin up an entire VM. It could also be recreated much easier than an entire VM. The examples in the previously referenced article use a command (docker.exe) which I didn't have on my machine so the first order of business was to figure out how to run Docker Read more [...]

Categories Containers, Docker, PowerShell Tags Containers, Docker, PowerShell

PowerShell Tokenizer more Accurate than AST in Certain Scenarios

Mike F Robbins February 21, 2019February 21, 2019 1

As many of you know, I've been working on some module building tools. One of the things I needed was to retrieve a list of PowerShell modules that each function required (a list of dependencies). This seemed simple enough through PowerShell's AST (Abstract Syntax Tree) as shown in the following example.

$File = 'U:\GitHub\PowerShell\MrToolkit\Public\Find-MrModuleUpdate.ps1'
$AST = [System.Management.Automation.Language.Parser]::ParseFile($File, [ref]$null, [ref]$null)
$AST.ScriptRequirements.RequiredModules.Name

$File = 'U:\GitHub\PowerShell\MrToolkit\Public\Find-MrModuleUpdate.ps1'

$AST = [System.Management.Automation.Language.Parser]::ParseFile($File, [ref]$null, [ref]$null)

$AST.ScriptRequirements.RequiredModules.Name

The modules that are retrieved by the AST are simply the ones specified in a functions Requires statement. What if someone forgot to add a required module to Read more [...]

Categories PowerShell Tags PowerShell

My Solution to Iron Scripter 2019 Preparatory Challenge 1

Mike F Robbins February 16, 2019February 16, 2019 0

Anyone who has competed in the scripting games before knows that I'm always looking for a challenge when it comes to writing PowerShell code. While the scripting games haven't been held in the last several years, they've somewhat been replaced by the Iron Scripter competition at the PowerShell + DevOps Global Summit and 2019 is shaping up to be no different. Think you've got skills? Bring them on! and Get-Involved. Whether you've previously competed or not, you should definitely head over to IronScripter.us Read more [...]

Categories PowerShell, PowerShell Summit Tags PowerShell, PowerShell Summit, Scripting Games

Unexpected Results when Comparing Different Datatypes in PowerShell

Mike F Robbins February 14, 2019February 14, 2019 3

Earlier this week, I saw a tweet from a fellow PowerShell community member who mentioned PowerShell was returning inaccurate results. The command shown in the tweet was similar to the one in the following example.

Get-AppxPackage |
Where-Object -Property IsFramework -eq 'False' |
Select-Object -Property Name, SignatureKind, IsFramework

Get-AppxPackage |

Where-Object -Property IsFramework -eq 'False' |

Select-Object -Property Name, SignatureKind, IsFramework

Why would results be returned where "IsFramework" is true when the command is filtering them down to only the ones that are false? I knew exactly what the problem was because I've been bit by it more times than I care to remember. Piping the Get-AppxPackage Read more [...]

Categories PowerShell Tags PowerShell

What’s a PowerShell One-Liner & NOT a PowerShell One-Liner?

Mike F Robbins February 7, 2019February 7, 2019 2

Lately, I've seen a few examples of commands that aren't PowerShell one-liners being passed off as such by people in the PowerShell community who "should" know better. If I were interviewing someone who claimed to be a PowerShell expert with more than five years of experience, I would definitely ask these types of questions. Example 1 - The following command is a PowerShell one-liner? (True or False)

$Process = 'notepad.exe'; Start-Process $Process -PassThru -OutVariable NoteProc; Stop-Process -Id $NoteProc.Id -Force

1	$Process = 'notepad.exe'; Start-Process $Process -PassThru -OutVariable NoteProc; Stop-Process -Id $NoteProc.Id -Force

Example 2 - The following command is a PowerShell one-liner? Read more [...]

Categories PowerShell Tags PowerShell

Return a List of the Private Functions in a PowerShell Module

Mike F Robbins January 31, 2019January 31, 2019 2

In my quest to build a PowerShell module to convert a non-monolithic PowerShell module from development to a monolithic one for production, I wanted some way to validate that all of the functions were indeed migrated. While I'm pointing my tools to the public and private sub-folders within my development module and that should get them all, how can you be sure especially when a module may not have any private functions? Determining the publicly accessible functions for a module is easy enough Read more [...]

Categories PowerShell Tags PowerShell

Resolving Microsoft SQL Server Error 4064 with PowerShell

Mike F Robbins January 11, 2019January 11, 2019 2

Recently, a fellow IT Pro contacted me and stated they were unable to login to one of their SQL Servers using Windows Authentication. The following error was generated when attempting to login to SQL Server Management Studio (SSMS). Their exact words were "I think we have a permissions problem". Clicking on the "Show technical details" icon at the bottom of that error message showed the following information. You can work around this problem by clicking on the "Options >>" button: Then Read more [...]

Categories PowerShell, SQL Server Tags PowerShell, SQL Server

Finish the year off helping others in the PowerShell Community

Mike F Robbins December 20, 2018December 20, 2018 0

If you follow my blog, then I'm sure you're aware that earlier this year I embarked on a project to help others get started with PowerShell. I leveraged the contacts I'd made over the years in the PowerShell community and created a book with many of them, named "The PowerShell Conference Book". We all donated our time as 100% of the royalties go towards funding scholarships for the OnRamp track at the PowerShell + DevOps Global Summit. So far, we've fully funded three scholarships ($4,000 Read more [...]

Categories PowerShell, PowerShell Summit Tags PowerShell, The PowerShell Conference Book

Book Sale! Save on my PowerShell 101 Book & The PowerShell Conference Book

Mike F Robbins December 13, 2018December 13, 2018 0

There's never been a better time to purchase my PowerShell 101: The No-Nonsense Beginner’s Guide to PowerShell eBook. It's currently on sale for $4.99 using this link which automatically includes a coupon code that's good from now until the end of the year or for the first 50 redemptions, whichever comes first. Not sure whether or not this book is for you? Download the free sample which includes the first two chapters.
About the Book

Before PowerShell, I spent the first third of my career Read more [...]

Categories Career Development, PowerShell Tags Career Development, PowerShell, The PowerShell Conference Book