Fixed error action of include keyword #127

microsoft · Jan 18, 2021 · d0c2852 · d0c2852
1 parent 9ebc42e
commit d0c2852
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ What's changed since v0.7.0:
 - Engine features:
   - Added support for custom configuration key values. [#121](https://github.com/BernieWhite/PSDocs/issues/121)
     - See `about_PSDocs_Configuration` for more details.
+- Bug fixes:
+  - Fixed use of error action preference with `Include` keyword. [#127](https://github.com/BernieWhite/PSDocs/issues/127)
 
 ## v0.7.0
 

diff --git a/src/PSDocs/Commands/IncludeCommand.cs b/src/PSDocs/Commands/IncludeCommand.cs
@@ -1,6 +1,8 @@
 
 using PSDocs.Models;
+using PSDocs.Resources;
 using PSDocs.Runtime;
+using System.IO;
 using System.Management.Automation;
 
 namespace PSDocs.Commands
@@ -29,7 +31,18 @@ protected override void BeginProcessing()
 
         protected override void EndProcessing()
         {
-            WriteObject(ModelHelper.Include(BaseDirectory, Culture, FileName, UseCulture));
+            var result = ModelHelper.Include(BaseDirectory, Culture, FileName, UseCulture);
+            if (result == null || !result.Exists)
+            {
+                WriteError(new ErrorRecord(
+                    exception: new FileNotFoundException(PSDocsResources.IncludeNotFound, result.Path),
+                    errorId: "PSDocs.Runtime.IncludeNotFound",
+                    errorCategory: ErrorCategory.ObjectNotFound,
+                    targetObject: result.Path
+                ));
+                return;
+            }
+            WriteObject(result);            
         }
     }
 }
diff --git a/src/PSDocs/Models/Include.cs b/src/PSDocs/Models/Include.cs
@@ -1,14 +1,28 @@
 
+using System.IO;
+
 namespace PSDocs.Models
 {
     public sealed class Include : DocumentNode
     {
+        private string _Path;
+
         public override DocumentNodeType Type => DocumentNodeType.Include;
 
-        public string Path { get; set; }
+        public string Path
+        {
+            get { return _Path; }
+            set
+            {
+                _Path = value;
+                Exists = File.Exists(_Path);
+            }
+        }
 
         public string Content { get; set; }
 
+        internal bool Exists { get; private set; }
+
         public override string ToString()
         {
             return Content;

diff --git a/src/PSDocs/Models/ModelHelper.cs b/src/PSDocs/Models/ModelHelper.cs
@@ -1,6 +1,5 @@
 
 using PSDocs.Configuration;
-using PSDocs.Resources;
 using System.IO;
 
 namespace PSDocs.Models
@@ -55,15 +54,16 @@ public static Include Include(string baseDirectory, string culture, string fileN
         {
             baseDirectory = PSDocumentOption.GetRootedPath(baseDirectory);
             var absolutePath = Path.IsPathRooted(fileName) ? fileName : Path.Combine(baseDirectory, (useCulture ? culture : string.Empty), fileName);
-            if (!File.Exists(absolutePath))
-                throw new FileNotFoundException(PSDocsResources.IncludeNotFound, absolutePath);
-
-            var text = File.ReadAllText(absolutePath);
-            return new Include
+            var result = new Include
             {
-                Path = absolutePath,
-                Content = text,
+                Path = absolutePath
             };
+            if (result.Exists)
+            {
+                var text = File.ReadAllText(absolutePath);
+                result.Content = text;
+            }
+            return result;
         }
     }
 }
diff --git a/tests/PSDocs.Tests/FromFile.Keyword.Doc.ps1 b/tests/PSDocs.Tests/FromFile.Keyword.Doc.ps1
@@ -96,6 +96,11 @@ Document 'IncludeCulture' {
     Include IncludeFile3.md -UseCulture -BaseDirectory tests/PSDocs.Tests/
 }
 
+# Synopsis: Test Include keyword with -ErrorAction SilentlyContinue
+Document 'IncludeOptional' {
+    Include 'NotFile.md' -ErrorAction SilentlyContinue;
+}
+
 #endregion Include
 
 #region Metadata

diff --git a/tests/PSDocs.Tests/PSDocs.Include.Tests.ps1 b/tests/PSDocs.Tests/PSDocs.Include.Tests.ps1
@@ -18,7 +18,6 @@ $outputPath = Join-Path -Path $rootPath -ChildPath out/tests/PSDocs.Tests/Includ
 Remove-Item -Path $outputPath -Force -Recurse -Confirm:$False -ErrorAction Ignore;
 $Null = New-Item -Path $outputPath -ItemType Directory -Force;
 $here = (Resolve-Path $PSScriptRoot).Path;
-$dummyObject = New-Object -TypeName PSObject;
 
 Describe 'PSDocs -- Include keyword' -Tag Include {
     $docFilePath = Join-Path -Path $here -ChildPath 'FromFile.Keyword.Doc.ps1';
@@ -27,12 +26,12 @@ Describe 'PSDocs -- Include keyword' -Tag Include {
         $invokeParams = @{
             Path = $docFilePath
             OutputPath = $outputPath
-            # PassThru = $True
+            ErrorAction = [System.Management.Automation.ActionPreference]::Stop
         }
 
         It 'Should include a relative path' {
             $outputDoc = "$outputPath\IncludeRelative.md";
-            $result = Invoke-PSDocument @invokeParams -InputObject $rootPath -Name 'IncludeRelative';
+            $Null = Invoke-PSDocument @invokeParams -InputObject $rootPath -Name 'IncludeRelative';
 
             Test-Path -Path $outputDoc | Should -Be $True;
             $outputDoc | Should -FileContentMatch 'This is included from an external file.';
@@ -41,14 +40,14 @@ Describe 'PSDocs -- Include keyword' -Tag Include {
 
         It 'Should include an absolute path' {
             $outputDoc = "$outputPath\IncludeAbsolute.md";
-            $result = Invoke-PSDocument @invokeParams -InputObject $rootPath -Name 'IncludeAbsolute';
+            $Null = Invoke-PSDocument @invokeParams -InputObject $rootPath -Name 'IncludeAbsolute';
 
             Test-Path -Path $outputDoc | Should -Be $True;
             $outputDoc | Should -FileContentMatch 'This is included from an external file.';
         }
 
         It 'Should include from culture' {
-            $result = Invoke-PSDocument @invokeParams -Culture 'en-AU','en-US' -Name 'IncludeCulture';
+            $Null = Invoke-PSDocument @invokeParams -Culture 'en-AU','en-US' -Name 'IncludeCulture';
 
             $outputDoc = "$outputPath\en-AU\IncludeCulture.md";
             Test-Path -Path $outputDoc | Should -Be $True;
@@ -58,5 +57,9 @@ Describe 'PSDocs -- Include keyword' -Tag Include {
             Test-Path -Path $outputDoc | Should -Be $True;
             $outputDoc | Should -FileContentMatch 'This is en-US.';
         }
+
+        It 'Should include when file exists' {
+            $Null = Invoke-PSDocument @invokeParams -Name 'IncludeOptional';
+        }
     }
 }