Add type spec

Author: sjakati98

cmd/helm2go-operator-sdk/new/chart.go

@@ -149,7 +149,12 @@ func scaffoldOverwrite(outputDir, kind, apiVersion string, rcache *resourcecache
 	ok = templating.ResourceFileStructure(rcache, resDir)
 	ok = templating.TemplatesToFiles(templates, resDir)
 	if !ok {
-		return fmt.Errorf("Writing to File Error")
+		return fmt.Errorf("error writing to file")
+	}
+
+	//begin overwritting the types file
+	ok = templating.OverwriteKindTypes(outputDir, kind, apiVersion)
+	if !ok {
+		return fmt.Errorf("error overwriting kind types")
 	}
-	return nil
 }

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/Masterminds/sprig v0.0.0-20190301161902-9f8fceff796f // indirect
 	github.com/cyphar/filepath-securejoin v0.2.2 // indirect
 	github.com/ghodss/yaml v0.0.0-20180820084758-c7ce16629ff4 // indirect
+	github.com/go-openapi/inflect v0.19.0 // indirect
 	github.com/gobwas/glob v0.2.3 // indirect
 	github.com/huandu/xstrings v1.2.0 // indirect
 	github.com/iancoleman/strcase v0.0.0-20190422225806-e506e3ef7365

go.sum

@@ -23,6 +23,8 @@ github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/ghodss/yaml v0.0.0-20180820084758-c7ce16629ff4 h1:bRzFpEzvausOAt4va+I/22BZ1vXDtERngp0BNYDKej0=
 github.com/ghodss/yaml v0.0.0-20180820084758-c7ce16629ff4/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
+github.com/go-openapi/inflect v0.19.0 h1:9jCH9scKIbHeV9m12SmPilScz6krDxKRasNNSNPXu/4=
+github.com/go-openapi/inflect v0.19.0/go.mod h1:lHpZVlpIQqLyKwJ4N+YSc9hchQy/i12fJykb83CRBH4=
 github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
 github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
 github.com/gogo/protobuf v1.0.0 h1:2jyBKDKU/8v3v2xVR2PtiWQviFUyiaGk2rpfyFT8rTM=

internal/pkg/load/validation_test.go

@@ -1,6 +1,8 @@
 package load
 
 import (
+	"os"
+	"path/filepath"
 	"testing"
 
 	. "github.com/onsi/ginkgo"
@@ -14,7 +16,8 @@ func TestValidation(t *testing.T) {
 
 var _ = Describe("Resource Validation", func() {
 	It("Validates Resources", func() {
-		_, err := PerformResourceValidation("/home/sjakati/go/src/github.com/redhat-nfvpe/helm2go-operator-sdk/test/resources")
+		gopath := os.Getenv("GOPATH")
+		_, err := PerformResourceValidation(filepath.Join(gopath, "src/github.com/redhat-nfvpe/helm2go-operator-sdk/test/resources"))
 		Expect(err).ToNot(HaveOccurred())
 	})
 })

internal/pkg/templating/crTemplate.go

@@ -0,0 +1,62 @@
+package templating
+
+import (
+	"bytes"
+	"text/template"
+)
+
+// CRTemplateConfig is used to template the appropriate CR Scaffold
+type CRTemplateConfig struct {
+	APIVersion string
+	Kind       string
+	LowerKind  string
+	Spec       CRSpec
+}
+
+// CRSpec contains the specific values needed for the CRTemplate
+type CRSpec struct {
+	placeholder string
+}
+
+// NewCRTemplateConfig ...
+// TODO : need to implement the function to create an actual spec struct
+func NewCRTemplateConfig(apiVersion, kind, lowerKind string, spec CRSpec) *CRTemplateConfig {
+	return &CRTemplateConfig{
+		APIVersion: apiVersion,
+		Kind:       kind,
+		LowerKind:  lowerKind,
+		Spec:       spec,
+	}
+}
+
+// Execute renders the template and returns the templated string
+func (c *CRTemplateConfig) Execute() (string, error) {
+	temp, err := template.New("CRTemplate").Parse(c.GetTemplate())
+	if err != nil {
+		return "", err
+	}
+
+	var wr bytes.Buffer
+	err = temp.Execute(&wr, c)
+	if err != nil {
+		return "", err
+	}
+	return wr.String(), nil
+}
+
+// GetTemplate returns the necessary template for the CR
+func (c *CRTemplateConfig) GetTemplate() string {
+
+	return `apiVersion: {{ .Resource.APIVersion }}
+	kind: {{ .Resource.Kind }}
+	metadata:
+	  name: example-{{ .Resource.LowerKind }}
+	spec:
+	{{- with .Spec }}
+	{{ . | indent 2 }}
+	{{- else }}
+	  # Add fields here
+	  size: 3
+	{{- end }}
+	`
+}

internal/pkg/templating/kindSpecTemplate.go

@@ -0,0 +1,87 @@
+package templating
+
+import (
+	"bytes"
+	"io/ioutil"
+	"reflect"
+	"text/template"
+
+	"gopkg.in/yaml.v2"
+)
+
+// NewSpecConfig returns a spec config
+func NewSpecConfig(name, valuesPath string) *SpecConfig {
+	yamlMap, err := getYAMLMap(valuesPath)
+	if err != nil {
+		panic(err)
+	}
+	return &SpecConfig{
+		Name:          name,
+		InstanceValue: expandInstanceValue(yamlMap),
+	}
+}
+
+// SpecConfig is the YAML spec config
+type SpecConfig struct {
+	Name          string
+	InstanceValue string
+}
+
+// GetTemplate returns the necessary template
+func (s *SpecConfig) GetTemplate() string {
+	structTemplate := `
+	type {{ .Name }} struct {
+		{{ .InstanceValue }}
+	}
+	`
+	return structTemplate
+}
+
+// Execute renders the template and returns the templated string
+func (s *SpecConfig) Execute() (string, error) {
+	temp, err := template.New("TypeSpec").Parse(s.GetTemplate())
+	if err != nil {
+		return "", err
+	}
+
+	s.Name = s.Name + "Type"
+
+	var wr bytes.Buffer
+	err = temp.Execute(&wr, s)
+	if err != nil {
+		return "", err
+	}
+	return wr.String(), nil
+}
+
+func getYAMLMap(yamlInput string) (map[interface{}]interface{}, error) {
+	var output map[interface{}]interface{}
+	//read bytes yaml
+	bytes, err := ioutil.ReadFile(yamlInput)
+	if err != nil {
+		return nil, err
+	}
+	err = yaml.Unmarshal(bytes, &output)
+	if err != nil {
+		return nil, err
+	}
+	return output, nil
+}
+
+func expandInstanceValue(instance map[interface{}]interface{}) string {
+	var result string
+	for k, v := range instance {
+		strK, _ := k.(string)
+		if reflect.TypeOf(v).Kind() != reflect.Map {
+			result = result + "\t" + strK + " string " + getJSONTag(strK) + "\n"
+		} else {
+			mapV := v.(map[interface{}]interface{})
+			result = result + "\t" + strK + " struct { " + "\n" + "\t" + expandInstanceValue(mapV) + "}" + "\n"
+		}
+	}
+	return result
+}
+
+func getJSONTag(input string) string {
+	return "`" + "json:" + `"` + input + `,omitempty"` + "`"
+}

internal/pkg/templating/kindTypesTemplate.go

@@ -0,0 +1,106 @@
+package templating
+
+import (
+	"bytes"
+	"text/template"
+)
+
+// KindTypesTemplateConfig is used to overwrite the generated kind_types.go file
+type KindTypesTemplateConfig struct {
+	Kind                            string
+	Version                         string
+	LowerPlural                     string
+	KindSpec                        string
+	SpecConfigurationName           string
+	SpecConfigurationTypeName       string
+	LowerCamelSpecConfigurationName string
+}
+
+// NewKindTypesTemplateConfig returns a new KindTypesConfig
+func NewKindTypesTemplateConfig(kind, apiVersion, kindSpec string) *KindTypesTemplateConfig {
+
+	lowerPlural := getLowerPlural(kind)
+	components, _ := getAPIVersionComponents(apiVersion)
+	version := components.Version
+	kindSpecName := getKindSpecName(kind)
+	kindSpecTypeName := getKindSpecTypeName(kind)
+	kindSpecLowerCamel := kindToLowerCamel(kind)
+
+	// create config and return address
+	return &KindTypesTemplateConfig{
+		Kind:                            kind,
+		Version:                         version,
+		LowerPlural:                     lowerPlural,
+		KindSpec:                        kindSpec,
+		SpecConfigurationName:           kindSpecName,
+		SpecConfigurationTypeName:       kindSpecTypeName,
+		LowerCamelSpecConfigurationName: kindSpecLowerCamel,
+	}
+}
+
+// Execute renders the template and returns the templated string
+func (k *KindTypesTemplateConfig) Execute() (string, error) {
+	temp, err := template.New("CRTemplate").Parse(k.GetTemplate())
+	if err != nil {
+		return "", err
+	}
+
+	var wr bytes.Buffer
+	err = temp.Execute(&wr, k)
+	if err != nil {
+		return "", err
+	}
+	return wr.String(), nil
+}
+
+// GetTemplate returns the necessary template for the kind_types.go
+func (k *KindTypesTemplateConfig) GetTemplate() string {
+	return `package {{ .Version }}
+	import (
+		metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	)
+	// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+	// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+	{{ .KindSpec }}
+	
+
+	// {{.Kind}}Spec defines the desired state of {{.Kind}}
+	// +k8s:openapi-gen=true
+	type {{.Kind}}Spec struct {
+		// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+		// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
+		// Add custom validation using kubebuilder tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html
+
+		{{ .SpecConfigurationName }} {{ .SpecConfigurationTypeName }}` + "`" + `json:"{{ .LowerCamelSpecConfigurationName }},omitempty"` + "`" + `
+		
+	}
+	// {{.Kind}}Status defines the observed state of {{.Kind}}
+	// +k8s:openapi-gen=true
+	type {{.Kind}}Status struct {
+		// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+		// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
+		// Add custom validation using kubebuilder tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html
+	}
+	// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+	// {{.Kind}} is the Schema for the {{ .LowerPlural }} API
+	// +k8s:openapi-gen=true
+	// +kubebuilder:subresource:status
+	type {{.Kind}} struct {
+		metav1.TypeMeta   ` + "`" + `json:",inline"` + "`" + `
+		metav1.ObjectMeta ` + "`" + `json:"metadata,omitempty"` + "`" + `
+		Spec   {{.Kind}}Spec   ` + "`" + `json:"spec,omitempty"` + "`" + `
+		Status {{.Kind}}Status ` + "`" + `json:"status,omitempty"` + "`" + `
+	}
+	// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+	// {{.Kind}}List contains a list of {{.Kind}}
+	type {{.Kind}}List struct {
+		metav1.TypeMeta ` + "`" + `json:",inline"` + "`" + `
+		metav1.ListMeta ` + "`" + `json:"metadata,omitempty"` + "`" + `
+		Items           []{{ .Kind }} ` + "`" + `json:"items"` + "`" + `
+	}
+	func init() {
+		SchemeBuilder.Register(&{{.Kind}}{}, &{{.Kind}}List{})
+	}
+	`
+}

internal/pkg/templating/resources.go

@@ -7,6 +7,7 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/go-openapi/inflect"
 	"github.com/iancoleman/strcase"
 
 	"github.com/redhat-nfvpe/helm2go-operator-sdk/internal/resourcecache"
@@ -159,12 +160,13 @@ func getImportMap(outputDir, kind, apiVersion string) map[string]string {
 }
 
 func getAppTypeImport(outputDir, apiVersion string) string {
-	comps, err := getAPIVersionComponents(apiVersion)
+	var comps []string
+	components, err := getAPIVersionComponents(apiVersion)
 	if err != nil {
 		panic(err)
 	}
 	sp := strings.Split(outputDir, "src/")
-	comps = append([]string{sp[len(sp)-1], "pkg", "apis"}, comps...)
+	comps = append([]string{sp[len(sp)-1], "pkg", "apis"}, components.Subdomain, components.Version)
 
 	return filepath.Join(comps...)
 
@@ -181,26 +183,52 @@ func getResourceCRImport(outputDir, resourceType string) string {
 	return importString
 }
 
-func getAPIVersionComponents(input string) ([]string, error) {
-
-	var group string
-	var version string
+// APIComponents used to seperate api components
+type APIComponents struct {
+	Subdomain string
+	Domain    string
+	Version   string
+}
 
-	fmt.Printf("Input: %v", input)
+func getAPIVersionComponents(input string) (*APIComponents, error) {
 
 	// matches the input string and returns the groups
 	pattern := regexp.MustCompile(`(.*)\.(.*)\..*\/(.*)`)
 	matches := pattern.FindStringSubmatch(input)
 	if l := len(matches); l != 3+1 {
-		return []string{}, fmt.Errorf("expected four matches, received %d instead", l)
+		return nil, fmt.Errorf("expected four matches, received %d instead", l)
 	}
-	group = matches[1]
-	version = matches[3]
 
-	var result = []string{
-		group,
-		version,
+	var result = &APIComponents{
+		matches[1],
+		matches[2],
+		matches[3],
 	}
 
 	return result, nil
 }
+
+func getKindSpecName(kind string) string {
+	return kind + "Spec"
+}
+
+func getKindSpecTypeName(kind string) string {
+	return kind + "Spec" + "Type"
+}
+
+func getLowerPlural(kind string) string {
+	return inflect.Pluralize(inflect.CamelizeDownFirst(kind))
+}
+
+func getSpecifiedOrDefault(attribute string, values map[string]string) string {
+	// check if attribute is in the map
+	val, ok := values[attribute]
+	if !ok {
+		return getDefault(attribute)
+	}
+	return val
+}
+
+func getDefault(attribute string) string {
+	return "placeholder"
+}