Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // By convention, modules with a major version equal to or above v2 // have it as suffix in their module path. VCSUrlMajorVersionSuffixRegex = regexp.MustCompile(`(/v[\d]+)$`) // gopkg.in/user/pkg.v -> github.com/user/pkg VCSUrlGoPkgInRegexWithUser = regexp.MustCompile(`^gopkg\.in/([^/]+)/([^.]+)\..*$`) // gopkg.in without user segment // Example: gopkg.in/pkg.v3 -> github.com/go-pkg/pkg VCSUrlGoPkgInRegexWithoutUser = regexp.MustCompile(`^gopkg\.in/([^.]+)\..*$`) )
View Source
var ( // execute go mod tidy in normal folder GoModNormal = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-version@v0.0.0-20240603093900-cf8a8d29271d", Name: "github.com/aquasecurity/go-version", Version: "v0.0.0-20240603093900-cf8a8d29271d", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-version", }, }, }, { ID: "stdlib@v1.22.5", Name: "stdlib", Version: "v1.22.5", Relationship: ftypes.RelationshipDirect, }, { ID: "github.com/davecgh/go-spew@v1.1.2-0.20180830191138-d8f796af33cc", Name: "github.com/davecgh/go-spew", Version: "v1.1.2-0.20180830191138-d8f796af33cc", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/davecgh/go-spew", }, }, }, { ID: "github.com/pmezard/go-difflib@v1.0.1-0.20181226105442-5d4384ee4fb2", Name: "github.com/pmezard/go-difflib", Version: "v1.0.1-0.20181226105442-5d4384ee4fb2", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/pmezard/go-difflib", }, }, }, { ID: "github.com/stretchr/testify@v1.9.0", Name: "github.com/stretchr/testify", Version: "v1.9.0", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/stretchr/testify", }, }, }, { ID: "golang.org/x/xerrors@v0.0.0-20231012003039-104605ab7028", Name: "golang.org/x/xerrors", Version: "v0.0.0-20231012003039-104605ab7028", Relationship: ftypes.RelationshipIndirect, }, } GoModNormalDeps = ftypes.Dependencies{ { ID: "github.com/org/repo", DependsOn: []string{ "github.com/aquasecurity/go-version@v0.0.0-20240603093900-cf8a8d29271d", "stdlib@v1.22.5", }, }, } GoModNormalWithoutStdlib = slices.DeleteFunc(slices.Clone(GoModNormal), func(f ftypes.Package) bool { return f.Name == "stdlib" }) GoModNormalWithoutStdlibDeps = ftypes.Dependencies{ { ID: "github.com/org/repo", DependsOn: []string{ "github.com/aquasecurity/go-version@v0.0.0-20240603093900-cf8a8d29271d", }, }, } // execute go mod tidy in replaced folder GoModReplaced = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20220406074731-71021a481237", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20220406074731-71021a481237", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "golang.org/x/xerrors@v0.0.0-20200804184101-5ec99f83aff1", Name: "golang.org/x/xerrors", Version: "v0.0.0-20200804184101-5ec99f83aff1", Relationship: ftypes.RelationshipIndirect, }, } GoModReplacedDeps = ftypes.Dependencies{ { ID: "github.com/org/repo", DependsOn: []string{ "github.com/aquasecurity/go-dep-parser@v0.0.0-20220406074731-71021a481237", }, }, } // execute go mod tidy in replaced folder GoModUnreplaced = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211110174639-8257534ffed3", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211110174639-8257534ffed3", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "golang.org/x/xerrors@v0.0.0-20200804184101-5ec99f83aff1", Name: "golang.org/x/xerrors", Version: "v0.0.0-20200804184101-5ec99f83aff1", Relationship: ftypes.RelationshipIndirect, }, } GoModUnreplacedDeps = ftypes.Dependencies{ { ID: "github.com/org/repo", DependsOn: []string{ "github.com/aquasecurity/go-dep-parser@v0.0.0-20211110174639-8257534ffed3", }, }, } // execute go mod tidy in replaced-with-version folder GoModReplacedWithVersion = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20220406074731-71021a481237", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20220406074731-71021a481237", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "golang.org/x/xerrors@v0.0.0-20200804184101-5ec99f83aff1", Name: "golang.org/x/xerrors", Version: "v0.0.0-20200804184101-5ec99f83aff1", Relationship: ftypes.RelationshipIndirect, }, } GoModReplacedWithVersionDeps = ftypes.Dependencies{ { ID: "github.com/org/repo", DependsOn: []string{ "github.com/aquasecurity/go-dep-parser@v0.0.0-20220406074731-71021a481237", }, }, } // execute go mod tidy in replaced-with-version-mismatch folder GoModReplacedWithVersionMismatch = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211224170007-df43bca6b6ff", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211224170007-df43bca6b6ff", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "golang.org/x/xerrors@v0.0.0-20200804184101-5ec99f83aff1", Name: "golang.org/x/xerrors", Version: "v0.0.0-20200804184101-5ec99f83aff1", Relationship: ftypes.RelationshipIndirect, }, { ID: "gopkg.in/yaml.v3@v3.0.0-20210107192922-496545a6307b", Name: "gopkg.in/yaml.v3", Version: "v3.0.0-20210107192922-496545a6307b", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/go-yaml/yaml", }, }, }, } // execute go mod tidy in replaced-with-local-path folder GoModReplacedWithLocalPath = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211224170007-df43bca6b6ff", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211224170007-df43bca6b6ff", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "gopkg.in/yaml.v3@v3.0.0-20210107192922-496545a6307b", Name: "gopkg.in/yaml.v3", Version: "v3.0.0-20210107192922-496545a6307b", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/go-yaml/yaml", }, }, }, } // execute go mod tidy in replaced-with-local-path-and-version folder GoModReplacedWithLocalPathAndVersion = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211224170007-df43bca6b6ff", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211224170007-df43bca6b6ff", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "gopkg.in/yaml.v3@v3.0.0-20210107192922-496545a6307b", Name: "gopkg.in/yaml.v3", Version: "v3.0.0-20210107192922-496545a6307b", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/go-yaml/yaml", }, }, }, } // execute go mod tidy in replaced-with-local-path-and-version-mismatch folder GoModReplacedWithLocalPathAndVersionMismatch = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211224170007-df43bca6b6ff", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211224170007-df43bca6b6ff", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, { ID: "golang.org/x/xerrors@v0.0.0-20200804184101-5ec99f83aff1", Name: "golang.org/x/xerrors", Version: "v0.0.0-20200804184101-5ec99f83aff1", Relationship: ftypes.RelationshipIndirect, }, { ID: "gopkg.in/yaml.v3@v3.0.0-20210107192922-496545a6307b", Name: "gopkg.in/yaml.v3", Version: "v3.0.0-20210107192922-496545a6307b", Relationship: ftypes.RelationshipIndirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/go-yaml/yaml", }, }, }, } // execute go mod tidy in go116 folder GoMod116 = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211224170007-df43bca6b6ff", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211224170007-df43bca6b6ff", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, } // execute go mod tidy in no-go-version folder GoModNoGoVersion = []ftypes.Package{ { ID: "github.com/org/repo", Name: "github.com/org/repo", Relationship: ftypes.RelationshipRoot, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/org/repo", }, }, }, { ID: "github.com/aquasecurity/go-dep-parser@v0.0.0-20211224170007-df43bca6b6ff", Name: "github.com/aquasecurity/go-dep-parser", Version: "v0.0.0-20211224170007-df43bca6b6ff", Relationship: ftypes.RelationshipDirect, ExternalReferences: []ftypes.ExternalRef{ { Type: ftypes.RefVCS, URL: "https://github.com/aquasecurity/go-dep-parser", }, }, }, } )
Functions ¶
This section is empty.
Types ¶
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
func (*Parser) GetExternalRefs ¶
func (p *Parser) GetExternalRefs(path string) []ftypes.ExternalRef
func (*Parser) Parse ¶
func (p *Parser) Parse(_ context.Context, r xio.ReadSeekerAt) ([]ftypes.Package, []ftypes.Dependency, bool, error)
Parse parses a go.mod file and returns the packages, the dependencies and whether indirect requirements were skipped. They are skipped for modules below Go 1.17 ("1.16" is assumed when the `go` directive is omitted), whose go.mod is not required to list every transitive dependency. For those the caller should merge go.sum to get the full set.
Click to show internal directories.
Click to hide internal directories.