Initial version #1

cucumberjim · 2022-10-20T18:43:47Z

Initial cmdlets to set up a Rundeck session and do some basic job management.

splatteredbits

It would be nice to have some tests for this module. It looks like you can use Vagrant on AppVeyor, we just have to ask AppVeyor to turn on nested virtualization. Let me know if you'd like me to do that.

If you can get Rundeck running in a container, that would work on AppVeyor.

I usually write an init.ps1 script that installs the software I'm testing and add that to my build script.

splatteredbits · 2022-10-21T15:38:18Z

RundeckAutomation/Functions/Disable-RundeckJobSchedule.ps1

+    Demonstrates how to disable a job.
+    #>
+    param(
+        [Parameter(Mandatory,ValueFromPipelineByPropertyName)]


nit: our standard for parameters is now:

# Parameter documentation. [Parameter()] [Type] $Name

e.g

# The job ID. [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Guid] $Id

These should all be to the new standard now.

splatteredbits · 2022-10-21T15:39:45Z

RundeckAutomation/Functions/Get-RundeckJob.ps1

+    Demonstrates how to get a specific job usng its ID.
+    #>
+    param(
+        [Parameter(Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName,ParameterSetName='ByName')]


nit: Separate Parameter attribute properties with a comma and a space.

These should all be to the new standard now. I also cleaned up some of the properties that had floated in from copy/paste.

splatteredbits · 2022-10-21T15:40:57Z

RundeckAutomation/Functions/Get-RundeckJob.ps1

+        }
+        else
+        {
+            $queryFilter = [ScriptBlock]::Create($Filter)


Maybe change the type of the $Filter paramete to be [scriptblock]?

I wanted to replicate the filter parameter from Get-ChildItem so passing in a string that filters like -Filter "test" to get all jobs with test in them. I wasn't able to get inline type transformation to work so this was my workaround.

splatteredbits · 2022-10-21T15:41:51Z

RundeckAutomation/Functions/Get-RundeckJob.ps1

+        else
+        {
+            $queryFilter = [ScriptBlock]::Create($Filter)
+            return ($allJobs | Where-Object { $_.name -like $queryFilter })


If $queryFilter is a script block, I believe you should be doing ($allJobs | Where-Object -FilterScript $queryFilter)?

This was a method I found I'll test with -FilterScript, but the intent here was to pass a string filter.

I tested -FilterScript and it didn't work as expected transforming the string value.

Why are you converting $Filter into a script block? Why aren't you return ($allJobs | Where-Object 'name' -Like $Filter)?

When I supply it as a string it wasn't doing pattern matching for me. I'll retest.

splatteredbits · 2022-10-21T15:42:17Z

RundeckAutomation/Functions/Get-RundeckJobExecution.ps1

+    The `Get-RundeckJobExecution` function gets a job execution status from Rundeck.
+
+    .EXAMPLE
+    Get-RundeckJobExecution -ProjectName $refProject.Name -ID 'b090d4c8-585c-4330-8bc6-ad4783089dfd'


Example params don't match the function's signature.

Should be fixed in the next commit.

splatteredbits · 2022-10-21T16:08:30Z

RundeckAutomation/Functions/Start-RundeckJob.ps1

+        {
+            while ($jobRun.status -eq 'running')
+            {
+                Start-Sleep -Seconds 10


I would make this sleep duration a parameter.

[TimeSpan] $WaitInterval = [TimeSpan]'00:00:10' # ...snip... Start-Sleep -Milliseconds $WaitInterval.TotalMilliseconds

Added as a function parameter.

splatteredbits · 2022-10-21T16:10:27Z

RundeckAutomation/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License


Usually this file goes in the repo root and we use a CopyFile build task in whiskey.yml to copy it into the module root before packaging. That should probably be in the default whiskey.yml file.

Same with the NOTICE and README.md files: keep them in the root, and copy them into the module root before packaging.

Also, the NOTICE file is empty.

These should be in the right locations now and populated.

splatteredbits · 2022-10-21T16:10:52Z

RundeckAutomation/README.md

@@ -0,0 +1,26 @@
+# Overview


Remove this file.

splatteredbits · 2022-10-21T16:11:43Z

RundeckAutomation/RundeckAutomation.psd1

@@ -116,8 +128,7 @@
            Prerelease = ''

            # ReleaseNotes of this module
-            ReleaseNotes = @'
-'@
+            ReleaseNotes = 'https://github.com/webmd-health-services/RundeckAutomation/CHANGELOG.md'


Correct URL is https://github.com/webmd-health-services/RundeckAutomation/blob/main/CHANGELOG.md .

Corrected this.

splatteredbits · 2022-10-21T16:13:46Z

whiskey.yml

@@ -14,7 +19,7 @@ Build:
 - Exec:
      OnlyBy: BuildServer
      Path: appveyor
-      Argument: [ UpdateBuild, -Version, $(WHISKEY_SEMVER2) ]
+      Argument: [ UpdateBuild, -Version, "$(WHISKEY_SEMVER2)+$(WHISKEY_BUILD_NUMBER)" ]

 # Dot-sourcing files is expensive. Move all functions into .psm1 file to improve import speed. Do this before testing


Add this task after the existing MergeFile task:

- CopyFile: Path: - LICENSE - NOTICE - README.md - CHANGELOG.md DestinationDirectory: RundeckAutomation

Which means you'll want to add these lines to your .gitignore, too:

/RundeckAutomation/CHANGELOG.md /RundeckAutomation/LICENSE /RundeckAutomation/NOTICE /RundeckAutomation/README.md

Updated whiskey and the file locations.

splatteredbits · 2022-10-21T16:26:44Z

Here's the content for the NOTICE file:

RundeckAutomation

Copyright 2022 WebMD Health Services

This product includes software developed at WebMD Health Services (https://www.webmdhealthservices.com/).

…ndeckAutomation into initial_version

cucumberjim · 2022-11-16T18:13:00Z

I'm ready for a re-review. I think I've updated or replied to everything and the build looks green.

splatteredbits

Can you take a look at my previous comments that have questions and respond to them?

.gitignore

CHANGELOG.md

splatteredbits · 2022-11-17T01:43:22Z

RundeckAutomation/Functions/Disable-RundeckJobSchedule.ps1

+    param(
+        # The job ID.    
+        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+        [GUID]


Nit a parameter's type and name should be on the same line and use the same case as the underlying type. e.g.

[Guid] $ID

These should all be updated in the next commit.

cucumberjim · 2024-03-12T16:57:10Z

Sorry this took so long to get back to, but I think I've responded to the issues and am ready for a review.

splatteredbits · 2024-03-12T18:13:12Z

I can't stress strongly enough that you should pass a mandatory session object to each function instead of having a global session object. I know many modules do it that way, but we should be following the pattern of PowerShell itself, not third-party modules. PowerShell has you create a session to something, then pass that session object around. Global variables are in general frowned upon and not recommended.

Update New-RundeckSession to return a session object and update each function to have a mandatory first parameter:

   [Parameter(Mandatory)]
   [Object] $Session,

splatteredbits · 2024-03-12T18:02:57Z

RundeckAutomation/Functions/Get-RundeckJob.ps1

+        else
+        {
+            $queryFilter = [ScriptBlock]::Create($Filter)
+            return ($allJobs | Where-Object { $_.name -like $queryFilter })


Why are you converting $Filter into a script block? Why aren't you return ($allJobs | Where-Object 'name' -Like $Filter)?

splatteredbits · 2024-03-12T18:08:05Z

RundeckAutomation/Functions/Export-RundeckProject.ps1

+        $relativeUri = "project/$($Name)/export"
+        $relativeUri = '{0}?{1}' -f $relativeUri, "exportConfigs=true&exportAll=false"
+        $endpointUri = New-Object 'Uri' -ArgumentList @($_RundeckSession.Uri, $relativeUri)
+        Invoke-WebRequest -ErrorAction 'Stop' -WebSession $_RundeckSession.WebSession -Method 'GET' -Uri $endpointUri -OutFile $Path


Update to use Invoke-RundeckRestMethod instead of Invoke-WebRequest. Keep all the logic for communicating with Rundeck in one function.

splatteredbits · 2024-03-12T18:15:29Z

RundeckAutomation/Functions/Invoke-RundeckRestMethod.ps1

+        [String] $QueryString,
+
+        # Content is XML format rather than JSON.
+        [Switch] $ContentIsXML


Rename to BodyIsXml.

splatteredbits · 2024-03-12T18:17:33Z

RundeckAutomation/Functions/Start-RundeckJob.ps1

+        }
+
+
+        Start-Sleep -Seconds 1


I would remove this Start-Sleep in favor of the Wait behavior below.

I think I ran into a race condition where it didn't have a status on the job, but re-testing.

splatteredbits · 2024-03-12T18:18:16Z

RundeckAutomation/RundeckAutomation.psd1

@@ -18,7 +18,7 @@
    RootModule = 'RundeckAutomation.psm1'

    # Version number of this module.
-    ModuleVersion = '0.0.0'
+    ModuleVersion = '0.1.1'


Set the version to 1.0.0 and update the whiskey.yml so you publish prerelease versions.

splatteredbits · 2024-03-12T18:19:06Z

Tests/Enable-RundeckJobSchedule.Tests.ps1

+
+Describe 'Enable-RundeckJobSchedule' {
+
+    BeforeAll {


Lint: usually BeforeAll blocks are outside Describe blocks.

splatteredbits · 2024-03-12T18:23:55Z

init.ps1

 Set-StrictMode -Version 'Latest'
 $ErrorActionPreference = 'Stop'
 $InformationPreference = 'Continue'
+$VerbosePreference = 'Continue'
+
+Write-Information -InformationAction Continue -MessageData 'Starting init.ps1 script'


Instead of all the -InformationAction Continue statements, add this to the top of the script:

$InformationPreference = 'Continue'

splatteredbits · 2024-03-12T18:25:21Z

whiskey.yml

+            Find-Module -Name 'Prism' | Select-Object -First 1 | Install-Module -Force
+        }
+        prism install | Format-Table -Auto
+
 - Version:
    Path: RundeckAutomation\RundeckAutomation.psd1
    Prerelease:


Standard is now:

- Version: Path: RundeckAuomation\RundeckAutomation.psd1 Prerelease: - main: "" - "*": rc1 IncrementPrereleaseVersion: true

dividebycucumber and others added 8 commits October 19, 2022 12:38

initial version

44cb615

add getting started info to readme

94145dc

add a basic Rundeck Vagrantfile

691197e

add support for API Token and fix content type no Export-RundeckJob

d8a2459

Migrating tests to Pester 5.

ce306dc

Fixed: build fails setting build number.

aab46f2

Build failing in Windows PowerShell 5.1/.NET 4.6.2.

e647447

Whiskey requires newer versions of PackageManagement and PowerShellGet.

eacfa6f

splatteredbits requested changes Oct 21, 2022

View reviewed changes

dividebycucumber added 20 commits November 4, 2022 13:20

adding init script content to install rundeck for testing

2209399

Merge branch 'initial_version' of github.com:webmd-health-services/Ru…

97f686c

…ndeckAutomation into initial_version

fix parameter descriptions

c89d4c0

fix spacing in parameter attributes

f87ef7e

fix licensing, readme, and changelog to use root copies only

bd488bf

add notice content

2bf3ea4

miscellaneous cleanup

6e63a89

fixes to init for listening and opening port on all IPs

de94094

adding export, import, and remove functions for jobs and projects

4a1087f

misc fixes and refactoring

e09dfac

adding tests

6a58e8c

adding a pause after site port comes up in init.ps1

348d108

move New-RundeckSession call in tests to Initialize-Tests.ps1

b52b4fe

set verbose preference to continue in Initialize-Test

fc78604

import module in test helpers

e9bbf07

fix Import-Project test

2116c94

init script change java.exe test

ca97ca2

configure to use docker for non-Windows Powershell tests

f20b739

configure to use docker for non-Windows Powershell tests

edb3bb3

switch to Docker for PS core builds

78f50e4

dividebycucumber added 10 commits November 16, 2022 08:32

add linux and osx installs to init.ps1

c421647

add linux and osx installs to init.ps1

1064077

add linux and osx installs to init.ps1

3e99766

add linux and osx installs to init.ps1

b628ef3

add linux and osx installs to init.ps1

05af358

add linux and osx installs to init.ps1

c991610

add linux and osx installs to init.ps1

c3be653

add linux and osx installs to init.ps1

3497b46

fix service creation and start for nix in init.ps1

2bdc4d1

fix cross compatibility in tests

84a69c7

splatteredbits reviewed Nov 17, 2022

View reviewed changes

dividebycucumber and others added 3 commits November 17, 2022 07:25

paramter format cleanup and collapse versions

36d98a8

move BeforeAll into Describe blocks per Pester error

bc97d42

make build.ps1 work with vagrant

ecaa9f8

splatteredbits requested changes Mar 12, 2024

View reviewed changes

cucumberjim added 12 commits March 26, 2024 08:03

rename xml content parameter on Invoke-RundeckRestMethod

5020435

rename xml content parameter on Invoke-RundeckRestMethod

1184ce5

remove unneeded -InformationPreference parameters

2c0c687

update to publish prerelease versions

ca2d643

remove unnecessary sleep, can't reproduce race condition

2682fe3

make Invoke-RundeckRestMethod handle binary stream as return

235a0a2

test project export is actually a zip file

88c9071

test project export is actually a zip file

d4adc1a

fixes and cleanup to build/init

685fc1b

move BeforeAll blocks outside of Describe

1fcc7ec

remove unneeded conversion of Get-RundeckJob filter to scriptblock

ef00fb6

change to return session object rather than storing as private variable

b7f9daf

Initial version #1

Are you sure you want to change the base?

Initial version #1

Conversation

cucumberjim commented Oct 20, 2022

splatteredbits left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

splatteredbits commented Oct 21, 2022

cucumberjim commented Nov 16, 2022

splatteredbits left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cucumberjim commented Mar 12, 2024

splatteredbits commented Mar 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment