feat(core): YAML Parsing Logic by sung-jun98 · Pull Request #4 · api-ghost/api-ghost

sung-jun98 · 2025-05-01T08:27:16Z

Related Issue

[Feature] Add YAML scenario parser #1

Description

Completed the logic to parse YAML files in the local directory and convert them to DTO.
DTO file definition complete
Add JUnit test code to check if the parsing result is reflected well
The logic to convert a local YAML file into a DTO file has been implemented.

Testing

I printed out whether the values were entered correctly in the DTO class created based on the same content as the test file in Notion.
tested file

Additional Notes

Pre-Submission Checklist

Have you completed code style (convention) checks locally?
Have you passed the CI tests in your local environment?

- Add annotation for parsing to DTO - Add method to convert YAML to DTO - Add test code for conversion logic

cod0216 · 2025-05-01T08:33:52Z

core/src/main/java/com/apighost/model/scenario/testfile/Position.java

+public class Position {
+
+    private Integer x;
+    private Integer y;


Is there a particular reason you used the Integer wrapper class for the coordinate values?

I think If the YAML is generated from the CLI, it could contain null values.

cod0216 · 2025-05-01T08:34:35Z

core/src/main/java/com/apighost/model/scenario/testfile/Position.java

+public class Position {
+
+    private Integer x;
+    private Integer y;


What do you think about using names like positionX and positionY instead of just x and y?

cod0216 · 2025-05-01T08:38:48Z

parser/src/test/java/parser/JacksonConvert.java

+                            if (response != null) {
+                                System.out.println("  response #" + (i + 1));
+
+                                // when 출력


cod0216 · 2025-05-01T08:40:29Z

Other than that, everything looks great. Awesome work! LGTM 👍👍

haerim-kweon · 2025-05-01T08:41:06Z

core/src/main/java/com/apighost/model/scenario/Request.java

+    /**
+     * HTTP methods (GET, POST .etc)
+     */
+    private String method;


I think it would be better to manage it with enum.

You could take a look at my code for reference—it might help!

haerim-kweon · 2025-05-01T08:42:04Z

core/src/main/java/com/apighost/model/scenario/Step.java

+    /**
+     * HTTP or WEBSOCKET
+     */
+    private String type;


I think it would be better to manage it with enum.

You could take a look at my code for reference—it might help! ✌️

haerim-kweon · 2025-05-01T08:43:35Z

core/src/main/java/com/apighost/model/scenario/When.java

+    /**
+     * status of response ex. "200-299" or 200
+     */
+    private Object status;


The object's type definition may benefit from improved type safety.

I think String would be a better choice here.

haerim-kweon · 2025-05-01T08:44:20Z

parser/src/main/java/com/apighost/parser/ScenarioParser.java

+
+    /**
+     * 파일 경로로부터 시나리오 YAML을 파싱
+     *


Please write comments in English.

haerim-kweon · 2025-05-01T08:45:29Z

parser/src/main/java/com/apighost/parser/ScenarioParser.java

+            System.out.println("\nSteps information:");
+            for (int i = 0; i < scenario.getSteps().size(); i++) {
+                Scenario.Step step = scenario.getSteps().get(i);
+                System.out.println("Step " + (i + 1) + ": " + step.getName());


It seems that System.out.println is used quite frequently. Would using StringBuilder or another approach be more efficient?

haerim-kweon · 2025-05-01T08:50:27Z

parser/src/main/java/com/apighost/parser/ScenarioParser.java

+
+            // 각 스텝 정보 출력
+            System.out.println("\nSteps information:");
+            for (int i = 0; i < scenario.getSteps().size(); i++) {


It might be more efficient to avoid calling scenario.getSteps().size() on each iteration of the loop.

kobenlys · 2025-05-01T08:57:09Z

parser/src/test/java/parser/JacksonConvert.java

        Scenario scenario = reader.readScenario(filePath);

-        System.out.println("===== 변환된 Scenario 객체 정보 =====");
+        System.out.println("===== converted Scenario information =====");


Please avoid using System.out.println in test logic! 🏆

kobenlys · 2025-05-01T08:58:54Z

parser/src/test/java/parser/JacksonConvert.java

+            }
+        }
+
+        // steps 출력 (null 체크)


Could you remove the Kr-Comment??

haazz · 2025-05-01T09:01:18Z

parser/src/main/java/com/apighost/parser/reader/YamlScenarioReader.java

+        ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
+
+        File yamlFile = new File(yamlFilePath);
+        Scenario scenario = objectMapper.readValue(yamlFile, Scenario.class);


I think we need to handle an IOException here.

haazz · 2025-05-01T09:06:37Z

core/src/main/java/com/apighost/model/scenario/testfile/Scenario.java

+    private String name;
+    private String description;
+    private String scenarioId;
+    private Integer timeoutMs;


I think it's better to use long type to represent microseconds.

kobenlys · 2025-05-01T09:17:54Z

Appreciated the hardwork @sung-jun98
Stay strong and keep up the great work! 🦾🦾

sung-jun98 added 7 commits May 1, 2025 17:03

feat: made DTOs of Senario

979f3cf

feat: create test scenario YAML model

8c85d74

feat: add comments above DTOs

10727d7

test: delete test file

bfcc27c

refactor: move testDto files to new directory

a62ebee

feat: create readYaml method

8f883a6

- Add annotation for parsing to DTO - Add method to convert YAML to DTO - Add test code for conversion logic

refactor: modified comments and java docs

54f883b

sung-jun98 requested a review from haazz May 1, 2025 08:27

sung-jun98 changed the title ~~Yaml read login~~ feat(core): YAML Parsing Logic May 1, 2025

cod0216 reviewed May 1, 2025

View reviewed changes

haerim-kweon reviewed May 1, 2025

View reviewed changes

kobenlys reviewed May 1, 2025

View reviewed changes

haazz reviewed May 1, 2025

View reviewed changes

sung-jun98 closed this May 1, 2025

haazz added BETA-0.0.1 feature labels May 9, 2025

Conversation

sung-jun98 commented May 1, 2025

Related Issue

Description

Testing

Additional Notes

Pre-Submission Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cod0216 commented May 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kobenlys commented May 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants