models

Documentation

Index

• Constants
• func IdGen(data string) string
• func NewPackageDetail(e, n, v string) lockfile.PackageDetails
• type Package
  • func (p *Package) GetName() string
  • func (p *Package) GetSpecEcosystem() modelspec.Ecosystem
  • func (p *Package) GetVersion() string
  • func (p *Package) Id() string
  • func (p *Package) ShortName() string
• type PackageManifest
  • func (pm *PackageManifest) AddPackage(pkg *Package)
  • func (pm *PackageManifest) GetDisplayPath() string
  • func (pm *PackageManifest) GetPackagesCount() int
  • func (pm *PackageManifest) GetPath() string
  • func (pm *PackageManifest) GetSpecEcosystem() modelspec.Ecosystem
  • func (pm *PackageManifest) Id() string
  • func (pm *PackageManifest) SetDisplayPath(path string)

Constants

const (
	EcosystemMaven     = "Maven"
	EcosystemRubyGems  = "RubyGems"
	EcosystemGo        = "Go"
	EcosystemNpm       = "npm"
	EcosystemPyPI      = "PyPI"
	EcosystemCargo     = "Cargo"
	EcosystemNuGet     = "NuGet"
	EcosystemPackagist = "Packagist"
	EcosystemHex       = "Hex"
	EcosystemPub       = "Pub"
	EcosystemCyDxSBOM  = "CycloneDxSbom"
	EcosystemSpdxSBOM  = "SpdxSbom"
)

Functions

func IdGen

func IdGen(data string) string

This is probably not the best place for IdGen but keeping it here since this package is the most stable (SDP)

func NewPackageDetail

func NewPackageDetail(e, n, v string) lockfile.PackageDetails

Types

type Package

type Package struct {
	lockfile.PackageDetails `json:"package_detail"`

	// Insights obtained for this package
	Insights *insightapi.PackageVersionInsight `json:"insights,omitempty"`

	// This package is a transitive dependency of parent package
	Parent *Package `json:"-"`

	// Depth of this package in dependency tree
	Depth int `json:"depth"`

	// Manifest from where this package was found directly or indirectly
	Manifest *PackageManifest `json:"-"`
}

Represents a package such as a version of a library defined as a dependency in Gemfile.lock, pom.xml etc.

func (*Package) GetName

func (p *Package) GetName() string

func (*Package) GetSpecEcosystem

func (p *Package) GetSpecEcosystem() modelspec.Ecosystem

FIXME: For SPDX/CycloneDX, package ecosystem may be different from the manifest ecosystem

func (*Package) GetVersion

func (p *Package) GetVersion() string

func (*Package) Id

func (p *Package) Id() string

func (*Package) ShortName

func (p *Package) ShortName() string

type PackageManifest

type PackageManifest struct {
	// Filesystem path of this manifest
	Path string `json:"path"`

	// When we scan non-path entities like Github org / repo
	// then only path doesn't make sense, which is more local
	// temporary file path
	DisplayPath string `json:"display_path"`

	// Ecosystem to interpret this manifest
	Ecosystem string `json:"ecosystem"`

	// List of packages obtained by parsing the manifest
	Packages []*Package `json:"packages"`
	// contains filtered or unexported fields
}

Represents a package manifest that contains a list of packages. Example: pom.xml, requirements.txt

func (*PackageManifest) AddPackage

func (pm *PackageManifest) AddPackage(pkg *Package)

func (*PackageManifest) GetDisplayPath

func (pm *PackageManifest) GetDisplayPath() string

GetDisplayPath returns the [DisplayPath] if available or fallsback to [Path]

func (*PackageManifest) GetPackagesCount

func (pm *PackageManifest) GetPackagesCount() int

func (*PackageManifest) GetPath

func (pm *PackageManifest) GetPath() string

func (*PackageManifest) GetSpecEcosystem

func (pm *PackageManifest) GetSpecEcosystem() modelspec.Ecosystem

func (*PackageManifest) Id

func (pm *PackageManifest) Id() string

func (*PackageManifest) SetDisplayPath

func (pm *PackageManifest) SetDisplayPath(path string)