Skip to content

Refactor input validation in New-AsBuiltConfig, New-AsBuiltReport, and New-AsBuiltReportConfig scripts #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rebelinux wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Refactor input validation in New-AsBuiltConfig, New-AsBuiltReport, and New-AsBuiltReportConfig scripts #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86e53a1
Refactor input validation in New-AsBuiltConfig, New-AsBuiltReport, an…
rebelinux Apr 4, 2026
d6c49e4
Merge branch 'AsBuiltReport:dev' into dev
rebelinux Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
needs: publish-to-gallery
runs-on: ubuntu-latest
steps:
- uses: zentered/bluesky-post-action@v0.3.0
- uses: zentered/bluesky-post-action@v0.4.0
with:
post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #AsBuiltReport #PowerShell"
env:
Expand Down
2 changes: 1 addition & 1 deletion AsBuiltReport.Core/AsBuiltReport.Core.Style.ps1
View file
Open in desktop

Large diffs are not rendered by default.

114 changes: 57 additions & 57 deletions AsBuiltReport.Core/Src/Public/New-AsBuiltConfig.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function New-AsBuiltConfig {
Draw-AsciiBanner -Lines @($translate.ReportInfo.BannerTitle) -TextColor 'Cyan' -SeparatorColor 'Cyan'

$ReportAuthor = Read-Host -Prompt ($translate.ReportInfo.ReportAuthor -f [System.Environment]::Username)
if (($null -eq $ReportAuthor) -or ($ReportAuthor -eq "")) {
if (($null -eq $ReportAuthor) -or ($ReportAuthor -eq '')) {
$ReportAuthor = $([System.Environment]::Username)
}

Expand All @@ -59,13 +59,13 @@ function New-AsBuiltConfig {
Draw-AsciiBanner -Lines @($translate.CompanyConfig.BannerTitle) -TextColor 'Cyan' -SeparatorColor 'Cyan'

$CompanyInfo = Read-Host -Prompt $translate.CompanyConfig.CompanyInfo
if (($null -eq $CompanyInfo) -or ($CompanyInfo -eq "")) {
$CompanyInfo = "n"
if (($null -eq $CompanyInfo) -or ($CompanyInfo -eq '')) {
$CompanyInfo = 'n'
}
while ("y", "n" -notcontains $CompanyInfo) {
while ('y', 'n' -notcontains $CompanyInfo) {
$CompanyInfo = Read-Host -Prompt $translate.CompanyConfig.CompanyInfo
if (($null -eq $CompanyInfo) -or ($CompanyInfo -eq "")) {
$CompanyInfo = "n"
if (($null -eq $CompanyInfo) -or ($CompanyInfo -eq '')) {
$CompanyInfo = 'n'
}
}

Expand All @@ -76,7 +76,7 @@ function New-AsBuiltConfig {
do {
$CompanyEmail = Read-Host -Prompt $translate.CompanyConfig.CompanyEmail

if (($null -eq $CompanyEmail) -or ($CompanyEmail -eq "")) {
if (($null -eq $CompanyEmail) -or ($CompanyEmail -eq '')) {
# Allow blank/empty - no validation needed
$isValid = $true
} else {
Expand Down Expand Up @@ -110,21 +110,21 @@ function New-AsBuiltConfig {
Draw-AsciiBanner -Lines @($translate.EmailConfig.BannerTitle) -TextColor 'Cyan' -SeparatorColor 'Cyan'
if (-not ($SendEmail)) {
$ConfigureMailSettings = Read-Host -Prompt $translate.EmailConfig.ConfigureMailSettings
if (($null -eq $ConfigureMailSettings) -or ($ConfigureMailSettings -eq "")) {
$ConfigureMailSettings = "n"
if (($null -eq $ConfigureMailSettings) -or ($ConfigureMailSettings -eq '')) {
$ConfigureMailSettings = 'n'
}
while ("y", "n" -notcontains $ConfigureMailSettings) {
while ('y', 'n' -notcontains $ConfigureMailSettings) {
$ConfigureMailSettings = Read-Host -Prompt $translate.EmailConfig.ConfigureMailSettings
if (($null -eq $ConfigureMailSettings) -or ($ConfigureMailSettings -eq "")) {
$ConfigureMailSettings = "n"
if (($null -eq $ConfigureMailSettings) -or ($ConfigureMailSettings -eq '')) {
$ConfigureMailSettings = 'n'
}
}
}
if (($SendEmail) -or ($ConfigureMailSettings -eq "y")) {
if (($SendEmail) -or ($ConfigureMailSettings -eq 'y')) {
do {
$MailServer = Read-Host -Prompt $translate.EmailConfig.MailServer

if (($null -eq $MailServer) -or ($MailServer -eq "")) {
if (($null -eq $MailServer) -or ($MailServer -eq '')) {
Write-Host $translate.EmailConfig.EmptyMailServerAddress -ForegroundColor Red
$isValid = $false
} else {
Expand Down Expand Up @@ -180,7 +180,7 @@ function New-AsBuiltConfig {
$MailServerPort = Read-Host -Prompt $translate.EmailConfig.MailServerPort587
$portNumber = 0 # Initialize the variable

if (($null -eq $MailServerPort) -or ($MailServerPort -eq "")) {
if (($null -eq $MailServerPort) -or ($MailServerPort -eq '')) {
$MailServerPort = '587'
$isValid = $true
} elseif ([int]::TryParse($MailServerPort, [ref]$portNumber) -and $portNumber -ge 1 -and $portNumber -le 65535) {
Expand All @@ -195,7 +195,7 @@ function New-AsBuiltConfig {
$MailServerPort = Read-Host -Prompt $translate.EmailConfig.MailServerPort25
$portNumber = 0 # Initialize the variable

if (($null -eq $MailServerPort) -or ($MailServerPort -eq "")) {
if (($null -eq $MailServerPort) -or ($MailServerPort -eq '')) {
$MailServerPort = '25'
$isValid = $true
} elseif ([int]::TryParse($MailServerPort, [ref]$portNumber) -and $portNumber -ge 1 -and $portNumber -le 65535) {
Expand All @@ -208,38 +208,38 @@ function New-AsBuiltConfig {
}

$MailServerUseSSL = Read-Host -Prompt $translate.EmailConfig.MailServerUseSSL
if (($null -eq $MailServerUseSSL) -or ($MailServerUseSSL -eq "")) {
$MailServerUseSSL = "n"
if (($null -eq $MailServerUseSSL) -or ($MailServerUseSSL -eq '')) {
$MailServerUseSSL = 'n'
}
while ("y", "n" -notcontains $MailServerUseSSL) {
while ('y', 'n' -notcontains $MailServerUseSSL) {
$MailServerUseSSL = Read-Host -Prompt $translate.EmailConfig.MailServerUseSSL
if (($null -eq $MailServerUseSSL) -or ($MailServerUseSSL -eq "")) {
$MailServerUseSSL = "n"
if (($null -eq $MailServerUseSSL) -or ($MailServerUseSSL -eq '')) {
$MailServerUseSSL = 'n'
}
}
$MailServerUseSSL = switch ($MailServerUseSSL) {
"y" { $true }
"n" { $false }
'y' { $true }
'n' { $false }
}

$MailCredentials = Read-Host -Prompt $translate.EmailConfig.MailCredentials
if (($null -eq $MailCredentials) -or ($MailCredentials -eq "")) {
$MailCredentials = "n"
if (($null -eq $MailCredentials) -or ($MailCredentials -eq '')) {
$MailCredentials = 'n'
}
while ("y", "n" -notcontains $MailCredentials) {
while ('y', 'n' -notcontains $MailCredentials) {
$MailCredentials = Read-Host -Prompt $translate.EmailConfig.MailCredentials
if (($null -eq $MailCredentials) -or ($MailCredentials -eq "")) {
$MailCredentials = "n"
if (($null -eq $MailCredentials) -or ($MailCredentials -eq '')) {
$MailCredentials = 'n'
}
}
$MailCredentials = switch ($MailCredentials) {
"y" { $true }
"n" { $false }
'y' { $true }
'n' { $false }
}

do {
$MailFrom = Read-Host -Prompt $translate.EmailConfig.MailFrom
if (($null -eq $MailFrom) -or ($MailFrom -eq "")) {
if (($null -eq $MailFrom) -or ($MailFrom -eq '')) {
Write-Host $translate.EmailConfig.EmptyEmail -ForegroundColor Red
$isValid = $false
} else {
Expand All @@ -258,7 +258,7 @@ function New-AsBuiltConfig {
do {
$MailTo = Read-Host -Prompt $translate.EmailConfig.MailTo

if (($null -eq $MailTo) -or ($MailTo -eq "")) {
if (($null -eq $MailTo) -or ($MailTo -eq '')) {
Write-Host $translate.EmailConfig.EmptyEmail -ForegroundColor Red
$isValid = $false
} else {
Expand All @@ -275,18 +275,18 @@ function New-AsBuiltConfig {
$MailRecipients += $MailTo
$AnotherRecipient = @()
$AnotherRecipient = Read-Host -Prompt $translate.EmailConfig.AnotherRecipient
if (($null -eq $AnotherRecipient) -or ($AnotherRecipient -eq "")) {
$AnotherRecipient = "n"
if (($null -eq $AnotherRecipient) -or ($AnotherRecipient -eq '')) {
$AnotherRecipient = 'n'
}
while ("y", "n" -notcontains $AnotherRecipient) {
while ('y', 'n' -notcontains $AnotherRecipient) {
$AnotherRecipient = Read-Host -Prompt $translate.EmailConfig.AnotherRecipient
if (($null -eq $AnotherRecipient) -or ($AnotherRecipient -eq "")) {
$AnotherRecipient = "n"
if (($null -eq $AnotherRecipient) -or ($AnotherRecipient -eq '')) {
$AnotherRecipient = 'n'
}
}
} until($AnotherRecipient -eq "n")
} until($AnotherRecipient -eq 'n')
$MailBody = Read-Host -Prompt $translate.EmailConfig.MailBodyPrompt
if (($null -eq $MailBody) -or ($MailBody -eq "")) {
if (($null -eq $MailBody) -or ($MailBody -eq '')) {
$MailBody = $translate.EmailConfig.MailBody
}
}
Expand All @@ -307,9 +307,9 @@ function New-AsBuiltConfig {
Clear-Host
# Show Report configuration banner
Draw-AsciiBanner -Lines @($translate.ReportConfig.BannerTitle) -TextColor 'Cyan' -SeparatorColor 'Cyan'
$DefaultConfigFolder = Join-Path -Path $Home -ChildPath "AsBuiltReport"
$DefaultConfigFolder = Join-Path -Path $Home -ChildPath 'AsBuiltReport'
$ReportConfigFolder = Read-Host -Prompt ($translate.ReportConfig.ReportConfigFolder -f $DefaultConfigFolder)
if (($null -eq $ReportConfigFolder) -or ($ReportConfigFolder -eq "")) {
if (($null -eq $ReportConfigFolder) -or ($ReportConfigFolder -eq '')) {
$ReportConfigFolder = $DefaultConfigFolder
}

Expand Down Expand Up @@ -343,13 +343,13 @@ function New-AsBuiltConfig {
try {
if (Test-Path -Path $DestinationPath) {
$OverwriteReportConfig = Read-Host -Prompt ($translate.ReportConfig.OverwriteReportConfig -f $ReportModuleName)
if (($null -eq $OverwriteReportConfig) -or ($OverwriteReportConfig -eq "")) {
$OverwriteReportConfig = "n"
if (($null -eq $OverwriteReportConfig) -or ($OverwriteReportConfig -eq '')) {
$OverwriteReportConfig = 'n'
}
while ("y", "n" -notcontains $OverwriteReportConfig) {
while ('y', 'n' -notcontains $OverwriteReportConfig) {
$OverwriteReportConfig = Read-Host -Prompt ($translate.ReportConfig.OverwriteReportConfig -f $ReportModuleName)
if (($null -eq $OverwriteReportConfig) -or ($OverwriteReportConfig -eq "")) {
$OverwriteReportConfig = "n"
if (($null -eq $OverwriteReportConfig) -or ($OverwriteReportConfig -eq '')) {
$OverwriteReportConfig = 'n'
}
}
if ($OverwriteReportConfig -eq 'y') {
Expand All @@ -375,36 +375,36 @@ function New-AsBuiltConfig {
Clear-Host
Draw-AsciiBanner -Lines @($translate.ReportConfig.BannerTitle) -TextColor 'Cyan' -SeparatorColor 'Cyan'
$SaveAsBuiltConfig = Read-Host -Prompt $translate.ReportConfig.SaveAsBuiltConfig
if (($null -eq $SaveAsBuiltConfig) -or ($SaveAsBuiltConfig -eq "")) {
$SaveAsBuiltConfig = "y"
if (($null -eq $SaveAsBuiltConfig) -or ($SaveAsBuiltConfig -eq '')) {
$SaveAsBuiltConfig = 'y'
}
while ("y", "n" -notcontains $SaveAsBuiltConfig) {
while ('y', 'n' -notcontains $SaveAsBuiltConfig) {
$SaveAsBuiltConfig = Read-Host -Prompt $translate.ReportConfig.SaveAsBuiltConfig
if (($null -eq $SaveAsBuiltConfig) -or ($SaveAsBuiltConfig -eq "")) {
$SaveAsBuiltConfig = "y"
if (($null -eq $SaveAsBuiltConfig) -or ($SaveAsBuiltConfig -eq '')) {
$SaveAsBuiltConfig = 'y'
}
}

if ($SaveAsBuiltConfig -eq 'y') {
$AsBuiltName = Read-Host -Prompt $translate.ReportConfig.AsBuiltName
if (($null -eq $AsBuiltName) -or ($AsBuiltName -eq "")) {
$AsBuiltName = "AsBuiltReport"
if (($null -eq $AsBuiltName) -or ($AsBuiltName -eq '')) {
$AsBuiltName = 'AsBuiltReport'
}
if ($Config.UserFolder.Path) {
$AsBuiltExportPath = Read-Host -Prompt ($translate.ReportConfig.AsBuiltExportPath -f $Config.UserFolder.Path)
if (($null -eq $AsBuiltExportPath) -or ($AsBuiltExportPath -eq "")) {
if (($null -eq $AsBuiltExportPath) -or ($AsBuiltExportPath -eq '')) {
$AsBuiltExportPath = $Config.UserFolder.Path
}
} elseif ($ReportConfigFilePath) {
$ReportConfigFolderPath = Split-Path -Path $ReportConfigFilePath
$AsBuiltExportPath = Read-Host -Prompt ($translate.ReportConfig.AsBuiltExportPath -f $ReportConfigFolderPath)
if (($null -eq $AsBuiltExportPath) -or ($AsBuiltExportPath -eq "")) {
if (($null -eq $AsBuiltExportPath) -or ($AsBuiltExportPath -eq '')) {
$AsBuiltExportPath = $ReportConfigFolderPath
}
} else {
$DefaultConfigFolder = Join-Path -Path $Home -ChildPath "AsBuiltReport"
$DefaultConfigFolder = Join-Path -Path $Home -ChildPath 'AsBuiltReport'
$AsBuiltExportPath = Read-Host -Prompt ($translate.ReportConfig.AsBuiltExportPath -f $DefaultConfigFolder)
if (($null -eq $AsBuiltExportPath) -or ($AsBuiltExportPath -eq "")) {
if (($null -eq $AsBuiltExportPath) -or ($AsBuiltExportPath -eq '')) {
$AsBuiltExportPath = $DefaultConfigFolder
}
}
Expand Down
Loading
Loading