Json matching function #1690

akaswenwilk · 2024-12-30T10:26:49Z

Summary

This enables flexible json matching based on matcher functions in addition to json equality checks.

Changes

added new JSONMatchedBy func
added a jsonmatch package to compare json objects
added comparison via functions for values of json objects

Motivation

My colleagues and I from every go based team I've worked with have always had difficulty with json. Oftentimes we want to check aspects of certain parts of JSON objects without having to do a full equality check. For instance, determining that a value is a uuid format, or that a datetime is in the past etc etc. While this can be done in other ways such as unmarshalling an object and checking individual values, giving an overview in the form of a json object can be much more clear.

an exmple from one of the tests:

func TestJSONMatchesBy_DeeplyNestedMatchers(t *testing.T) {
	mockT := new(testing.T)
	True(t, JSONMatchesBy(
		mockT,
		`["$THREE", {"foo": {"bar": {"baz": "$NOT_EMPTY"}}}, {"nested": { "array": ["$NOT_EMPTY", "foo"]}}]`,
		`[3, {"foo": {"bar": {"baz": "qux"}}}, {"nested": { "array": ["quux", "foo"]}}]`,
		ValueMatchers{
			"$THREE":     func(v interface{}) bool { return v == 3.0 },
			"$NOT_EMPTY": func(v interface{}) bool { return v != "" },
		}))
}

The only issue I'd like to still solve in another PR is adjusting the display of the diff to factor in matchers. I think it would be better to solve that problem separately.

Related issues

ccoVeille · 2024-12-30T12:40:53Z

assert/assertion_forward.go

@@ -3,6 +3,7 @@
 package assert

 import (
+	jsonmatch "github.com/stretchr/testify/assert/jsonmatch"


Fix the import order please

I think this is what is meant? bdff014

ccoVeille · 2024-12-30T12:41:05Z

assert/assertion_format.go

@@ -3,6 +3,7 @@
 package assert

 import (
+	jsonmatch "github.com/stretchr/testify/assert/jsonmatch"


Fix the imports order please

what do you mean by the order actually? like alphabetically by package name?

also here: bdff014

ccoVeille · 2024-12-30T12:45:15Z

assert/assertions.go

@@ -1703,7 +1689,6 @@ func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interf
 	}

 	return !match
-


These files might need formating for sure, but I would encourage you to revert all these spaces changes. It mess up the history of the files.

If you want to format them, why not, but then please open a PR about it or use a separate commit in your current PR

makes sense, undid the auto formatting: bdff014

ccoVeille · 2024-12-30T12:46:20Z

assert/assertions_test.go

@@ -842,11 +829,9 @@ func TestNil(t *testing.T) {
 	if Nil(mockT, new(AssertionTesterConformingObject)) {
 		t.Error("Nil should return false: object is not nil")
 	}
-


Here also your formatter committed so many changes

oops, i'll adjust this

removed: bdff014

ccoVeille · 2024-12-30T12:55:39Z

assert/assertions_test.go

-	var cases = []struct {
+	cases := []struct {


I'm pretty sure you are using gofumpt as I do 😁

hehe, indeed

also here: bdff014

ccoVeille · 2024-12-30T12:56:51Z

assert/jsonmatch/matches_by.go

+	case float64:
+		n.kind = Number
+		n.value = v


What about json.Number?

instead of float64 for instance?

I'm not opposed to it, but what benefit would it provide?

I'm sorry if I didn't explain it well.

Of course, the float64 case is needed.

My point was about the fact, and maybe I'm wrong, this function could receive data that was, or will be, decoded with UseNumber

https://pkg.go.dev/encoding/json#Decoder.UseNumber

But maybe I'm wrong and it cannot happen

ahh, i see. I think that would have been caught by this test here: https://github.com/stretchr/testify/pull/1690/files#diff-7190065248695df477329c4cada2d71f323ab7940ecffff2d3d5fa43caf79427R2454

ccoVeille · 2024-12-30T12:57:45Z

require/require.go

 	assert "github.com/stretchr/testify/assert"
+	jsonmatch "github.com/stretchr/testify/assert/jsonmatch"
 	http "net/http"
 	url "net/url"
 	time "time"


Please fix these imports please

Yes existing ones are already messed up

adjusted: bdff014

ccoVeille · 2024-12-30T12:58:26Z

require/require_forward.go

 	assert "github.com/stretchr/testify/assert"
+	jsonmatch "github.com/stretchr/testify/assert/jsonmatch"
 	http "net/http"
 	url "net/url"
 	time "time"


ccoVeille · 2024-12-30T14:58:17Z

assert/assertion_format.go

 import (
 	http "net/http"
+	jsonmatch "github.com/stretchr/testify/assert/jsonmatch"
 	url "net/url"
 	time "time"
 )


The canonical way is this

Suggested change

import (

http "net/http"

jsonmatch "github.com/stretchr/testify/assert/jsonmatch"

url "net/url"

time "time"

)

import (

http "net/http"

url "net/url"

time "time"

jsonmatch "github.com/stretchr/testify/assert/jsonmatch"

)

ah, i see. fixed then!

looks like go generate doesn't let me fix the import order: https://github.com/stretchr/testify/actions/runs/12549993792/job/34992001258?pr=1690

Oh indeed then

The files are generated. I assume there is something to improve in the script that generate them. But then it's out of the scope of this PR.

Thank you for trying, and I'm sorry if you had to undo

no prob, thanks for the review!

akaswenwilk · 2024-12-31T19:32:30Z

thanks @ccoVeille for your review and suggested changes! If you have a chance to look over it as well, I'd be grateful to be able to merge it to the main package @boyan-soubachov @dolmen @MovieStoreGuy @arjunmahishi or @brackendawson and also for an idea when/how we might be able to release it. thanks for the help!

dolmen · 2025-01-07T09:18:02Z

This seems to be an interesting feature, but at this time we do not want to increase the API surface of this framework which is already too huge for the limited maintainers resources.

Aaron Kaswen-Wilk added 3 commits December 30, 2024 10:20

add json node with customer marshaling

34cdc2b

finish implementation of json matches by with diff view and tests

f85dd19

fix ci failures

688992a

ccoVeille reviewed Dec 30, 2024

View reviewed changes

akaswenwilk force-pushed the json-matching-function branch from f199b16 to 80861e6 Compare December 30, 2024 13:58

formatting fixes

bdff014

akaswenwilk force-pushed the json-matching-function branch from 80861e6 to bdff014 Compare December 30, 2024 14:00

akaswenwilk requested a review from ccoVeille December 30, 2024 14:00

ccoVeille reviewed Dec 30, 2024

View reviewed changes

formatting fixes

ecbed80

akaswenwilk force-pushed the json-matching-function branch from 3cf1fa9 to ecbed80 Compare December 30, 2024 17:45

akaswenwilk requested a review from ccoVeille December 30, 2024 17:45

ccoVeille approved these changes Dec 30, 2024

View reviewed changes

undo import ordering

dd85eac

ccoVeille approved these changes Dec 31, 2024

View reviewed changes

dolmen added enhancement pkg-mock Any issues related to Mock mock.ArgumentMatcher About matching arguments in mock labels Jan 7, 2025

dolmen closed this Jan 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Json matching function #1690

Json matching function #1690

akaswenwilk commented Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 31, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

ccoVeille Dec 30, 2024

akaswenwilk Dec 30, 2024

akaswenwilk Dec 31, 2024

ccoVeille Dec 31, 2024

akaswenwilk Dec 31, 2024

akaswenwilk commented Dec 31, 2024

dolmen commented Jan 7, 2025

		@@ -1703,7 +1689,6 @@ func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interf
		}

		return !match

Json matching function #1690

Json matching function #1690

Conversation

akaswenwilk commented Dec 30, 2024

Summary

Changes

Motivation

Related issues

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akaswenwilk commented Dec 31, 2024

dolmen commented Jan 7, 2025