Created test code for parsing JSON files into JSON objects and then into Game objects. #599

noahklowden · 2020-05-17T23:11:51Z

I have written test code in a sandbox directory in src/wdl that can be used to test parsing JSON objects (Explained in further detail in #485.

This code currently faces compiler errors as I was unable to figure out how to integrate the necessary code from the game-state using the Makefile. I suspect that, because of the switch from Make to CMake, there is no longer a Makefile that can make the game-state files into executables for me to be able to use for the test.

However, apart from being unable to integrate the game-state functions, the code should be functional once the Makefile issue is resolved.

Closes #485.

…d_rooms.wdl' in the tests directory

…chiventure into wdl/json_parse_test

…s to code. Fixed warnings of unused inputs in code.

…r to have parsing occur in separate function from main.

… will add rooms to the game.

…game.c

dtbukowski

Nice work. I tested the code before all of the game stuff got added and the code works. This code should work when the makefile error is fixed. However, I don't know enough about game state to fix the error of a missing game.h file.

src/wdl/sandbox/parser.c

src/wdl/sandbox/parser.h

MaxineK36

This is a great start in terms of practicing with the json parsing library, but needs a couple modifications before it'll be useful in the sandbox. Also, I've suggested a stopgap solution to your makefile issue.

src/wdl/sandbox/Makefile

MaxineK36 · 2020-05-21T05:53:24Z

src/wdl/sandbox/parser.c

+
+
+/* DEBUG is 0 normally, 1 to print debugging statements */
+#define DEBUG 1


Make sure to change to 0 before this merges

MaxineK36 · 2020-05-21T05:53:39Z

src/wdl/sandbox/parser.c

+
+/* Helper function: to print debugging statements only when debugging */
+int my_print(char *string) {
+


Please delete these excess spaces (lines 14 and 18)

MaxineK36 · 2020-05-21T05:54:09Z

src/wdl/sandbox/parser.c

+    /* reads the input file */
+    fp = fopen(filename, "r");
+    assert(fp);
+    fread(buffer, 4096, 1, fp);


What happens if the file is empty?

MaxineK36 · 2020-05-21T05:54:24Z

src/wdl/sandbox/parser.c

+
+game_t *parse_wdl(char* filename) {
+    FILE *fp;
+    char buffer[4096];


Please declare a macro for 4096

src/wdl/sandbox/parser.c

…if jsonobjs are libobjs, however makefile has problems

dtbukowski · 2020-05-22T23:53:31Z

@MaxineK36 I had problems with implementing the workaround as you suggested. I got an error that says /usr/bin/ld: cannot find -l:ibgame-state.a when using -l:$libgame
Now I doubt that the makefile should be trying to find -l:ibgame-state.a, so I tried -lgame-state.a and that didn't work either. You sure that the library should be -l:$libgame?

Also I was pretty certain that having an empty file would result in reading 0 bytes. This stackoverflow should confirm that:
https://stackoverflow.com/questions/18255384/read-an-empty-file-with-fread

Also, I see that the this task is still part of sprint 2. Should this be changed? The ideal situation would (I'm guessing) to do something at the start of this sprint. But what action should be done now?

MaxineK36 · 2020-05-23T03:03:14Z

@dtbukowski It's ok that this is still assigned to sprint2 since it's associated with a sprint2 issue.
@noahklowden Please make sure you're checking this regularly (or that you have email notifications set up) so that you can update as needed when changes are requested, and re-request our reviews once you've made the changes.

re: Makefile: It looks like there were just a few typos in the Makefile, but I just pushed a commit that should resolve this and allow "make" to function properly. Now that this is working, I'm going to go through and review this PR again.

MaxineK36

Make is now working, and I've noticed a couple of other things that need fixing.

MaxineK36 · 2020-05-23T03:04:24Z

src/wdl/sandbox/parser.c

+
+int add_rooms_to_game(json_object *rooms, game_t *g) {
+
+    //initializes json_objects for use in making room_t


Comments referring to multiple lines of code should be block comments
(/* Some comment here */)

I changed all of the code that should be block comments

src/wdl/sandbox/parser.c

… to 0

dtbukowski · 2020-05-23T03:37:45Z

I implemented all of the small fix-ups that Maxine did. An error message shows when there are no arguments. Also got rid of a warning by using the return result of fread to get number of bytes parsed, where if it equals zero then the file is empty.

… parsed from the returned game object. Also fixed fread file so that empty file text only displays when file is actually empty.

noahklowden · 2020-05-23T07:22:10Z

I added actual code that will show the game object and rooms were properly parsed by the code. This should make the code complete for the purposes of being a demonstration of the ease of parsing JSON files into game objects (or any other type of objects we want to convert it to).

MaxineK36

Looking good! This should be helpful as you continue working on the parser for wdl++.

MaxineK36 · 2020-05-26T01:47:39Z

Issue Score: ✔️

Comments:
This is a very solid first PR, with an excellent summary. A few things to think about for next time:

Make sure that, when you create a PR, the code is ready for review and passes all the tests. The Makefile problem on this PR should have been resolved (either on your own or with my help) before making a PR.
When a pull request is merged, you should include a final comment summarizing what was done, and why the PR is being closed.

noahklowden · 2020-05-26T02:04:44Z

This code has successfully been merged into the dev branch. It should now act as a basis for how we can implement parsing JSON files into code. With this, this pull request is officially closed.

Noah Elliot Chewbacca Klowden and others added 14 commits May 9, 2020 18:09

adding a test text file to add sandbox directory

650240f

Created a test json file as 'connected_rooms.jwdl' based on 'connecte…

7afc2f5

…d_rooms.wdl' in the tests directory

Added a README file

131b6af

Created a Makefile and the first parser test function.

0235844

Removed text.txt

269c967

Updated README.md

20a6689

Fixed Makefile to compile parser properly

413d350

Merge branch 'wdl/json_parse_test' of https://github.com/uchicago-cs/…

66395b0

…chiventure into wdl/json_parse_test

Added first test to ensure information could be printed. Added assert…

7fc6ba1

…s to code. Fixed warnings of unused inputs in code.

Updated header file to be used to specify functions. Rearranged parse…

1fb1633

…r to have parsing occur in separate function from main.

Proper swap to .jwdl instead of .json

8648ff2

This time actually pushing with connected_rooms.jwdl

fc06e83

Rewrote parser so that it would return game_t. Added in a parser that…

dfccaef

… will add rooms to the game.

Fixed some typos. Continued trying to get the Makefile to connect to …

05d30e4

…game.c

noahklowden added the x/wdl label May 17, 2020

noahklowden added this to the 2020/Sprint 2 milestone May 17, 2020

noahklowden requested review from MaxineK36 and dtbukowski May 17, 2020 23:11

noahklowden self-assigned this May 17, 2020

noahklowden linked an issue May 17, 2020 that may be closed by this pull request

Write test WDL++ files and JSON parsers to test out parsing of JSON files for WDL purposes #485

Closed

dtbukowski approved these changes May 18, 2020

View reviewed changes

src/wdl/sandbox/parser.c Show resolved Hide resolved

src/wdl/sandbox/parser.h Show resolved Hide resolved

MaxineK36 requested changes May 21, 2020

View reviewed changes

dtbukowski and others added 2 commits May 22, 2020 18:11

Merge branch 'dev' into wdl/json_parse_test

c849b6d

Did the small changes that were requested besides doing tests to see …

44bb8ab

…if jsonobjs are libobjs, however makefile has problems

MaxineK36 self-requested a review May 23, 2020 02:49

Resolving makefile issues

0157a70

MaxineK36 requested changes May 23, 2020

View reviewed changes

Added print statements for no arguments, empty file and changed Debug…

67b2c5b

… to 0

Made all changes requested by Maxine

b9870f9

Added code to main function that prints out game information that was…

9deddaa

… parsed from the returned game object. Also fixed fread file so that empty file text only displays when file is actually empty.

MaxineK36 self-requested a review May 24, 2020 03:45

MaxineK36 approved these changes May 24, 2020

View reviewed changes

Merge branch 'dev' into wdl/json_parse_test

a85574e

MaxineK36 merged commit 0f45867 into dev May 24, 2020

noahklowden mentioned this pull request May 26, 2020

Write test WDL++ files and JSON parsers to test out parsing of JSON files for WDL purposes #485

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created test code for parsing JSON files into JSON objects and then into Game objects. #599

Created test code for parsing JSON files into JSON objects and then into Game objects. #599

noahklowden commented May 17, 2020

dtbukowski left a comment

MaxineK36 left a comment

MaxineK36 May 21, 2020

MaxineK36 May 21, 2020

MaxineK36 May 21, 2020

MaxineK36 May 21, 2020

dtbukowski commented May 22, 2020

MaxineK36 commented May 23, 2020

MaxineK36 left a comment

MaxineK36 May 23, 2020

dtbukowski May 23, 2020

dtbukowski commented May 23, 2020

noahklowden commented May 23, 2020

MaxineK36 left a comment

MaxineK36 commented May 26, 2020

noahklowden commented May 26, 2020



		/* DEBUG is 0 normally, 1 to print debugging statements */
		#define DEBUG 1


		/* Helper function: to print debugging statements only when debugging */
		int my_print(char *string) {


		int add_rooms_to_game(json_object rooms, game_t g) {

		//initializes json_objects for use in making room_t

Created test code for parsing JSON files into JSON objects and then into Game objects. #599

Created test code for parsing JSON files into JSON objects and then into Game objects. #599

Conversation

noahklowden commented May 17, 2020

dtbukowski left a comment

Choose a reason for hiding this comment

MaxineK36 left a comment

Choose a reason for hiding this comment

MaxineK36 May 21, 2020

Choose a reason for hiding this comment

MaxineK36 May 21, 2020

Choose a reason for hiding this comment

MaxineK36 May 21, 2020

Choose a reason for hiding this comment

MaxineK36 May 21, 2020

Choose a reason for hiding this comment

dtbukowski commented May 22, 2020

MaxineK36 commented May 23, 2020

MaxineK36 left a comment

Choose a reason for hiding this comment

MaxineK36 May 23, 2020

Choose a reason for hiding this comment

dtbukowski May 23, 2020

Choose a reason for hiding this comment

dtbukowski commented May 23, 2020

noahklowden commented May 23, 2020

MaxineK36 left a comment

Choose a reason for hiding this comment

MaxineK36 commented May 26, 2020

noahklowden commented May 26, 2020