fossa

Documentation

Overview

Package fossa provides a high-level interface to the FOSSA API (by default, located at https://app.fossa.io).

Index

• Constants
• Variables
• func Get(endpoint string) (res string, statusCode int, err error)
• func GetJSON(endpoint string, v interface{}) (statusCode int, err error)
• func GetOrganizationID() (string, error)
• func Init(server, APIKey string) error
• func MustInit(server, APIKey string)
• func NormalizeGitURL(project string) string
• func Post(endpoint string, body []byte) (res string, statusCode int, err error)
• func PutJSON(endpoint string, body []byte, v interface{}) (statusCode int, err error)
• func SourceUnitType(t pkg.Type) (string, error)
• type Build
  • func GetBuilds(locator Locator) ([]Build, error)
  • func QueueBuild(locator Locator) (Build, error)
• type Issue
  • func GetIssues(locator Locator) ([]Issue, error)
• type License
• type Locator
  • func LocatorOf(id pkg.ID) Locator
  • func ReadLocator(locator string) Locator
  • func Upload(fetcher, project, revision, title, branch string, data []SourceUnit) (Locator, error)
  • func (l Locator) IsResolved() bool
  • func (l Locator) String() string
• type Project
• type Revision
  • func GetRevision(locator Locator) (Revision, error)
  • func GetRevisions(locators []Locator) (revs []Revision, err error)
• type RevisionMeta
• type SourceUnit
  • func Normalize(modules []module.Module) ([]SourceUnit, error)
• type SourceUnitBuild
• type SourceUnitDependency
• type User

Constants

const BuildsAPI = "/api/builds/%s"

const IssuesAPI = "/api/issues/%s"

const RevisionsAPI = "/api/revisions/%s"

RevisionsAPI is the API endpoint for revisions.

Variables

var (
	ErrNoProject   = errors.New("no project provided for upload")
	ErrNoRevision  = errors.New("no revision provided for upload")
	ErrNoBuildData = errors.New("no build data to upload")
)

Errors related to preconditions.

var (
	ErrForbidden            = errors.New("authentication failed (is the API key correct?)")
	ErrRevisionDoesNotExist = errors.New("revision does not exist (are the project and revision correct and published in FOSSA?)")
)

Errors resulting from a bad API response.

var UsersAPI = "/api/users/%s"

Functions

func Get

func Get(endpoint string) (res string, statusCode int, err error)

Get makes a GET request to a FOSSA API endpoint.

func GetJSON

func GetJSON(endpoint string, v interface{}) (statusCode int, err error)

GetJSON makes a JSON GET request to a FOSSA API endpoint.

func GetOrganizationID

func GetOrganizationID() (string, error)

func Init

func Init(server, APIKey string) error

Init sets up an API instance.

func MustInit

func MustInit(server, APIKey string)

MustInit crashes and logs a fatal exception if `Init` fails.

func NormalizeGitURL

func NormalizeGitURL(project string) string

NormalizeGitURL normalizes all forms of git remote URLs to a single standard form.

func Post

func Post(endpoint string, body []byte) (res string, statusCode int, err error)

Post makes a POST request to a FOSSA API endpoint.

func PutJSON

func PutJSON(endpoint string, body []byte, v interface{}) (statusCode int, err error)

PutJSON makes a JSON PUT request to a FOSSA API endpoint.

func SourceUnitType

func SourceUnitType(t pkg.Type) (string, error)

SourceUnitType normalizes pkg.Types into SourceUnit types.

Types

type Build

type Build struct {
	ID    int
	Error string
	Task  struct {
		Status string
	}
}

A Build holds the FOSSA API response for the builds API.

func GetBuilds

func GetBuilds(locator Locator) ([]Build, error)

GetBuilds loads the build for a revision.

func QueueBuild

func QueueBuild(locator Locator) (Build, error)

type Issue

type Issue struct {
	PriorityString string
	Resolved       bool
	Revision       Revision
	Type           string
}

An Issue holds the FOSSA API response for the issue API.

func GetIssues

func GetIssues(locator Locator) ([]Issue, error)

GetIssues loads the issues for a project.

type License

type License struct {
	ID             int64
	LicenseID      string
	RevisionID     string
	LicenseGroupID int64
	Ignored        bool
	Title          string
	URL            string
	FullText       string
	Copyright      string
}

A License holds the FOSSA API response for the license API.

type Locator

type Locator struct {
	Fetcher  string `json:"fetcher"`
	Project  string `json:"package"`
	Revision string `json:"revision"`
}

Locator serializes FOSSA API locators.

func LocatorOf

func LocatorOf(id pkg.ID) Locator

LocatorOf returns the locator of a pkg.ID.

func ReadLocator

func ReadLocator(locator string) Locator

ReadLocator parses a string locator into a Locator.

func Upload

func Upload(fetcher, project, revision, title, branch string, data []SourceUnit) (Locator, error)

Upload uploads a project's analysis.

func (Locator) IsResolved

func (l Locator) IsResolved() bool

IsResolved returns true only if a locator is resolved.

func (Locator) String

func (l Locator) String() string

type Project

type Project struct {
	Title   string
	URL     string
	Public  bool
	Authors []string
}

A Project holds the FOSSA API response for the project API.

type Revision

type Revision struct {
	Locator  *Locator `json:"loc"`
	Licenses []License
	Project  *Project
	Meta     []RevisionMeta
	Issues   []Issue
}

A Revision holds the FOSSA API response for the revision API.

func GetRevision

func GetRevision(locator Locator) (Revision, error)

GetRevision loads a single revision.

func GetRevisions

func GetRevisions(locators []Locator) (revs []Revision, err error)

GetRevisions loads many revisions in batched requests.

type RevisionMeta

type RevisionMeta struct {
	LastScan string `json:"last_scan"`
}

A RevisionMeta holds metadata about a FOSSA API revision.

type SourceUnit

type SourceUnit struct {
	Name     string
	Type     string
	Manifest string
	Build    SourceUnitBuild
}

SourceUnit is the basic module unit of the FOSSA API.

func Normalize

func Normalize(modules []module.Module) ([]SourceUnit, error)

Normalize transforms module.Modules into SourceUnits.

type SourceUnitBuild

type SourceUnitBuild struct {
	Artifact string
	Context  interface{}

	Succeeded bool
	Error     error `json:",omitempty"`

	Imports      []string
	Dependencies []SourceUnitDependency
}

A SourceUnitBuild contains the build information of a SourceUnit.

type SourceUnitDependency

type SourceUnitDependency struct {
	// Location
	Locator string   `json:"locator"`
	Imports []string `json:"imports,omitempty"`

	// Metadata
	Data *json.RawMessage `json:"data,omitempty"`

	// Context
	Depth              int      `json:"depth,omitempty"`
	Parent             string   `json:"parent,omitempty"`
	UnresolvedLocators []string `json:"unresolved_locators,omitempty"`
}

A SourceUnitDependency contains the dependency information of a SourceUnit.

type User

type User struct {
	OrganizationID int
}