depgraph

Documentation

Index

• type DepGraph
  • func GetDepGraph(logger *logrus.Logger, path string) (*DepGraph, error)
  • func NewGraph(logger *logrus.Logger, path string, main *modules.Module) *DepGraph
  • func (g *DepGraph) AddDependency(module *modules.Module) *Dependency
  • func (g *DepGraph) DeepCopy() *DepGraph
  • func (g *DepGraph) GetDependency(name string) (*Dependency, bool)
  • func (g *DepGraph) PruneUnsharedDeps() *DepGraph
  • func (g *DepGraph) RemoveDependency(name string)
  • func (g *DepGraph) SubGraph(filters []*DependencyFilter) *DepGraph
• type Dependency
  • func (n *Dependency) Name() string
  • func (n *Dependency) SelectedVersion() string
  • func (n *Dependency) Timestamp() *time.Time
• type DependencyFilter
• type DependencyMap
  • func NewDependencyMap() *DependencyMap
  • func (m *DependencyMap) Add(dependencyReference *DependencyReference)
  • func (m *DependencyMap) Copy() *DependencyMap
  • func (m *DependencyMap) Delete(name string)
  • func (m *DependencyMap) Get(name string) (*DependencyReference, bool)
  • func (m *DependencyMap) Len() int
  • func (m *DependencyMap) List() []*DependencyReference
• type DependencyReference

Types

type DepGraph

type DepGraph struct {
	Path string

	Main         *Dependency
	Dependencies *DependencyMap
	// contains filtered or unexported fields
}

DepGraph represents a Go module's dependency graph.

func GetDepGraph

func GetDepGraph(logger *logrus.Logger, path string) (*DepGraph, error)

GetDepGraph will return the dependency graph for the Go module that can be found at the specified path. The 'logger' parameter can be 'nil' which will result in no output or logging information being provided.

func NewGraph

func NewGraph(logger *logrus.Logger, path string, main *modules.Module) *DepGraph

NewGraph returns a new DepGraph instance which will use the specified logger for writing log output. If nil a null-logger will be used instead.

func (*DepGraph) AddDependency

func (g *DepGraph) AddDependency(module *modules.Module) *Dependency

func (*DepGraph) DeepCopy

func (g *DepGraph) DeepCopy() *DepGraph

DeepCopy returns a separate copy of the current dependency graph that can be safely modified without affecting the original graph.

func (*DepGraph) GetDependency

func (g *DepGraph) GetDependency(name string) (*Dependency, bool)

func (*DepGraph) PruneUnsharedDeps

func (g *DepGraph) PruneUnsharedDeps() *DepGraph

PruneUnsharedDeps returns a copy of the dependency graph with all dependencies removed that are not part of a chain leading to a dependency with more than two predecessors.

func (*DepGraph) RemoveDependency

func (g *DepGraph) RemoveDependency(name string)

func (*DepGraph) SubGraph

func (g *DepGraph) SubGraph(filters []*DependencyFilter) *DepGraph

SubGraph returns a copy of the dependency graph with all dependencies that are part of chains that need to be modified for the specified dependency to be set to a given target version annotated as such.

type Dependency

type Dependency struct {
	Module       *modules.Module
	Predecessors *DependencyMap
	Successors   *DependencyMap
}

Dependency represents a module in a Go module's dependency graph.

func (*Dependency) Name

func (n *Dependency) Name() string

Name of the module represented by this Dependency in the DepGraph instance.

func (*Dependency) SelectedVersion

func (n *Dependency) SelectedVersion() string

SelectedVersion corresponds to the version of the dependency represented by this Dependency which was selected for use.

func (*Dependency) Timestamp

func (n *Dependency) Timestamp() *time.Time

Timestamp returns the time corresponding to the creation of the version at which this dependency is used.

type DependencyFilter

type DependencyFilter struct {
	Module  string
	Version string
}

DependencyFilter allows to specify a dependency graph filter that removes any edges that are not part of a chain leading to this dependency. If a version is given then we only keep edges that prevent the use of the dependency at that given version due to the Go module's minimal version selection.

type DependencyMap

type DependencyMap struct {
	// contains filtered or unexported fields
}

func NewDependencyMap

func NewDependencyMap() *DependencyMap

func (*DependencyMap) Add

func (m *DependencyMap) Add(dependencyReference *DependencyReference)

func (*DependencyMap) Copy

func (m *DependencyMap) Copy() *DependencyMap

func (*DependencyMap) Delete

func (m *DependencyMap) Delete(name string)

func (*DependencyMap) Get

func (m *DependencyMap) Get(name string) (*DependencyReference, bool)

func (*DependencyMap) Len

func (m *DependencyMap) Len() int

func (*DependencyMap) List

func (m *DependencyMap) List() []*DependencyReference

type DependencyReference

type DependencyReference struct {
	*Dependency
	VersionConstraint string
}