[teleport-update] common MakeURL with ability to override BaseURL (#51383)

* Add templates for client tools auto-update download url

* Change to base url setting by env

MakeURL moved to common function to be general for both, agent and client tools

* Reuse MakeURL moved to common package

* Fix linter warning

* Add common env variable to override base url

* Remove template from interface

* Make template exported
Change a stale comment

* Remove unused code

Author: vapopov

lib/autoupdate/agent/config.go

@@ -19,7 +19,6 @@
 package agent
 
 import (
-	"encoding/json"
 	"errors"
 	"fmt"
 	"io/fs"
@@ -30,6 +29,8 @@ import (
 	"github.com/google/renameio/v2"
 	"github.com/gravitational/trace"
 	"gopkg.in/yaml.v3"
+
+	"github.com/gravitational/teleport/lib/autoupdate"
 )
 
 const (
@@ -59,8 +60,8 @@ type UpdateSpec struct {
 	Proxy string `yaml:"proxy"`
 	// Group specifies the update group identifier for the agent.
 	Group string `yaml:"group,omitempty"`
-	// URLTemplate for the Teleport tgz download URL.
-	URLTemplate string `yaml:"url_template,omitempty"`
+	// BaseURL is CDN base URL used for the Teleport tgz download URL.
+	BaseURL string `yaml:"base_url,omitempty"`
 	// Enabled controls whether auto-updates are enabled.
 	Enabled bool `yaml:"enabled"`
 	// Pinned controls whether the active_version is pinned.
@@ -84,13 +85,13 @@ type Revision struct {
 	// Version is the version of Teleport.
 	Version string `yaml:"version" json:"version"`
 	// Flags describe the edition of Teleport.
-	Flags InstallFlags `yaml:"flags,flow,omitempty" json:"flags,omitempty"`
+	Flags autoupdate.InstallFlags `yaml:"flags,flow,omitempty" json:"flags,omitempty"`
 }
 
 // NewRevision create a Revision.
 // If version is not set, no flags are returned.
 // This ensures that all Revisions without versions are zero-valued.
-func NewRevision(version string, flags InstallFlags) Revision {
+func NewRevision(version string, flags autoupdate.InstallFlags) Revision {
 	if version != "" {
 		return Revision{
 			Version: version,
@@ -113,16 +114,16 @@ func NewRevisionFromDir(dir string) (Revision, error) {
 	}
 	switch flags := parts[1:]; len(flags) {
 	case 2:
-		if flags[1] != FlagFIPS.DirFlag() {
+		if flags[1] != autoupdate.FlagFIPS.DirFlag() {
 			break
 		}
-		out.Flags |= FlagFIPS
+		out.Flags |= autoupdate.FlagFIPS
 		fallthrough
 	case 1:
-		if flags[0] != FlagEnterprise.DirFlag() {
+		if flags[0] != autoupdate.FlagEnterprise.DirFlag() {
 			break
 		}
-		out.Flags |= FlagEnterprise
+		out.Flags |= autoupdate.FlagEnterprise
 		fallthrough
 	case 0:
 		return out, nil
@@ -135,11 +136,11 @@ func (r Revision) Dir() string {
 	// Do not change the order of these statements.
 	// Otherwise, installed versions will no longer match update.yaml.
 	var suffix string
-	if r.Flags&(FlagEnterprise|FlagFIPS) != 0 {
-		suffix += "_" + FlagEnterprise.DirFlag()
+	if r.Flags&(autoupdate.FlagEnterprise|autoupdate.FlagFIPS) != 0 {
+		suffix += "_" + autoupdate.FlagEnterprise.DirFlag()
 	}
-	if r.Flags&FlagFIPS != 0 {
-		suffix += "_" + FlagFIPS.DirFlag()
+	if r.Flags&autoupdate.FlagFIPS != 0 {
+		suffix += "_" + autoupdate.FlagFIPS.DirFlag()
 	}
 	return r.Version + suffix
 }
@@ -203,16 +204,16 @@ func validateConfigSpec(spec *UpdateSpec, override OverrideConfig) error {
 	if override.Group != "" {
 		spec.Group = override.Group
 	}
-	switch override.URLTemplate {
+	switch override.BaseURL {
 	case "":
 	case "default":
-		spec.URLTemplate = ""
+		spec.BaseURL = ""
 	default:
-		spec.URLTemplate = override.URLTemplate
+		spec.BaseURL = override.BaseURL
 	}
-	if spec.URLTemplate != "" &&
-		!strings.HasPrefix(strings.ToLower(spec.URLTemplate), "https://") {
-		return trace.Errorf("Teleport download URL must use TLS (https://)")
+	if spec.BaseURL != "" &&
+		!strings.HasPrefix(strings.ToLower(spec.BaseURL), "https://") {
+		return trace.Errorf("Teleport download base URL %s must use TLS (https://)", spec.BaseURL)
 	}
 	if override.Enabled {
 		spec.Enabled = true
@@ -239,89 +240,3 @@ type FindResp struct {
 	// Jitter duration before an automated install
 	Jitter time.Duration `yaml:"jitter"`
 }
-
-// InstallFlags sets flags for the Teleport installation
-type InstallFlags int
-
-const (
-	// FlagEnterprise installs enterprise Teleport
-	FlagEnterprise InstallFlags = 1 << iota
-	// FlagFIPS installs FIPS Teleport
-	FlagFIPS
-)
-
-// NewInstallFlagsFromStrings returns InstallFlags given a slice of human-readable strings.
-func NewInstallFlagsFromStrings(s []string) InstallFlags {
-	var out InstallFlags
-	for _, f := range s {
-		for _, flag := range []InstallFlags{
-			FlagEnterprise,
-			FlagFIPS,
-		} {
-			if f == flag.String() {
-				out |= flag
-			}
-		}
-	}
-	return out
-}
-
-// Strings converts InstallFlags to a slice of human-readable strings.
-func (i InstallFlags) Strings() []string {
-	var out []string
-	for _, flag := range []InstallFlags{
-		FlagEnterprise,
-		FlagFIPS,
-	} {
-		if i&flag != 0 {
-			out = append(out, flag.String())
-		}
-	}
-	return out
-}
-
-// String returns the string representation of a single InstallFlag flag, or "Unknown".
-func (i InstallFlags) String() string {
-	switch i {
-	case 0:
-		return ""
-	case FlagEnterprise:
-		return "Enterprise"
-	case FlagFIPS:
-		return "FIPS"
-	}
-	return "Unknown"
-}
-
-// DirFlag returns the directory path representation of a single InstallFlag flag, or "unknown".
-func (i InstallFlags) DirFlag() string {
-	switch i {
-	case 0:
-		return ""
-	case FlagEnterprise:
-		return "ent"
-	case FlagFIPS:
-		return "fips"
-	}
-	return "unknown"
-}
-
-func (i InstallFlags) MarshalYAML() (any, error) {
-	return i.Strings(), nil
-}
-
-func (i InstallFlags) MarshalJSON() ([]byte, error) {
-	return json.Marshal(i.Strings())
-}
-
-func (i *InstallFlags) UnmarshalYAML(n *yaml.Node) error {
-	var s []string
-	if err := n.Decode(&s); err != nil {
-		return trace.Wrap(err)
-	}
-	if i == nil {
-		return trace.BadParameter("nil install flags while parsing YAML")
-	}
-	*i = NewInstallFlagsFromStrings(s)
-	return nil
-}

lib/autoupdate/agent/config_test.go

@@ -22,7 +22,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
-	"gopkg.in/yaml.v3"
+
+	"github.com/gravitational/teleport/lib/autoupdate"
 )
 
 func TestNewRevisionFromDir(t *testing.T) {
@@ -46,15 +47,15 @@ func TestNewRevisionFromDir(t *testing.T) {
 			dir:  "1.2.3_ent_fips",
 			rev: Revision{
 				Version: "1.2.3",
-				Flags:   FlagEnterprise | FlagFIPS,
+				Flags:   autoupdate.FlagEnterprise | autoupdate.FlagFIPS,
 			},
 		},
 		{
 			name: "ent",
 			dir:  "1.2.3_ent",
 			rev: Revision{
 				Version: "1.2.3",
-				Flags:   FlagEnterprise,
+				Flags:   autoupdate.FlagEnterprise,
 			},
 		},
 		{
@@ -124,72 +125,3 @@ func TestNewRevisionFromDir(t *testing.T) {
 		})
 	}
 }
-
-func TestInstallFlagsYAML(t *testing.T) {
-	t.Parallel()
-
-	for _, tt := range []struct {
-		name     string
-		yaml     string
-		flags    InstallFlags
-		skipYAML bool
-	}{
-		{
-			name:  "both",
-			yaml:  `["Enterprise", "FIPS"]`,
-			flags: FlagEnterprise | FlagFIPS,
-		},
-		{
-			name:     "order",
-			yaml:     `["FIPS", "Enterprise"]`,
-			flags:    FlagEnterprise | FlagFIPS,
-			skipYAML: true,
-		},
-		{
-			name:     "extra",
-			yaml:     `["FIPS", "Enterprise", "bad"]`,
-			flags:    FlagEnterprise | FlagFIPS,
-			skipYAML: true,
-		},
-		{
-			name:  "enterprise",
-			yaml:  `["Enterprise"]`,
-			flags: FlagEnterprise,
-		},
-		{
-			name:  "fips",
-			yaml:  `["FIPS"]`,
-			flags: FlagFIPS,
-		},
-		{
-			name: "empty",
-			yaml: `[]`,
-		},
-		{
-			name:     "nil",
-			skipYAML: true,
-		},
-	} {
-		t.Run(tt.name, func(t *testing.T) {
-			var flags InstallFlags
-			err := yaml.Unmarshal([]byte(tt.yaml), &flags)
-			require.NoError(t, err)
-			require.Equal(t, tt.flags, flags)
-
-			// verify test YAML
-			var v any
-			err = yaml.Unmarshal([]byte(tt.yaml), &v)
-			require.NoError(t, err)
-			res, err := yaml.Marshal(v)
-			require.NoError(t, err)
-
-			// compare verified YAML to flag output
-			out, err := yaml.Marshal(flags)
-			require.NoError(t, err)
-
-			if !tt.skipYAML {
-				require.Equal(t, string(res), string(out))
-			}
-		})
-	}
-}

lib/autoupdate/agent/installer.go

@@ -31,15 +31,14 @@ import (
 	"os"
 	"path"
 	"path/filepath"
-	"runtime"
 	"syscall"
-	"text/template"
 	"time"
 
 	"github.com/google/renameio/v2"
 	"github.com/gravitational/trace"
 
 	"github.com/gravitational/teleport"
+	"github.com/gravitational/teleport/lib/autoupdate"
 	"github.com/gravitational/teleport/lib/utils"
 )
 
@@ -89,6 +88,8 @@ type LocalInstaller struct {
 	// ValidateBinary returns true if a file is a linkable binary, or
 	// false if a file should not be linked.
 	ValidateBinary func(ctx context.Context, path string) (bool, error)
+	// Template is download URI Template of Teleport packages.
+	Template string
 }
 
 // Remove a Teleport version directory from InstallDir.
@@ -127,15 +128,15 @@ func (li *LocalInstaller) Remove(ctx context.Context, rev Revision) error {
 // Install a Teleport version directory in InstallDir.
 // This function is idempotent.
 // See Installer interface for additional specs.
-func (li *LocalInstaller) Install(ctx context.Context, rev Revision, template string) (err error) {
+func (li *LocalInstaller) Install(ctx context.Context, rev Revision, baseURL string) (err error) {
 	versionDir, err := li.revisionDir(rev)
 	if err != nil {
 		return trace.Wrap(err)
 	}
 	sumPath := filepath.Join(versionDir, checksumType)
 
-	// generate download URI from template
-	uri, err := makeURL(template, rev)
+	// generate download URI from Template
+	uri, err := autoupdate.MakeURL(li.Template, baseURL, autoupdate.DefaultPackage, rev.Version, rev.Flags)
 	if err != nil {
 		return trace.Wrap(err)
 	}
@@ -229,30 +230,6 @@ func (li *LocalInstaller) Install(ctx context.Context, rev Revision, template st
 	return nil
 }
 
-// makeURL to download the Teleport tgz.
-func makeURL(uriTmpl string, rev Revision) (string, error) {
-	tmpl, err := template.New("uri").Parse(uriTmpl)
-	if err != nil {
-		return "", trace.Wrap(err)
-	}
-	var uriBuf bytes.Buffer
-	params := struct {
-		OS, Version, Arch string
-		FIPS, Enterprise  bool
-	}{
-		OS:         runtime.GOOS,
-		Version:    rev.Version,
-		Arch:       runtime.GOARCH,
-		FIPS:       rev.Flags&FlagFIPS != 0,
-		Enterprise: rev.Flags&(FlagEnterprise|FlagFIPS) != 0,
-	}
-	err = tmpl.Execute(&uriBuf, params)
-	if err != nil {
-		return "", trace.Wrap(err)
-	}
-	return uriBuf.String(), nil
-}
-
 // readChecksum from the version directory.
 func readChecksum(path string) ([]byte, error) {
 	f, err := os.Open(path)
@@ -354,7 +331,7 @@ func (li *LocalInstaller) download(ctx context.Context, w io.Writer, max int64,
 	return shaReader.Sum(nil), nil
 }
 
-func (li *LocalInstaller) extract(ctx context.Context, dstDir string, src io.Reader, max int64, flags InstallFlags) error {
+func (li *LocalInstaller) extract(ctx context.Context, dstDir string, src io.Reader, max int64, flags autoupdate.InstallFlags) error {
 	if err := os.MkdirAll(dstDir, systemDirMode); err != nil {
 		return trace.Wrap(err)
 	}
@@ -372,7 +349,7 @@ func (li *LocalInstaller) extract(ctx context.Context, dstDir string, src io.Rea
 	}
 	li.Log.InfoContext(ctx, "Extracting Teleport tarball.", "path", dstDir, "size", max)
 
-	err = utils.Extract(zr, dstDir, tgzExtractPaths(flags&(FlagEnterprise|FlagFIPS) != 0)...)
+	err = utils.Extract(zr, dstDir, tgzExtractPaths(flags&(autoupdate.FlagEnterprise|autoupdate.FlagFIPS) != 0)...)
 	if err != nil {
 		return trace.Wrap(err)
 	}