Convert v1alpha1 Github projects to v1alpha2 Git projects

When converting a devfile in v1alpha1 that contains projects with type
Github, convert those projects to Git-type projects in v1alpha2 and
apply attribute 'conversion.api.devfile.io/converted-from=GitHub' to
them.

When converting from v1alpha2, convert Git-type projects with the above
attribute back to Github-type projects in v1alpha1.

Reenable testing conversion for Github-type projects in v1alpha1 now
that it is supported.

Signed-off-by: Angel Misevski <[email protected]>

Author: amisevsk

pkg/apis/workspaces/v1alpha1/conversion.go

@@ -4,6 +4,12 @@ import (
 	"github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 )
 
+const (
+	// ConvertedFromAttribute marks a devfile element as being converted from a different underlying field. For example,
+	// since v1alpha2 does not support
+	ConvertedFromAttribute = "conversion.api.devfile.io/converted-from"
+)
+
 func convertDevWorkspaceTo_v1alpha2(src *DevWorkspace, dest *v1alpha2.DevWorkspace) error {
 	dest.ObjectMeta = src.ObjectMeta
 	dest.Status.DevWorkspaceId = src.Status.WorkspaceId

pkg/apis/workspaces/v1alpha1/conversion_test.go

@@ -148,21 +148,25 @@ var parentCommandFuzzFunc = func(command *Command, c fuzz.Continue) {
 var parentProjectFuzzFunc = func(project *Project, c fuzz.Continue) {
 	// Custom projects are not supported in v1alpha2 parent
 	project.Name = c.RandString()
-	switch c.Intn(2) {
+	switch c.Intn(3) {
 	case 0:
 		c.Fuzz(&project.Git)
 	case 1:
+		c.Fuzz(&project.Github)
+	case 2:
 		c.Fuzz(&project.Zip)
 	}
 }
 
 var projectFuzzFunc = func(project *Project, c fuzz.Continue) {
-	switch c.Intn(3) {
+	switch c.Intn(4) {
 	case 0:
 		c.Fuzz(&project.Git)
 	case 1:
-		c.Fuzz(&project.Zip)
+		c.Fuzz(&project.Github)
 	case 2:
+		c.Fuzz(&project.Zip)
+	case 3:
 		c.Fuzz(&project.Custom)
 	}
 }

pkg/apis/workspaces/v1alpha1/projects_conversion.go

@@ -4,9 +4,25 @@ import (
 	"encoding/json"
 
 	"github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	"github.com/devfile/api/v2/pkg/attributes"
+)
+
+const (
+	GitHubConversionFromAttributeValue = "GitHub"
 )
 
 func convertProjectTo_v1alpha2(src *Project, dest *v1alpha2.Project) error {
+	// Convert Github type projects in v1alpha1 to Git-type projects in v1alpha2, since Github was dropped
+	if src.Github != nil {
+		src.Git = &GitProjectSource{
+			GitLikeProjectSource: src.Github.GitLikeProjectSource,
+		}
+		if dest.Attributes == nil {
+			dest.Attributes = attributes.Attributes{}
+		}
+		dest.Attributes.PutString(ConvertedFromAttribute, GitHubConversionFromAttributeValue)
+	}
+
 	jsonProject, err := json.Marshal(src)
 	if err != nil {
 		return err
@@ -15,6 +31,7 @@ func convertProjectTo_v1alpha2(src *Project, dest *v1alpha2.Project) error {
 	if err != nil {
 		return err
 	}
+
 	var sparseCheckoutDir string
 	switch {
 	case src.Git != nil:
@@ -25,6 +42,12 @@ func convertProjectTo_v1alpha2(src *Project, dest *v1alpha2.Project) error {
 	if sparseCheckoutDir != "" {
 		dest.SparseCheckoutDirs = []string{sparseCheckoutDir}
 	}
+
+	// Make sure we didn't modify underlying src struct
+	if src.Github != nil {
+		src.Git = nil
+	}
+
 	return nil
 }
 
@@ -51,10 +74,33 @@ func convertProjectFrom_v1alpha2(src *v1alpha2.Project, dest *Project) error {
 			dest.Zip.SparseCheckoutDir = sparseCheckoutDir
 		}
 	}
+
+	// Check if a Git-type project was originally a Github-type project in v1alpha1
+	if src.Git != nil && src.Attributes != nil {
+		convertedFrom := src.Attributes.GetString(ConvertedFromAttribute, nil)
+		if convertedFrom == GitHubConversionFromAttributeValue {
+			dest.Github = &GithubProjectSource{
+				GitLikeProjectSource: dest.Git.GitLikeProjectSource,
+			}
+			dest.Git = nil
+		}
+	}
+
 	return nil
 }
 
 func convertStarterProjectTo_v1alpha2(src *StarterProject, dest *v1alpha2.StarterProject) error {
+	// Convert Github type projects in v1alpha1 to Git-type projects in v1alpha2, since Github was dropped
+	if src.Github != nil {
+		src.Git = &GitProjectSource{
+			GitLikeProjectSource: src.Github.GitLikeProjectSource,
+		}
+		if dest.Attributes == nil {
+			dest.Attributes = attributes.Attributes{}
+		}
+		dest.Attributes.PutString(ConvertedFromAttribute, GitHubConversionFromAttributeValue)
+	}
+
 	jsonProject, err := json.Marshal(src)
 	if err != nil {
 		return err
@@ -74,6 +120,11 @@ func convertStarterProjectTo_v1alpha2(src *StarterProject, dest *v1alpha2.Starte
 		dest.SubDir = src.Zip.SparseCheckoutDir
 	}
 
+	// Make sure we didn't modify underlying src struct
+	if src.Github != nil {
+		src.Git = nil
+	}
+
 	return nil
 }
 
@@ -96,5 +147,16 @@ func convertStarterProjectFrom_v1alpha2(src *v1alpha2.StarterProject, dest *Star
 		}
 	}
 
+	// Check if a Git-type project was originally a Github-type project in v1alpha1
+	if src.Git != nil && src.Attributes != nil {
+		convertedFrom := src.Attributes.GetString(ConvertedFromAttribute, nil)
+		if convertedFrom == GitHubConversionFromAttributeValue {
+			dest.Github = &GithubProjectSource{
+				GitLikeProjectSource: dest.Git.GitLikeProjectSource,
+			}
+			dest.Git = nil
+		}
+	}
+
 	return nil
 }