docker enablement (#193)

Author: gdbarron

.github/workflows/cd.yml

@@ -11,6 +11,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           token: ${{ secrets.CD_TOKEN }}
+
       - name: Update psd version
         shell: pwsh
         run: |
@@ -26,13 +27,15 @@ jobs:
           "New version: $newVersion"
           # set version to be used in later steps
           "module_new_version=$newVersion" | Out-File -FilePath $env:GITHUB_ENV -Append
+
       - name: Update changelog
         shell: pwsh
         run: |
           $newVersionString = '## ${{ env.module_new_version }}'
           $releaseNotes = Get-Content -Path '${{ github.workspace }}/RELEASE.md' -Raw
           $changelog = Get-Content -Path '${{ github.workspace }}/CHANGELOG.md' -Raw
           Set-Content -Path '${{ github.workspace }}/CHANGELOG.md' -Value ($newVersionString + "`r`n" + $releaseNotes + "`r`n`r`n" + $changelog)
+
       - name: Update repo
         run: |
           git config --global user.name 'Greg Brownstein'
@@ -42,14 +45,33 @@ jobs:
           git status
           git commit -m "Update manifest to ${{ env.module_new_version }}"
           git push
+
       - name: Create GitHub release
         if: github.ref == 'refs/heads/master'
         uses: softprops/action-gh-release@v1
         with:
           tag_name: v${{ env.module_new_version }}
           body_path: ${{ github.workspace }}/RELEASE.md
+
       - name: Publish
         if: github.ref == 'refs/heads/master'
         shell: pwsh
         run: |
           Publish-Module -Path "${{ github.workspace }}/${{ env.module_name }}" -NuGetApiKey ${{ secrets.NUGET_KEY }} -Verbose
+
+      - name: Login to dockerhub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build image
+        run: >
+          docker build
+          --pull
+          -t ${{ secrets.DOCKER_USERNAME }}/servicenow-module:latest
+          -t ${{ secrets.DOCKER_USERNAME }}/servicenow-module:${{ env.module_new_version }}
+          .
+
+      - name: Publish image and tags
+        run: docker push --all-tags ${{ secrets.DOCKER_USERNAME }}/servicenow-module

Dockerfile

@@ -0,0 +1,11 @@
+FROM mcr.microsoft.com/powershell:latest
+
+RUN pwsh -Command 'Set-PSRepository PSGallery -InstallationPolicy Trusted; Install-Module ServiceNow -ErrorAction Stop'
+
+ENV SNOW_SERVER=${SNOW_SERVER}
+ENV SNOW_TOKEN=${SNOW_TOKEN}
+ENV SNOW_USER=${SNOW_USER}
+ENV SNOW_PASS=${SNOW_PASS}
+ENV POWERSHELL_TELEMETRY_OPTOUT=1
+
+SHELL ["pwsh"]

RELEASE.md

@@ -1,2 +1,5 @@
-- Fix `Get-ServiceNowAttachment` returning 0 records when the table name didn't match the table class name, [#188](https://github.com/Snow-Shell/servicenow-powershell/issues/188)
-- Update `Add-ServiceNowAttachment` `-Table` and `-ID` parameters with the same 'smarts' as other functions with table name lookup
+- Add docker image with each new build and [publish to dockerhub](https://hub.docker.com/repository/docker/gdbarron/servicenow-module).  Add the below environment variables to `Get-ServiceNowAuth` for use with docker image, but could be used outside of it as well.
+  - SNOW_SERVER: the ServiceNow instance, eg. instance.service-now.com
+  - SNOW_TOKEN: pre-generated oauth token.  Provide this or SNOW_USER/SNOW_PASS.
+  - SNOW_USER: username to connect to SNOW_SERVER
+  - SNOW_PASS: password for SNOW_USER

Readme.md

@@ -22,6 +22,14 @@ Requires authorization in your ServiceNow tenant.  Due to the custom nature of S
 
 The ServiceNow module should be installed from the [PowerShell Gallery](https://www.powershellgallery.com/packages/ServiceNow) with `install-module ServiceNow`.
 
+A [docker image](https://hub.docker.com/repository/docker/gdbarron/servicenow-module) is also available with [Microsoft's PowerShell base image](https://hub.docker.com/_/microsoft-powershell) and the ServiceNow module preinstalled.  The following environment variables should be used:
+- SNOW_SERVER: the ServiceNow instance, eg. instance.service-now.com
+- SNOW_TOKEN: pre-generated oauth token.  Provide this or SNOW_USER/SNOW_PASS.
+- SNOW_USER: username to connect to SNOW_SERVER
+- SNOW_PASS: password for SNOW_USER
+
+When using the docker image, creating a new session is not required.
+
 ### Creating a new session
 
 Creating a new session will create a script scoped variable `$ServiceNowSession` which will be used by default in other functions.

ServiceNow/Private/Get-ServiceNowAuth.ps1

@@ -35,27 +35,35 @@ function Get-ServiceNowAuth {
                 $hashOut.Headers = @{
                     'Authorization' = 'Bearer {0}' -f $ServiceNowSession.AccessToken.GetNetworkCredential().password
                 }
-            }
-            else {
+            } else {
                 $hashOut.Credential = $ServiceNowSession.Credential
             }
 
             if ( $ServiceNowSession.Proxy ) {
                 $hashOut.Proxy = $ServiceNowSession.Proxy
                 if ( $ServiceNowSession.ProxyCredential ) {
                     $hashOut.ProxyCredential = $ServiceNowSession.ProxyCredential
-                }
-                else {
+                } else {
                     $hashOut.ProxyUseDefaultCredentials = $true
                 }
             }
-        }
-        elseif ( $Connection ) {
+        } elseif ( $Connection ) {
             Write-Verbose 'connection'
             $SecurePassword = ConvertTo-SecureString $Connection.Password -AsPlainText -Force
             $Credential = New-Object System.Management.Automation.PSCredential ($Connection.Username, $SecurePassword)
             $hashOut.Credential = $Credential
             $hashOut.Uri = 'https://{0}/api/now/v1' -f $Connection.ServiceNowUri
+        } elseif ( $env:SNOW_SERVER ) {
+            $hashOut.Uri = 'https://{0}/api/now' -f $env:SNOW_SERVER
+            if ( $env:SNOW_TOKEN ) {
+                $hashOut.Headers = @{
+                    'Authorization' = 'Bearer {0}' -f $env:SNOW_TOKEN
+                }
+            } elseif ( $env:SNOW_USER -and $env:SNOW_PASS ) {
+                $hashOut.Credential = New-Object System.Management.Automation.PSCredential($env:SNOW_USER, ($env:SNOW_PASS | ConvertTo-SecureString -AsPlainText -Force))
+            } else {
+                throw 'A ServiceNow server environment variable has been set, but authentication via SNOW_TOKEN or SNOW_USER/SNOW_PASS was not found'
+            }
         } else {
             throw "You must authenticate by either calling the New-ServiceNowSession cmdlet or passing in an Azure Automation connection object"
         }

ServiceNow/ServiceNow.psd1

@@ -12,7 +12,7 @@
 RootModule = 'ServiceNow.psm1'
 
 # Version number of this module.
-ModuleVersion = '3.2.0'
+ModuleVersion = '3.3'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()