Merge pull request #66 from codefresh-io/original_yaml_string-preserve-keys-order

preserve keys order for original_yaml_string

Author: denis-codefresh

.gitignore

@@ -1,5 +1,6 @@
 terraform-provider-codefresh
 dist/
+.vscode/
 
 **/.terraform
 **/terraform.tfstate

GNUmakefile

@@ -3,7 +3,7 @@ GOFMT_FILES?=$$(find . -name '*.go' |grep -v vendor)
 WEBSITE_REPO=github.com/hashicorp/terraform-website
 HOSTNAME=codefresh.io
 PKG_NAME=codefresh
-NAMESPACE=codefresh-io
+NAMESPACE=app
 BINARY=terraform-provider-${PKG_NAME}
 VERSION=0.1.0
 OS_ARCH=darwin_amd64

codefresh/resource_pipeline.go

@@ -1,13 +1,13 @@
 package codefresh
 
 import (
+	"encoding/json"
 	"fmt"
 	"log"
 	"regexp"
 	"strings"
 
 	cfClient "github.com/codefresh-io/terraform-provider-codefresh/client"
-	ghodss "github.com/ghodss/yaml"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	"gopkg.in/yaml.v2"
@@ -752,92 +752,41 @@ func mapResourceToPipeline(d *schema.ResourceData) *cfClient.Pipeline {
 // We cannot leverage on the standard marshal/unmarshal because the steps attribute needs to maintain the order of elements
 // while by default the standard function doesn't do it because in JSON maps are unordered
 func extractSpecAttributesFromOriginalYamlString(originalYamlString string, pipeline *cfClient.Pipeline) {
-	// Use mapSlice to preserve order of items from the YAML string
-	m := yaml.MapSlice{}
-	err := yaml.Unmarshal([]byte(originalYamlString), &m)
+	ms := OrderedMapSlice{}
+	err := yaml.Unmarshal([]byte(originalYamlString), &ms)
 	if err != nil {
 		log.Fatalf("Unable to unmarshall original_yaml_string. Error: %v", err)
 	}
 
 	stages := "[]"
-	// Dynamically build JSON object for steps using String builder
-	stepsBuilder := strings.Builder{}
-	stepsBuilder.WriteString("{")
-	// Dynamically build JSON object for steps using String builder
-	hooksBuilder := strings.Builder{}
-	hooksBuilder.WriteString("{")
-
-	// Parse elements of the YAML string to extract Steps and Stages if defined
-	for _, item := range m {
+	steps := "{}"
+	hooks := "{}"
+
+	// Parse elements of the YAML string to extract Steps, Hooks and Stages if defined
+	for _, item := range ms {
 		key := item.Key.(string)
 		switch key {
 		case "steps":
 			switch x := item.Value.(type) {
 			default:
 				log.Fatalf("unsupported value type: %T", item.Value)
 
-			case yaml.MapSlice:
-				numberOfSteps := len(x)
-				for index, item := range x {
-					// We only need to preserve order at the first level to guarantee order of the steps, hence the child nodes can be marshalled
-					// with the standard library
-					y, _ := yaml.Marshal(item.Value)
-					j2, _ := ghodss.YAMLToJSON(y)
-					stepsBuilder.WriteString("\"" + item.Key.(string) + "\" : " + string(j2))
-					if index < numberOfSteps-1 {
-						stepsBuilder.WriteString(",")
-					}
-				}
+			case OrderedMapSlice:
+				s, _ := json.Marshal(x)
+				steps = string(s)
 			}
 		case "stages":
-			// For Stages we don't have ordering issue because it's a list
-			y, _ := yaml.Marshal(item.Value)
-			j2, _ := ghodss.YAMLToJSON(y)
-			stages = string(j2)
+			s, _ := json.Marshal(item.Value)
+			stages = string(s)
+
 		case "hooks":
-			switch hooks := item.Value.(type) {
+			switch x := item.Value.(type) {
 			default:
 				log.Fatalf("unsupported value type: %T", item.Value)
 
-			case yaml.MapSlice:
-				numberOfHooks := len(hooks)
-				for indexHook, hook := range hooks {
-					// E.g. on_finish
-					hooksBuilder.WriteString("\"" + hook.Key.(string) + "\" : {")
-					numberOfAttributes := len(hook.Value.(yaml.MapSlice))
-					for indexAttribute, hookAttribute := range hook.Value.(yaml.MapSlice) {
-						attribute := hookAttribute.Key.(string)
-						switch attribute {
-						case "steps":
-							hooksBuilder.WriteString("\"steps\" : {")
-							numberOfSteps := len(hookAttribute.Value.(yaml.MapSlice))
-							for indexStep, step := range hookAttribute.Value.(yaml.MapSlice) {
-								// We only need to preserve order at the first level to guarantee order of the steps, hence the child nodes can be marshalled
-								// with the standard library
-								y, _ := yaml.Marshal(step.Value)
-								j2, _ := ghodss.YAMLToJSON(y)
-								hooksBuilder.WriteString("\"" + step.Key.(string) + "\" : " + string(j2))
-								if indexStep < numberOfSteps-1 {
-									hooksBuilder.WriteString(",")
-								}
-							}
-							hooksBuilder.WriteString("}")
-						default:
-							// For Other elements we don't need to preserve order
-							y, _ := yaml.Marshal(hookAttribute.Value)
-							j2, _ := ghodss.YAMLToJSON(y)
-							hooksBuilder.WriteString("\"" + hookAttribute.Key.(string) + "\" : " + string(j2))
-						}
-
-						if indexAttribute < numberOfAttributes-1 {
-							hooksBuilder.WriteString(",")
-						}
-					}
-					hooksBuilder.WriteString("}")
-					if indexHook < numberOfHooks-1 {
-						hooksBuilder.WriteString(",")
-					}
-				}
+			case OrderedMapSlice:
+				h, _ := json.Marshal(x)
+				hooks = string(h)
 			}
 		case "mode":
 			pipeline.Spec.Mode = item.Value.(string)
@@ -850,10 +799,7 @@ func extractSpecAttributesFromOriginalYamlString(originalYamlString string, pipe
 			log.Printf("Unsupported entry %s", key)
 		}
 	}
-	stepsBuilder.WriteString("}")
-	hooksBuilder.WriteString("}")
-	steps := stepsBuilder.String()
-	hooks := hooksBuilder.String()
+
 	pipeline.Spec.Steps = &cfClient.Steps{
 		Steps: steps,
 	}

codefresh/utils_encoding.go

@@ -0,0 +1,39 @@
+package codefresh
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+
+	"gopkg.in/yaml.v2"
+)
+
+// can be used instead the yaml.MapSlice (as an argument to yaml.Unmarshal) in order to preserve the keys order when converting to JSON later
+//
+//	  // Usage example:
+//	  ms := OrderedMapSlice{}
+//	  yaml.Unmarshal([]byte(originalYamlString), &ms)
+//	  orderedJson, _ := json.Marshal(ms)
+//
+// implements json.Marshaler interface
+type OrderedMapSlice []yaml.MapItem
+
+func (ms OrderedMapSlice) MarshalJSON() ([]byte, error) {
+	//	keep the order of keys while converting to json with json.Marshal(ms)
+
+	buf := &bytes.Buffer{}
+	buf.Write([]byte{'{'})
+	for i, mi := range ms {
+		b, err := json.Marshal(&mi.Value)
+		if err != nil {
+			return nil, err
+		}
+		buf.WriteString(fmt.Sprintf("%q:", fmt.Sprintf("%v", mi.Key)))
+		buf.Write(b)
+		if i < len(ms)-1 {
+			buf.Write([]byte{','})
+		}
+	}
+	buf.Write([]byte{'}'})
+	return buf.Bytes(), nil
+}

examples/pipelines/main.tf

@@ -0,0 +1,102 @@
+provider "codefresh" {
+  api_url = var.api_url
+  token = var.token
+}
+
+resource "codefresh_project" "test" {
+  name = "myproject"
+
+  tags = [
+    "docker",
+  ]
+}
+
+resource "codefresh_pipeline" "test" {
+  name    = "${codefresh_project.test.name}/react-sample-app"
+
+  tags = [
+    "production",
+    "docker",
+  ]
+
+  original_yaml_string = <<EOT
+version: "1.0"
+hooks: 
+ on_finish:
+   steps:
+     b:
+       image: alpine:3.9
+       commands:
+         - echo "echo cleanup step"
+     a:
+       image: cloudposse/slack-notifier
+       commands:
+         - echo "Notify slack"
+steps:
+    freestyle:
+        image: alpine
+        commands:
+        - sleep 10
+    a_freestyle:
+        image: alpine
+        commands:
+        - sleep 10
+        - echo Hey!
+        arguments:
+            c: 3
+            a: 1
+            b: 2
+  EOT
+
+  spec {
+    concurrency = 1
+    priority    = 5
+
+    # spec_template {
+    #   repo        = "codefresh-contrib/react-sample-app"
+    #   path        = "./codefresh.yml"
+    #   revision    = "master"
+    #   context     = "git"
+    # }
+
+    contexts = [
+      "context1-name",
+      "context2-name",
+    ]
+
+    trigger {
+      branch_regex  = "/.*/gi"
+      context       = "git"
+      description   = "Trigger for commits"
+      disabled      = false
+      events        = [
+        "push.heads"
+      ]
+      modified_files_glob = ""
+      name                = "commits"
+      provider            = "github"
+      repo                = "codefresh-contrib/react-sample-app"
+      type                = "git"
+    }
+
+    trigger {
+      branch_regex  = "/.*/gi"
+      context       = "git"
+      description   = "Trigger for tags"
+      disabled      = false
+      events        = [
+        "push.tags"
+      ]
+      modified_files_glob = ""
+      name                = "tags"
+      provider            = "github"
+      repo                = "codefresh-contrib/react-sample-app"
+      type                = "git"
+    }
+
+    variables = {
+      MY_PIP_VAR      = "value"
+      ANOTHER_PIP_VAR = "another_value"
+    }
+  }
+}

examples/pipelines/terraform.tfvars

@@ -0,0 +1,2 @@
+api_url = "http://g.codefresh.io/api"
+token = ""

examples/pipelines/vars.tf

@@ -0,0 +1,8 @@
+variable api_url {
+  type = string
+}
+
+variable token {
+  type = string
+  default = ""
+}

main.go

@@ -2,10 +2,11 @@ package main
 
 import (
 	"context"
-	"github.com/codefresh-io/terraform-provider-codefresh/codefresh"
-	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
 	"log"
 	"os"
+
+	"github.com/codefresh-io/terraform-provider-codefresh/codefresh"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
 	//"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )