add explicit error code UNKNOWN_API_VERSION (GoogleContainerTools#5848

)

docs/content/en/docs/references/api/grpc.md

@@ -1008,6 +1008,7 @@ For Cancelled Error code, use range 800 to 850.<br>
 | CONFIG_FILE_PATHS_SUBSTITUTION_ERR | 1210 | Failed to substitute absolute file paths in config |
 | CONFIG_MULTI_IMPORT_PROFILE_CONFLICT_ERR | 1211 | Same config imported at least twice with different set of profiles |
 | CONFIG_PROFILES_NOT_FOUND_ERR | 1212 | Profile selection did not match known profile names |
+| CONFIG_UNKNOWN_API_VERSION_ERR | 1213 | Config API version not found |
 | INSPECT_UNKNOWN_ERR | 1301 | Catch-all `skaffold inspect` command error |
 | INSPECT_BUILD_ENV_ALREADY_EXISTS_ERR | 1302 | Trying to add new build environment that already exists |
 
@@ -1067,6 +1068,7 @@ Enum for Suggestion codes
 | CONFIG_CHECK_PROFILE_DEFINITION | 704 | Check profile definition in current config |
 | CONFIG_CHECK_DEPENDENCY_PROFILES_SELECTION | 705 | Check active profile selection for dependency config |
 | CONFIG_CHECK_PROFILE_SELECTION | 706 | Check profile selection flag |
+| CONFIG_FIX_API_VERSION | 707 | Fix config API version or upgrade the skaffold binary |
 | INSPECT_DEDUP_NEW_BUILD_ENV | 800 | `skaffold inspect` command error suggestion codes |
 | OPEN_ISSUE | 900 | Open an issue so this situation can be diagnosed |
 | CHECK_CUSTOM_COMMAND | 1000 | Test error suggestion codes |

pkg/skaffold/build/buildpacks/build_test.go

@@ -24,6 +24,7 @@ import (
 
 	"github.com/buildpacks/pack"
 	packcfg "github.com/buildpacks/pack/config"
+	"github.com/docker/docker/api/types"
 
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/docker"
@@ -414,6 +415,8 @@ func TestBuildWithArtifactDependencies(t *testing.T) {
 				Add(test.artifact.BuildpackArtifact.Builder, "builderImageID").
 				Add(test.artifact.BuildpackArtifact.RunImage, "runImageID").
 				Add("img:latest", "builtImageID")
+			t.Override(&docker.DefaultAuthHelper, testAuthHelper{})
+
 			localDocker := fakeLocalDaemon(test.api)
 
 			builder := NewArtifactBuilder(localDocker, test.pushImages, test.mode, test.resolver)
@@ -478,3 +481,12 @@ func (r mockArtifactResolver) GetImageTag(imageName string) (string, bool) {
 	val, found := r.m[imageName]
 	return val, found
 }
+
+type testAuthHelper struct{}
+
+func (t testAuthHelper) GetAuthConfig(string) (types.AuthConfig, error) {
+	return types.AuthConfig{}, nil
+}
+func (t testAuthHelper) GetAllAuthConfigs(context.Context) (map[string]types.AuthConfig, error) {
+	return nil, nil
+}

pkg/skaffold/schema/errors/errors.go

@@ -184,3 +184,19 @@ func ConfigProfileConflictErr(config, file string) error {
 			},
 		})
 }
+
+// ConfigUnknownAPIVersionErr specifies that the config API version doesn't match any known versions.
+func ConfigUnknownAPIVersionErr(version string) error {
+	msg := fmt.Sprintf("unknown skaffold config API version %q", version)
+	return sErrors.NewError(fmt.Errorf(msg),
+		proto.ActionableErr{
+			Message: msg,
+			ErrCode: proto.StatusCode_CONFIG_UNKNOWN_API_VERSION_ERR,
+			Suggestions: []*proto.Suggestion{
+				{
+					SuggestionCode: proto.SuggestionCode_CONFIG_FIX_API_VERSION,
+					Action:         "Set the config 'apiVersion' to a known value. Check https://skaffold.dev/docs/references/yaml/ for the list of valid API versions. Otherwise, check that your skaffold version is up-to-date",
+				},
+			},
+		})
+}

pkg/skaffold/schema/versions.go

@@ -29,6 +29,7 @@ import (
 
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/apiversion"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes"
+	sErrors "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/errors"
 	latestV1 "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest/v1"
 	latestV2 "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest/v2"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/util"
@@ -225,7 +226,7 @@ func configFactoryFromAPIVersion(buf []byte) ([]func() util.VersionedConfig, err
 		}
 		factory, present := AllVersions.Find(v.Version)
 		if !present {
-			return nil, fmt.Errorf("unknown api version: %q", v.Version)
+			return nil, sErrors.ConfigUnknownAPIVersionErr(v.Version)
 		}
 		factories = append(factories, factory)
 	}

proto/enums/enums.proto

@@ -403,6 +403,8 @@ enum StatusCode {
     CONFIG_MULTI_IMPORT_PROFILE_CONFLICT_ERR = 1211;
     // Profile selection did not match known profile names
     CONFIG_PROFILES_NOT_FOUND_ERR = 1212;
+    // Config API version not found
+    CONFIG_UNKNOWN_API_VERSION_ERR = 1213;
 
     // Inspect command errors
 
@@ -539,6 +541,8 @@ enum SuggestionCode {
     CONFIG_CHECK_DEPENDENCY_PROFILES_SELECTION = 705;
     // Check profile selection flag
     CONFIG_CHECK_PROFILE_SELECTION = 706;
+    // Fix config API version or upgrade the skaffold binary
+    CONFIG_FIX_API_VERSION = 707;
 
     // `skaffold inspect` command error suggestion codes
     INSPECT_DEDUP_NEW_BUILD_ENV = 800;