Merge pull request #20 from steviecoaster/develop

Prep for release

Author: steviecoaster

.github/workflows/build.yml

@@ -45,6 +45,8 @@ jobs:
       - name: Upload Test Results
         uses: EnricoMi/publish-unit-test-result-action/composite@v1
         if: always()
+        with:
+          files: TestResults.xml
 
       - name: Create Release
         if: ${{ github.ref == 'refs/heads/main' }}

build.ps1

@@ -48,18 +48,27 @@ process {
                 Import-Module NexuShell
             }
 
-            $TestArguments = @{
-                Path                   = "$root\tests"
-
-                OutputFile             = "$root\TestResults.xml"
-                OutputFormat           = "JUnitXml"
-                
-                CodeCoverage           = (Get-ChildItem $root\Output\NexuShell -Recurse -Filter '*.ps*1').FullName
-                CodeCoverageOutputFile = "$root\Coverage.xml"
+            $TestConfiguration = New-PesterConfiguration @{
+                Run          = @{
+                    Path = "$root\tests"
+                }
+                TestResult   = @{
+                    Enabled      = $true
+                    OutputPath   = "$root\TestResults.xml"
+                    OutputFormat = "JUnitXml"
+                }
+                Output = @{
+                    Verbosity  = "Detailed"
+                }
+                CodeCoverage = @{
+                    Enabled    = $true
+                    Path       = (Get-ChildItem $root\Output\NexuShell -Recurse -Filter '*.ps*1').FullName
+                    OutputPath = "$root\Coverage.xml"
+                }
             }
 
-            if (Test-Path $TestArguments.Path) {
-                Invoke-Pester @TestArguments
+            if (Test-Path $TestConfiguration.Run.Path.Value) {
+                Invoke-Pester -Configuration $TestConfiguration
             }
         }
 

docs/CHANGELOG.md

@@ -0,0 +1,20 @@
+# NexuShell Changelog
+
+## 1.0
+
+Initial release
+
+## 1.0.1 (21 July 2021)
+
+### Bug Fixes
+
+- #9 Set-NexusUserPassword reports "Unsupported Media Type"
+- #8 Set-NexusUser requires parameters (some of which can't be supplied)
+- #7 Get-NexusNuGetApiKey does not work with a user not authenticated through Connect-NexusServer
+- Fixes parameter typo in ChocolateyInstall.ps1
+- Switches to `Join-Path` for building zip archive path in ChocolateyInstall.ps1
+
+### Maintenance
+
+- Added a `-Force` Parameter to `Compress-Archive` in the build script to allow the choco package to be created locally without having to manually delete files.
+- Adds logo to Project README

src/private/Convert-ObjectToHashtable.ps1

@@ -0,0 +1,28 @@
+function Convert-ObjectToHashtable {
+    <#
+    .SYNOPSIS
+    Converts a PSObject to a Hashtable
+
+    .DESCRIPTION
+    Invoke-Nexus outputs PSObjects, due to the underlying use of Invoke-RestMethod.
+    Invoke-Nexus takes a Hashtable as body. This allows some pass-between.
+
+    .PARAMETER InputObject
+    The object to convert.
+
+    .EXAMPLE
+    Get-NexusBlobStorage -Name default -Type File | Convert-ObjectToHashtable
+    #>
+    param(
+        [Parameter(Mandatory, ValueFromPipeline)]
+        $InputObject
+    )
+    process {
+        $Hashtable = @{}
+        $InputObject.PSObject.Properties.ForEach{
+            $Hashtable[$_.Name] = $_.Value
+        }
+
+        $Hashtable
+    }
+}

src/public/BlobStore/Update-NexusFileBlobStore.ps1

@@ -0,0 +1,89 @@
+function Update-NexusFileBlobStore {
+    <#
+    .SYNOPSIS
+    Updates some properties of a given file blobstore
+
+    .PARAMETER Name
+    The Name of the file blobstore to update
+
+    .PARAMETER Path
+    The path for the blob store to use
+
+    .PARAMETER SoftQuotaType
+    The type of soft quota limit to enforce
+
+    .PARAMETER SoftQuotaLimit
+    The size of the soft quota limit, in MB
+
+    .NOTES
+    This does not automatically migrate blobs from the previous location.
+    There may be some time where the store is inaccessible.
+
+    .EXAMPLE
+    Update-NexusFileBlobStore -Name default -Path D:\NexusStore
+
+    # Sets the default blobstore to the location listed
+    #>
+    [CmdletBinding(HelpUri = 'https://steviecoaster.dev/NexuShell/Update-NexusFileBlobStore/', SupportsShouldProcess, ConfirmImpact = 'High')]
+    param(
+        [Parameter(Mandatory)]
+        [string]
+        $Name,
+
+        [string]
+        $Path,
+
+        [ValidateSet("Remaining", "Used")]
+        [string]
+        $SoftQuotaType,
+
+        [ValidateRange(1, [int]::MaxValue)]
+        [int]
+        $SoftQuotaLimit
+    )
+    begin {
+        if (-not $header) {
+            throw "Not connected to Nexus server! Run Connect-NexusServer first."
+        }
+    }
+    end {
+        $urislug = "/service/rest/v1/blobstores/file/$Name"
+
+        $Body = Get-NexusBlobStore -Name $Name -Type File | Convert-ObjectToHashtable
+
+        $Modified = $false
+        switch -Wildcard ($PSBoundParameters.Keys) {
+            "Path" {
+                if ($Body.path -ne $Path) {
+                    $Body.path = $Path
+                    $Modified = $true
+                }
+            }
+            "SoftQuota*" {
+                if (-not $Body.softQuota) {
+                    $Body.softQuota = @{}
+                }
+            }
+            "SoftQuotaType" {
+                if ($Body.softQuota.type -ne "space$($SoftQuotaType)Quota") {
+                    $Body.softQuota.type = "space$($SoftQuotaType)Quota"
+                    $Modified = $true
+                }
+            }
+            "SoftQuotaLimit" {
+                if ($Body.softQuota.limit -ne $SoftQuotaLimit) {
+                    $Body.softQuota.limit = $SoftQuotaLimit * 1MB
+                    $Modified = $true
+                }
+            }
+        }
+
+        if ($Modified) {
+            if ($PSCmdlet.ShouldProcess($Name, "Update File Blob Store")) {
+                Invoke-Nexus -UriSlug $urislug -Method Put -Body $Body
+            }
+        } else {
+            Write-Verbose "No change to '$($Name)' was required."
+        }
+    }
+}

tests/public/BlobStore/Update-NexusFileBlobStore.Tests.ps1

@@ -0,0 +1,69 @@
+#requires -Modules NexuShell
+
+Describe "Update-NexusFileBlobStore" {
+    BeforeAll {
+        $InModule = @{
+            ModuleName = "NexuShell"
+        }
+
+        InModuleScope @InModule {
+            $script:header = @{
+                Authentication = "fake auth"
+            }
+        }
+
+        Mock Invoke-Nexus @InModule
+        Mock Get-NexusBlobStore @InModule -MockWith {
+            if ($script:BlobStoreObject) {
+                $script:BlobStoreObject
+            } else {
+                [PSCustomObject]@{
+                    path = "default"
+                    softQuota = @{
+                        type  = ""
+                        limit = ""
+                    }
+                }
+            }
+        }
+    }
+
+    Context "Updating a BlobStore Path from 'default'" {
+        BeforeAll {
+            Update-NexusFileBlobStore -Name "Test" -Path "D:\Repository\" -Confirm:$false
+        }
+
+        It "Sets the specified path for the specified BlobStore" {
+            Assert-MockCalled Invoke-Nexus @InModule -ParameterFilter {
+                $UriSlug -eq "/service/rest/v1/blobstores/file/Test" -and
+                $Method -eq "Put" -and
+                $Body.path -eq "D:\Repository\"
+            } -Scope Context
+        }
+    }
+
+    Context "Updating a BlobStore Path that is already correct" {
+        BeforeAll {
+            Update-NexusFileBlobStore -Name "Test" -Path "default" -Confirm:$false
+        }
+
+        It "Does not attempt to modify the BlobStore" {
+            Assert-MockCalled Invoke-Nexus @InModule -Times 0 -Scope Context
+        }
+    }
+
+    Context "Updating a BlobStore Quota" {
+        BeforeAll {
+            Update-NexusFileBlobStore -Name "QuotaTest" -SoftQuotaType Remaining -SoftQuotaLimit 203 -Confirm:$false
+        }
+
+        It "Sets the specified quota limit for the specified BlobStore" {
+            Assert-MockCalled Invoke-Nexus @InModule -ParameterFilter {
+                $UriSlug -eq "/service/rest/v1/blobstores/file/QuotaTest" -and
+                $Method -eq "Put" -and
+                $Body.softQuota.type -eq "spaceRemainingQuota" -and
+                $Body.softQuota.limit -eq 203MB
+            } -Scope Context
+        }
+    }
+}