steviecoaster / nexushell

PowerShell Module for Sonatype Nexus REST Api

Hi there 👋 , I'm @steviecoaster!

PS | 1:08 PM | Choco Stuff> Get-GithubBio

Name        : Stephen Valdinger
Company     : Chocolatey Software
Title       : Support Manager
Hobbies     : {woodworking, fishing, music}
Description : Hi! I'm Stephen! I'm passionate about PowerShell, and software automation. I also thoroughly enjoy 
helping other level up their skillsets,either directly by sharing my knowledge, or by connecting them to someone 
in the industry with expertise in the area of their question.
Tagline     : Software Automation: I know a thing or two, because I've seen a thing or two!

• 🔭 I’m currently working on NexuShell, and Chocolatey

nexushell's Issues

Feature Request: Add some tests to exercise the module against a real Nexus repository

I'd like to build some Test Kitchen tests that will allow a VM with a Nexus repository to be used to test against a real Nexus repository.

I've noticed some issues that don't seem to present themselves unless you're pushing large files, and that feels like something we can't really mock.

Get-NexusComponent not paginating results properly

This command should return all components on a repository, however only provides back 20 results

New-NexusRawComponent Needs better validation

A couple of things to note:

• When running New-NexusRawComponent prior to running Connect-NexusServer, receive the error: Invoke-WebRequest: Invalid URI: The hostname could not be parsed.
• When running New-NexusRawComponent while pointing to a file that doesn't exist, receive the error: Invoke-WebRequest: Cannot find path '<path/to/file>' because it does not exist.

I realize this is a pretty trash issue, but if someone cough @steviecoaster cough would provide a reasonable template for issues I would be glad to fill it out 🤪

Get-NexusNuGetApiKey does not work with a user not authenticated through Connect-NexusServer

This is because it (and the child function for getting a token) use the $script:Header containing the auth token for the original user.

I see a few ways to sort this:

• Replace the use of $Header within the two functions with a base authentication token generated from the passed Credential
• Require that folk run Connect-NexusServer before using it

I feel the former feels better. I'll happily submit a PR shortly, if that seems reasonable.

Feature Request: Remove-NexusComponent

There's currently not a way to remove a nexus component, though we can remove an asset.

After work today, it seems that it would be handy if there was a way to do this! I used the following (taken from here):

InModuleScope NexuShell {
    $null = Invoke-Nexus -UriSlug "/service/rest/v1/components/$($Package.Id)" -Method DELETE
}

There could easily be a quick function added for this.

Generate docs as part of build

The build pipeline should process the PowerShell scripts and write Markdown help automatically, and publish these help files to the docs site for this module.

New-NexusRawComponet - underlying connection was closed error

New-NexusRawComponet cmdlet with a 900mb file I am getting this error

The underlying connection was closed: A connection that was expected to be kept alive was closed by the server.

Smaller size files are working as expected.

Set-NexusUserPassword reports "Unsupported Media Type"

When trying to set a password using Set-NexusUserPassword, I'm getting an error related to the media type being unsupported.

Set-NexusUserPassword -Username admin -NewPassword ("Sausage2021" | ConvertTo-SecureString -AsPlainText -Force)

Invoke-RestMethod : The remote server returned an error: (415) Unsupported Media Type.
At C:\Program Files\WindowsPowerShell\Modules\NexuShell\1.0.0\NexuShell.psm1:106 char:9
+         Invoke-RestMethod @Params
+         ~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

New-NexusRawComponent tries to upload the files from home directory

New-NexusRawComponent seems to pass the path through to Upload-File which seems to end up with relative paths coming from ~ instead of $PWD.

Feature Request: Update File BlobStore Path

As someone setting up a Nexus instance, I may want to move the default blobstore to another drive or location.

Issue

There's currently seems to be no way to update the path of a blobstore, e.g. the default blob store created on initial installation.

Request

There is an endpoint to do this (PUT /v1/blobstores/file/{name}).

It would be ideal if there was a function to update blob store values, rather than having to delete and recreate the blobstore - this won't work unless there are no current repositories available (which is mostly fine).

Given the specificity of the endpoint, I would suggest Set- or Update-NexusFileBlobStore. You could potentially add some kind of migration function, but I think that's out of scope of this module.

Feature Request: The ability to specify the chunk size when uploading large files

Set-NexusUser requires parameters (some of which can't be supplied)

This was spotted against Nexus OSS 3.31.1-01

When running Set-NexusUser with limited parameters, there is an error stating that more parameters are required.

Set-NexusUser -Username admin -Status Active

Invoke-RestMethod : [{"id":"PARAMETER roles","message":"must not be empty"},{"id":"PARAMETER userId","message":"must not be blank"},{"id":"PARAMETER firstName","message":"must not be empty"},{"id":"PARAMETER 
source","message":"must not be blank"},{"id":"PARAMETER lastName","message":"must not be empty"},{"id":"PARAMETER emailAddress","message":"must not be empty"}]
At C:\Program Files\WindowsPowerShell\Modules\NexuShell\1.0.0\NexuShell.psm1:106 char:9
+         Invoke-RestMethod @Params
+         ~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

Most of these should (but currently aren't) being satisfied by the existing values on the user, but those aren't coming through properly.

If you manually provide them to the function, those are removed from the list as being needed.

Set-NexusUser -Username admin -Status Active -FirstName 'Administrator' -LastName 'User' -EmailAddress '[email protected]' -Roles 'nx-admin'

Invoke-RestMethod : [{"id":"PARAMETER userId","message":"must not be blank"},{"id":"PARAMETER source","message":"must not be blank"}]
At C:\Program Files\WindowsPowerShell\Modules\NexuShell\1.0.0\NexuShell.psm1:106 char:9
+         Invoke-RestMethod @Params
+         ~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

There are two remainders:

1. It looks like userName should be going through as userId
2. There also needs to be source, which is available on the original user object

An aside: the docs also reference a Password parameter which I assume is from before the Set-NexusUserPassword function was done.