Fixed snippet with short relative template causes exception #26 (#33)

* Fixed snippet with short relative template causes exception #26

* Updated expect content test

Author: BernieWhite

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+What's changed since v0.1.0:
+
+- Bug fixes:
+  - Fixed snippet with short relative template causes exception. [#26](https://github.com/Azure/PSDocs.Azure/issues/26)
+
 ## v0.1.0
 
 - Initial release.

src/PSDocs.Azure/docs/Azure.Template.Doc.ps1

@@ -33,9 +33,15 @@ function global:GetTemplateExample {
         [String]$Path
     )
     process {
+        if (![System.IO.Path]::IsPathRooted($Path)) {
+            $Path = Join-Path -Path $PWD -ChildPath $Path;
+        }
         $template = Get-Content -Path $Path -Raw | ConvertFrom-Json;
-        $normalPath = $Path.Substring(([String]$PWD).Length);
-        $normalPath = ($normalPath -replace '\\', '/').TrimStart('/');
+        $normalPath = $Path;
+        if ($normalPath.StartsWith($PWD, [System.StringComparison]::InvariantCultureIgnoreCase)) {
+            $normalPath = $Path.Substring(([String]$PWD).Length);
+            $normalPath = ($normalPath -replace '\\', '/').TrimStart('/');
+        }
         $baseContent = [PSCustomObject]@{
             '$schema'= "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json`#"
             contentVersion = '1.0.0.0'

tests/PSDocs.Azure.Tests/Azure.Common.Tests.ps1

@@ -41,6 +41,23 @@ Describe 'PSDocs' -Tag 'PSDocs', 'Common' {
             $result = Invoke-PSDocument @invokeParams;
             $result | Should -Not -BeNullOrEmpty;
         }
+
+        It 'With relative path' {
+            Push-Location -Path (Join-Path -Path $rootPath -ChildPath 'templates/storage/v1/');
+            try {
+                $invokeParams = @{
+                    Module = 'PSDocs.Azure'
+                    OutputPath = $outputPath
+                    InputObject = './template.json'
+                    Option = @{ 'Output.Culture' = 'en-US' }
+                }
+                $result = Invoke-PSDocument @invokeParams;
+                $result | Should -Not -BeNullOrEmpty;
+            }
+            finally {
+                Pop-Location;
+            }
+        }
     }
 }
 

tests/PSDocs.Azure.Tests/Azure.Templates.Tests.ps1

@@ -0,0 +1,45 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+#
+# Unit tests for PSDocs.Azure functionality using example templates
+#
+
+[CmdletBinding()]
+param ()
+
+# Setup error handling
+$ErrorActionPreference = 'Stop';
+Set-StrictMode -Version latest;
+
+# Setup tests paths
+$rootPath = $PWD;
+
+Import-Module (Join-Path -Path $rootPath -ChildPath out/modules/PSDocs.Azure) -Force;
+
+$outputPath = Join-Path -Path $rootPath -ChildPath out/tests/PSDocs.Azure.Tests/Common;
+Remove-Item -Path $outputPath -Force -Recurse -Confirm:$False -ErrorAction Ignore;
+$Null = New-Item -Path $outputPath -ItemType Directory -Force;
+
+Describe 'Templates' -Tag 'Template' {
+    $templatePath = Join-Path -Path $rootPath -ChildPath 'templates/';
+
+    Context 'Documentation for examples' {
+        It 'Generates expected output' {
+            $invokeParams = @{
+                Module = 'PSDocs.Azure'
+            }
+
+            # Generates templates
+            $result = Get-AzDocTemplateFile -Path $templatePath | ForEach-Object {
+                $template = Get-Item -Path $_.TemplateFile;
+                $parentPath = $template.Directory.FullName;
+                $expectedContent = Get-Content -Path (Join-Path -Path $parentPath -ChildPath 'README.md') -Raw;
+                $actualContent = Invoke-PSDocument @invokeParams -OutputPath $outputPath -InputObject $template.FullName -PassThru;
+                $actualContent | Should -BeExactly $expectedContent;
+                $actualContent;
+            }
+            $result | Should -Not -BeNullOrEmpty;
+        }
+    }
+}