vkdoom_m/libraries/cppdap/src/json_serializer_test.cpp
Nikita 45ac7c1d9e
ZScript DAP Debug server (#3009)
* Add STL-standard type traits and functions to TMap to enable for loop iteration

* add third-party range-map library

I have e-mailed the author for clarifcation on the license, will update this when they respond

* vcpkg: Add cppdap and eventpp libraries, update baseline

* DAP implementation

* Add `FileSystem::FileHash()` to get the CRC32 hash

* add `starting_offset` param to `VMDisasm()` for debugger disassembly view

Defaults to `0`, should not change output if it's not set

* Add `VMFrameStack::HasFrames()` to prevent assertions when inspecting in the debugger

* Add `PC` field to VMFrame, ensure that it is updated whenever vm increments/decrements the pc

Does not change alignment, the offsets used in VMFrame still work
We need this for the debugger because we otherwise have no way to get the pc; it was a local in `ExecScriptFunc()`

* `ZCCCompiler::CreateClassTypes()`: ensure SourceLumpName is set for classes derived from non-native classes

* start debug server in d_main, add `vm_debug` cvars and `-debug` CLI arg

* Add documentation for `vm_debug` cvars

* vm_exec: Add debugger hooks for instruction execution events

* c_console: Add debugger hooks for logging events in `PrintString`

* add `.cache/` to gitignore

* vendor cppdap on main @ 6464cd7

Patches:
removed .gitmodules (submodules were thirdparty/json, thirdparty/googletest)
removed thirdparty/googletest, not needed
removed thirdparty/json/docs, thirdparty/json/test, thirdparty/json/benchmarks to prevent massive bloat

* vendor eventpp on master @ 1224dd6

* build: use internal cppdap and eventpp by default

* dap: fix Binary::GetFunctionLineRange()

* fix bug in range_map::find_ranges

* make Binary dap::Source dynamic

* cache source code upon retrieval

* refactor Binary into a class, cleanup PexCache

* fix ending session gracefully

* d_main: Stop debug server in D_Cleanup()

* Fix connecting to debugger when session already started

* cleanup unused stuff in ZScriptDebugger

* always send TerminateEvents on disconnect if initialized

* tweak color display

* Don't cache disassembly lines when scanning scripts

* Cache nodes when getting runtime state

* WIP display locals

* Fix display of static arrays

* Ensure names display in proper order

* dap: Fix struct locals display, add args display

* Support `start` parameter

* Support `filter` parameter

* remove struct unbound native data display

Practically useless for debugging zscript and didn't work properly anyway

* d_main: fix vm_jit and vm_jit not being disabled soon enough

* support breaking on abort exceptions

* dap: refactor game event emitter functions into seperate header

* dap: show native functions on stack

* dap: Remove "Native" from exception handling, simplify exception event emit

* dap: add instruction breakpoints

* dap: fix display of locals not in scope yet

* dap: Make disassembly view display invalid instructions for non-code addresses

* dap: remove dot initializers

* dap: fix local structs in scope

* dap: don't parse the non-used options in the launch/attach requests

* dap: fix local struct view

* dap: Fix displaying objects that aren't their actual types

* dap: Fix action and state handling

* dap: stack display view

* dap: fix object display view

* d_dehacked: set qualified name in addition to the printable name

* dap: fix displaying breakpoint errors when script isn't loaded

* dap: remove debug print

* dap: Display parameter names

* dap: Turn down verbosity of logging

* dap: fix disassembly view

* dap: fix performance problems with arrays

* c_console: emit event only if not PRINT_NODAPEVENT

* dap: improve logging

* dap: update upstream cppdap library to fix deadlocks on no bind

* dap: Fix ending session on client socket closed

* dap: prevent DebugServer.h from pulling in `dap` and `ZScriptDebugger.h`

* dap: fix pause event not being emitted on pause

* dap: remove eventpp emitters, way too slow

* Remove eventpp dependency

* dap: Display correct register names

* dap: Show special inits in registers

* dap: Add stack offset to VMLocalVariable

* dap: fix display of static arrays and local variables on stack vs. registers

* dap: fix displaying function pointers

* dap: tweak color display

* dap: fix scalar display < 4

* dap: add Globals display to debugger

* dap: unify methods to get vmvalue

* dap: rename free method to freeValue to avoid running afoul of macro defs

* fix windows builds

* fix compile on linux

* cleanup

* Fix display of function breakpoints

* dap: Don't send back binary files

* dap: include sbarinfo in script types (no debug support for anything but zscript yet, this is just for returning source info)

* dap: don't show ending session message unless initialized

* fix erroneous commit

* dap: handle evaluate requests

* Fix getting bitfield values

* Add CVars Scope and evaluation

* add running console commands from repl

* dap: disable commands via repl for now

* fix loading functions DECORATE scripts

* Add source information to Dehacked VM functions, add debugging support

* dap: cleanup

* fix resolving archive paths

* don't send source back on native stack frames

* handle `modules` request

* cleanup

* allow evaluating cvars on hover

* fix oob bpinfos

* fix restarting the game blowing out the debug server

* dap: process input events while paused to prevent deadlocks

* fix getting local state

* dap: fix LocalState alignment

* dap: fix DumpStateHelper

* update cppdap protocol version to 1.68.0

* remove cppdap from vcpkg deps

We can't use the upstream version anyway because the maintainers are not merging our patches

* dap: make named variable nodes derive from the same class

* dap: make cvar scope available in native stack frames

* handle local variables with conflicting names

* add I_GetWindowEvent() to win32 to only process window events when debugging is paused

* dap: fix evaluate

* dap: fix display of `out` variables
2025-07-18 00:01:18 -03:00

266 lines
8.8 KiB
C++

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "json_serializer.h"
#include "dap/typeinfo.h"
#include "dap/typeof.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
namespace dap {
struct JSONInnerTestObject {
integer i;
};
DAP_STRUCT_TYPEINFO(JSONInnerTestObject,
"json-inner-test-object",
DAP_FIELD(i, "i"));
struct JSONTestObject {
boolean b;
integer i;
number n;
array<integer> a;
object o;
string s;
optional<integer> o1;
optional<integer> o2;
JSONInnerTestObject inner;
};
DAP_STRUCT_TYPEINFO(JSONTestObject,
"json-test-object",
DAP_FIELD(b, "b"),
DAP_FIELD(i, "i"),
DAP_FIELD(n, "n"),
DAP_FIELD(a, "a"),
DAP_FIELD(o, "o"),
DAP_FIELD(s, "s"),
DAP_FIELD(o1, "o1"),
DAP_FIELD(o2, "o2"),
DAP_FIELD(inner, "inner"));
struct JSONObjectNoFields {};
DAP_STRUCT_TYPEINFO(JSONObjectNoFields, "json-object-no-fields");
struct SimpleJSONTestObject {
boolean b;
integer i;
};
DAP_STRUCT_TYPEINFO(SimpleJSONTestObject,
"simple-json-test-object",
DAP_FIELD(b, "b"),
DAP_FIELD(i, "i"));
} // namespace dap
class JSONSerializer : public testing::Test {
protected:
static dap::object GetSimpleObject() {
return dap::object({{"one", dap::integer(1)},
{"two", dap::number(2)},
{"three", dap::string("three")},
{"four", dap::boolean(true)}});
}
void TEST_SIMPLE_OBJECT(const dap::object& obj) {
NESTED_TEST_FAILED = true;
auto ref_obj = GetSimpleObject();
ASSERT_EQ(obj.size(), ref_obj.size());
ASSERT_TRUE(obj.at("one").is<dap::integer>());
ASSERT_TRUE(obj.at("two").is<dap::number>());
ASSERT_TRUE(obj.at("three").is<dap::string>());
ASSERT_TRUE(obj.at("four").is<dap::boolean>());
ASSERT_EQ(ref_obj.at("one").get<dap::integer>(),
obj.at("one").get<dap::integer>());
ASSERT_EQ(ref_obj.at("two").get<dap::number>(),
obj.at("two").get<dap::number>());
ASSERT_EQ(ref_obj.at("three").get<dap::string>(),
obj.at("three").get<dap::string>());
ASSERT_EQ(ref_obj.at("four").get<dap::boolean>(),
obj.at("four").get<dap::boolean>());
NESTED_TEST_FAILED = false;
}
template <typename T>
void TEST_SERIALIZING_DESERIALIZING(const T& encoded, T& decoded) {
NESTED_TEST_FAILED = true;
dap::json::Serializer s;
ASSERT_TRUE(s.serialize(encoded));
dap::json::Deserializer d(s.dump());
ASSERT_TRUE(d.deserialize(&decoded));
NESTED_TEST_FAILED = false;
}
bool NESTED_TEST_FAILED = false;
#define _ASSERT_PASS(NESTED_TEST) \
NESTED_TEST; \
ASSERT_FALSE(NESTED_TEST_FAILED);
};
TEST_F(JSONSerializer, SerializeDeserialize) {
dap::JSONTestObject encoded;
encoded.b = true;
encoded.i = 32;
encoded.n = 123.456;
encoded.a = {2, 4, 6, 8, 0x100000000, -2, -4, -6, -8, -0x100000000};
encoded.o["one"] = dap::integer(1);
encoded.o["two"] = dap::number(2);
encoded.s = "hello world";
encoded.o2 = 42;
encoded.inner.i = 70;
dap::json::Serializer s;
ASSERT_TRUE(s.serialize(encoded));
dap::JSONTestObject decoded;
dap::json::Deserializer d(s.dump());
ASSERT_TRUE(d.deserialize(&decoded));
ASSERT_EQ(encoded.b, decoded.b);
ASSERT_EQ(encoded.i, decoded.i);
ASSERT_EQ(encoded.n, decoded.n);
ASSERT_EQ(encoded.a, decoded.a);
ASSERT_EQ(encoded.o["one"].get<dap::integer>(),
decoded.o["one"].get<dap::integer>());
ASSERT_EQ(encoded.o["two"].get<dap::number>(),
decoded.o["two"].get<dap::number>());
ASSERT_EQ(encoded.s, decoded.s);
ASSERT_EQ(encoded.o2, decoded.o2);
ASSERT_EQ(encoded.inner.i, decoded.inner.i);
}
TEST_F(JSONSerializer, SerializeObjectNoFields) {
dap::JSONObjectNoFields obj;
dap::json::Serializer s;
ASSERT_TRUE(s.serialize(obj));
ASSERT_EQ(s.dump(), "{}");
}
TEST_F(JSONSerializer, SerializeDeserializeObject) {
dap::object encoded = GetSimpleObject();
dap::object decoded;
_ASSERT_PASS(TEST_SERIALIZING_DESERIALIZING(encoded, decoded));
_ASSERT_PASS(TEST_SIMPLE_OBJECT(decoded));
}
TEST_F(JSONSerializer, SerializeDeserializeEmbeddedObject) {
dap::object encoded;
dap::object decoded;
// object nested inside object
dap::object encoded_embed_obj = GetSimpleObject();
dap::object decoded_embed_obj;
encoded["embed_obj"] = encoded_embed_obj;
_ASSERT_PASS(TEST_SERIALIZING_DESERIALIZING(encoded, decoded));
ASSERT_TRUE(decoded["embed_obj"].is<dap::object>());
decoded_embed_obj = decoded["embed_obj"].get<dap::object>();
_ASSERT_PASS(TEST_SIMPLE_OBJECT(decoded_embed_obj));
}
TEST_F(JSONSerializer, SerializeDeserializeEmbeddedStruct) {
dap::object encoded;
dap::object decoded;
// object nested inside object
dap::SimpleJSONTestObject encoded_embed_struct;
encoded_embed_struct.b = true;
encoded_embed_struct.i = 50;
encoded["embed_struct"] = encoded_embed_struct;
dap::object decoded_embed_obj;
_ASSERT_PASS(TEST_SERIALIZING_DESERIALIZING(encoded, decoded));
ASSERT_TRUE(decoded["embed_struct"].is<dap::object>());
decoded_embed_obj = decoded["embed_struct"].get<dap::object>();
ASSERT_TRUE(decoded_embed_obj.at("b").is<dap::boolean>());
ASSERT_TRUE(decoded_embed_obj.at("i").is<dap::integer>());
ASSERT_EQ(encoded_embed_struct.b, decoded_embed_obj["b"].get<dap::boolean>());
ASSERT_EQ(encoded_embed_struct.i, decoded_embed_obj["i"].get<dap::integer>());
}
TEST_F(JSONSerializer, SerializeDeserializeEmbeddedIntArray) {
dap::object encoded;
dap::object decoded;
// array nested inside object
dap::array<dap::integer> encoded_embed_arr = {1, 2, 3, 4};
dap::array<dap::any> decoded_embed_arr;
encoded["embed_arr"] = encoded_embed_arr;
_ASSERT_PASS(TEST_SERIALIZING_DESERIALIZING(encoded, decoded));
// TODO: Deserializing array should infer basic member types
ASSERT_TRUE(decoded["embed_arr"].is<dap::array<dap::any>>());
decoded_embed_arr = decoded["embed_arr"].get<dap::array<dap::any>>();
ASSERT_EQ(encoded_embed_arr.size(), decoded_embed_arr.size());
for (std::size_t i = 0; i < decoded_embed_arr.size(); i++) {
ASSERT_TRUE(decoded_embed_arr[i].is<dap::integer>());
ASSERT_EQ(encoded_embed_arr[i], decoded_embed_arr[i].get<dap::integer>());
}
}
TEST_F(JSONSerializer, SerializeDeserializeEmbeddedObjectArray) {
dap::object encoded;
dap::object decoded;
dap::array<dap::object> encoded_embed_arr = {GetSimpleObject(),
GetSimpleObject()};
dap::array<dap::any> decoded_embed_arr;
encoded["embed_arr"] = encoded_embed_arr;
_ASSERT_PASS(TEST_SERIALIZING_DESERIALIZING(encoded, decoded));
// TODO: Deserializing array should infer basic member types
ASSERT_TRUE(decoded["embed_arr"].is<dap::array<dap::any>>());
decoded_embed_arr = decoded["embed_arr"].get<dap::array<dap::any>>();
ASSERT_EQ(encoded_embed_arr.size(), decoded_embed_arr.size());
for (std::size_t i = 0; i < decoded_embed_arr.size(); i++) {
ASSERT_TRUE(decoded_embed_arr[i].is<dap::object>());
_ASSERT_PASS(TEST_SIMPLE_OBJECT(decoded_embed_arr[i].get<dap::object>()));
}
}
TEST_F(JSONSerializer, DeserializeSerializeEmptyObject) {
auto empty_obj = "{}";
dap::object decoded;
dap::json::Deserializer d(empty_obj);
ASSERT_TRUE(d.deserialize(&decoded));
dap::json::Serializer s;
ASSERT_TRUE(s.serialize(decoded));
ASSERT_EQ(s.dump(), empty_obj);
}
TEST_F(JSONSerializer, SerializeDeserializeEmbeddedEmptyObject) {
dap::object encoded_empty_obj;
dap::object encoded = {{"empty_obj", encoded_empty_obj}};
dap::object decoded;
_ASSERT_PASS(TEST_SERIALIZING_DESERIALIZING(encoded, decoded));
ASSERT_TRUE(decoded["empty_obj"].is<dap::object>());
dap::object decoded_empty_obj = decoded["empty_obj"].get<dap::object>();
ASSERT_EQ(encoded_empty_obj.size(), decoded_empty_obj.size());
}
TEST_F(JSONSerializer, SerializeDeserializeObjectWithNulledField) {
auto thing = dap::any(dap::null());
dap::object encoded;
encoded["nulled_field"] = dap::null();
dap::json::Serializer s;
ASSERT_TRUE(s.serialize(encoded));
dap::object decoded;
auto dump = s.dump();
dap::json::Deserializer d(dump);
ASSERT_TRUE(d.deserialize(&decoded));
ASSERT_TRUE(encoded["nulled_field"].is<dap::null>());
}