docs:adding Java docs to the code base (keploy#143)

* Adding Java docs

Signed-off-by: charankamarapu <[email protected]>

* Adding Java docs

Signed-off-by: charankamarapu <[email protected]>

---------

Signed-off-by: charankamarapu <[email protected]>

Author: charankamarapu

agent/src/main/java/io/keploy/advice/CustomGoogleResponseAdvice.java

@@ -13,8 +13,16 @@
 import java.lang.reflect.Method;
 import java.util.Objects;
 
+/**
+ * This class is used for intercepting method parseResponse of OkHttpPendingResult class and to record required data from
+ * the method
+ */
 public class CustomGoogleResponseAdvice {
 
+    /**
+     * This method gets executed before method parseResponse of OkHttpPendingResult class. In record mode it saves the
+     * data from the parseResponse method arguments and help in recording mocks/tests.
+     */
     @Advice.OnMethodEnter
     static void enterMethods(@Advice.Origin Method method, @Advice.AllArguments Object[] obj) throws Exception {
         final Logger logger = LogManager.getLogger(CustomGoogleResponseAdvice.class);

agent/src/main/java/io/keploy/advice/OkHttpAdvice_Kotlin.java

@@ -9,13 +9,24 @@
 import java.lang.reflect.Constructor;
 
 
+/**
+ * This class is used for intercepting constructor of OkHttpClient$Builder class and to add an interceptor to its builder
+ */
 public class OkHttpAdvice_Kotlin {
 
-
+    /**
+     * This method gets executed before the constructor of OkHttpClient$Builder class.This does nothing as we don't
+     * want to change anything before the invocation of OkHttpClient$Builder constructor.
+     */
     @Advice.OnMethodEnter
     static void enterMethods(@Advice.Origin Constructor constructor) throws Exception {
     }
 
+    /**
+     * This method gets executed after constructor of OkHttpClient$Builder class and Adds a interceptor to its builder
+     *
+     * @param builder - OkHttpClient.Builder
+     */
     @Advice.OnMethodExit
     static void exitMethods(@Advice.Origin Constructor constructor, @Advice.This OkHttpClient.Builder builder) {
         final Logger logger = LogManager.getLogger(OkHttpAdvice_Kotlin.class);

agent/src/main/java/io/keploy/advice/ksql/DataBaseMetaData_Advice.java

@@ -1,6 +1,5 @@
 package io.keploy.advice.ksql;
 
-
 import io.keploy.ksql.KDatabaseMetaData;
 import net.bytebuddy.asm.Advice;
 import org.apache.logging.log4j.LogManager;
@@ -9,12 +8,27 @@
 import java.lang.reflect.Constructor;
 import java.sql.DatabaseMetaData;
 
+
+/**
+ * This class is used for intercepting constructor of NewProxyDatabaseMetaData class and to replace value of a field to
+ * a custom value i.e. KDatabaseMetaData on exit of that constructor method.
+ */
 public class DataBaseMetaData_Advice {
 
+    /**
+     * This method gets executed before the constructor of NewProxyDatabaseMetaData class.This does nothing as we don't
+     * want to change anything before the invocation of NewProxyDatabaseMetaData constructor.
+     */
     @Advice.OnMethodEnter
     static void enterMethods(@Advice.Origin Constructor constructor) throws Exception {
     }
 
+    /**
+     * This method gets executed after constructor of NewProxyDatabaseMetaData class and replaces the value of field metaData
+     * to KDatabaseMetaData .
+     *
+     * @param metaData - a field in NewProxyDatabaseMetaData class
+     */
     @Advice.OnMethodExit
     static void exitMethods(@Advice.Origin Constructor constructor, @Advice.FieldValue(value = "inner", readOnly = false) DatabaseMetaData metaData) {
         final Logger logger = LogManager.getLogger(DataBaseMetaData_Advice.class);

agent/src/main/java/io/keploy/advice/ksql/HealthCheckInterceptor.java

@@ -4,19 +4,30 @@
 
 import java.lang.reflect.Method;
 
+/**
+ * This class is used for intercepting method withDetail of Health$Builder class and to replace an argument value to
+ * a custom value on entry of that withDetail method.
+ */
 public class HealthCheckInterceptor {
 
+    /**
+     * This method gets executed before the withDetail method of Health$Builder class.In test mode of keploy this method
+     * will throw error as we don't get health check from database. so we mock the health check response and feed it to
+     * the method. Whenever the value of the health check argument is NULL we replace it with "HI" so that the method
+     * never fails
+     */
     @Advice.OnMethodEnter
     public static void enterMethod(@Advice.Origin Method method, @Advice.Argument(value = 0, readOnly = false) String key, @Advice.Argument(value = 1, readOnly = false) Object value) {
-//        System.out.println("Inside Enter Advice: " + method);
-//        System.out.println("Health Checkk !!");
         if (value == null) {
             value = "HI";
         }
     }
 
+    /**
+     * This method gets executed after the withDetail method of Health$Builder class.This does nothing as we don't
+     * want to change anything after the completion of withDetail method of Health$Builder class.
+     */
     @Advice.OnMethodExit
     public static void exitMethod(@Advice.Origin Method method) {
-//        System.out.println("Inside Exit Advice: " + method);
     }
 }

agent/src/main/java/io/keploy/advice/ksql/RegisterDialect.java

@@ -7,16 +7,27 @@
 import java.lang.reflect.Constructor;
 import java.util.Map;
 
+/**
+ * This class is used for intercepting constructor of JpaProperties class and to modify the value of a field value of
+ * the class on exit of that constructor method.
+ */
 public class RegisterDialect {
 
+    /**
+     * This method gets executed before the constructor of JpaProperties class.This does nothing as we don't
+     * want to change anything before the invocation of JpaProperties constructor.
+     */
     @Advice.OnMethodEnter
     static void enterMethods(@Advice.Origin Constructor constructor) throws Exception {
-//        System.out.println("Inside RegisterDialect Enter Advice: " + constructor);
     }
 
+    /**
+     * This method gets executed after constructor of JpaProperties class and modifies the value of the field - properties.
+     *
+     * @param properties - a field in JpaProperties class
+     */
     @Advice.OnMethodExit
     static void exitMethods(@Advice.Origin Constructor constructor, @Advice.FieldValue(readOnly = false, value = "properties") Map<String, String> properties) throws Exception {
-//        System.out.println("Inside RegisterDialect Exit Advice: " + constructor);
         properties.put("hibernate.dialect", KDriver.Dialect);
     }
 }

agent/src/main/java/io/keploy/advice/ksql/RegisterDriverAdvice.java

@@ -5,12 +5,19 @@
 
 import java.lang.reflect.Method;
 
-//@Component
+/**
+ * This class is used for intercepting method setDriverClassName of DataSourceProperties class and to replace an argument value to
+ * a custom value on entry of setDriverClassName method.
+ */
 public class RegisterDriverAdvice {
 
+    /**
+     * This method gets executed before the setDriverClassName method of DataSourceProperties class. According to the
+     * driverClassName that is present, Dialect of KDriver is changed and driverClassName value is replaced with KDriver
+     * path
+     */
     @Advice.OnMethodEnter
     public static void enterMethod(@Advice.Origin Method method, @Advice.Argument(value = 0, readOnly = false) String driverClassName) {
-//        System.out.println("Entering method[" + method + "] with argument[" + driverClassName + "] from EnterAdvice");
 
         if (driverClassName != null && !driverClassName.equals("io.keploy.ksql.KDriver")) {
             KDriver.DriverName = driverClassName;
@@ -32,16 +39,14 @@ public static void enterMethod(@Advice.Origin Method method, @Advice.Argument(va
                     System.out.println("Dialect for driver: " + driverClassName + " is not supported yet");
             }
         }
-//        mode.ModeType KEPLOY_MODE = mode.getMode();
-//        System.out.println(KEPLOY_MODE);
-//        if (KEPLOY_MODE.equals(mode.ModeType.MODE_OFF)){
-//            return;
-//        }
         driverClassName = "io.keploy.ksql.KDriver";
     }
 
+    /**
+     * This method gets executed after the setDriverClassName method of DataSourceProperties class.This does nothing as we don't
+     * want to change anything after the completion of the setDriverClassName method of DataSourceProperties class.
+     */
     @Advice.OnMethodExit
     public static void exitMethod(@Advice.Origin Method method) {
-//        System.out.println("exit advice -> " + method);
     }
 }

agent/src/main/java/io/keploy/advice/ksql/RegisterDriverAdvice_Interceptor.java

@@ -8,12 +8,24 @@
 import java.util.concurrent.Callable;
 
 
+/**
+ * This class is used for intercepting method determineDriverClassName of DataSourceProperties class and returns a
+ * custom value instead of value returned by the determineDriverClassName method .
+ */
 public class RegisterDriverAdvice_Interceptor {
 
+    /**
+     * This method will get called instead of determineDriverClassName
+     * @param client - original method client
+     * @param method - contains all the details regarding original method
+     * @return - path to Driver class
+     */
     public static String execute(@SuperCall Callable<String> client, @Origin Method method) throws Exception {
-//        System.out.println("Inside RegisterDriverAdvice_Interceptor -> " + method);
+
+        // Getting actual response from original method
         String s = client.call();
-//        System.out.println("determineDriverClassName returns : " + s);
+
+        // Changing KDriver Dialect according to the response from original method
         if (s != null && !s.equals("io.keploy.ksql.KDriver")) {
             KDriver.DriverName = s;
             switch (s) {
@@ -34,6 +46,8 @@ public static String execute(@SuperCall Callable<String> client, @Origin Method
                     System.out.println("Dialect for driver: " + s + " is not supported yet");
             }
         }
+
+        // returning wrapped Driver class path
         return "io.keploy.ksql.KDriver";
     }
 }

agent/src/main/java/io/keploy/advice/ksql/SetDdlAuto_Advice.java

@@ -4,16 +4,26 @@
 
 import java.lang.reflect.Method;
 
+/**
+ * This class is used for intercepting method setDdlAuto of HibernateProperties class and to replace an argument value to
+ * a custom value on entry of setDdlAuto method.
+ */
 public class SetDdlAuto_Advice {
 
+    /**
+     * This method gets executed before the setDdlAuto method of HibernateProperties class. According to the
+     * Keploy mode that is present, The argument value will be changed.
+     */
     @Advice.OnMethodEnter
     public static void enterMethod(@Advice.Origin Method method, @Advice.Argument(value = 0, readOnly = false) String ddlAuto) {
-//        System.out.println("Entering method[" + method + "] with argument[" + ddlAuto + "] from EnterAdvice");
         ddlAuto = (System.getenv("KEPLOY_MODE").equals("test")) ? "none" : ddlAuto;
     }
 
+    /**
+     * This method gets executed after the setDdlAuto method of HibernateProperties class.This does nothing as we don't
+     * want to change anything after the completion of the setDdlAuto method of HibernateProperties class.
+     */
     @Advice.OnMethodExit
     public static void exitMethod(@Advice.Origin Method method) {
-//        System.out.println("exit advice -> " + method);
     }
 }

agent/src/main/java/io/keploy/advice/ksql/SetEnabled_Advice.java

@@ -4,16 +4,26 @@
 
 import java.lang.reflect.Method;
 
+/**
+ * This class is used for intercepting method setEnabled of LiquibaseProperties class and to replace an argument value to
+ * a custom value on entry of setEnabled method.
+ */
 public class SetEnabled_Advice {
 
+    /**
+     * This method gets executed before the setEnabled method of LiquibaseProperties class. According to the
+     * Keploy mode that is present, The argument value will be changed
+     */
     @Advice.OnMethodEnter
     public static void enterMethod(@Advice.Origin Method method, @Advice.Argument(value = 0, readOnly = false) boolean enabled) {
-//        System.out.println("Entering method[" + method + "] with argument[" + enabled + "] from EnterAdvice");
         enabled = (System.getenv("KEPLOY_MODE").equals("test")) ? false : enabled;
     }
 
+    /**
+     * This method gets executed after the setEnabled method of LiquibaseProperties class.This does nothing as we don't
+     * want to change anything after the completion of the setEnabled method of LiquibaseProperties class.
+     */
     @Advice.OnMethodExit
     public static void exitMethod(@Advice.Origin Method method) {
-//        System.out.println("exit advice -> " + method);
     }
 }