steampipe/pkg/modinstaller/resolved_mod_ref.go

package modinstaller

import (
	"github.com/Masterminds/semver/v3"
	"github.com/go-git/go-git/v5/plumbing"
	"github.com/turbot/steampipe/pkg/steampipeconfig/modconfig"
	"github.com/turbot/steampipe/pkg/versionhelpers"
)

// ResolvedModRef is a struct to represent a resolved mod git reference
type ResolvedModRef struct {
	// the FQN of the mod - also the Git URL of the mod repo
	Name string
	// the mod version
	Version *semver.Version
	// the vestion constraint
	Constraint *versionhelpers.Constraints
	// the Git branch/tag
	GitReference plumbing.ReferenceName
	// the file path for local mods
	FilePath string
}

func NewResolvedModRef(requiredModVersion *modconfig.ModVersionConstraint, version *semver.Version) (*ResolvedModRef, error) {
	res := &ResolvedModRef{
		Name:       requiredModVersion.Name,
		Version:    version,
		Constraint: requiredModVersion.Constraint,
		// this may be empty strings
		FilePath: requiredModVersion.FilePath,
	}
	if res.FilePath == "" {
		res.setGitReference()
	}

	return res, nil
}

func (r *ResolvedModRef) setGitReference() {
	// TODO handle branches

	// NOTE: use the original version string - this will be the tag name
	r.GitReference = plumbing.NewTagReferenceName(r.Version.Original())
}

// DependencyPath returns name in the format <dependency name>@v<dependencyVersion>
func (r *ResolvedModRef) DependencyPath() string {
	return modconfig.BuildModDependencyPath(r.Name, r.Version)
}