https://github.com/package-url/packageurl-go

Go implementation of the package url spec
https://github.com/package-url/packageurl-go

go go-library golang golang-library library package-url purl

Last synced: 7 days ago
JSON representation

Go implementation of the package url spec

• Host: GitHub
• URL: https://github.com/package-url/packageurl-go
• Owner: package-url
• License: mit
• Created: 2017-11-16T14:26:14.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-09T04:35:44.000Z (3 months ago)
• Last Synced: 2024-10-30T16:04:44.689Z (9 days ago)
• Topics: go, go-library, golang, golang-library, library, package-url, purl
• Language: Go
• Size: 64.5 KB
• Stars: 54
• Watchers: 3
• Forks: 48
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# packageurl-go

[![build](https://github.com/package-url/packageurl-go/workflows/test/badge.svg)](https://github.com/package-url/packageurl-go/actions?query=workflow%3Atest) [![Coverage Status](https://coveralls.io/repos/github/package-url/packageurl-go/badge.svg)](https://coveralls.io/github/package-url/packageurl-go) [![PkgGoDev](https://pkg.go.dev/badge/github.com/package-url/packageurl-go)](https://pkg.go.dev/github.com/package-url/packageurl-go) [![Go Report Card](https://goreportcard.com/badge/github.com/package-url/packageurl-go)](https://goreportcard.com/report/github.com/package-url/packageurl-go)

Go implementation of the package url spec.

## Install

```

go get -u github.com/package-url/packageurl-go

```

## Versioning

The versions will follow the spec. So if the spec is released at ``1.0``. Then all versions in the ``1.x.y`` will follow the ``1.x`` spec.

## Usage

### Create from parts

```go

package main

import (

	"fmt"

	"github.com/package-url/packageurl-go"

)

func main() {

	instance := packageurl.NewPackageURL("test", "ok", "name", "version", nil, "")

	fmt.Printf("%s", instance.ToString())

}

```

### Parse from string

```go

package main

import (

	"fmt"

	"github.com/package-url/packageurl-go"

)

func main() {

	instance, err := packageurl.FromString("test:ok/name@version")

	if err != nil {

		panic(err)

	}

	fmt.Printf("%#v", instance)

}

```

## Test

Testing using the normal ``go test`` command. Using ``make test`` will pull the test fixtures shared between all package-url projects and then execute the tests.

```

curl -Ls https://raw.githubusercontent.com/package-url/purl-spec/master/test-suite-data.json -o testdata/test-suite-data.json

go test -v -cover ./...

=== RUN   TestFromStringExamples

--- PASS: TestFromStringExamples (0.00s)

=== RUN   TestToStringExamples

--- PASS: TestToStringExamples (0.00s)

=== RUN   TestStringer

--- PASS: TestStringer (0.00s)

=== RUN   TestQualifiersMapConversion

--- PASS: TestQualifiersMapConversion (0.00s)

PASS

        github.com/package-url/packageurl-go    coverage: 90.7% of statements

ok      github.com/package-url/packageurl-go    0.004s  coverage: 90.7% of statements

```

## Fuzzing

Fuzzing is done with standard [Go fuzzing](https://go.dev/doc/fuzz/), introduced in Go 1.18.

Fuzz tests check for inputs that cause `FromString` to panic.

Using `make fuzz` will run fuzz tests for one minute.

To run fuzz tests longer:

```

go test -fuzztime=60m -fuzz .

```

Or omit `-fuzztime` entirely to run indefinitely.