Add API to get the array of method parameters given the callable object.

Signed-off-by: Rahul Krishna <[email protected]>

Author: rahlk

package.json

@@ -38,10 +38,12 @@
     "JSONStream": "^1.3.5",
     "bun": "^1.2.10",
     "c8": "^10.1.3",
+    "chalk": "^5.4.1",
     "extract-zip": "^2.0.1",
     "fast-glob": "^3.3.3",
     "graphology": "^0.26.0",
     "loglevel": "^1.9.2",
+    "signale": "^1.4.0",
     "zod": "^3.24.3"
   },
   "testing": {

src/analysis/java/JavaAnalysis.ts

@@ -262,4 +262,36 @@ export class JavaAnalysis {
   public async getMethodParameters(qualifiedName: string, methodName: string): Promise<Array<types.JCallableParameterType>> {
     return (await this.getMethodByQualifiedName(qualifiedName, methodName)).parameters ?? [];
   }
+
+  /**
+   * Get all the method parameters in a specific method within a specific class by its callable object.
+   * @param {types.JCallableType} callable - The callable object representing the method to retrieve
+   * @returns {Promise<Array<types.JCallableParameterType>>} A promise that resolves to an array of {@link JCallableParameterType} objects
+   * 
+   * @notes This method retrieves all the parameters of a specific method from the application by its callable object.
+   * If the method is found, it returns an array of {@link JCallableParameter} objects representing
+   * the parameters of the method. Otherwise, it returns an empty array.
+   */
+  public async getMethodParametersFromCallable(callable: types.JCallableType): Promise<Array<types.JCallableParameterType>> {
+    return callable.parameters ?? [];
+  }
+
+  /**
+   * Get the java file path given the qualified name of the class.
+   * @param {string} qualifiedName - The qualified name of the class to retrieve
+   * @returns {Promise<string>} A promise that resolves to the file path of the Java file containing the class
+   * @throws {Error} If the class is not found in the application.
+   * 
+   * @notes This method retrieves the file path of the Java file containing the class with the specified qualified name.
+   * If the class is found, it returns the file path as a string. If the class is not found, it throws an error.
+   */
+  public async getJavaFilePathByQualifiedName(qualifiedName: string): Promise<string> {
+    const symbolTable = await this.getSymbolTable();
+    for (const [filePath, compilationUnit] of Object.entries(symbolTable)) {
+      if (Object.keys(compilationUnit.type_declarations).includes(qualifiedName)) {
+        return filePath;
+      }
+    }
+    throw new Error(`Class ${qualifiedName} not found in the application.`);
+  }
 }

test/conftest.ts

@@ -20,9 +20,8 @@
 
 import * as fs from 'fs';
 import * as path from 'path';
-import * as https from 'https';
 import extract from 'extract-zip';
-import {beforeAll, afterAll } from "bun:test";
+import { beforeAll, afterAll } from "bun:test";
 import { CLDK } from "../src/CLDK";
 
 /*
@@ -36,7 +35,7 @@ beforeAll(async () => {
     const javaSampleAppsDir = path.join(__dirname, "test-applications", "java");
     const appZipFile = path.join(javaSampleAppsDir, "sample.daytrader8-1.2.zip");
     const extractedDir = path.join(javaSampleAppsDir, "sample.daytrader8-1.2");
-    await extract(appZipFile, {dir: javaSampleAppsDir});
+    await extract(appZipFile, { dir: javaSampleAppsDir });
 
     /**
      * I am just hardcoding the extracted directory name for now. The extracted directory name would follow GitHub's
@@ -63,7 +62,7 @@ beforeAll(async () => {
  */
 afterAll(async () => {
     if (dayTraderApp) {
-        fs.rmSync(dayTraderApp, {recursive: true, force: true});
+        fs.rmSync(dayTraderApp, { recursive: true, force: true });
     }
 })
 

test/unit/analysis/java/JavaAnalysis.test.ts

@@ -1,6 +1,10 @@
 import { JCallable, JCallableParameter, JType } from "../../../../src/models/java/";
 import { daytraderJavaAnalysis } from "../../../conftest";
 import { expect, test } from "bun:test";
+import chalk from "chalk";
+import { Signale } from "signale";
+
+const logger = new Signale();
 
 test("Must get analysis object from JavaAnalysis object", () => {
   expect(daytraderJavaAnalysis).toBeDefined();
@@ -60,8 +64,27 @@ test("Must get parameters of a specific method in a specific class in the applic
     "com.ibm.websphere.samples.daytrader.impl.direct.TradeDirect", "publishQuotePriceChange(QuoteDataBean, BigDecimal, BigDecimal, double)");
 
   expect(parameters).toBeDefined();
-  expect(parameters.length).toBeGreaterThan(0);
+  logger.success(chalk.green("parameters are defined"));
+  expect(parameters.length).toBe(4);
+  logger.success(chalk.green("there are 4 parameters"));
   parameters.forEach(param => {
     expect(async () => JCallableParameter.parse(param)).not.toThrow();
   });
-});
+  logger.success(chalk.green("All parameters are valid JCallableParameter instances"));
+});
+
+test("Must get parameters of a specific method in a specific class in the application given the callable object", async () => {
+  const method = await daytraderJavaAnalysis.getMethodByQualifiedName(
+    "com.ibm.websphere.samples.daytrader.impl.direct.TradeDirect", "publishQuotePriceChange(QuoteDataBean, BigDecimal, BigDecimal, double)");
+  const parameters = await daytraderJavaAnalysis.getMethodParametersFromCallable(method);
+  expect(parameters).toBeDefined();
+  logger.success(chalk.green("parameters are defined"));
+  expect(parameters.length).toBe(4);
+  logger.success(chalk.green("there are 4 parameters"));
+  parameters.forEach(param => {
+    expect(async () => JCallableParameter.parse(param)).not.toThrow();
+  }
+  );
+  logger.success(chalk.green("All parameters are valid JCallableParameter instances"));
+});
+