deprecate extended images on dev in favour of build section (#2269)

* feat: deprecate extended images on dev Signed-off-by: Javier López Barba <javier@okteto.com> * refactor: change depreciation message Signed-off-by: Javier López Barba <javier@okteto.com>
okteto · Mar 7, 2022 · f49b132 · f49b132
1 parent 6617c18
commit f49b132
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 36 deletions.
diff --git a/cmd/utils/dev_test.go b/cmd/utils/dev_test.go
@@ -46,7 +46,7 @@ func Test_LoadManifestOrDefault(t *testing.T) {
 			expectErr:  false,
 			dev: &model.Dev{
 				Name: "loaded",
-				Image: &model.BuildInfo{
+				Image: &model.DevBuildInfo{
 					Name: "okteto/test:1.0",
 				},
 				Sync: model.Sync{

diff --git a/pkg/cmd/doctor/run.go b/pkg/cmd/doctor/run.go
@@ -161,8 +161,8 @@ func generateManifestFile(devPath string) (string, error) {
 	}
 
 	dev := &model.Dev{
-		Image:       &model.BuildInfo{},
-		Push:        &model.BuildInfo{},
+		Image:       &model.DevBuildInfo{},
+		Push:        &model.DevBuildInfo{},
 		Environment: make([]model.EnvVar, 0),
 		Secrets:     make([]model.Secret, 0),
 		Forward:     make([]model.Forward, 0),

diff --git a/pkg/cmd/doctor/run_test.go b/pkg/cmd/doctor/run_test.go
@@ -34,19 +34,19 @@ func Test_generateManifestFile(t *testing.T) {
 			name: "basic",
 			dev: &model.Dev{
 				Name:    "dev",
-				Image:   &model.BuildInfo{Name: "okteto/dev"},
+				Image:   &model.DevBuildInfo{Name: "okteto/dev"},
 				Command: model.Command{Values: []string{"bash"}},
 			},
 		},
 		{
 			name: "with-services",
 			dev: &model.Dev{
 				Name:    "dev",
-				Image:   &model.BuildInfo{Name: "okteto/dev"},
+				Image:   &model.DevBuildInfo{Name: "okteto/dev"},
 				Command: model.Command{Values: []string{"bash"}},
 				Services: []*model.Dev{{
 					Name:    "svc",
-					Image:   &model.BuildInfo{Name: "okteto/svc"},
+					Image:   &model.DevBuildInfo{Name: "okteto/svc"},
 					Command: model.Command{Values: []string{"bash"}},
 				}, {
 					Name:        "svc2",

diff --git a/pkg/k8s/apps/crud_test.go b/pkg/k8s/apps/crud_test.go
@@ -69,7 +69,7 @@ func TestGetStatefulset(t *testing.T) {
 	dev := &model.Dev{
 		Name:      "test",
 		Namespace: "test",
-		Image: &model.BuildInfo{
+		Image: &model.DevBuildInfo{
 			Name: "image",
 		},
 		PersistentVolumeInfo: &model.PersistentVolumeInfo{
@@ -114,7 +114,7 @@ func TestGetDeployment(t *testing.T) {
 	dev := &model.Dev{
 		Name:      "test",
 		Namespace: "test",
-		Image: &model.BuildInfo{
+		Image: &model.DevBuildInfo{
 			Name: "image",
 		},
 		PersistentVolumeInfo: &model.PersistentVolumeInfo{

diff --git a/pkg/linguist/dev.go b/pkg/linguist/dev.go
@@ -304,7 +304,7 @@ func GetDevDefaults(language, workdir string) (*model.Dev, error) {
 	vals := languageDefaults[language]
 
 	dev := &model.Dev{
-		Image: &model.BuildInfo{
+		Image: &model.DevBuildInfo{
 			Name: vals.image,
 		},
 		Command: model.Command{

diff --git a/pkg/model/dev.go b/pkg/model/dev.go
@@ -58,8 +58,8 @@ type Dev struct {
 	Namespace            string             `json:"namespace,omitempty" yaml:"namespace,omitempty"`
 	Container            string             `json:"container,omitempty" yaml:"container,omitempty"`
 	EmptyImage           bool               `json:"-" yaml:"-"`
-	Image                *BuildInfo         `json:"image,omitempty" yaml:"image,omitempty"`
-	Push                 *BuildInfo         `json:"-" yaml:"push,omitempty"`
+	Image                *DevBuildInfo      `json:"image,omitempty" yaml:"image,omitempty"`
+	Push                 *DevBuildInfo      `json:"-" yaml:"push,omitempty"`
 	ImagePullPolicy      apiv1.PullPolicy   `json:"imagePullPolicy,omitempty" yaml:"imagePullPolicy,omitempty"`
 	Secrets              []Secret           `json:"secrets,omitempty" yaml:"secrets,omitempty"`
 	Command              Command            `json:"command,omitempty" yaml:"command,omitempty"`
@@ -125,6 +125,9 @@ type BuildInfo struct {
 	Image      string      `yaml:"image,omitempty"`
 }
 
+// DevBuildInfo throws a warning if it's not single line
+type DevBuildInfo BuildInfo
+
 // Volume represents a volume in the development container
 type Volume struct {
 	LocalPath  string
@@ -302,8 +305,8 @@ func Get(devPath string) (*Manifest, error) {
 }
 func NewDev() *Dev {
 	return &Dev{
-		Image:       &BuildInfo{},
-		Push:        &BuildInfo{},
+		Image:       &DevBuildInfo{},
+		Push:        &DevBuildInfo{},
 		Environment: make(Environment, 0),
 		Secrets:     make([]Secret, 0),
 		Forward:     make([]Forward, 0),
@@ -428,7 +431,7 @@ func (dev *Dev) loadSelector() error {
 func (dev *Dev) loadImage() error {
 	var err error
 	if dev.Image == nil {
-		dev.Image = &BuildInfo{}
+		dev.Image = &DevBuildInfo{}
 	}
 	if len(dev.Image.Name) > 0 {
 		dev.Image.Name, err = ExpandEnv(dev.Image.Name)
@@ -551,6 +554,18 @@ func (dev *Dev) SetDefaults() error {
 	return nil
 }
 
+func (build *DevBuildInfo) setBuildDefaults() {
+	if build == nil {
+		build = &DevBuildInfo{}
+	}
+	if build.Context == "" {
+		build.Context = "."
+	}
+	if _, err := url.ParseRequestURI(build.Context); err != nil && build.Dockerfile == "" {
+		build.Dockerfile = "Dockerfile"
+	}
+}
+
 func (build *BuildInfo) setBuildDefaults() {
 	if build == nil {
 		build = &BuildInfo{}

diff --git a/pkg/model/dev_test.go b/pkg/model/dev_test.go
@@ -506,8 +506,8 @@ func TestDev_validateName(t *testing.T) {
 			dev := &Dev{
 				Name:            tt.devName,
 				ImagePullPolicy: apiv1.PullAlways,
-				Image:           &BuildInfo{},
-				Push:            &BuildInfo{},
+				Image:           &DevBuildInfo{},
+				Push:            &DevBuildInfo{},
 				Sync: Sync{
 					Folders: []SyncFolder{
 						{
@@ -533,15 +533,15 @@ func TestDev_readImageContext(t *testing.T) {
 	tests := []struct {
 		name     string
 		manifest []byte
-		expected *BuildInfo
+		expected *DevBuildInfo
 	}{
 		{
 			name: "context pointing to url",
 			manifest: []byte(`name: deployment
 image:
   context: https://github.com/okteto/okteto.git
 `),
-			expected: &BuildInfo{
+			expected: &DevBuildInfo{
 				Context: "https://github.com/okteto/okteto.git",
 			},
 		},
@@ -551,7 +551,7 @@ image:
 image:
   context: .
 `),
-			expected: &BuildInfo{
+			expected: &DevBuildInfo{
 				Context:    ".",
 				Dockerfile: "Dockerfile",
 			},

diff --git a/pkg/model/serializer.go b/pkg/model/serializer.go
@@ -285,6 +285,24 @@ func (sync Sync) MarshalYAML() (interface{}, error) {
 	return syncRaw(sync), nil
 }
 
+// UnmarshalYAML Implements the Unmarshaler interface of the yaml pkg.
+func (buildInfo *DevBuildInfo) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var rawString string
+	err := unmarshal(&rawString)
+	if err == nil {
+		buildInfo.Name = rawString
+		return nil
+	}
+	var rawBuildInfo BuildInfo
+	err = unmarshal(&rawBuildInfo)
+	if err != nil {
+		return err
+	}
+	oktetoLog.Yellow("The `image` extended syntax is deprecated. Define the images you want to build in the 'build' section of your manifest. More info at https://www.okteto.com/docs/reference/manifest/#build")
+	*buildInfo = DevBuildInfo(rawBuildInfo)
+	return nil
+}
+
 // UnmarshalYAML Implements the Unmarshaler interface of the yaml pkg.
 func (buildInfo *BuildInfo) UnmarshalYAML(unmarshal func(interface{}) error) error {
 	var rawString string

diff --git a/pkg/model/serializer_test.go b/pkg/model/serializer_test.go
@@ -1114,7 +1114,7 @@ dev:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1124,7 +1124,7 @@ dev:
 						PersistentVolumeInfo: &PersistentVolumeInfo{
 							Enabled: true,
 						},
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1179,7 +1179,7 @@ dev:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1189,7 +1189,7 @@ dev:
 						PersistentVolumeInfo: &PersistentVolumeInfo{
 							Enabled: true,
 						},
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1259,7 +1259,7 @@ sync:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1269,7 +1269,7 @@ sync:
 						PersistentVolumeInfo: &PersistentVolumeInfo{
 							Enabled: true,
 						},
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1340,7 +1340,7 @@ services:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1350,7 +1350,7 @@ services:
 						PersistentVolumeInfo: &PersistentVolumeInfo{
 							Enabled: true,
 						},
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1380,7 +1380,7 @@ services:
 								Annotations:     Annotations{},
 								Selector:        Selector{},
 								EmptyImage:      true,
-								Image:           &BuildInfo{},
+								Image:           &DevBuildInfo{},
 								ImagePullPolicy: v1.PullAlways,
 								Secrets:         []Secret{},
 								Probes: &Probes{
@@ -1469,7 +1469,7 @@ dev:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1480,7 +1480,7 @@ dev:
 							Enabled: true,
 						},
 						Secrets: make([]Secret, 0),
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1554,7 +1554,7 @@ dev:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1564,7 +1564,7 @@ dev:
 						PersistentVolumeInfo: &PersistentVolumeInfo{
 							Enabled: true,
 						},
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1619,7 +1619,7 @@ dev:
 						Selector:        Selector{},
 						EmptyImage:      true,
 						ImagePullPolicy: v1.PullAlways,
-						Image: &BuildInfo{
+						Image: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",
@@ -1629,7 +1629,7 @@ dev:
 						PersistentVolumeInfo: &PersistentVolumeInfo{
 							Enabled: true,
 						},
-						Push: &BuildInfo{
+						Push: &DevBuildInfo{
 							Name:       "",
 							Context:    ".",
 							Dockerfile: "Dockerfile",

diff --git a/pkg/model/translation_test.go b/pkg/model/translation_test.go
@@ -468,7 +468,7 @@ func TestSSHServerPortTranslationRule(t *testing.T) {
 		{
 			name: "default",
 			manifest: &Dev{
-				Image:         &BuildInfo{},
+				Image:         &DevBuildInfo{},
 				SSHServerPort: oktetoDefaultSSHServerPort,
 			},
 			expected: Environment{
@@ -479,7 +479,7 @@ func TestSSHServerPortTranslationRule(t *testing.T) {
 		{
 			name: "custom port",
 			manifest: &Dev{
-				Image:         &BuildInfo{},
+				Image:         &DevBuildInfo{},
 				SSHServerPort: 22220,
 			},
 			expected: Environment{