Add API to get all methods within a specific class in the application.

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

Author: rahlk

.github/workflows/coverage.yml

@@ -20,7 +20,7 @@ jobs:
         run: bun install
 
       - name: Run tests with coverage
-        run: bun run test
+        run: bun run test:withCoverage
 
       - name: Upload coverage to Coveralls
         uses: coverallsapp/github-action@v2

package.json

@@ -13,7 +13,8 @@
   "homepage": "https://github.com/codellm-devkit/typescript-sdk#readme",
   "scripts": {
     "build": "bun build ./src/index.ts --outdir ./dist",
-    "test": "bun test --verbose --coverage --coverage-reporter=lcov --preload ./test/conftest.ts --timeout=600000",
+    "test": "bun test --verbose --coverage --preload ./test/conftest.ts --timeout=600000",
+    "test:withCoverage": "bun test --verbose --coverage --coverage-reporter=lcov --preload ./test/conftest.ts --timeout=600000",
     "clean": "rm -rf dist coverage *.lock"
   },
   "files": [
@@ -36,6 +37,7 @@
     "@types/jsonstream": "^0.8.33",
     "JSONStream": "^1.3.5",
     "bun": "^1.2.10",
+    "c8": "^10.1.3",
     "extract-zip": "^2.0.1",
     "fast-glob": "^3.3.3",
     "graphology": "^0.26.0",

src/analysis/java/JavaAnalysis.ts

@@ -80,9 +80,9 @@ export class JavaAnalysis {
       const tmpFilePath = path.join(os.tmpdir(), `${Date.now()}-${crypto.randomUUID()}`);
       const command = [
         ...this.getCodeAnalyzerExec(),
-        "-i",
+        "--input",
         projectPath,
-        "-o",
+        "--output",
         tmpFilePath,
         `--analysis-level=${this.analysisLevel}`,
         "--verbose",
@@ -174,22 +174,14 @@ export class JavaAnalysis {
   }
 
   /**
-   * Get all methods in the application.
-   * @returns {Promise<Record<string, Record<string, types.JCallableType>>>} A promise that resolves to a record of
-   * method names and their corresponding {@link JCallableType} objects
+   * Get a specific class by its qualified name.
+   * @param {string} qualifiedName - The qualified name of the class to retrieve
+   * @returns {Promise<types.JTypeType>} A promise that resolves to the {@link JTypeType} object representing the class
+   * @throws {Error} If the class is not found in the application
    * 
-   * @notes This method retrieves all methods from the symbol table and returns them as a record. The returned
-   *       record contains class names as keys and their corresponding {@link JCallableType} objects as values.
-   *       Each {@link JCallableType} object contains information about the method's parameters, return type, and
-   *       other relevant details.
+   * @notes This method retrieves a specific class from the application by its qualified name. If the class is found,
+   *       it returns the corresponding {@link JType} object. If the class is not found, it throws an error.
    */
-  public async getAllMethods(): Promise<Record<string, Record<string, types.JCallableType>>> {
-    return Object.entries(await this.getAllClasses()).reduce((allMethods, [key, value]) => {
-      allMethods[key] = value.callable_declarations;
-      return allMethods;
-    }, {} as Record<string, Record<string, types.JCallableType>>);
-  }
-
   public async getClassByQualifiedName(qualifiedName: string): Promise<types.JTypeType> {
     const allClasses = await this.getAllClasses();
     if (allClasses[qualifiedName]) {
@@ -198,4 +190,36 @@ export class JavaAnalysis {
     else
       throw new Error(`Class ${qualifiedName} not found in the application.`);
   }
+
+  /**
+  * Get all methods in the application.
+  * @returns {Promise<Record<string, Record<string, types.JCallableType>>>} A promise that resolves to a record of
+  * method names and their corresponding {@link JCallableType} objects
+  * 
+  * @notes This method retrieves all methods from the symbol table and returns them as a record. The returned
+  *       record contains class names as keys and their corresponding {@link JCallableType} objects as values.
+  *       Each {@link JCallableType} object contains information about the method's parameters, return type, and
+  *       other relevant details.
+  */
+  public async getAllMethods(): Promise<Record<string, Record<string, types.JCallableType>>> {
+    return Object.entries(await this.getAllClasses()).reduce((allMethods, [key, value]) => {
+      allMethods[key] = value.callable_declarations;
+      return allMethods;
+    }, {} as Record<string, Record<string, types.JCallableType>>);
+  }
+
+  /**
+   * Get all methods in a specific class in the application.
+   * @returns {Promise<Record<string, Record<string, types.JCallableType>>>} A promise that resolves to a record of
+   * method names and their corresponding {@link JCallableType} objects
+   * 
+   * @notes This method retrieves all methods from the symbol table and returns them as a record. The returned
+   *       record contains class names as keys and their corresponding {@link JCallableType} objects as values.
+   *       Each {@link JCallableType} object contains information about the method's parameters, return type, and
+   *       other relevant details.
+   */
+  public async getAllMethodsByClass(qualifiedName: string): Promise<Array<types.JCallableType>> {
+    const classForWhichMethodsAreRequested = await this.getClassByQualifiedName(qualifiedName);
+    return classForWhichMethodsAreRequested ? Object.values(classForWhichMethodsAreRequested.callable_declarations ?? {}) : [];
+  }
 }

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

@@ -22,7 +22,7 @@ test("Must get all classes in a Java application", async () => {
 
 test("Must get a specific class the application", async () => {
   const tradeDirectObject = await daytraderJavaAnalysis.getClassByQualifiedName("com.ibm.websphere.samples.daytrader.impl.direct.TradeDirect");
-  expect(async () => JType.parse(tradeDirectObject)).not.toThrow(); 
+  expect(async () => JType.parse(tradeDirectObject)).not.toThrow();
 });
 
 test("Must throw error when a requested class in the application does not exist", async () => {
@@ -32,7 +32,7 @@ test("Must throw error when a requested class in the application does not exist"
    * by saying "Hey, I expect this promise to be rejected with this error ..." 
    */
   await expect(daytraderJavaAnalysis.getClassByQualifiedName("this.class.does.not.Exist")).rejects.toThrow(
-    "Class this.class.does.not.Exist not found in the application."); 
+    "Class this.class.does.not.Exist not found in the application.");
 });
 
 test("Must get all methods in the application", () => {
@@ -41,3 +41,9 @@ test("Must get all methods in the application", () => {
   });
 });
 
+test("Must get all methods in a specific class in the application", async () => {
+  expect(
+    (
+      await daytraderJavaAnalysis.getAllMethodsByClass("com.ibm.websphere.samples.daytrader.impl.direct.TradeDirect")).length
+  ).toBeGreaterThan(0)
+});