Inject base image/config instead of os/tag (#262)

Author: kylekthompson

cmd/rwx/resolve.go

@@ -8,7 +8,7 @@ import (
 )
 
 var resolveCmd = &cobra.Command{
-	Short: "Resolve and add versions for base layers and RWX packages",
+	Short: "Resolve and add versions for base images and RWX packages",
 	Use:   "resolve [flags] [files...]",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		if len(args) > 0 {
@@ -29,19 +29,13 @@ var resolveCmd = &cobra.Command{
 }
 
 var (
-	resolveBaseOs   string
-	resolveBaseTag  string
-	resolveBaseArch string
-
 	resolveBaseCmd = &cobra.Command{
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return resolveBase(args)
 		},
-		Short: "Add a base layer to RWX run configurations that do not have one",
-		Long: "Add a base layer to RWX run configurations that do not have one.\n" +
-			"Updates all top-level YAML files in .rwx that are missing a 'base' to include one.\n" +
-			"The best match will be found based on the provided flags. If no flags are provided,\n" +
-			"it will use the current default base layer.",
+		Short: "Add a base image to RWX run configurations that do not have one",
+		Long: "Add a base image to RWX run configurations that do not have one.\n" +
+			"Updates all top-level YAML files in .rwx that are missing a 'base' to include one.",
 		Use: "base [flags] [files...]",
 	}
 
@@ -58,7 +52,7 @@ var (
 )
 
 func resolveBase(files []string) error {
-	base, err := service.ResolveBase(cli.ResolveBaseConfig{
+	base, err := service.InsertBase(cli.InsertBaseConfig{
 		Files:        files,
 		RwxDirectory: RwxDirectory,
 	})
@@ -81,9 +75,6 @@ func resolvePackages(files []string) error {
 }
 
 func init() {
-	resolveBaseCmd.Flags().StringVar(&resolveBaseOs, "os", "", "target operating system")
-	resolveBaseCmd.Flags().StringVar(&resolveBaseTag, "tag", "", "target base layer tag")
-	resolveBaseCmd.Flags().StringVar(&resolveBaseArch, "arch", "", "target architecture")
 	addRwxDirFlag(resolveBaseCmd)
 
 	addRwxDirFlag(resolvePackagesCmd)

cmd/rwx/update.go

@@ -33,9 +33,9 @@ var (
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return updateBase(args)
 		},
-		Short: "Update all base layers to their latest (minor) version",
-		Long: "Update all base layers to their latest (minor) version.\n" +
-			"Takes a list of files as arguments, or updates all toplevel YAML files in .rwx if no files are given.",
+		Short: "Add a base image to RWX run configurations that do not have one",
+		Long: "Add a base image to RWX run configurations that do not have one.\n" +
+			"Updates all top-level YAML files in .rwx that are missing a 'base' to include one.",
 		Use: "base [flags] [files...]",
 	}
 
@@ -51,7 +51,7 @@ var (
 )
 
 func updateBase(files []string) error {
-	_, err := service.UpdateBase(cli.UpdateBaseConfig{
+	_, err := service.InsertBase(cli.InsertBaseConfig{
 		Files:        files,
 		RwxDirectory: RwxDirectory,
 	})

go.mod

@@ -19,7 +19,6 @@ require (
 	github.com/spf13/cobra v1.10.1
 	github.com/stretchr/testify v1.11.1
 	golang.org/x/crypto v0.45.0
-	golang.org/x/sync v0.18.0
 	golang.org/x/term v0.37.0
 )
 

go.sum

@@ -247,8 +247,6 @@ golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU=
 golang.org/x/oauth2 v0.30.0 h1:dnDm7JmhM45NNpd8FDDeLhK6FwqbOf4MLCM9zb1BOHI=
 golang.org/x/oauth2 v0.30.0/go.mod h1:B++QgG3ZKulg6sRPGD/mqlHQs5rB3Ml9erfeDY7xKlU=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I=
-golang.org/x/sync v0.18.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
 golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=

internal/api/client.go

@@ -474,16 +474,11 @@ func (c Client) GetPackageVersions() (*PackageVersionsResult, error) {
 	return &respBody, nil
 }
 
-func (c Client) ResolveBaseLayer(cfg ResolveBaseLayerConfig) (ResolveBaseLayerResult, error) {
-	endpoint := "/mint/api/base_layers/resolve"
-	result := ResolveBaseLayerResult{}
+func (c Client) GetDefaultBase() (DefaultBaseResult, error) {
+	endpoint := "/mint/api/base/default"
+	result := DefaultBaseResult{}
 
-	encodedBody, err := json.Marshal(cfg)
-	if err != nil {
-		return result, errors.Wrap(err, "unable to encode as JSON")
-	}
-
-	req, err := http.NewRequest(http.MethodPost, endpoint, bytes.NewBuffer(encodedBody))
+	req, err := http.NewRequest(http.MethodGet, endpoint, nil)
 	if err != nil {
 		return result, errors.Wrap(err, "unable to create new HTTP request")
 	}

internal/api/client_test.go

@@ -285,16 +285,13 @@ func TestAPIClient_GetDispatch(t *testing.T) {
 	})
 }
 
-func TestAPIClient_ResolveBaseLayer(t *testing.T) {
+func TestAPIClient_GetDefaultBase(t *testing.T) {
 	t.Run("builds the request and parses the response", func(t *testing.T) {
 		roundTrip := func(req *http.Request) (*http.Response, error) {
-			require.Equal(t, "/mint/api/base_layers/resolve", req.URL.Path)
-			require.Equal(t, http.MethodPost, req.Method)
-			reqBody, err := io.ReadAll(req.Body)
-			require.NoError(t, err)
-			require.Contains(t, string(reqBody), "gentoo 99")
+			require.Equal(t, "/mint/api/base/default", req.URL.Path)
+			require.Equal(t, http.MethodGet, req.Method)
 
-			body := `{"os": "gentoo 99", "tag": "1.2", "arch": "quantum"}`
+			body := `{"image": "ubuntu:24.04", "config": "rwx/base 1.0.0", "arch": "x86_64"}`
 			return &http.Response{
 				Status:     "200 OK",
 				StatusCode: 200,
@@ -304,15 +301,11 @@ func TestAPIClient_ResolveBaseLayer(t *testing.T) {
 
 		c := api.NewClientWithRoundTrip(roundTrip)
 
-		resolveConfig := api.ResolveBaseLayerConfig{
-			Os: "gentoo 99",
-		}
-
-		result, err := c.ResolveBaseLayer(resolveConfig)
+		result, err := c.GetDefaultBase()
 		require.NoError(t, err)
-		require.Equal(t, "gentoo 99", result.Os)
-		require.Equal(t, "1.2", result.Tag)
-		require.Equal(t, "quantum", result.Arch)
+		require.Equal(t, "ubuntu:24.04", result.Image)
+		require.Equal(t, "rwx/base 1.0.0", result.Config)
+		require.Equal(t, "x86_64", result.Arch)
 	})
 }
 

internal/api/config.go

@@ -225,15 +225,12 @@ type PackageVersionsResult struct {
 	LatestMinor map[string]map[string]string `json:"latest_minor"`
 }
 
-type resolveBaseLayerSpec struct {
-	Os   string `json:"os,omitempty"`
-	Tag  string `json:"tag,omitempty"`
-	Arch string `json:"arch,omitempty"`
+type DefaultBaseResult struct {
+	Image  string `json:"image,omitempty"`
+	Config string `json:"config,omitempty"`
+	Arch   string `json:"arch,omitempty"`
 }
 
-type ResolveBaseLayerConfig = resolveBaseLayerSpec
-type ResolveBaseLayerResult = resolveBaseLayerSpec
-
 type StartImagePushConfig struct {
 	TaskID      string                          `json:"task_id"`
 	Image       StartImagePushConfigImage       `json:"image"`

internal/cli/config.go

@@ -4,13 +4,11 @@ import (
 	"io"
 	"time"
 
-	"github.com/Masterminds/semver/v3"
 	"github.com/distribution/reference"
 	"github.com/rwx-cloud/cli/internal/accesstoken"
 	"github.com/rwx-cloud/cli/internal/api"
 	"github.com/rwx-cloud/cli/internal/docker"
 	"github.com/rwx-cloud/cli/internal/errors"
-	"github.com/rwx-cloud/cli/internal/versions"
 )
 
 type Config struct {
@@ -187,15 +185,6 @@ func (c SetSecretsInVaultConfig) Validate() error {
 	return nil
 }
 
-type UpdateBaseConfig struct {
-	RwxDirectory string
-	Files        []string
-}
-
-func (c UpdateBaseConfig) Validate() error {
-	return nil
-}
-
 type UpdatePackagesConfig struct {
 	RwxDirectory             string
 	Files                    []string
@@ -210,97 +199,33 @@ func (c UpdatePackagesConfig) Validate() error {
 	return nil
 }
 
-type ResolveBaseConfig struct {
+type InsertBaseConfig struct {
 	RwxDirectory string
 	Files        []string
-	Os           string
-	Tag          string
-	Arch         string
 }
 
-func (c ResolveBaseConfig) Validate() error {
+func (c InsertBaseConfig) Validate() error {
 	return nil
 }
 
-type BaseLayerSpec struct {
-	Os   string `yaml:"os"`
-	Tag  string `yaml:"tag"`
-	Arch string `yaml:"arch"`
-}
-
-func (b BaseLayerSpec) TagVersion() *semver.Version {
-	if b.Tag == "" {
-		return versions.EmptyVersion
-	}
-
-	return semver.MustParse(b.Tag)
-}
-
-func (b BaseLayerSpec) Equal(other BaseLayerSpec) bool {
-	if b.Os != other.Os {
-		return false
-	}
-
-	if b.Tag != other.Tag {
-		return false
-	}
-
-	arch1 := b.Arch
-	if arch1 == "" {
-		arch1 = DefaultArch
-	}
-	arch2 := other.Arch
-	if arch2 == "" {
-		arch2 = DefaultArch
-	}
-	if arch1 != arch2 {
-		return false
-	}
-
-	return true
-}
-
-func (b BaseLayerSpec) Merge(other BaseLayerSpec) BaseLayerSpec {
-	os := b.Os
-	if other.Os != "" {
-		os = other.Os
-	}
-
-	tag := b.Tag
-	if other.Tag != "" {
-		tag = other.Tag
-	}
-
-	arch := b.Arch
-	if other.Arch != "" {
-		arch = other.Arch
-	}
-
-	return BaseLayerSpec{
-		Os:   os,
-		Tag:  tag,
-		Arch: arch,
-	}
+type BaseSpec struct {
+	Image  string `yaml:"image"`
+	Config string `yaml:"config"`
+	Arch   string `yaml:"arch"`
 }
 
 type BaseLayerRunFile struct {
-	Spec         BaseLayerSpec
-	OriginalBase BaseLayerSpec
-	ResolvedBase BaseLayerSpec
+	ResolvedBase BaseSpec
 	OriginalPath string
 	Error        error
 }
 
-func (rf BaseLayerRunFile) HasChanges() bool {
-	return !rf.OriginalBase.Equal(rf.ResolvedBase)
-}
-
-type ResolveBaseResult struct {
+type InsertDefaultBaseResult struct {
 	ErroredRunFiles []BaseLayerRunFile
 	UpdatedRunFiles []BaseLayerRunFile
 }
 
-func (r ResolveBaseResult) HasChanges() bool {
+func (r InsertDefaultBaseResult) HasChanges() bool {
 	return len(r.ErroredRunFiles) > 0 || len(r.UpdatedRunFiles) > 0
 }
 

internal/cli/interfaces.go

@@ -19,7 +19,7 @@ type APIClient interface {
 	Whoami() (*api.WhoamiResult, error)
 	SetSecretsInVault(api.SetSecretsInVaultConfig) (*api.SetSecretsInVaultResult, error)
 	GetPackageVersions() (*api.PackageVersionsResult, error)
-	ResolveBaseLayer(api.ResolveBaseLayerConfig) (api.ResolveBaseLayerResult, error)
+	GetDefaultBase() (api.DefaultBaseResult, error)
 	StartImagePush(cfg api.StartImagePushConfig) (api.StartImagePushResult, error)
 	ImagePushStatus(pushID string) (api.ImagePushStatusResult, error)
 	TaskStatus(api.TaskStatusConfig) (api.TaskStatusResult, error)