[#1878] Updating SystemTestUtil::assertJson to compare Json objects instead of line-by-line analysis

[asdfghjkxd]

Fixes #1878

Proposed commit message

`SystemTestUtil::assertJson` currently checks if two JSON files are
equal by comparing the file contents line by line rather than by
converting the files directly into JSON objects, which can then be
directly compared using the built-in `equals` methods for
`JsonElement`.

This process also does not automatically check if the file is indeed a
JSON file, and implicitly assumes that the input paths are paths to
JSON files. This may cause expected behaviours if a user accidentally
or intentionally includes a path to a non-JSON file within the method
calls.

Let's move to refactor the code, and utilise the built-in methods for
`JsonElement` objects to check for the equality of JSON objects.

Other information

The original issue alludes to the use of JsonObject in the fixes, however, while trying to get the system test cases to run, it appears that this method is to be used on JsonObject and JsonArray as well. JsonElement was hence chosen as a suitable class that encapsulates the information of the parsed JSON objects, while allowing for equality of the JSON objects to be checked.

[jonasongg]

Not sure if this is strictly necessary, but you might want to put both FileReader instantiations in the try () block so that they will automatically close. Otherwise, LGTM!

[asdfghjkxd]

That's a good suggestion! I will look into moving FileReader into the try-with-resources clause!

[asdfghjkxd]

@jonasongg Just an update, but after having reviewed the code, it seems that both instances of FileReader are instantiated within the try-with-resources clause. Both FileReaders should close after the assertion is executed!

[sopa301]

LGTM!

[gok99]

LGTM!

[MarcusTXK]

LGTM, nice job

[github-actions]

The following links are for previewing this pull request:

• Dashboard Preview: https://dashboard-2087-pr-reposense-reposense.surge.sh
• Docs Preview: https://docs-2087-pr-reposense-reposense.surge.sh