Chore/update java employee docs

versioned_docs/version-2.0.0/concepts/installation.md

@@ -64,7 +64,7 @@
 Use "keploy [command] --help" for more information about a command.
 ```
 
 🎉 Wohoo! You are all set to use Keploy.
 
 ## Other Installation Methods
 
@@ -98,7 +98,7 @@
 
 ### Downloading and running Keploy in Native
 
 **Prequisites:**
 
 - Linux Kernel version 5.15 or higher
 - Run `uname -a` to verify the system architecture.
@@ -141,35 +141,3 @@
 > For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
 
 </details>
-
-<details>
-<summary>With Arkade</summary>
-
-### With Arkade
-
-1. Installing Arkade
-
-```bash
-# Note: you can also run without `sudo` and move the binary yourself
-curl -sLS https://get.arkade.dev | sudo sh
-
-arkade --help
-ark --help  # a handy alias
-
-# Windows users with Git Bash
-curl -sLS https://get.arkade.dev | sh
-```
-
-2. Install Keploy
-
-```bash
-arkade get keploy
-```
-
-Or you can also download specific version of Keploy using the following command:
-
-```bash
-arkade get keploy@2.2.0-alpha23
-```
-
-</details>

versioned_docs/version-2.0.0/quickstart/samples-java.md

@@ -29,7 +29,7 @@ keyword:
 A sample Employee-Manager app to test Keploy integration capabilities using **SpringBoot**
 and **PostgreSQL**.
 
-> This sample application is **not written for macOS users** since this application doesn't have a docker file yet.
+> If you are **macOS users** please try the application using docker compose.
 
 import InstallationGuide from '../concepts/installation.md'
 
@@ -49,23 +49,51 @@ git clone https://github.com/keploy/samples-java && cd samples-java/employee-man
 mvn clean install -Dmaven.test.skip=true
 ```
 
+You can start the backend using Keploy in 2 ways:
+
+- [Using Keploy's binary](#instructions-for-starting-using-binary)
+- [Using Keploy's docker image](#instructions-for-starting-using-docker)
+
+
+# Instructions For Starting Using Binary
+
+## Setup the backend
+
+You need to update the postgresql properties, go to
+`spring-petclinic/spring-petclinic-rest/src/main/resources/application-postgresql.properties`
+and change
+
+```bash 
+spring.datasource.url=jdbc:postgresql://postgres:5432/keploy-test/
+```
+
+to
+
+```bash
+spring.datasource.url=jdbc:postgresql://localhost:5432/keploy-test/
+```
+
+and then build the jar using:
+
+```bash
+mvn clean install -Dmaven.test.skip=true
+```
+
 ## Start the Postgres DB 🐳
 
 ```bash
-docker compose up -d
+docker run -e POSTGRES_USER=keploy-user -e POSTGRES_PASSWORD=keploy -e POSTGRES_DB=postgres -p 5432:5432 --name postgres postgres:15.2
 ```
 
 Note: You may have to use sudo if you are not part of the docker group.
 
 ### Capture the testcases 🎬
 
-Once we have our jar file ready,this command will start the recording of API calls using ebpf:-
-
 ```bash
 keploy record -c "java -jar target/springbootapp-0.0.1-SNAPSHOT.jar"
 ```
 
-![Testcases](https://github.com/keploy/samples-java/blob/main/employee-manager/img/test-cases.png?raw=true)
+![Testcases](https://github.com/keploy/samples-java/blob/main/employee-manager/img/keploy-record-docker.png)
 
 Now let's run a few tests to capture some more scenarios:
 
@@ -131,10 +159,10 @@ keploy test -c "java -jar target/springbootapp-0.0.1-SNAPSHOT.jar" --delay 10
 This will run the testcases and generate the report in `keploy/testReports` folder. You will see the following output:-
 
 ````shell
-🐰 Keploy: 2024-02-20T13:49:20Z 	INFO	starting test for of	{"test case": "test-1", "test set": "test-set-1"}
-2024-02-20 13:49:20.778  INFO 18888 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
-2024-02-20 13:49:20.778  INFO 18888 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
-2024-02-20 13:49:20.779  INFO 18888 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 1 ms
+🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    starting test for of    {"test case": "[test-1]", "test set": "[test-set-0]"}
+2025-04-17 13:30:11.410  INFO 28035 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
+2025-04-17 13:30:11.410  INFO 28035 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
+2025-04-17 13:30:11.410  INFO 28035 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 0 ms
 Testrun failed for testcase with id: "test-1"
 
 --------------------------------------------------------------------
@@ -148,48 +176,131 @@ Testrun failed for testcase with id: "test-1"
 |                                                                                                             |
 |                      EXPECT BODY                     |                    ACTUAL BODY                       |
 | -----------------------------------------------------+----------------------------------------------------- |
-|    {                                                 |  {                                                   |
-|      "email": "mt@gmail.com",                        |    "email": "mt@gmail.com",                          |
-|      "firstName": "Myke",                            |    "firstName": "Myke",                              |
-|      "id": 1,                                        |    "id": 1,                                          |
-|      "lastName": "Tyson",                            |    "lastName": "Tyson",                              |
-|   -  "timestamp": 1.70843653e+09                     | +  "timestamp": 1.70843696e+09                       |
+|   {                                                  | {                                                    |
+|    "timestamp": "1744871332" ,                       |  "timestamp": "1744876811" ,                         |
+|   lastName:Tyson                                     | lastName:Tyson                                       |
 |    }                                                 |  }                                                   |
 |                                                      |                                                      |
 |                                                                                                             |
 +-------------------------------------------------------------------------------------------------------------+
-🐰 Keploy: 2024-02-20T13:49:20Z 	INFO	result	{"testcase id": "test-1", "testset id": "test-set-1", "passed": "false"}
-🐰 Keploy: 2024-02-20T13:49:21Z 	INFO	starting test for of	{"test case": "test-2", "test set": "test-set-1"}
+🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    result  {"testcase id": "[test-1]", "testset id": "[test-set-0]", "passed": "[false]"}
+🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    starting test for of    {"test case": "[test-2]", "test set": "[test-set-0]"}
 Testrun passed for testcase with id: "test-2"
 
 --------------------------------------------------------------------
 
-🐰 Keploy: 2024-02-20T13:49:21Z 	INFO	result	{"testcase id": "test-2", "testset id": "test-set-1", "passed": "true"}
-🐰 Keploy: 2024-02-20T13:49:21Z 	INFO	test report for test-set-1: 	{"name: ": "report-2", "path: ": "/Users/neha/open-source/samples-java/employee-manager/keploy/report-2"}
+🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    result  {"testcase id": "[test-2]", "testset id": "[test-set-0]", "passed": "[true]"}
 
-<=========================================>
-TESTRUN SUMMARY. For testrun with id: "test-set-1"
-Total tests: 2
-Total test passed: 1
-Total test failed: 1
+ <=========================================> 
+  TESTRUN SUMMARY. For test-set: "test-set-0"
+        Total tests: 2
+        Total test passed: 1
+        Total test failed: 1
+        Time Taken: "10.37 s"
+ <=========================================> 
 <=========================================>```
 ````
 
 Did you spot that the `timestamp` is showing some differences? Yep, time has a way of doing that! 🕰️
 
 Worry not, just add the ever-changing fields (like our **ts** here) to the **noise parameter** to **dodge those assertions**.
 
-> Pro tip: Add `body.timestamp` to noise in `test-1.yaml`.
+> Pro tip: Add `body.timestamp` to noise in `keploy.yml`.
 
-<img src="/docs/img/code-snippets/java-sample-employee-manager-noise.png" alt="Adding Noise to Test case Java Postgres Employee Manager App" width="70%" style={{ borderRadius: '5px' }}/>
+<img src="https://github.com/keploy/samples-java/blob/main/employee-manager/img/test-noise.png" alt="Adding Noise to Test case Java Postgres Employee Manager App" width="70%" style={{ borderRadius: '5px' }}/>
 
 Run that `keploy test` command once more and watch as everything falls into place with all tests passing! 🌟
 
 Final thoughts? Dive deeper! Try different API calls, tweak the DB response in the `mocks.yml`, or fiddle with the request or response in `test-x.yml`. Run the tests again and see the magic unfold! ✨👩‍💻👨‍💻✨
 
+Next we move on to the instructions to start the application using docker.
+
+# Instructions For Starting Using Docker
+
+Prerequisites For Docker:
+
+1.  Docker Desktop 4.25.2 and above
+
+Here we just need to change the command used to start the application.
+
+```bash
+keploy record -c "docker compose up" --container-name javaApp --build-delay 100
+```
+
+<img src="https://github.com/keploy/samples-java/blob/main/employee-manager/img/Keploy-record-docker-compose.png" alt="Sample Keploy Record Java" width="100%" style={{ borderRadius: '5px' }} />
+
+
+Now let's run a few tests to capture some more scenarios:
+
+#### Generate testcases 📝
+
+To generate testcases we just need to **make some API calls.** You can use [Postman](https://www.postman.com/)
+, [Hoppscotch](https://hoppscotch.io/), or simply `curl`
+
+1. Make an employee entry 📥
+
+```bash
+curl --location --request POST 'http://localhost:8080/api/employees' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "firstName": "Myke",
+    "lastName": "Tyson",
+    "email": "mt@gmail.com",
+    "timestamp":1
+}'
+```
+
+this will return the response or an entry. The timestamp would automatically be ignored during testing because it'll
+always be different.
+
+```bash
+{
+    "id": 1,
+    "firstName": "Myke",
+    "lastName": "Tyson",
+    "email": "mt@gmail.com",
+    "timestamp": 1661493301
+}
+```
+
+2. Fetch recorded info about employees
+
+```bash
+curl --location --request GET 'http://localhost:8080/api/employees/1'
+```
+
+or by querying through the browser `http://localhost:8080/api/employees/1`
+
+Now both these API calls were captured as **editable** testcases and written to `keploy/test` folder. The keploy
+directory would also have `mock.yml` file.
+
+Now, let's see the magic! 🪄💫
+
+## Running the testcases using Keploy
+
+```bash
+keploy test -c "docker compose up" --container-name javaApp --build-delay 50 --delay 20
+```
+
+Your CLI should look something like this
+<img src="/static/img/keploy-test-docker-compose-command.png" alt="Sample Keploy Test Java" width="100%" style={{ borderRadius: '5px' }} />
+
+This is a summary of the test cases recorded
+<img src="https://github.com/keploy/samples-java/blob/main/employee-manager/img/Keploy-test-docker-compose.png" alt="Sample Keploy Test Summary Java" width="100%" style={{ borderRadius: '5px' }} />
+
+Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly.
+`buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself.
+
+
 ### 🎉 Wrapping it up
 
-Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀
+Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 
+
+### 🚀 Wanna try Keploy in CI/CD?
+
+We got you 😎  
+Here’s how to set it up with GitHub Actions:  
+👉 [Keploy + GitHub CI/CD Guide](https://keploy.io/docs/ci-cd/github)
 
 Hope this helps you out, if you still have any questions, reach out to us .