Merge pull request #169 from LowlyDBA/development

Development

Author: lowlydba

.github/CONTRIBUTING.md

@@ -43,10 +43,9 @@ for your commits to be automatically linted using Github Actions.
 
 ### PowerShell
 
-PowerShell is only used in the automation piece of this project, but could probably
-benefit from being better documented and standardized. Right now no particular
-style is enforced, 
-but [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) is recommended.
+PowerShell is only used in the automation piece of this project,
+but [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer)
+is used to lint it for general best practice adherement.
 
 [mdconfig]: https://github.com/LowlyDBA/dba-multitool/blob/master/.github/linters/.markdown-lint.yml
 [mdlint]: https://github.com/DavidAnson/markdownlint

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,7 +6,7 @@
 <!--- Why is this change required? What problem does it solve? -->
 
 <!--- Associated issue number -->
-**Issue:** 
+**Issue:** Fixes 
 
 ## How Has This Been Tested?
 <!--- Please describe in detail how you tested your changes. -->

.github/codecov.yml

@@ -3,7 +3,12 @@ coverage:
   round: down
   precision: 2
   status:
+    project:
+      default:
+        # basic
+        target: auto
+        threshold: 1%
     patch: off
 
 fixes:
-  - "::"        
+  - "::"

.github/linters/.markdown-lint.yml

@@ -18,12 +18,15 @@
 ###############
 # Rules by id #
 ###############
-MD033: 
-  allowed_elements: ["details", "summary", "img", "sub"]
+MD009: false
+MD010:
+  code_blocks: false
 MD013:
   code_blocks: false
   tables: false
 MD024: false
-MD010:
-  code_blocks: false
-MD009: false
+MD033: 
+  allowed_elements: ["details", "summary", "img", "sub"]
+
+
+

.github/workflows/super-linter.yml

@@ -45,4 +45,6 @@ jobs:
       - name: Lint Code Base
         uses: docker://github/super-linter:v3.13.5
         env:
-          VALIDATE_MD: true
+          VALIDATE_MARKDOWN: true
+          VALIDATE_POWERSHELL: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

appveyor/generate_sample_markdown.ps1

@@ -1,18 +1,18 @@
-param( 
-    [Parameter()] 
+#PSScriptAnalyzer rule excludes
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')]
+
+param(
+    [Parameter()]
     [string]$SqlInstance = $env:DB_INSTANCE,
     [string]$UtilityDatabase = $env:TARGET_DB,
-    [bool]$IsAzureSQL = [System.Convert]::ToBoolean($env:AzureSQL),
-    [string]$User = $env:AZURE_SQL_USER,
-    [string]$Pass = $env:AZURE_SQL_PASS,
     [string]$Color = "Green"
 )
 
 $ErrorActionPreference = "Stop";
 $Url = "https://github.com/Microsoft/sql-server-samples/releases/download/wide-world-importers-v1.0/WideWorldImporters-Full.bak"
 $BackupPath = "C:\WideWorldImporters-Full.bak"
 $SampleDatabase = "WideWorldImporters"
-$SampleMarkdown = "docs/$SampleDatabase.md"
+$SampleMarkdown = "docs/assets/$SampleDatabase.md"
 
 Write-Host "Generating $SampleDatabase markdown sample..." -ForegroundColor $Color
 
@@ -25,7 +25,8 @@ If (!(Get-DbaDatabase -SqlInstance $SqlInstance -Database $SampleDatabase -Warni
 }
 
 # Generate documentation
-sqlcmd -S $SqlInstance -d $UtilityDatabase -Q "EXEC sp_doc @DatabaseName = '$SampleDatabase';" -o $SampleMarkdown -y 0
+$Query = "EXEC sp_doc @DatabaseName = '$SampleDatabase';"
+Invoke-DbaQuery -SqlInstance $SqlInstance -Database $UtilityDatabase -Query $Query -As SingleValue | Out-File $SampleMarkdown
 
 # Remove footer to avoid eternal appveyor build loop from file diffs
 $Temp = Get-Content $SampleMarkdown

appveyor/install_dependencies.ps1

@@ -1,5 +1,8 @@
-param( 
-    [Parameter()] 
+#PSScriptAnalyzer rule excludes
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')]
+
+param(
+    [Parameter()]
     [switch]$CodeCoverage,
     $Color = "Green"
 )

appveyor/install_tsqlt.ps1

@@ -1,3 +1,7 @@
+#PSScriptAnalyzer rule excludes
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
+
 param(
     [Parameter()]
     [String]$SqlInstance = $env:DB_INSTANCE,
@@ -10,7 +14,7 @@ param(
 
 Write-Host "Downloading and installing tSQLt..." -ForegroundColor $Color
 
-# BaseUrl gets the latest version by default - blocked by https://github.com/LowlyDBA/dba-multitool/issues/165 
+# BaseUrl gets the latest version by default - blocked by https://github.com/LowlyDBA/dba-multitool/issues/165
 $Version = "1-0-5873-27393"
 $DownloadUrl = "http://tsqlt.org/download/tsqlt/?version=" + $Version
 $TempPath = [System.IO.Path]::GetTempPath()
@@ -26,7 +30,7 @@ IF EXISTS (SELECT 1 FROM sys.configurations WHERE name = 'clr strict security')
 BEGIN
 	EXEC sp_configure 'show advanced options', 1;
 	RECONFIGURE;
-	
+
 	EXEC sp_configure 'clr strict security', 0;
 	RECONFIGURE;
 END

appveyor/push_git_changes.ps1

@@ -6,6 +6,6 @@ $StagedFiles = git diff --staged
 
 # Commit & push if stated
 If ($StagedFiles) {
-    git commit -a -m "CI produced files" -q 
+    git commit -a -m "CI produced files" -q
     git push origin $env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH -f -q
 }

appveyor/run_pester_tests.ps1

@@ -1,32 +1,42 @@
 using namespace System.IO.Path
 
-param( 
-    [Parameter()] 
+#PSScriptAnalyzer rule excludes
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '')]
+param(
+    [Parameter()]
     [switch]$LocalTest,
     [string]$CoverageXMLPath = $env:COV_REPORT,
     [string]$SqlInstance = $env:DB_INSTANCE,
     [string]$Database = $env:TARGET_DB,
     [bool]$IsAzureSQL = [System.Convert]::ToBoolean($env:AzureSQL),
     [string]$User = $env:AZURE_SQL_USER,
     [string]$Pass = $env:AZURE_SQL_PASS,
-    [string]$Color = "Green",
+    [System.ConsoleColor]$Color = "Green",
     [switch]$CodeCoverage
 )
+
 . ".\tests\constants.ps1"
 $ErrorActionPreference = "Stop"
 $TestFiles = Get-ChildItem -Path .\tests\*.Tests.ps1
 $FailedTests = 0
 
 function Start-CodeCoverage {
+param(
+    [string]$SqlInstance,
+    [string]$Database,
+    [string]$User,
+    [string]$Pass,
+    [bool]$IsAzureSQL,
+    [System.ConsoleColor]$Color
+)
     # Setup vars
+    $ConnString = "server=$SqlInstance;initial catalog=$Database;Trusted_Connection=yes"
     If ($IsAzureSQL) {
         $ConnString = "server=$SqlInstance;initial catalog=$Database;User Id=$User;pwd=$Pass"
     }
 
-    Else {
-        $ConnString = "server=$SqlInstance;initial catalog=$Database;Trusted_Connection=yes"
-    }
-
     $NugetPath = (Get-Package GOEddie.SQLCover).Source | Convert-Path
     $SQLCoverRoot = Split-Path $NugetPath
     $SQLCoverPath = Join-Path $SQLCoverRoot "lib"
@@ -42,7 +52,11 @@ function Start-CodeCoverage {
 }
 
 function Complete-CodeCoverage {
-    # Stop covering 
+param (
+    [string]$CoverageXMLPath,
+    [string]$Color
+)
+    # Stop covering
     Write-Host "Stopping SQLCover..." -ForegroundColor $Color
     $coverageResults = $global:SQLCover.Stop()
 
@@ -51,10 +65,10 @@ function Complete-CodeCoverage {
     If (!($LocalTest.IsPresent)) {
         $SavePath = Join-Path -Path $PSScriptRoot -ChildPath "sqlcover"
         $coverageResults.OpenCoverXml() | Out-File $CoverageXMLPath -Encoding utf8
-        $coverageResults.SaveSourceFiles($SavePath)    
+        $coverageResults.SaveSourceFiles($SavePath)
     }
 
-    Else { 
+    Else {
         # Don't save any files and bring up html report for review
         $tmpFile = Join-Path $env:TEMP "Coverage.html"
         Set-Content -Path $tmpFile -Value $coverageResults.Html2() -Force
@@ -66,7 +80,15 @@ function Complete-CodeCoverage {
 
 # Start Coverage
 If ($CodeCoverage.IsPresent) {
-    Start-CodeCoverage
+    $Hash = @{
+        SqlInstance = $SqlInstance
+        Database    = $Database
+        User        = $User
+        Pass        = $Pass
+        IsAzureSQL  = $IsAzureSQL
+        Color       = $Color
+    }
+    Start-CodeCoverage @Hash
 }
 
 # Generate all-in-one installer script
@@ -88,7 +110,7 @@ ForEach ($file in $TestFiles) {
 
 # End Coverage
 If ($CodeCoverage.IsPresent) {
-    Complete-CodeCoverage
+    Complete-CodeCoverage -CoverageXMLPath $CoverageXMLPath -Color $Color
 }
 
 # Check for failures