Using ModuleTools

Author: belibug

.github/workflows/Tests.yml

@@ -0,0 +1,27 @@
+name: Run Tests
+
+# Controls when the workflow will run
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install ModuleTools module form PSGallery
+        run: |
+          Install-PSResource -Repository PSGallery -Name ModuleTools -TrustRepository
+        shell: pwsh
+
+      - name: Install ModuleTools module form PSGallery
+        run: |
+          Invoke-MTTest
+        shell: pwsh

project.json

@@ -19,7 +19,10 @@
     "LicenseUri": "https://github.com/belibug/SecretBackup/blob/main/LICENSE"
   },
   "Pester": {
-    "TestResult": false,
+    "TestResult": {
+      "Enabled": true,
+      "OutputFormat": "NUnitXml"
+    },
     "Output": {
       "Verbosity": "Detailed"
     }
@@ -35,4 +38,4 @@
       "PSAvoidUsingConvertToSecureStringWithPlainText"
     ]
   }
-}
+}

tests/integration/Module.Tests.ps1 tests/Module.Tests.ps1

@@ -1,6 +1,5 @@
 BeforeAll {
-    Import-Module -Name .\PSPacker
-    $data = Import-ProjectData
+    $data = Get-MTProjectInfo
 }
 
 Describe 'General Module Control' {

tests/integration/OutputFiles.Tests.ps1 tests/OutputFiles.Tests.ps1

@@ -1,6 +1,5 @@
 BeforeAll {
-    Import-Module -Name .\PSPacker
-    $data = Import-ProjectData
+    $data = Get-MTProjectInfo
     $files = Get-ChildItem $data.OutputModuleDir
 }
 
@@ -19,8 +18,7 @@ Describe 'Module and Manifest testing' {
             $status = (Get-AuthenticodeSignature -FilePath $_).Status
             if ($status -eq 'NotSigned') {
                 Set-TestInconclusive -Message 'Not yet signed'
-            }
-            else {
+            } else {
                 $status | Should -Be 'Valid'
             }
         }

tests/meta/ScriptAnalyzer.Tests.ps1 tests/ScriptAnalyzer.Tests.ps1

@@ -2,8 +2,11 @@ BeforeDiscovery {
     $files = Get-ChildItem -Path .\src -Filter '*.ps1' -Recurse
 }
 BeforeAll {
-    Import-Module -Name .\PSPacker -Force
-    $data = Import-ProjectData
+    $ScriptAnalyzerSettings = @{
+        IncludeDefaultRules = $true
+        Severity            = @('Warning', 'Error')
+        ExcludeRules        = @('PSAvoidUsingWriteHost', 'PSAvoidUsingConvertToSecureStringWithPlainText')
+    }
 }
 Describe 'File: <_.basename>' -ForEach $files {
     Context 'Code Quality Check' {
@@ -14,7 +17,7 @@ Describe 'File: <_.basename>' -ForEach $files {
             $errors.Count | Should -Be 0
         }
         It 'passess ScriptAnalyzer' {
-            $saResults = Invoke-ScriptAnalyzer -Path $_ -Settings $data.PSScriptAnalyzer
+            $saResults = Invoke-ScriptAnalyzer -Path $_ -Settings $ScriptAnalyzerSettings
             $saResults | Should -BeNullOrEmpty -Because $($saResults.Message -join ';')
         }         
     }