Expanded testing

Author: Adrian Wells

ITGlueAPI/Tests/ITGlueAPI.Tests.ps1

@@ -1,15 +1,22 @@
-# Tested with Pester module version 4.4.0
+#Requires -Modules Pester
 
-# Name of this module found by parsing name of test file (ITGlueAPI\Tests\ITGlueAPI.Tests.ps1)
+# Obtain name of this module by parsing name of test file (ITGlueAPI\Tests\ITGlueAPI.Tests.ps1)
 $ThisModule = $PSCommandPath -replace '\.Tests\.ps1$'
 $ThisModuleName = $ThisModule | Split-Path -Leaf
 
-# Path of the module based on location of test file (ITGlueAPI\Tests\ITGlueAPI.Tests.ps1)
+# Obtain path of the module based on location of test file (ITGlueAPI\Tests\ITGlueAPI.Tests.ps1)
 $ThisModulePath = Split-Path (Split-Path -Parent $PSCommandPath) -Parent
 
 # Make sure one or multiple versions of the module are not loaded
 Get-Module -Name $ThisModuleName | Remove-Module
 
+# Credit - borrowed with care from http://www.lazywinadmin.com/2016/05/using-pester-to-test-your-manifest-file.html and modified as needed
+# Manifest file path 
+$ManifestFile = "$ThisModulePath\$ThisModuleName.psd1"
+
+# Import the module and store the information about the module
+$ModuleInformation = Import-module -Name $ManifestFile -PassThru
+
 # Internal Files
 $InternalDirectoryFiles = (
     'APIKey.ps1',
@@ -46,17 +53,42 @@ $ResourceDirectoryFiles = (
     'Users.ps1'
 )
 
-Describe '$ThisModuleName Module Tests' {
+# Manifest Elements
+$ManifestFileElements = (
+    'RootModule',
+    'Author',
+    'CompanyName',
+    'Description',
+    'Copyright',
+    'PowerShellVersion',
+    'NestedModules',
+    'HelpInfoURI'
+)
+
+
+Test-ModuleManifest -Path .\ITGlueAPI.psd1
+write-host $ModuleInformation.ModuleVersion -ForegroundColor Cyan
+
+Describe "$ThisModuleName Module Tests" {
 
     Context 'Test Module' {
         It "has the root module $ThisModuleName.psm1" {
             "$ThisModulePath\$ThisModuleName.psm1" | Should Exist
         }
 
-        It "has a manifest file of $ThisModuleName.psd1" {
-            "$ThisModulePath\$ThisModuleName.psd1" | Should Exist
-            # TODO - This test is currently failing...
-            #"$ThisModulePath\$ThisModuleName.psd1" | Should Contain "ITGlueAPI.psm1"
+        Context "Test Manifest File (.psd1)"{
+            It "Should pass Test-ModuleManifest" {
+                $errors = $null
+                $errors = Test-ModuleManifest -Path $ThisModulePath\$ThisModuleName.psd1 -ErrorAction Stop
+                $errors.Count | Should Be 1
+            }
+
+            # Credit - borrowed with care from http://www.lazywinadmin.com/2016/05/using-pester-to-test-your-manifest-file.html and modified as needed
+            ForEach ($ManifestFileElement in $ManifestFileElements) {
+                It "Should contains $ManifestFileElement"{
+                    $ModuleInformation.$ManifestFileElement | Should not BeNullOrEmpty
+                }
+            }
         }
 
         It "$ThisModuleName\Resources directory has functions" {
@@ -78,7 +110,19 @@ Describe '$ThisModuleName Module Tests' {
             It "$InternalFile should exist" {
                 "$ThisModulePath\Internal\$InternalFile" | Should Exist
             }
+            It "$InternalFile is valid PowerShell code" {
+                $psFile = Get-Content -Path "$ThisModulePath\Internal\$InternalFile" -ErrorAction Stop
+                $errors = $null
+                $null = [System.Management.Automation.PSParser]::Tokenize($psfile, [ref]$errors)
+                $errors.Count | Should Be 0
+            }
         }
+        #Context "$InternalFile has tests" {
+            $InternalFileTest = $InternalFile -replace '\.ps1$'
+            It "$InternalFileTest.Tests.ps1 should exist" {
+                $InternalFileTest.Tests.ps1 | Should Exist
+            }
+        #}
     }
 
     # Check that Resource files exist
@@ -87,6 +131,21 @@ Describe '$ThisModuleName Module Tests' {
             It "$ResourceFile should exist" {
                 "$ThisModulePath\Resources\$ResourceFile" | Should Exist
             }
+            It "$ResourceFile is valid PowerShell code" {
+                $psFile = Get-Content -Path "$ThisModulePath\Resources\$ResourceFile" -ErrorAction Stop
+                $errors = $null
+                $null = [System.Management.Automation.PSParser]::Tokenize($psfile, [ref]$errors)
+                $errors.Count | Should Be 0
+            }
+        }
+        # TODO - add tests to check for tests files
+    }
+    
+    Context "PowerShell $ThisModuleName Import Test" {
+        # Credit - borrowed with care from https://github.com/TheMattCollins0/MattTools/blob/master/Tests/ModuleImport.Tests.ps1 and modified as needed
+        It "Should import PowerShell $ThisModuleName succesfully" {
+            Import-Module -Name $ThisModulePath -ErrorVariable ImportError
+            $ImportError | Should Be $null
         }
     }
 }