sp_doc: add indexes (#176)

*  add `<br>` to safe list for markdown linter
* improve some variable naming and data type usage
* add view/table indexes + tests
* upgrade pester to 5.1.0+
* add timeouts to unit test calls
* remove buggy sensitivity classification test (#177 )

Author: lowlydba

.github/linter-conf/.markdown-lint.yml

@@ -26,7 +26,7 @@ MD013:
   tables: false
 MD024: false
 MD033: 
-  allowed_elements: ["details", "summary", "img", "sub"]
+  allowed_elements: ["details", "summary", "img", "sub", "br"]
 
 
 

.vscode/settings.json

@@ -2,12 +2,15 @@
     "markdownlint.config": {
         "MD024": false,
         "MD010": {
-            "code_blocks": false },
+            "code_blocks": false 
+        },
         "MD033": {
-            "allowed_elements": ["details", "summary", "img", "sub"] },
+            "allowed_elements": ["details", "summary", "img", "sub", "br"] 
+        },
         "MD013": {
             "code_blocks": false,
-            "tables": false}
+            "tables": false
+        }
     },
     "powershell.codeFormatting.trimWhitespaceAroundPipe": true,
     "powershell.codeFormatting.useCorrectCasing": true

appveyor/appveyor.yml

@@ -13,7 +13,6 @@ environment:
   AZURE_SQL_PASS:
     secure: 'rYm3nE1kwpbdE7QtyLb8CjvA1ENjY3usz3Qqskf1TXU='
   CI_COMMIT_MSG: 'CI produced files'
-
   APPVEYOR_RDP_PASSWORD: Np^VNSzJI5#OmRdUNqro2T9UVkCdZ
   TARGET_DB: tSQLt
   COV_REPORT: appveyor\sqlcover\Coverage.opencoverxml
@@ -67,10 +66,8 @@ clone_script:
   - git config --global core.safecrlf false
   - git clone -q --single-branch --branch=%APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH% https://github.com/LowlyDBA/dba-multitool.git %APPVEYOR_BUILD_FOLDER%
   - cd %APPVEYOR_BUILD_FOLDER%
-  - ps: .\appveyor\skip_ci_commit.ps1
 
 install:
-  - ps: Install-Product node ''
   - ps: .\appveyor\install_dependencies.ps1
   - ps: .\appveyor\start_sqlserver.ps1
   - ps: .\appveyor\install_tsqlt.ps1
@@ -88,7 +85,7 @@ for:
 
   # Setup codecov, SQL Cover
   before_test:
-    - ps: .\appveyor\install_dependencies.ps1 -CodeCoverage
+    - ps: .\appveyor\install_dependencies.ps1 -CodeCoverageOnly
 
   # Run tests with SQL Cover analysis
   test_script:
@@ -101,6 +98,9 @@ for:
     - codecov -f %COV_REPORT%
     - ps: .\appveyor\push_git_changes.ps1
 
+  #on_finish:
+  #- ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
+
 # Azure SQL: No need to start SQL Server locally
 -
   matrix:

appveyor/generate_sample_markdown.ps1

@@ -30,4 +30,4 @@ Invoke-DbaQuery -SqlInstance $SqlInstance -Database $UtilityDatabase -Query $Que
 
 # Remove footer to avoid eternal appveyor build loop from file diffs
 $Temp = Get-Content $SampleMarkdown
-$Temp[0..($Temp.Length - 4)] | Out-File $SampleMarkdown -Encoding utf8
+$Temp[0..($Temp.Length - 4)] | Out-File $SampleMarkdown -Encoding ascii

appveyor/install_dependencies.ps1

@@ -3,32 +3,15 @@
 
 param(
     [Parameter()]
-    [switch]$CodeCoverage,
+    [switch]$CodeCoverageOnly,
     $Color = "Green"
 )
 
-Write-Host "Installing dependencies..." -ForegroundColor $Color
 
-# DbaTools
-if (!(Get-Module -ListAvailable -Name DbaTools)) {
-    $DbaToolsJob = Start-Job -ScriptBlock { Install-Module DbaTools -Force -AllowClobber }
-}
-
-# Pester
-if (!(Get-InstalledModule -Name Pester -MinimumVersion 5.0.0 -ErrorAction SilentlyContinue)) {
-    Install-Module Pester -Force -AllowClobber -WarningAction SilentlyContinue -SkipPublisherCheck -MinimumVersion 5.0.0
-}
-
-if (!(Get-Module -Name Pester | Where-Object { $PSItem.Version -lt 5.0.0 })) {
-    if (Get-Module -Name Pester) {
-        Remove-Module Pester -Force
-    }
-    Import-Module Pester -MinimumVersion 4.0.0
-}
+if ($CodeCoverageOnly.IsPresent) {
+    Write-Host "Installing code coverage tool..." -ForegroundColor $Color
 
-# GoEddie SQLCover
-If ($CodeCoverage.IsPresent) {
-    # Install code coverage tool
+    # GoEddie SQLCover
     If (!(Get-Package -Name GOEddie.SQLCover -ErrorAction SilentlyContinue)) {
         Install-Package GOEddie.SQLCover -Force | Out-Null
     }
@@ -37,6 +20,27 @@ If ($CodeCoverage.IsPresent) {
     choco install codecov --no-progress --limit-output | Out-Null
 }
 
-If ($DbaToolsJob) {
-    Wait-Job $DbaToolsJob.Id | Out-Null
-}
+else {
+    Write-Host "Installing dependencies..." -ForegroundColor $Color
+
+    # DbaTools
+    if (!(Get-Module -ListAvailable -Name DbaTools)) {
+        $DbaToolsJob = Start-Job -ScriptBlock { Install-Module DbaTools -Force -AllowClobber }
+    }
+
+    # Pester
+    if (!(Get-InstalledModule -Name Pester -MaximumVersion 5.1.9 -ErrorAction SilentlyContinue)) {
+        Install-Module Pester -Force -AllowClobber -WarningAction SilentlyContinue -SkipPublisherCheck -MaximumVersion 5.1.9
+    }
+
+    if (!(Get-Module -Name Pester | Where-Object { $PSItem.Version -lt 5.1.0 })) {
+        if (Get-Module -Name Pester) {
+            Remove-Module Pester -Force
+        }
+        Import-Module Pester -MaximumVersion 5.1.9 -Force
+    }
+
+    If ($DbaToolsJob) {
+        Wait-Job $DbaToolsJob.Id | Out-Null
+    }
+}

appveyor/install_tsqlt.ps1

@@ -14,16 +14,13 @@ 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
-$Version = "1-0-5873-27393"
-$DownloadUrl = "http://tsqlt.org/download/tsqlt/?version=" + $Version
+$DownloadUrl = "http://tsqlt.org/download/tsqlt/?version="
 $TempPath = [System.IO.Path]::GetTempPath()
 $ZipFile = Join-Path $TempPath "tSQLt.zip"
 $ZipFolder = Join-Path $TempPath "tSQLt"
-#$SetupFile = Join-Path $ZipFolder "PrepareServer.sql" # Used in latest version after 1.0.5873.27393
-$SetupFile = Join-Path $ZipFolder "SetClrEnabled.sql"
 $InstallFile = Join-Path $ZipFolder "tSQLt.class.sql"
 $CreateDbQuery = "CREATE DATABASE [tSQLt];"
+$SetupFile = Join-Path $ZipFolder "PrepareServer.sql"
 $CLRSecurityQuery = "
 /* Turn off CLR Strict for 2017+ fix */
 IF EXISTS (SELECT 1 FROM sys.configurations WHERE name = 'clr strict security')
@@ -36,36 +33,40 @@ BEGIN
 END
 GO"
 
-
-# Download
-Try {
-    Invoke-WebRequest -Uri $DownloadUrl -OutFile $ZipFile -ErrorAction Stop -UseBasicParsing
-    Expand-Archive -Path $ZipFile -DestinationPath $ZipFolder -Force
-}
-
-Catch {
-    Write-Error -Message "Error downloading tSQLt - try manually fetching from $DownloadUrl"
-}
-
 $Hash = @{
     SqlInstance     = $SqlInstance
     Database        = $Database
     EnableException = $true
 }
 
-# Setup
+# Cant use latest for AzureSQL yet
+# https://github.com/LowlyDBA/dba-multitool/issues/165
 If ($IsAzureSQL) {
+    $Version = "1-0-5873-27393"
+    $DownloadUrl = $DownloadUrl + $Version
+
+    # Azure creds
     $SecPass = ConvertTo-SecureString -String $Pass -AsPlainText -Force
     $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $SecPass
     $Hash.add("SqlCredential", $Credential)
 }
 
-Else {
+# Download
+Try {
+    Invoke-WebRequest -Uri $DownloadUrl -OutFile $ZipFile -ErrorAction Stop -UseBasicParsing
+    Expand-Archive -Path $ZipFile -DestinationPath $ZipFolder -Force
+}
+
+Catch {
+    Write-Error -Message "Error downloading tSQLt - try manually fetching from $DownloadUrl"
+}
+
+# Prep
+If (-not $IsAzureSQL) {
     Invoke-DbaQuery -SqlInstance $SqlInstance -Database "master" -Query $CreateDbQuery
-    # DbaQuery doesn't play nice with the setup script GOs - default back to sqlcmd
     Invoke-Command -ScriptBlock { sqlcmd -S $SqlInstance -d $Database -i $SetupFile } | Out-Null
     Invoke-DbaQuery @Hash -Query $CLRSecurityQuery
 }
 
 # Install
-Invoke-DbaQuery @Hash -File $InstallFile
+Invoke-DbaQuery @Hash -File $InstallFile -Verbose

appveyor/run_pester_tests.ps1

@@ -92,9 +92,6 @@ If ($CodeCoverage.IsPresent) {
     Start-CodeCoverage @Hash
 }
 
-# Generate all-in-one installer script
-Get-ChildItem -Path ".\" -Filter "sp_*.sql" | Get-Content | Out-File $InstallerFile -Encoding utf8
-
 # Run Tests
 ForEach ($file in $TestFiles) {
     If (!$LocalTest.IsPresent) { Add-AppveyorTest -Name $file.BaseName -Framework NUnit -Filename $file.FullName -Outcome Running }