Merge pull request #126 from LowlyDBA/development

Auto build sample documentation for sp_doc

Author: lowlydba

appveyor/appveyor.yml

@@ -1,4 +1,4 @@
-version: 1.1.{build}
+version: 1.2.{build}
 
 pull_requests:
   do_not_increment_build_number: false
@@ -17,7 +17,7 @@ environment:
   matrix:
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
     MSSQL: SQL2019
-    DB_INSTANCE: (local)\SQL2019
+    DB_INSTANCE: localhost\SQL2019
     LINT_CONFIG: appveyor\tsqllint\.tsqllintrc_150
     LATEST: True
 
@@ -34,28 +34,28 @@ environment:
 
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
     MSSQL: SQL2017
-    DB_INSTANCE: (local)\SQL2017
+    DB_INSTANCE: localhost\SQL2017
     LINT_CONFIG: appveyor\tsqllint\.tsqllintrc_140
     LATEST: False
     AzureSQL: False
 
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
     MSSQL: SQL2016
-    DB_INSTANCE: (local)\SQL2016
+    DB_INSTANCE: localhost\SQL2016
     LINT_CONFIG: appveyor\tsqllint\.tsqllintrc_130
     LATEST: False
     AzureSQL: False
 
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
     MSSQL: SQL2014
-    DB_INSTANCE: (local)\SQL2014
+    DB_INSTANCE: localhost\SQL2014
     LINT_CONFIG: appveyor\tsqllint\.tsqllintrc_120
     LATEST: False
     AzureSQL: False
 
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
     MSSQL: SQL2012SP1
-    DB_INSTANCE: (local)\SQL2012SP1
+    DB_INSTANCE: localhost\SQL2012SP1
     LINT_CONFIG: appveyor\tsqllint\.tsqllintrc_110
     LATEST: False
     AzureSQL: False
@@ -75,7 +75,7 @@ install:
   - ps: .\appveyor\install_tsqlt.ps1
 
 build_script:
-  - ps: .\appveyor\make_combined_script.ps1
+  - ps: .\appveyor\generate_combined_script.ps1
   - ps: .\appveyor\install_expsql.ps1
   - ps: .\appveyor\build_tsqlt_tests.ps1
 
@@ -85,7 +85,7 @@ test_script:
   - ps: .\appveyor\run_tsqlt_tests.ps1
 
 for:
-# Latest SQL Server - Code cov & Upload
+# Latest SQL Server: Code cov & Upload
 - 
   matrix:
     only:
@@ -99,12 +99,16 @@ for:
   test_script:
     - ps: .\appveyor\sqlcover\Run_SQLCover.ps1
 
+  # Build markdown w/ sp_doc
+  after_test:
+    - ps: .\appveyor\generate_sample_markdown.ps1
+
   # Upload code coverage report, push generated files
   on_success:
     - codecov -f %COV_REPORT%
     - ps: .\appveyor\push_git_changes.ps1
 
-# Azure SQL
+# Azure SQL: No need to start SQL Server locally
 -  
   matrix:
     only:
@@ -113,15 +117,3 @@ for:
   install:
     - ps: .\appveyor\install_dependencies.ps1
     - ps: .\appveyor\install_tsqlt.ps1
-
-  # Setup codecov, SQL Cover
-  #before_test:
-  #  - ps: .\appveyor\install_coverage_dependencies.ps1
-
-  # Run tests with SQL Cover analysis
-  #test_script:
-  # - ps: .\appveyor\sqlcover\Run_SQLCover.ps1
-
-  # Upload code coverage report, push generated files
-  #on_success:
-  #  - codecov -f %COV_REPORT%

appveyor/make_combined_script.ps1 renamed to appveyor/generate_combined_script.ps1

@@ -0,0 +1,35 @@
+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"
+
+Write-Host "Generating $SampleDatabase markdown sample..." -ForegroundColor $Color
+
+# Suppress DbaTools warning about SqlServer module also being loaded
+Set-DbatoolsConfig -Name Import.SqlpsCheck -Value $false -PassThru | Register-DbatoolsConfig
+
+# Download and restore WideWorldImporters sample database
+If (!(Get-DbaDatabase -SqlInstance $SqlInstance -Database $SampleDatabase)) {
+    Invoke-WebRequest -Uri $Url -OutFile $BackupPath
+
+    If (Test-Path $BackupPath) { Restore-DbaDatabase -SqlInstance $SqlInstance -DatabaseName $SampleDatabase -Path $BackupPath -WithReplace | Out-Null }
+    Else { Write-Error "$SampleDatabase backup failed to download properly." }
+}
+
+# Generate documentation
+sqlcmd -S $SqlInstance -d $UtilityDatabase -Q "EXEC sp_doc @DatabaseName = '$SampleDatabase';" -o $SampleMarkdown -y 0
+
+# 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

appveyor/generate_sample_markdown.ps1

@@ -10,8 +10,10 @@ Write-Host "Installing dependencies..." -ForegroundColor $Color
 Try { npm install tsqllint -g | Out-Null }
 Catch { }
 
-
 # SQLServer Module
 if (!(Get-Module -ListAvailable -Name SqlServer)) {
     Install-Module SqlServer -Force -AllowClobber
-}
+}
+
+# DbaTools Module
+Install-Module DbaTools -Force -AllowClobber

appveyor/install_dependencies.ps1

@@ -10,6 +10,8 @@ param(
 
 Write-Host "Installing ExpressSQL scripts..." -ForegroundColor $Color
 
+$ErrorActionPreference = "Stop";
+
 If ($IsAzureSQL) {
     Invoke-SqlCmd -ServerInstance $SqlInstance -Database $Database -InputFile "install_expsql.sql" -Username $User -Password $Pass
 }