feat: improve debugging for unmatched parameters and support top level included (Resolves #587) (#588)

Author: steve-r-west

external/json/to_json.go

@@ -3,14 +3,16 @@ package json
 import (
 	gojson "encoding/json"
 	"fmt"
+	"regexp"
+	"strconv"
+	"strings"
+
 	"github.com/elasticpath/epcc-cli/external/aliases"
 	"github.com/elasticpath/epcc-cli/external/resources"
 	"github.com/elasticpath/epcc-cli/external/templates"
 	"github.com/itchyny/gojq"
 	"github.com/mitchellh/mapstructure"
 	log "github.com/sirupsen/logrus"
-	"regexp"
-	"strings"
 )
 
 var segmentRegex = regexp.MustCompile("(.+?)(\\[[0-9]+])?$")
@@ -20,7 +22,26 @@ var attributeWithArrayIndex = regexp.MustCompile("\\[[0-9]+]")
 func ToJson(args []string, noWrapping bool, compliant bool, attributes map[string]*resources.CrudEntityAttribute, useAliases bool, autoAddConstantValues bool) (string, error) {
 
 	if len(args)%2 == 1 {
-		return "", fmt.Errorf("the number of arguments %d supplied isn't even, json should be passed in key value pairs. Do you have an extra/missing id?", len(args))
+		if log.IsLevelEnabled(log.DebugLevel) {
+			fmt.Printf("\n\nArgument Dump:\n")
+			maxlen := 0
+
+			for _, v := range args {
+				if len(v) > maxlen {
+					maxlen = len(v)
+				}
+			}
+
+			for i := 0; i < len(args); i++ {
+				fmt.Printf("%"+strconv.Itoa(maxlen)+"s ", args[i])
+
+				if i%2 == 1 {
+					fmt.Println()
+				}
+			}
+			fmt.Printf("\n\n")
+		}
+		return "", fmt.Errorf("the number of arguments %d supplied isn't even, json should be passed in key value pairs. Do you have an extra/missing id? **Tip**: Use --log debug to see a column aligned dump", len(args))
 	}
 
 	firstArrayKeyIdx := -1
@@ -183,7 +204,26 @@ func toJsonObject(args []string, noWrapping bool, compliant bool, attributes map
 	}
 
 	if !noWrapping {
-		result, err = RunJQ(`{ "data": . }`, result)
+
+		if rm, ok := result.(map[string]interface{}); ok {
+			var inc any
+			if included, ok := rm["included"]; ok {
+				delete(rm, "included")
+				inc = included
+
+				result, err = RunJQ(`{ "data": . }`, result)
+
+				if rm2, ok := result.(map[string]interface{}); ok {
+					rm2["included"] = inc
+				}
+			} else {
+				result, err = RunJQ(`{ "data": . }`, result)
+			}
+
+		} else {
+			result, err = RunJQ(`{ "data": . }`, result)
+		}
+
 	}
 
 	jsonStr, err := gojson.Marshal(result)

external/json/to_json_test.go

@@ -2,10 +2,11 @@ package json
 
 import (
 	"fmt"
+	"testing"
+
 	"github.com/elasticpath/epcc-cli/external/aliases"
 	"github.com/elasticpath/epcc-cli/external/resources"
 	"github.com/stretchr/testify/require"
-	"testing"
 )
 
 func init() {
@@ -16,7 +17,7 @@ func init() {
 func TestErrorMessageWhenOddNumberOfValuesPassed(t *testing.T) {
 	// Fixture Setup
 	input := []string{"[0]"}
-	expected := fmt.Errorf("the number of arguments 1 supplied isn't even, json should be passed in key value pairs. Do you have an extra/missing id?")
+	expected := fmt.Errorf("the number of arguments 1 supplied isn't even, json should be passed in key value pairs. Do you have an extra/missing id? **Tip**: Use --log debug to see a column aligned dump")
 
 	// Execute SUT
 	_, actual := ToJson(input, false, true, map[string]*resources.CrudEntityAttribute{}, true, true)
@@ -742,3 +743,18 @@ func TestToJsonDoesNotAddsAdjacentConstantValuesWithoutAnAdjacentObject(t *testi
 		t.Fatalf("Testing json conversion of empty value %s did not match\nExpected: %s\nActually: %s", input, expected, actual)
 	}
 }
+
+// This is primarily a "hack" for manual-orders, could be improved later.
+func TestToJsonLegacyFormatIncludedKeyNotPromoted(t *testing.T) {
+	// Fixture Setup
+	input := []string{"key", "val", "included", "val"}
+	expected := `{"data":{"key":"val"},"included":"val"}`
+
+	// Execute SUT
+	actual, _ := ToJson(input, false, false, map[string]*resources.CrudEntityAttribute{}, true, true)
+
+	// Verification
+	if actual != expected {
+		t.Fatalf("Testing json conversion of empty value %s did not match expected %s, actually: %s", input, expected, actual)
+	}
+}

external/runbooks/account-cart-associations.epcc.yml

@@ -69,6 +69,7 @@ actions:
   delete-accounts-and-carts:
     description:
       short: "Delete all the accounts and their carts"
+    ignore_errors: true
     commands:
       - epcc get -s accounts
       - epcc delete account-cart-association id=acct1_only data[0].type account data[0].id name=acct1

external/runbooks/customer-cart-associations.epcc.yml

@@ -55,8 +55,8 @@ actions:
         epcc create customer --auto-fill email "[email protected]" password test
         epcc create customer --auto-fill email "[email protected]" password test
         epcc create customer --auto-fill email "[email protected]" password test
-        epcc create cart name "Customer 4 Cart" id cust1_only description "Customer 4 Cart"
-        epcc create cart name "Customer 4&5 Shared Cart" id cust1_and_2 description "Customer 4 & 5 Cart"
+        epcc create cart name "Customer 4 Cart" id cust4_only description "Customer 4 Cart"
+        epcc create cart name "Customer 4&5 Shared Cart" id cust4_and_5 description "Customer 4 & 5 Cart"
         epcc create cart name "No Customer Cart" id no_cust_cart_custom_items description "No Customer Cart (Custom Items)"
       - epcc create customer-cart-association id=cust4_only data[0].type customer data[0].id [email protected]
       - epcc create customer-cart-association id=cust4_and_5 data[0].type customer data[0].id [email protected]
@@ -69,7 +69,7 @@ actions:
   delete-customer-and-carts-with-product-items:
     description:
       short: "Delete all the customers and their carts"
-    ignore_errors: false
+    ignore_errors: true
     commands:
       - epcc get -s customers filter 'like(email,*@example.com)'
       - epcc delete customer-cart-association id=cust1_only data[0].type customer data[0].id [email protected]
@@ -109,7 +109,7 @@ actions:
   delete-customer-and-carts-with-custom-items:
     description:
       short: "Delete all the customers and their carts"
-    ignore_errors: false
+    ignore_errors: true
     commands:
       - epcc get -s customers filter 'like(email,*@example.com)'
       - epcc delete customer-cart-association id=cust4_only data[0].type customer data[0].id [email protected]