From 2a0a3f049ccff74b1d45315d5ba3fa09713e6929 Mon Sep 17 00:00:00 2001
From: Martin Atkins <mart@degeneration.co.uk>
Date: Tue, 12 Mar 2024 15:24:34 -0700
Subject: Standardize on only two value dumping/diffing libraries

Due to the quite messy heritage of this codebase -- including a large part
of it being just a fork of my earlier personal project ZCL -- there were
many different conventions for how to pretty-print and diff values in the
tests in different parts of the codebase.

To reduce the dependency sprawl, this commit now standardizes on:
  - github.com/davecgh/go-spew for pretty-printing
  - github.com/google/go-cmp for diffing

These two dependencies were already present anyway, are the most general
out of all of the candidates, and are also already in use by at least some
of HCL's most significant callers, such as HashiCorp Terraform.

The version of go-cmp we were previously using seems to have a bug that
causes the tests to crash when run under the Go race detector, so I've
also upgraded that dependency to latest here to clear that bug.
---
 hclwrite/parser_test.go | 33 ++++++---------------------------
 1 file changed, 6 insertions(+), 27 deletions(-)

(limited to 'hclwrite/parser_test.go')

diff --git a/hclwrite/parser_test.go b/hclwrite/parser_test.go
index e557940..8ccae99 100644
--- a/hclwrite/parser_test.go
+++ b/hclwrite/parser_test.go
@@ -5,15 +5,11 @@ package hclwrite
 
 import (
 	"fmt"
-	"reflect"
 	"testing"
 
 	"github.com/davecgh/go-spew/spew"
-
 	"github.com/google/go-cmp/cmp"
 
-	"github.com/kylelemons/godebug/pretty"
-
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/hclsyntax"
 )
@@ -1360,12 +1356,6 @@ func TestPartitionTokens(t *testing.T) {
 		},
 	}
 
-	prettyConfig := &pretty.Config{
-		Diffable:          true,
-		IncludeUnexported: true,
-		PrintStringers:    true,
-	}
-
 	for i, test := range tests {
 		t.Run(fmt.Sprintf("%02d", i), func(t *testing.T) {
 			gotStart, gotEnd := partitionTokens(test.tokens, test.rng)
@@ -1373,7 +1363,7 @@ func TestPartitionTokens(t *testing.T) {
 			if gotStart != test.wantStart || gotEnd != test.wantEnd {
 				t.Errorf(
 					"wrong result\ntokens: %s\nrange: %#v\ngot:   %d, %d\nwant:  %d, %d",
-					prettyConfig.Sprint(test.tokens), test.rng,
+					spew.Sdump(test.tokens), test.rng,
 					gotStart, test.wantStart,
 					gotEnd, test.wantEnd,
 				)
@@ -1437,12 +1427,6 @@ func TestPartitionLeadCommentTokens(t *testing.T) {
 		},
 	}
 
-	prettyConfig := &pretty.Config{
-		Diffable:          true,
-		IncludeUnexported: true,
-		PrintStringers:    true,
-	}
-
 	for i, test := range tests {
 		t.Run(fmt.Sprintf("%02d", i), func(t *testing.T) {
 			gotStart := partitionLeadCommentTokens(test.tokens)
@@ -1450,7 +1434,7 @@ func TestPartitionLeadCommentTokens(t *testing.T) {
 			if gotStart != test.wantStart {
 				t.Errorf(
 					"wrong result\ntokens: %s\ngot:   %d\nwant:  %d",
-					prettyConfig.Sprint(test.tokens),
+					spew.Sdump(test.tokens),
 					gotStart, test.wantStart,
 				)
 			}
@@ -1589,20 +1573,15 @@ foo "bar" "baz" {
 		},
 	}
 
-	prettyConfig := &pretty.Config{
-		Diffable:          true,
-		IncludeUnexported: true,
-		PrintStringers:    true,
-	}
-
 	for _, test := range tests {
 		t.Run(test.input, func(t *testing.T) {
 			got := lexConfig([]byte(test.input))
 
-			if !reflect.DeepEqual(got, test.want) {
-				diff := prettyConfig.Compare(test.want, got)
+			diff := cmp.Diff(test.want, got)
+			if diff != "" {
 				t.Errorf(
-					"wrong result\ninput: %s\ndiff:  %s", test.input, diff,
+					"wrong result\ninput: %s\ndiff:\n%s",
+					test.input, diff,
 				)
 			}
 		})
-- 
cgit v1.2.3