Skip to content

Commit

Permalink
go: Add tests for JSON (de)serialization
Browse files Browse the repository at this point in the history
  • Loading branch information
@svix-jplatte
svix-jplatte committed Dec 5, 2024
1 parent 25713a4 commit f179863
Showing 1 changed file with 239 additions and 0 deletions.
239 changes: 239 additions & 0 deletions go/svix_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package svix_test

import (
"context"
"encoding/json"
"errors"
"net/http"
"net/url"
Expand Down Expand Up @@ -114,3 +115,241 @@ func TestStaticNullableString(t *testing.T) {
t.Fatalf("app.Uid is set but shouldn't be")
}
}

func assertMarshalEq(v any, expected string, t *testing.T) {
bytes, err := json.Marshal(v)
if err != nil {
t.Error("JSON serialization failed", err)
return
}

s := string(bytes)
if s != expected {
t.Error("Unexpected serialization", s)
}
}

func TestModelSerialization(t *testing.T) {
ep_in := svix.EndpointIn{
Url: "http://example.local",
}
assertMarshalEq(ep_in, `{"url":"http://example.local"}`, t)

uid := "test"
ep_in.Uid = &uid
assertMarshalEq(ep_in, `{"uid":"test","url":"http://example.local"}`, t)

uid = ""
ep_in.Uid = &uid
assertMarshalEq(ep_in, `{"uid":"","url":"http://example.local"}`, t)

metadata := make(map[string]string)
ep_in.Uid = nil
ep_in.Metadata = &metadata
assertMarshalEq(ep_in, `{"metadata":{},"url":"http://example.local"}`, t)

ep_patch := svix.EndpointPatch{}
assertMarshalEq(ep_patch, `{}`, t)

// FIXME: setting channels to `null` not currently possible
ep_patch.Channels = []string{}
assertMarshalEq(ep_patch, `{"channels":[]}`, t)

ep_patch.Channels = []string{"foo"}
assertMarshalEq(ep_patch, `{"channels":["foo"]}`, t)

ep_patch.Channels = nil
disabled := false
ep_patch.Disabled = &disabled
assertMarshalEq(ep_patch, `{"disabled":false}`, t)

ep_patch.Disabled = nil
ep_patch.Uid = *svix.NullableString(nil)
assertMarshalEq(ep_patch, `{"uid":null}`, t)
}

func TestModelDeserialization(t *testing.T) {
var ep_out svix.EndpointOut

// only required properties
err := json.Unmarshal(
[]byte(`{
"id": "ep_foo",
"metadata": {"foo": "bar"},
"description": "x",
"url": "http://example.local",
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}`),
&ep_out,
)
if err != nil {
t.Fatal("JSON deserialization failed", err)
}
if len(ep_out.Channels) != 0 {
t.Error("unexpected value for channels", ep_out.Channels)
}
if ep_out.Id != "ep_foo" {
t.Error("unexpected value for id", ep_out.Id)
}
if len(ep_out.Metadata) != 1 {
t.Error("unexpected value for metadata", ep_out.Metadata)
}
if ep_out.Metadata["foo"] != "bar" {
t.Error("unexpected value for metadata", ep_out.Metadata)
}
if ep_out.Description != "x" {
t.Error("unexpected value for description", ep_out.Description)
}
if ep_out.Disabled != nil {
t.Error("unexpected value for disabled", ep_out.Disabled)
}
if len(ep_out.FilterTypes) != 0 {
t.Error("unexpected value for filterTypes", ep_out.FilterTypes)
}
if ep_out.RateLimit != nil {
t.Error("unexpected value for rateLimit", ep_out.RateLimit)
}
if ep_out.Uid != nil {
t.Error("unexpected value for uid", ep_out.Uid)
}
if ep_out.Url != "http://example.local" {
t.Error("unexpected value for url", ep_out.Url)
}
if ep_out.Version != 1 {
t.Error("unexpected value for version", ep_out.Version)
}

// full example from API docs
err = json.Unmarshal(
[]byte(`{
"id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
"metadata": {
"property1": "string",
"property2": "string"
},
"description": "string",
"rateLimit": 0,
"uid": "unique-ep-identifier",
"url": "https://example.com/webhook/",
"version": 1,
"disabled": false,
"filterTypes": [
"user.signup",
"user.deleted"
],
"channels": [
"project_123",
"group_2"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}`),
&ep_out,
)
if err != nil {
t.Fatal("JSON deserialization failed", err)
}
if ep_out.Id != "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2" {
t.Error("unexpected value for id", ep_out.Id)
}
if len(ep_out.Metadata) != 2 {
t.Error("unexpected value for metadata", ep_out.Metadata)
}
if ep_out.Metadata["property1"] != "string" {
t.Error("unexpected value for metadata", ep_out.Metadata)
}
if ep_out.Metadata["property2"] != "string" {
t.Error("unexpected value for metadata", ep_out.Metadata)
}
if ep_out.Description != "string" {
t.Error("unexpected value for description", ep_out.Description)
}
if *ep_out.RateLimit != 0 {
t.Error("unexpected value for rateLimit", ep_out.RateLimit)
}
if *ep_out.Uid != "unique-ep-identifier" {
t.Error("unexpected value for uid", ep_out.Uid)
}
if ep_out.Url != "https://example.com/webhook/" {
t.Error("unexpected value for url", ep_out.Url)
}
if ep_out.Version != 1 {
t.Error("unexpected value for version", ep_out.Version)
}
if *ep_out.Disabled != false {
t.Error("unexpected value for disabled", ep_out.Disabled)
}
if len(ep_out.FilterTypes) != 2 {
t.Error("unexpected value for filterTypes", ep_out.FilterTypes)
}
if ep_out.FilterTypes[0] != "user.signup" {
t.Error("unexpected value for filterTypes", ep_out.FilterTypes)
}
if ep_out.FilterTypes[1] != "user.deleted" {
t.Error("unexpected value for filterTypes", ep_out.FilterTypes)
}
if len(ep_out.Channels) != 2 {
t.Error("unexpected value for channels", ep_out.Channels)
}
if ep_out.Channels[0] != "project_123" {
t.Error("unexpected value for channels", ep_out.Channels)
}
if ep_out.Channels[1] != "group_2" {
t.Error("unexpected value for channels", ep_out.Channels)
}

// same example with optional / nullable fields set to null explicitly
// (and empty metadata)
err = json.Unmarshal(
[]byte(`{
"id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
"metadata": {},
"description": "string",
"rateLimit": null,
"uid": null,
"url": "https://example.com/webhook/",
"version": 1,
"disabled": null,
"filterTypes": null,
"channels": null,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}`),
&ep_out,
)
if err != nil {
t.Fatal("JSON deserialization failed", err)
}
if ep_out.Id != "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2" {
t.Error("unexpected value for id", ep_out.Id)
}
if len(ep_out.Metadata) != 0 {
t.Error("unexpected value for metadata", ep_out.Metadata)
}
if ep_out.Description != "string" {
t.Error("unexpected value for description", ep_out.Description)
}
if ep_out.RateLimit != nil {
t.Error("unexpected value for rateLimit", ep_out.RateLimit)
}
if ep_out.Uid != nil {
t.Error("unexpected value for uid", ep_out.Uid)
}
if ep_out.Url != "https://example.com/webhook/" {
t.Error("unexpected value for url", ep_out.Url)
}
if ep_out.Version != 1 {
t.Error("unexpected value for version", ep_out.Version)
}
if ep_out.Disabled != nil {
t.Error("unexpected value for disabled", ep_out.Disabled)
}
if len(ep_out.FilterTypes) != 0 {
t.Error("unexpected value for filterTypes", ep_out.FilterTypes)
}
if len(ep_out.Channels) != 0 {
t.Error("unexpected value for channels", ep_out.Channels)
}
}

0 comments on commit f179863

Please sign in to comment.