crawl

Documentation

Overview

Package crawl implements the core of the dependency crawler.

Index

• func Crawl(repourl, dataDir string, l *log.Logger) <-chan Result
• type Progress
• type Result

Functions

func Crawl

func Crawl(repourl, dataDir string, l *log.Logger) <-chan Result

Crawl performs a parallelized breadth first exploration of the graph rooted at repourl. Nodes in the graph are dep.ID, and edges are dependencies to other dep.ID's. Child dependencies at each node can be found a variety of strategies, and new strategies will be added over time. There will typically be at least one strategy attempted at each node per package ecosystem. In the case of Golang, there would eventually be several: Go 1.11 modules, Godeps, etc.

Types

type Progress

type Progress struct {
	Found     int `json:"found"`
	Processed int `json:"processed"`
}

Progress indicates the status of the crawl.

type Result

type Result struct {
	Dep      *dep.Dep
	Progress *Progress
}

Result contains information about a call to Crawl.