Merge pull request #287 from puppetlabs/use_latest_pdk

(CAT-1763) Update PDK version to fix acceptance tests
puppetlabs · Mar 25, 2024 · 8bdd229 · 8bdd229
2 parents 0438743 + 8550c32
commit 8bdd229
Show file tree

Hide file tree

Showing 15 changed files with 220 additions and 153 deletions.
diff --git a/.adr-dir b/.adr-dir
@@ -0,0 +1 @@
+docs/adr
diff --git a/.github/actions/configure-winrm/README.md b/.github/actions/configure-winrm/README.md
@@ -0,0 +1,15 @@
+# configure-winrm
+
+## Description
+
+## Usage
+
+To trigger this action from within a workflow, call it using the `steps` snippet something like below:
+
+```yaml
+jobs:
+  acceptance:
+    steps:
+      - name: Configure WinRM
+        uses: ./.github/actions/configure-winrm
+```
diff --git a/.github/actions/configure-winrm/action.yml b/.github/actions/configure-winrm/action.yml
@@ -0,0 +1,16 @@
+---
+name: 'Configure WinRM'
+description: 'Configures WinRM'
+runs:
+  using: 'composite'
+  steps:
+    - name: Configure WinRM
+      run: |
+        Write-Host 'Ensuring WinRM is configured for DSC'
+        Get-ChildItem WSMan:\localhost\Listener\ -OutVariable Listeners | Format-List * -Force
+        $HTTPListener = $Listeners | Where-Object -FilterScript { $_.Keys.Contains('Transport=HTTP') }
+        If ($HTTPListener.Count -eq 0) {
+          winrm create winrm/config/Listener?Address=*+Transport=HTTP
+          winrm e winrm/config/listener
+        }
+      shell: powershell
diff --git a/.github/actions/install-pdk/README.md b/.github/actions/install-pdk/README.md
@@ -0,0 +1,27 @@
+# install-pdk
+
+## Description
+
+## Usage
+
+To trigger this action from within a workflow, call it using the `steps` snippet something like below:
+
+```yaml
+jobs:
+  acceptance:
+    steps:
+      - name: Install PDK
+        uses: ./.github/actions/install-pdk
+```
+
+Or if you want to over-ride the default pdk version, then something like:
+
+```yaml
+jobs:
+  acceptance:
+    steps:
+      - name: Install PDK
+        uses: ./.github/actions/install-pdk
+        with:
+          pdk_version: 3.0.1.3
+```
diff --git a/.github/actions/install-pdk/action.yml b/.github/actions/install-pdk/action.yml
@@ -0,0 +1,16 @@
+---
+name: 'Install PDK'
+description: 'Installs PDK using Chocolatey'
+inputs:
+  pdk_version:
+    description: 'PDK version to install'
+    required: false
+    default: '3.0.1.3'
+runs:
+  using: 'composite'
+  steps:
+    - name: Install PDK
+      run: |
+        choco feature disable -n=showDownloadProgress
+        choco install pdk --version ${{ inputs.pdk_version }} -y
+      shell: powershell
diff --git a/.github/actions/run-acceptance-tests/README.md b/.github/actions/run-acceptance-tests/README.md
@@ -0,0 +1,15 @@
+# run-acceptance-tests
+
+## Description
+
+## Usage
+
+To trigger this action from within a workflow, call it using the `steps` snippet something like below:
+
+```yaml
+jobs:
+  acceptance:
+    steps:
+      - name: Run Acceptance Tests
+        uses: ./.github/actions/run-acceptance-tests
+```
diff --git a/.github/actions/run-acceptance-tests/action.yml b/.github/actions/run-acceptance-tests/action.yml
@@ -0,0 +1,29 @@
+---
+name: 'Run Acceptance Tests'
+description: 'Run Acceptance Tests'
+runs:
+  using: 'composite'
+  steps:
+    - name: Run Acceptance Tests
+      run: |
+        Import-Module $env:ChocolateyInstall\helpers\chocolateyProfile.psm1
+        refreshenv
+        Import-Module -Name PSDesiredStateConfiguration -Force
+        Import-Module -Name .\src\Puppet.Dsc\puppet.dsc.psd1 -Force
+        $null = Get-Command -Module Puppet.Dsc
+
+        $ErrorActionPreference = "Stop"
+        $TestParameters = @{
+          TestPath         = @((Resolve-Path .\acceptance))
+          ResultsPath      = "${{ matrix.results_file }}"
+          Tag              = "${{ matrix.tag }}"
+          PwshLibSource    = "${{ matrix.pwshlib_source }}"
+          PwshLibRepo      = "${{ matrix.pwshlib_repo }}"
+          PwshLibReference = "${{ matrix.pwshlib_ref }}"
+        }
+
+        $Results = .\scripts\invoke_tests.ps1 @TestParameters
+        if ($Results.FailedCount -gt 0) {
+          throw "$($Results.FailedCount) tests failed."
+        }
+      shell: powershell
diff --git a/.github/actions/run-unit-tests/README.md b/.github/actions/run-unit-tests/README.md
@@ -0,0 +1,15 @@
+# configure-winrm
+
+## Description
+
+## Usage
+
+To trigger this action from within a workflow, call it using the `steps` snippet something like below:
+
+```yaml
+jobs:
+  acceptance:
+    steps:
+      - name: Run Unit Tests
+        uses: ./.github/actions/run-unit-tests
+```
diff --git a/.github/actions/run-unit-tests/action.yml b/.github/actions/run-unit-tests/action.yml
@@ -0,0 +1,24 @@
+---
+name: 'Run Unit Tests'
+description: 'Run Unit Tests'
+runs:
+  using: 'composite'
+  steps:
+    - name: Run Unit Tests
+      run: |
+        Import-Module -Name PSDesiredStateConfiguration -Force
+        Import-Module -Name .\src\Puppet.Dsc\puppet.dsc.psd1 -Force
+        $null = Get-Command -Module Puppet.Dsc
+
+        $ErrorActionPreference = "Stop"
+        $ResultsPath = "${{ matrix.results_file }}"
+        $TestPath = @(
+          (Resolve-Path .\src\Puppet.Dsc\functions)
+          (Resolve-Path .\src\Puppet.Dsc\internal\functions)
+          (Resolve-Path .\src\Puppet.Dsc\tests\general)
+        )
+        $Results = .\scripts\invoke_tests.ps1 -TestPath $TestPath -ResultsPath $ResultsPath -Tag ${{ matrix.tag }}
+        if ($Results.FailedCount -gt 0) {
+          throw "$($Results.FailedCount) tests failed."
+        }
+      shell: powershell
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,7 +9,6 @@ on:
   workflow_dispatch:
 
 env:
-  pdk_version: 2.7.1.0
   module_cache: PSFramework, PSDscResources, AccessControlDSC, powershell-yaml, PSScriptAnalyzer
   COVERAGE_ENABLED: 'yes'
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
@@ -42,33 +41,11 @@ jobs:
           shell: powershell
           modules-to-cache: ${{ env.module_cache }}
 
-      - name: "configure winrm"
-        run: |
-          Write-Host 'Ensuring WinRM is configured for DSC'
-          Get-ChildItem WSMan:\localhost\Listener\ -OutVariable Listeners | Format-List * -Force
-          $HTTPListener = $Listeners | Where-Object -FilterScript { $_.Keys.Contains('Transport=HTTP') }
-          If ($HTTPListener.Count -eq 0) {
-            winrm create winrm/config/Listener?Address=*+Transport=HTTP
-            winrm e winrm/config/listener
-          }
+      - name: Configure WinRM
+        uses: ./.github/actions/configure-winrm
 
-      - name: "test"
-        run: |
-          Import-Module -Name PSDesiredStateConfiguration -Force
-          Import-Module -Name .\src\Puppet.Dsc\puppet.dsc.psd1 -Force
-          $null = Get-Command -Module Puppet.Dsc
-
-          $ErrorActionPreference = "Stop"
-          $ResultsPath = "${{ matrix.results_file }}"
-          $TestPath = @(
-            (Resolve-Path .\src\Puppet.Dsc\functions)
-            (Resolve-Path .\src\Puppet.Dsc\internal\functions)
-            (Resolve-Path .\src\Puppet.Dsc\tests\general)
-          )
-          $Results = .\scripts\invoke_tests.ps1 -TestPath $TestPath -ResultsPath $ResultsPath -Tag ${{ matrix.tag }}
-          if ($Results.FailedCount -gt 0) {
-            throw "$($Results.FailedCount) tests failed."
-          }
+      - name: Run Unit Tests
+        uses: ./.github/actions/run-unit-tests
 
       - name: Upload coverage reports to Codecov
         # Only upload report once per CI run
@@ -109,40 +86,11 @@ jobs:
           shell: powershell
           modules-to-cache: ${{ env.module_cache }}
 
-      - name: "install pdk"
-        run: |
-          choco feature disable -n=showDownloadProgress
-          choco install pdk --version ${{ env.pdk_version }} -y
-
-      - name: "configure winrm"
-        run: |
-          Write-Host 'Ensuring WinRM is configured for DSC'
-          Get-ChildItem WSMan:\localhost\Listener\ -OutVariable Listeners | Format-List * -Force
-          $HTTPListener = $Listeners | Where-Object -FilterScript { $_.Keys.Contains('Transport=HTTP') }
-          If ($HTTPListener.Count -eq 0) {
-            winrm create winrm/config/Listener?Address=*+Transport=HTTP
-            winrm e winrm/config/listener
-          }
-
-      - name: "test"
-        run: |
-          Import-Module $env:ChocolateyInstall\helpers\chocolateyProfile.psm1
-          refreshenv
-          Import-Module -Name PSDesiredStateConfiguration -Force
-          Import-Module -Name .\src\Puppet.Dsc\puppet.dsc.psd1 -Force
-          $null = Get-Command -Module Puppet.Dsc
+      - name: Install PDK
+        uses: ./.github/actions/install-pdk
 
-          $ErrorActionPreference = "Stop"
-          $TestParameters = @{
-            TestPath         = @((Resolve-Path .\acceptance))
-            ResultsPath      = "${{ matrix.results_file }}"
-            Tag              = "${{ matrix.tag }}"
-            PwshLibSource    = "${{ matrix.pwshlib_source }}"
-            PwshLibRepo      = "${{ matrix.pwshlib_repo }}"
-            PwshLibReference = "${{ matrix.pwshlib_ref }}"
-          }
+      - name: Configure WinRM
+        uses: ./.github/actions/configure-winrm
 
-          $Results = .\scripts\invoke_tests.ps1 @TestParameters
-          if ($Results.FailedCount -gt 0) {
-            throw "$($Results.FailedCount) tests failed."
-          }
+      - name: Run Acceptance Tests
+        uses: ./.github/actions/run-acceptance-tests
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -5,7 +5,6 @@ on:
   workflow_dispatch:
 
 env:
-  pdk_version: 2.7.1.0
   module_cache: PSFramework, PSDscResources, AccessControlDSC, powershell-yaml, PSScriptAnalyzer
 
 defaults:
@@ -36,33 +35,11 @@ jobs:
           shell: powershell
           modules-to-cache: ${{ env.module_cache }}
 
-      - name: "configure winrm"
-        run: |
-          Write-Host 'Ensuring WinRM is configured for DSC'
-          Get-ChildItem WSMan:\localhost\Listener\ -OutVariable Listeners | Format-List * -Force
-          $HTTPListener = $Listeners | Where-Object -FilterScript { $_.Keys.Contains('Transport=HTTP') }
-          If ($HTTPListener.Count -eq 0) {
-            winrm create winrm/config/Listener?Address=*+Transport=HTTP
-            winrm e winrm/config/listener
-          }
+      - name: Configure WinRM
+        uses: ./.github/actions/configure-winrm
 
-      - name: "test"
-        run: |
-          Import-Module -Name PSDesiredStateConfiguration -Force
-          Import-Module -Name .\src\Puppet.Dsc\puppet.dsc.psd1 -Force
-          $null = Get-Command -Module Puppet.Dsc
-
-          $ErrorActionPreference = "Stop"
-          $ResultsPath = "${{ matrix.results_file }}"
-          $TestPath = @(
-            (Resolve-Path .\src\Puppet.Dsc\functions)
-            (Resolve-Path .\src\Puppet.Dsc\internal\functions)
-            (Resolve-Path .\src\Puppet.Dsc\tests\general)
-          )
-          $Results = .\scripts\invoke_tests.ps1 -TestPath $TestPath -ResultsPath $ResultsPath -Tag ${{ matrix.tag }}
-          if ($Results.FailedCount -gt 0) {
-            throw "$($Results.FailedCount) tests failed."
-          }
+      - name: Run Unit Tests
+        uses: ./.github/actions/run-unit-tests
 
   acceptance:
     runs-on: ${{ matrix.os }}
@@ -93,40 +70,11 @@ jobs:
           shell: powershell
           modules-to-cache: ${{ env.module_cache }}
 
-      - name: "install pdk"
-        run: |
-          choco feature disable -n=showDownloadProgress
-          choco install pdk --version ${{ env.pdk_version }} -y
-
-      - name: "configure winrm"
-        run: |
-          Write-Host 'Ensuring WinRM is configured for DSC'
-          Get-ChildItem WSMan:\localhost\Listener\ -OutVariable Listeners | Format-List * -Force
-          $HTTPListener = $Listeners | Where-Object -FilterScript { $_.Keys.Contains('Transport=HTTP') }
-          If ($HTTPListener.Count -eq 0) {
-            winrm create winrm/config/Listener?Address=*+Transport=HTTP
-            winrm e winrm/config/listener
-          }
-
-      - name: "test"
-        run: |
-          Import-Module $env:ChocolateyInstall\helpers\chocolateyProfile.psm1
-          refreshenv
-          Import-Module -Name PSDesiredStateConfiguration -Force
-          Import-Module -Name .\src\Puppet.Dsc\puppet.dsc.psd1 -Force
-          $null = Get-Command -Module Puppet.Dsc
+      - name: Install PDK
+        uses: ./.github/actions/install-pdk
 
-          $ErrorActionPreference = "Stop"
-          $TestParameters = @{
-            TestPath         = @((Resolve-Path .\acceptance))
-            ResultsPath      = "${{ matrix.results_file }}"
-            Tag              = "${{ matrix.tag }}"
-            PwshLibSource    = "${{ matrix.pwshlib_source }}"
-            PwshLibRepo      = "${{ matrix.pwshlib_repo }}"
-            PwshLibReference = "${{ matrix.pwshlib_ref }}"
-          }
+      - name: Configure WinRM
+        uses: ./.github/actions/configure-winrm
 
-          $Results = .\scripts\invoke_tests.ps1 @TestParameters
-          if ($Results.FailedCount -gt 0) {
-            throw "$($Results.FailedCount) tests failed."
-          }
+      - name: Run Acceptance Tests
+        uses: ./.github/actions/run-acceptance-tests
diff --git a/.github/workflows/puppetize.yml b/.github/workflows/puppetize.yml
@@ -11,7 +11,6 @@ on:
         required: false
 
 env:
-  pdk_version: 2.7.1.0
   module_cache: PSFramework, PSDscResources, powershell-yaml
 
 jobs:
@@ -86,20 +85,11 @@ jobs:
           shell: powershell
           modules-to-cache: ${{ env.module_cache }}
 
-      - name: "install pdk"
-        run: |
-          choco feature disable -n=showDownloadProgress
-          choco install pdk --version ${{ env.pdk_version }} -y
+      - name: Install PDK
+        uses: ./.github/actions/install-pdk
 
-      - name: "configure winrm"
-        run: |
-          Write-Host 'Ensuring WinRM is configured for DSC'
-          Get-ChildItem WSMan:\localhost\Listener\ -OutVariable Listeners | Format-List * -Force
-          $HTTPListener = $Listeners | Where-Object -FilterScript { $_.Keys.Contains('Transport=HTTP') }
-          If ($HTTPListener.Count -eq 0) {
-            winrm create winrm/config/Listener?Address=*+Transport=HTTP
-            winrm e winrm/config/listener
-          }
+      - name: Configure WinRM
+        uses: ./.github/actions/configure-winrm
 
       - name: "publish module"
         env: