fix(mocklib): fixed false positive file existence checks for mocks in mockLib (#138)

- While recording mocks using mockLib, it was showing that mock already exists since functionality
was checking only folder name and not the actual file in the path.

Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com>

Author: gouravkrosx

README.md

@@ -5,12 +5,12 @@
 
 [//]: # ([![Maven Central](https://img.shields.io/maven-central/v/io.keploy/keploy-sdk/1.2.6.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.keploy%22%20AND%20a:%22keploy-sdk%22%20AND%20v:%221.2.6%22))
 
-
 # Keploy
 
 [Keploy](https://keploy.io) is a no-code testing platform that generates tests from API calls.
 
 This is the client SDK for Keploy API testing platform. There are 2 modes:
+
 1. **Record mode**
     1. Record requests, response and all external calls and sends to Keploy server.
     2. It runs the request on the API again to identify noisy fields.
@@ -20,7 +20,6 @@ This is the client SDK for Keploy API testing platform. There are 2 modes:
     2. Calls the API with same request payload in testcase.
     3. Validates the respones and uploads results to the keploy server
 
-
 The Keploy Java SDK helps you to integrate keploy with java applications. (For other languages,
 see [KEPLOY SDKs](https://docs.keploy.io/application-development))
 
@@ -53,6 +52,17 @@ or to *build.gradle*:
 
     implementation 'io.keploy:keploy-sdk:N.N.N' (eg: 1.2.8)
 
+### KEPLOY_MODE
+
+There are 3 modes:
+
+- **Record**: Sets to record mode.
+- **Test**: Sets to test mode.
+- **Off**: Turns off all the functionality provided by the API
+
+**Note:** `KEPLOY_MODE` value is case sensitive.
+
+
 ## Usage
 
 - **Start keploy server [refer](https://github.com/keploy/keploy#start-keploy-server)**
@@ -77,11 +87,12 @@ or to *build.gradle*:
     - Download the latest - Download the latest agent jar
       from [here](https://search.maven.org/artifact/io.keploy/keploy-sdk/1.2.8/jar)  (eg: 1.2.8)
 
-    - Prefix `-javaagent:` with absolute classpath of agent jar (eg: `-javaagent:<your full path to agent jar>/agent-1.2.8.jar`).
+    - Prefix `-javaagent:` with absolute classpath of agent jar (
+      eg: `-javaagent:<your full path to agent jar>/agent-1.2.8.jar`).
 
-        1. **Using Intellij :** Go to Edit Configuration-> add VM options -> paste _java agent_ edited above.
+        1. **Using Intellij:** Go to Edit Configuration-> add VM options -> paste _java agent_ edited above.
 
-        2. **Using Command Line :** 
+        2. **Using command line:**
             - First add below plugins in your *pom.xml* file.
              ```xml
                   <plugin>
@@ -114,8 +125,11 @@ or to *build.gradle*:
                      </configuration>
                  </plugin>
              ```
-            - And then run this command:`java -javaagent:<your full path to agent jar>/agent-1.2.8.jar -jar <your full path to application jar>.jar`. This command will attach agent jar and also run the application. You need to set some required env variables written below in order to generate test cases. So, run this command after setting the env variables.
-  
+            - And then run this
+              command:`java -javaagent:<your full path to agent jar>/agent-1.2.8.jar -jar <your full path to application jar>.jar`
+              . This command will attach agent jar and also run the application. You need to set some required env
+              variables written below in order to generate test cases. So, run this command after setting the env
+              variables.
 
 
 - **Configure Environment Variables**
@@ -130,11 +144,11 @@ or to *build.gradle*:
     - `DENOISE`            (default DENOISE = false)
       **Note:** By enabling denoise, it will filter out noisy fields for the testcase.
     - `RUN_TEST_BEFORE_RECORD` (default RUN_TEST_BEFORE_RECORD = false)
-      **Note:** It is used to maintain the same database state.
+      **Note:** It is used to maintain the same database state when mocking is disabled.
 
 
 - **Generate testcases**
-    - To generate/capture TestCases set  and run your application.
+    - To generate/capture TestCases set and run your application.
         1. Set `KEPLOY_MODE = record` (default "off")
         2. Run your application.
         3. Make some API calls.
@@ -143,51 +157,57 @@ or to *build.gradle*:
     - **Note:** Before running tests stop the sample application.
 
         - Set `KEPLOY_MODE = test` (default "off")
-            - Using IDE
+            - **Using IDE:**  _(for local use-case we prefer running tests via IDE)_
                 1. Run your application.
                 2. You can also run the application with coverage to see the test coverage.
 
-            - Using command line
-                1. Add below code in your testfile and run `mvn test -DargLine="-javaagent:<your full path to agent jar>.jar"`.
-
-                   ```java
-                      @Test
-                      public void TestKeploy() throws InterruptedException {
+            - If you want to run keploy tests along with other unit testcases. You will be required to set the `javaagent` again in your test profile just like below.
 
-                          CountDownLatch countDownLatch = HaltThread.getInstance().getCountDownLatch();
-                          Mode.setTestMode();
+               ![run_configuration](./src/main/resources/Run_Configuration.png "Run_Configuration")
+             
+               1. Add below code in your testfile and run it with or without coverage.
 
-                          new Thread(() -> {
-                              <Your Application Class>.main(new String[]{""});
-                              countDownLatch.countDown();
-                          }).start();
+                  ```java
+                     @Test
+                     public void TestKeploy() throws InterruptedException {
 
-                          countDownLatch.await();
-                          assertTrue(AssertKTests.result(), "Keploy Test Result");
-                      }
-                   ```     
+                         CountDownLatch countDownLatch = HaltThread.getInstance().getCountDownLatch();
+                         Mode.setTestMode();
 
-                2. To get test coverage, in addition to above follow below instructions.
+                         new Thread(() -> {
+                             <Your Application Class>.main(new String[]{""});
+                             countDownLatch.countDown();
+                         }).start();
 
-                3. Add maven-surefire-plugin to your *pom.xml*.
+                         countDownLatch.await();
+                         assertTrue(AssertKTests.result(), "Keploy Test Result");
+                     }
+                  ```
+                
+              2. **Using command line**
+                 - Add maven-surefire-plugin to your *pom.xml*. In `<argLine> </argLine>` don't add jacoco agent if you don't want coverage report.
 
                    ```xml 
-                        <plugin>
-                            <groupId>org.apache.maven.plugins</groupId>
-                            <artifactId>maven-surefire-plugin</artifactId>
-                            <version>2.22.2</version>
-                            <configuration>
+                     <plugin>
+                         <groupId>org.apache.maven.plugins</groupId>
+                         <artifactId>maven-surefire-plugin</artifactId>
+                         <version>2.22.2</version>
+                         <configuration>
 
-                        <!-- <skipTests>true</skipTests> -->
+                     <!-- <skipTests>true</skipTests> -->
+                         <argLine>
+                            -javaagent:<your full path to agent jar>.jar
+                            -javaagent:${settings.localRepository}/org/jacoco/org.jacoco.agent/0.8.7/org.jacoco.agent-0.8.7-runtime.jar=destfile=target/jacoco.exec-->
+                         </argLine>
 
-                                <systemPropertyVariables>
-                                    <jacoco-agent.destfile>target/jacoco.exec
-                                    </jacoco-agent.destfile>
-                                </systemPropertyVariables>
-                            </configuration>
-                        </plugin>
+                             <systemPropertyVariables>
+                                 <jacoco-agent.destfile>target/jacoco.exec
+                                 </jacoco-agent.destfile>
+                             </systemPropertyVariables>
+                         </configuration>
+                     </plugin>
                    ```  
-                4. Add Jacoco plugin to your *pom.xml*.
+                 - If you want coverage report also add Jacoco plugin to your *pom.xml*.
                       ```xml
                            <plugin>
                               <groupId>org.jacoco</groupId>
@@ -215,7 +235,7 @@ or to *build.gradle*:
                                       </goals>
                                       <configuration>
                                           <!-- Sets the path to the file which contains the execution data. -->
-    
+
                                           <dataFile>target/jacoco.exec</dataFile>
                                           <!-- Sets the output directory for the code coverage report. -->
                                           <outputDirectory>target/my-reports</outputDirectory>
@@ -224,18 +244,31 @@ or to *build.gradle*:
                               </executions>
                           </plugin>
                       ```
-                5. Run your tests using command : `mvn test -DargLine="-javaagent:<your full path to agent jar>.jar"
-                   `.
-
-
-### KEPLOY_MODE
-There are 3 modes:
-- **Record**: Sets to record mode.
-- **Test**: Sets to test mode.
-- **Off**: Turns off all the functionality provided by the API
-
-**Note:** `KEPLOY_MODE` value is case sensitive.
-
+                 - Run your tests using command : `mvn test`.
+
+## Want stubs for unit test cases as well?
+- Java-sdk also supports mocking feature for unit testcase, where you write your own unit test cases and use keploy generated mocks as stubs.
+
+### Usage
+- Set `javaagent` in your unit test file configuration.
+- You just need to set the name of the mock as shown below.
+```java
+    @Test
+    public void testHttpCall() throws Exception {
+        new MockLib("okhttpCall"); //setting name of the mock 
+        ``` your unit test case code goes here ```
+    }
+```
+- You can also provide location where your mocks can be stored using `KEPLOY_MOCK_PATH`. (default **/src/test/e2e/mocks** directory of your application)
+
+
+- **Generate mocks**
+   1. Record mocks by setting `KEPLOY_MODE=record` and run your test file.
+   2. You will be able to see _editable_ and _readable_ mocks at your provided location.
+- **Run your unit testcases**
+   1. Just set `KEPLOY_MODE=test`, run your test file and you are good to go. 
+
+#### 🤩 See, you didn't even need to create a stub for your unit test cases, it's all generated using the java-sdk mock library. 
 
 ## Community support
 

api/src/main/java/io/keploy/service/mock/MockLib.java

@@ -101,7 +101,7 @@ public Kcontext NewContext() {
         }
         System.out.println(name + " -=-==-=-=-= " + mode.value);
         logger.info("Keploy created new mocking context in {} mode {}.If you dont see any logs about your dependencies below, your dependency/s are NOT wrapped.", mode, name);
-        boolean exists = StartRecordingMocks(kctx, mpath, mode.value, name, Config.Overwrite);
+        boolean exists = StartRecordingMocks(mpath + "/" + name + ".yaml", mode.value, name, Config.Overwrite);
         if (exists && !Config.Overwrite) {
             logger.error(" Keploy failed to record dependencies because yaml file already exists {} in directory: {}.", name, mpath);
             Config.MockId.put(name, true);
@@ -111,7 +111,7 @@ public Kcontext NewContext() {
     }
 
 
-    public static boolean StartRecordingMocks(Kcontext kctx, String path, String mode, String name, Boolean overWrite) {
+    public static boolean StartRecordingMocks(String path, String mode, String name, Boolean overWrite) {
         Service.StartMockReq startMockReq = Service.StartMockReq.newBuilder().setMode(mode).setPath(path).setName(name).setOverWrite(overWrite).build();
         Service.StartMockResp startMockResp = blockingStub.startMocking(startMockReq);
         if (startMockResp == null) { // TODO - check how to handle this error
@@ -155,5 +155,4 @@ public static boolean PutMock(String path, Service.Mock mock) {
     }
 
 
-
 }