https://github.com/sonatype-nexus-community/gonexus
Go API for provisioning and interacting with Sonatype's Nexus Repository Manager and Nexus IQ Server
https://github.com/sonatype-nexus-community/gonexus
iq lifecycle nexus repository sonatype
Last synced: 5 months ago
JSON representation
Go API for provisioning and interacting with Sonatype's Nexus Repository Manager and Nexus IQ Server
- Host: GitHub
- URL: https://github.com/sonatype-nexus-community/gonexus
- Owner: sonatype-nexus-community
- License: other
- Created: 2019-07-04T11:57:09.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T15:34:38.000Z (over 1 year ago)
- Last Synced: 2025-03-31T07:22:30.923Z (7 months ago)
- Topics: iq, lifecycle, nexus, repository, sonatype
- Language: Go
- Homepage:
- Size: 293 KB
- Stars: 43
- Watchers: 11
- Forks: 24
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# gonexus [](https://depshield.github.io) [](https://circleci.com/gh/sonatype-nexus-community/gonexus)
Provides a go client library for connecting to, and interacting with, [Sonatype](//www.sonatype.com) Nexus applications such as Nexus Repository Manager and Nexus IQ Server.
## Organization of this library
The library is broken into two packages. One for each application.
### nexusrm [](http://godoc.org/github.com/sonatype-nexus-community/gonexus/rm) [](http://gocover.io/github.com/sonatype-nexus-community/gonexus/rm)
Create a connection to an instance of Nexus Repository Manager
```go
// import "github.com/sonatype-nexus-community/gonexus/rm"
rm, err := nexusrm.New("http://localhost:8081", "username", "password")
if err != nil {
panic(err)
}
```
#### Supported RM Endpoints
| Endpoint | Status | Min RM Version |
| -------------------------------------------------------------------------------------------------------------- | :--------------------: | :------------: |
| [Assets](https://help.sonatype.com/repomanager3/rest-and-integration-api/assets-api) | :full_moon: | |
| [Blob Store](https://help.sonatype.com/repomanager3/rest-and-integration-api/blob-store-api) | :new_moon: | 3.19 |
| [Components](https://help.sonatype.com/repomanager3/rest-and-integration-api/components-api) | :waning_gibbous_moon: | |
| Content Selectors | :new_moon: | 3.19 |
| [Email](https://help.sonatype.com/repomanager3/rest-and-integration-api/email-api) | :new_moon: | 3.19 |
| [IQ Server](https://help.sonatype.com/repomanager3/rest-and-integration-api/iq-server-api) | :new_moon: | 3.19 |
| [Licensing](https://help.sonatype.com/repomanager3/rest-and-integration-api/licensing-api) | :new_moon: | 3.19 |
| [Lifecycle](https://help.sonatype.com/repomanager3/rest-and-integration-api/lifecycle-api) | :new_moon: | |
| [Maintenance](https://help.sonatype.com/repomanager3/rest-and-integration-api/maintenance-api) _pro_ | :waning_crescent_moon: | |
| [Nodes](https://help.sonatype.com/repomanager3/rest-and-integration-api/nodes-api) _pro_ | :new_moon: | |
| [Read-Only](https://help.sonatype.com/repomanager3/rest-and-integration-api/read-only-api) | :full_moon: | |
| [Repositories](https://help.sonatype.com/repomanager3/rest-and-integration-api/repositories-api) | :full_moon: | |
| Routing Rules | :new_moon: | 3.17 |
| [Search](https://help.sonatype.com/repomanager3/rest-and-integration-api/search-api) | :waning_gibbous_moon: | |
| [Script](https://help.sonatype.com/repomanager3/rest-and-integration-api/script-api) | :full_moon: | |
| [Security Management](https://help.sonatype.com/repomanager3/rest-and-integration-api/security-management-api) | :new_moon: | 3.19 |
| [Staging](https://help.sonatype.com/repomanager3/staging) _pro_ | :waning_gibbous_moon: | |
| [Status](https://help.sonatype.com/repomanager3/rest-and-integration-api/status-api) | :full_moon: | |
| [Support](https://help.sonatype.com/repomanager3/rest-and-integration-api/support-api) | :full_moon: | |
| [Tagging](https://help.sonatype.com/repomanager3/tagging) _pro_ | :waning_gibbous_moon: | |
| [Tasks](https://help.sonatype.com/repomanager3/rest-and-integration-api/tasks-api) | :new_moon: | |
#### Supported Provisioning API
| API | Status |
| ---------- | :-------------------: |
| Core | :new_moon: |
| Security | :new_moon: |
| Blob Store | :waning_gibbous_moon: |
| Repository | :waning_gibbous_moon: |
_Legend_: :full_moon: complete :new_moon: untouched :waning_crescent_moon::last_quarter_moon::waning_gibbous_moon: partial support
### nexusiq [](http://godoc.org/github.com/sonatype-nexus-community/gonexus/iq) [](http://gocover.io/github.com/sonatype-nexus-community/gonexus/iq)
Create a connection to an instance of Nexus IQ Server
```go
// import "github.com/sonatype-nexus-community/gonexus/iq"
iq, err := nexusiq.New("http://localhost:8070", "username", "password")
if err != nil {
panic(err)
}
```
#### Supported IQ Endpoints
| Endpoint | Status | Min IQ Version |
| -------------------------------------------------------------------------------------------------------------------- | :---------: | :------------: |
| [Application](https://help.sonatype.com/iqserver/automating/rest-apis/application-rest-apis---v2) | :full_moon: | |
| [Authorization Configuration](https://help.sonatype.com/iqserver/automating/rest-apis) | :full_moon: | r70 |
| [Component Details](https://help.sonatype.com/iqserver/automating/rest-apis/component-details-rest-api---v2) | :full_moon: | |
| [Component Evaluation](https://help.sonatype.com/iqserver/automating/rest-apis/component-evaluation-rest-apis---v2) | :full_moon: | |
| [Component Labels](https://help.sonatype.com/iqserver/automating/rest-apis/component-labels-rest-api---v2) | :full_moon: | |
| [Component Remediation](https://help.sonatype.com/iqserver/automating/rest-apis/component-remediation-rest-api---v2) | :full_moon: | r64 |
| [Component Search](https://help.sonatype.com/iqserver/automating/rest-apis/component-search-rest-apis---v2) | :full_moon: | |
| [Component Versions](https://help.sonatype.com/iqserver/automating/rest-apis/component-versions-rest-api---v2) | :full_moon: | |
| [Component Waivers](https://help.sonatype.com/iqserver/automating/rest-apis/component-waivers-rest-api---v2) | :new_moon: | r76 |
| [Configuration](https://help.sonatype.com/iqserver/automating/rest-apis/configuration-rest-api---v2) | :new_moon: | r65 |
| [Data Retention Policy](https://help.sonatype.com/iqserver/automating/rest-apis/data-retention-policy-rest-api---v2) | :full_moon: | |
| [Organization](https://help.sonatype.com/iqserver/automating/rest-apis/organization-rest-apis---v2) | :full_moon: | |
| [Policy Violation](https://help.sonatype.com/iqserver/automating/rest-apis/policy-violation-rest-api---v2) | :full_moon: | |
| [Policy Waiver](https://help.sonatype.com/iqserver/automating/rest-apis/policy-waiver-rest-api---v2) | :new_moon: | r71 |
| [Promote Scan](https://help.sonatype.com/iqserver/automating/rest-apis/promote-scan-rest-api---v2) | :new_moon: | |
| [Report-related](https://help.sonatype.com/iqserver/automating/rest-apis/report-related-rest-apis---v2) | :full_moon: | |
| [Role](https://help.sonatype.com/iqserver/automating/rest-apis/role-rest-api---v2) | :full_moon: | r70 |
| [SAML](https://help.sonatype.com/iqserver/automating/rest-apis/saml-rest-api---v2) | :new_moon: | r74 |
| [Source Control](https://help.sonatype.com/integrations/nexus-iq-for-github) | :full_moon: | |
| [Success Metrics Data](https://help.sonatype.com/iqserver/automating/rest-apis/success-metrics-data-rest-api---v2) | :full_moon: | |
| [Users](https://help.sonatype.com/iqserver/automating/rest-apis/user-rest-api---v2) | :full_moon: | r70 |
| [User Token](https://help.sonatype.com/iqserver/automating/rest-apis/user-token-rest-api---v2) | :new_moon: | r76 |
| [Vulnerability Details](https://help.sonatype.com/iqserver/automating/rest-apis/vulnerability-details-rest-api---v2) | :new_moon: | r75 |
| [Webhooks](https://help.sonatype.com/iqserver/automating/iq-server-webhooks) | :full_moon: | |
_Legend_: :full_moon: complete :new_moon: untouched :waning_crescent_moon::last_quarter_moon::waning_gibbous_moon: partial support
##### iqwebhooks [](http://godoc.org/github.com/sonatype-nexus-community/gonexus/iq/iqwebhooks) [](http://gocover.io/github.com/sonatype-nexus-community/gonexus/iq/iqwebhooks)
The `iq/iqwebhooks` subpackage provides structs for all of the event types along with helper functions.
Most notably it provides a function called `Listen` which is an `http.HandlerFunc` that can be used as an endpoint handler for a server functioning as a webhook listener.
The handler will place any webhook event it finds in a channel to be consumed at will.
An example of using the handler to listen for Application Evaluation events:
```go
// import "github.com/sonatype-nexus-community/gonexus/iq/webhooks"
appEvals, _ := iqwebhooks.ApplicationEvaluationEvents()
go func() {
for _ = range appEvals:
log.Println("Received Application Evaluation event")
}
}()
http.HandleFunc("/ingest", iqwebhooks.Listen)
```
See the [documentation](https://godoc.org/github.com/sonatype-nexus-community/gonexus/iq/iqwebhooks#example-Listen) for a full example showing other event types.
## The Fine Print
It is worth noting that this is **NOT SUPPORTED** by [Sonatype](//www.sonatype.com), and is a contribution of [@HokieGeek](https://github.com/HokieGeek)
plus us to the open source community (read: you!)
Remember:
- Use this contribution at the risk tolerance that you have
- Do **NOT** file Sonatype support tickets related to this
- **DO** file issues here on GitHub, so that the community can pitch in