Testimo - PowerShell Module

Testimo is a PowerShell Module to help with basic/more advanced testing of Active Directory and maybe in future other types of servers. Testimo is an alpha product and as such things do change. It's goal is to be fully automated solution where one can run the command and get results without executing 50 little functions.

If you're new to Testimo you should read this blog post!

Note: At present this module is not supported in PowerShell Core/PowerShell 7. This is because the Testimo module depends on other Microsoft moodules that are also not supported in PowerShell 7, including GroupPolicy and ServerManager. There is an issue tracking this compatibiity which you can follow: #110.

Things to know:

• ✅ Configuration hash is not written in stone and can change rapidly as Testimo gets tested
• ✅ Ideas are VERY welcome
• ✅ There's a big mess in files/function names - I'm still testing things out creating some random names, will be cleaned up later on
• ✅ There are lots of details missing for tests, and some things may not work as you want - please report issues or if you know how, fix them
• ✅ I don't know EVERYTHING - I'm very open to help with making Testimo more robust, detailed and easy to use
• ✅ This module works great in Windows PowerShell!

Known Issues / By Design

• Requirements for Sources work differently then for Tests
  • For Sources when Requirements are not met Testimo skips it totally from output
  • For Tests when Requirements are not met Testimo marks it as skipped

Installation

Install-Module -Name Testimo -AllowClobber -Force

Force and AllowClobber aren't really nessecary but they do skip errors in case some appear.

Updates

Update-Module -Name Testimo

Alternatively, rerunnng Install-Module with force will trigger reinstallation or update

Install-Module -Name Testimo -AllowClobber -Force

That's it. Whenever there's new version you simply run the command and you can enjoy it. Remember, that you may need to close, reopen PowerShell session if you have already used module before updating it.

The important thing is if something works for you on production, keep using it till you test the new version on a test computer. I do changes that may not be big, but big enough that auto-update will break your code. For example, small rename to a parameter and your code stops working! Be responsible!

Usage

With output to screen and HTML

Invoke-Testimo

Generate all tests but display content only in PowerShell

Invoke-Testimo -HideHTML

Please keep in mind that there is currently known issue that running all tests while works correctly generated HTML is very very slow when switching Tabs. It's advised to run seperate tests which will generate smaller file which will be more responsive

Invoke-Testimo -Source 'ForestOptionalFeatures','DomainWellKnownFolders','ForestSubnets' -Online -ReportPath $PSScriptRoot\Reports\TestimoSummary.html -AlwaysShowSteps

There are also other parameters available With option to be able to process output - for example to email

Invoke-Testimo -ReturnResults

Using Invoke-Testimo with non-default configuration

Following configuration allows you to:

• Edit default TestImo configuration with some other values
• Exclude one of the domains
• Return Results for future processing
• Limit sources to only 4 types (you could also limit that via Hashtable but this way is quicker for Adhoc enabling/disabling)

Import-Module Testimo

$OutputOrderedDictionary = Get-TestimoConfiguration
$OutputOrderedDictionary.ForestOptionalFeatures.Tests.RecycleBinEnabled.Enable = $false
$OutputOrderedDictionary.ForestOptionalFeatures.Tests.LapsAvailable.Enable = $true
$OutputOrderedDictionary.ForestOptionalFeatures.Tests.LapsAvailable.Parameters.ExpectedValue = $false

$Sources = @(
    'ForestFSMORoles'
    'ForestOptionalFeatures'
    'ForestBackup'
    'ForestOrphanedAdmins'
    'DomainPasswordComplexity'
    'DomainKerberosAccountAge'
    'DomainDNSScavengingForPrimaryDNSServer'
    'DCWindowsUpdates'
)

$TestResults = Invoke-Testimo -PassThru -ExcludeDomains 'ad.evotec.pl' -Sources $Sources -Configuration $OutputOrderedDictionary
$TestResults | Format-Table -AutoSize *

Be sure to checkout Examples section for more How-To.

Changing default configuration

Testimo comes with preset rules that may not apply to your environment. You may want to change some things like disabling some tests or changing some values (to an extent). There are 3 ways to do it. Depending on how you want to save/edit/pass configuration to TestIMO - I leave it up to you.

Straight to FILE/JSON

Get-TestimoConfiguration -FilePath $PSScriptRoot\Configuration\TestimoConfiguration.json

Straight to JSON

Get-TestimoConfiguration -AsJson

Output to Hashtable so you can edit it freely and keep in ps1

$OutputOrderedDictionary = Get-TestimoConfiguration
$OutputOrderedDictionary.ForestOptionalFeatures.Tests.RecycleBinEnabled.Enable = $false
$OutputOrderedDictionary.ForestOptionalFeatures.Tests.LapsAvailable.Enable = $true
$OutputOrderedDictionary.ForestOptionalFeatures.Tests.LapsAvailable.Parameters.ExpectedValue = $false

Comments

Keep in mind not all tests apply to each environment. I'm adding those to be flexible and be able to test things as needed. Each of those tests will need additional description and recommendation, most likely with links and steps to fix. Some of the tests are very basic and will need feedback, work on making it a robust test. Nothing is written in stone for now. Things can change day by day.

Things to consider

• Criticality of Tests - some tests are critical, some are less critical, some are informative only
• Recommended, Default, Sane - not all tests are equal or make sense in all conditions

Tests are based on:

• Active Directory CheckList
• AD Health & Checkup
• Some tests I've defined myself
• Feel free to submit your own ideas either via Issues or direct PR.

Dependencies

• PowerShell 5.1 - I know, bummer right?
• RSAT if run externally from Windows 10 machine

When you use the Install-Module option what happens in the backgrouns is that Windows will use PowershellGallery (hosted by Microsoft) to download Testimo and any dependencies this module needs. As it stands all dependencies except one (DSInternals) are my other PowerShell Modules. Why I am using it this way? Because I don't want to write multiple times the same code over and over.

• Testimo - this module
  • PSWinDocumentation.AD - PowerShell Module that's main purpose is deliver formmated/compressive Active Directory data for documentation purposes. It's read only.
    • DSInternals - Directory Services Internals PowerShell Module and Framework by Michael Grafnetter - it's main purpose is to verify Active Directory Passwords
  • PSWinDocumentation.DNS - PowerShell Module that's main purpose is deliver formmated/compressive DNS data for documentation purposes (it's a bit unfinished product but it works as far Testimo is concerned). It's read only.
  • ADEssentials - PowerShell Module that's supposed to hold a bunch of useful Get/Set tools for Active Directory.
  • PSSharedGoods - PowerShell Module with lots of different, helpfull functions that I have gathered over the years
    • PSWriteColor - PowerShell Module responsible for Console Colors
    • Connectimo - PowerShell Module responsible for Connecting to O365 - while it's not in use in this project PSSharedGoods depends on it, so it's here. No function is used from it.
  • PSWriteHTML - PowerShell Module that creates nice looking reports. Responsible for visual HTML reporting.
  • Emailimo - PowerShell Module that creates nice looking emails. Responsible for emails in Testimo.

In Testimo I'm using internal functions from some of the modules without any real documentation.

Portability

There are times where you may want to use Testimo in Portable way. Following function when executed will download all modules to given path and load them for you. Following blog post shows the way. It was written specifically for Testimo.

Initialize-ModulePortable -Name 'Testimo' -Path "$PSScriptRoot\TestimoPortable" -Download

After that,, you can use Invoke-Testimo as you normally would. You can also skip Download parameter if you already downloaded all the modules before. This function is also available as part of PSSharedGoods module.

Removal

In case you decide that Testimo is not for you, you can easily clean it up. Unfortunetly since Testimo uses all those dependencies as mentioned above you will have to remove all those modules one by one. Additionally if you have been using Testimo and you update it using Update-Module command and other modules got updated as well, it's possible there will be more then 1 version of said modules. Keep in mind that if you already use some of my modules some of the stuff may be already there and needed for different modules. Be careful when removing PowerShellModules.

Option 1

• Finding where modules are stored (Get-Module -ListAvailable Testimo).ModuleBase
• Manually deleting all folders Testimo, and other dependant modules

Option 2

• Run Uninstall-Module

$Modules = @('Testimo', 'PSWinDocumentation.AD','PSWinDocumentation.DNS','ADEssentials', 'PSSharedGoods','PSWriteColor', 'Connectimo', 'DSInternals','Emailimo','PSWriteHTML' )
foreach ($Module in $Modules) {
    Uninstall-Module $Module -Force -AllVersions
}

Due to multiple versions per each module you may need to rerun this couple of times to remove all those mdoules in case there are some problems.