New-StigChecklist path validation (#307)

* rem unused files

* added path validation

* added notes

* added initial test

* fixed path

Author: athaynes

.github/PULL_REQUEST_TEMPLATE.md

@@ -16,7 +16,7 @@ This fixes #
 
 **Task list:**
 
-- [ ] Change details added to Unreleased section of README.md (Not required for Convert modules)?
+- [ ] Change details added to Unreleased section of CHANGELOG.md (Not required for Convert modules)?
 - [ ] Added/updated documentation, comment-based help and descriptions where appropriate?
 - [ ] Examples appropriately updated?
 - [ ] New/changed code adheres to [Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)?

CHANGELOG.md

@@ -18,6 +18,7 @@ NEW
 
 UPDATES
 
+* Fixed [#258](https://github.com/Microsoft/PowerStig/issues/258): New-StigChecklist will not accept a path without an explicit filename
 * Fixed [#243](https://github.com/Microsoft/PowerStig/issues/243): [V-46515] Windows-All-IE11-1.15 Rawstring typo
 * Fixed [#289](https://github.com/Microsoft/PowerStig/issues/289): Updated DocumentRule and DocumentRuleConvert Classes to parse correctly.
 * Fixed [#284](https://github.com/Microsoft/PowerStig/issues/284): [V-74415] [V-74413] Windows 10 STIG rule V-74415 and V-74413 should not contain white space in key

Module/Rule.DnsServerRootHint/Convert/Methods.ps1

@@ -42,15 +42,25 @@ function New-StigCheckList
         $XccdfPath,
 
         [Parameter(Mandatory = $true)]
-        [string]
+        [System.IO.FileInfo]
         $OutputPath
     )
 
+    if (-not (Test-Path -Path $OutputPath.DirectoryName))
+    {
+        throw "$($OutputPath.DirectoryName) is not a valid directory. Please provide a valid directory."
+    }
+
+    if ($OutputPath.Extension -ne '.ckl')
+    {
+        throw "$($OutputPath.FullName) is not a valid checklist extension. Please provide a full valid path ending in .ckl"
+    }
+
     $xmlWriterSettings = [System.Xml.XmlWriterSettings]::new()
     $xmlWriterSettings.Indent = $true
     $xmlWriterSettings.IndentChars = "`t"
     $xmlWriterSettings.NewLineChars = "`n"
-    $writer = [System.Xml.XmlWriter]::Create($outputPath, $xmlWriterSettings)
+    $writer = [System.Xml.XmlWriter]::Create($OutputPath.FullName, $xmlWriterSettings)
 
     $writer.WriteStartElement('CHECKLIST')
 
@@ -94,17 +104,17 @@ function New-StigCheckList
     $xccdfBenchmarkContent = Get-StigXccdfBenchmarkContent -Path $xccdfPath
 
     $stigInfoElements = [ordered] @{
-        'version'        = $xccdfBenchmarkContent.version
+        'version' = $xccdfBenchmarkContent.version
         'classification' = 'UNCLASSIFIED'
-        'customname'     = ''
-        'stigid'         = $xccdfBenchmarkContent.id
-        'description'    = $xccdfBenchmarkContent.description
-        'filename'       = Split-Path -Path $xccdfPath -Leaf
-        'releaseinfo'    = $xccdfBenchmarkContent.'plain-text'.InnerText
-        'title'          = $xccdfBenchmarkContent.title
-        'uuid'           = (New-Guid).Guid
-        'notice'         = $xccdfBenchmarkContent.notice.InnerText
-        'source'         = $xccdfBenchmarkContent.reference.source
+        'customname' = ''
+        'stigid' = $xccdfBenchmarkContent.id
+        'description' = $xccdfBenchmarkContent.description
+        'filename' = Split-Path -Path $xccdfPath -Leaf
+        'releaseinfo' = $xccdfBenchmarkContent.'plain-text'.InnerText
+        'title' = $xccdfBenchmarkContent.title
+        'uuid' = (New-Guid).Guid
+        'notice' = $xccdfBenchmarkContent.notice.InnerText
+        'source' = $xccdfBenchmarkContent.reference.source
     }
 
     foreach ($StigInfoElement in $stigInfoElements.GetEnumerator())
@@ -134,7 +144,7 @@ function New-StigCheckList
 
         foreach ($attribute in $vulnerability.GetEnumerator())
         {
-            $status   = $null
+            $status = $null
             $comments = $null
 
             if ($attribute.Name -eq 'Vuln_Num')

Module/Rule.Manual/Convert/Methods.ps1

@@ -0,0 +1,14 @@
+. $PSScriptRoot\..\..\..\Module\STIG\Functions.Checklist.ps1
+
+Describe 'New-StigCheckList' {
+
+    It 'Should throw if an invalid path is provided' {
+        Mock Test-Path {return $false}
+        {New-StigCheckList -ReferenceConfiguration 'test' -XccdfPath 'test' -OutputPath 'c:\test'} | Should Throw
+    }
+
+    It 'Should throw if the full path to a .ckl file is not provided' {
+        Mock Test-Path {return $true}
+        {New-StigCheckList -ReferenceConfiguration 'test' -XccdfPath 'test' -OutputPath 'c:\test\test.ck'} | Should Throw
+    }
+}