Add flag to control document symbol based test discovery for java

package.json

@@ -101,6 +101,11 @@
         "bazelbsp.debug.launchConfigName": {
           "type": "string",
           "description": "Name of launch configuration that will be executed to begin the DAP debugging session. This must be a valid launch configuration in the launch.json file, workspace, or contributed by another extension."
+        },
+        "bazelbsp.java.useDocumentSymbols": {
+          "type": "boolean",
+          "default": false,
+          "description": "Use document symbols to find test cases in Java files. We will fall back to regex if this is not enabled."
         }
       }
     },

src/language-tools/java.ts

@@ -5,6 +5,7 @@ import {DocumentTestItem, LanguageTools, TestFileContents} from './manager'
 import {TestFinish} from '../bsp/bsp'
 import {JUnitStyleTestCaseData, TestFinishDataKind} from '../bsp/bsp-ext'
 import {SourceFileTestCaseInfo, TestCaseInfo} from '../test-info/test-info'
+import {getExtensionSetting, SettingName} from '../utils/settings'
 
 const TEST_FILE_REGEX = /^(Test.+\.java|.+Test\.java)$/
 const JAVA_TEST_REGEX =
@@ -76,8 +77,18 @@ export class JavaLanguageTools implements LanguageTools {
       }
     }
 
-    // Attempt to get document symbols via VS Code API.
-    // TODO(IDE-1109): Request document symbols and process them.
+    // Check if document symbols feature is enabled
+    const useDocumentSymbols = getExtensionSetting(
+      SettingName.JAVA_USE_DOCUMENT_SYMBOLS
+    )
+    if (useDocumentSymbols) {
+      // Attempt to get document symbols via VS Code API.
+      // TODO(IDE-1109): Request document symbols and process them.
+      return {
+        isTestFile: false,
+        testCases: [],
+      }
+    }
 
     // Fallback to resolve directly from document text.
     // Due to the variety of VS Code extensions and setups in the JVM ecosystem, this allows basic functionality even if the user is missing other extensions or has them misconfigured.

src/test/suite/language-tools/java.test.ts

@@ -10,6 +10,8 @@ import {
   TestItemTestCaseInfo,
 } from '../../../test-info/test-info'
 import {sampleBuildTarget} from '../test-utils'
+import * as sinon from 'sinon'
+import * as settings from '../../../utils/settings'
 
 const fixtureDir = path.join(
   __dirname,
@@ -25,13 +27,18 @@ const fixtureDir = path.join(
 suite('Java Language Tools', () => {
   let languageTools: JavaLanguageTools
   let testController: vscode.TestController
+  let settingsStub: sinon.SinonStub
+  const sandbox = sinon.createSandbox()
+
   beforeEach(async () => {
     testController = vscode.tests.createTestController('java sample', 'sample')
     languageTools = new JavaLanguageTools()
+    settingsStub = sandbox.stub(settings, 'getExtensionSetting')
   })
 
   afterEach(async () => {
     testController.dispose()
+    sandbox.restore()
   })
 
   test('process test cases, example 1', async () => {
@@ -402,4 +409,19 @@ suite('Java Language Tools', () => {
     result = languageTools.mapTestCaseInfoToLookupKey(testCaseInfo)
     assert.strictEqual(result, undefined)
   })
+
+  test('document symbols feature enabled but not implemented', async () => {
+    settingsStub
+      .withArgs(settings.SettingName.JAVA_USE_DOCUMENT_SYMBOLS)
+      .returns(true)
+
+    const result = await languageTools.getDocumentTestCases(
+      vscode.Uri.file(
+        path.join(fixtureDir, 'language_files', 'SampleValidExampleTest.java')
+      )
+    )
+    assert.strictEqual(result.isTestFile, false)
+    assert.strictEqual(result.testCases.length, 0)
+    assert.strictEqual(result.documentTest, undefined)
+  })
 })

src/utils/settings.ts

@@ -13,6 +13,7 @@ export enum SettingName {
   DEBUG_BAZEL_FLAGS = 'debug.bazelFlags',
   LAUNCH_CONFIG_NAME = 'debug.launchConfigName',
   DEBUG_READY_PATTERN = 'debug.readyPattern',
+  JAVA_USE_DOCUMENT_SYMBOLS = 'java.useDocumentSymbols',
   ADDITIONAL_INSTALL_FLAGS = 'additionalInstallFlags',
 }
 
@@ -27,6 +28,7 @@ export interface SettingTypes {
   [SettingName.DEBUG_BAZEL_FLAGS]: string[]
   [SettingName.LAUNCH_CONFIG_NAME]: string
   [SettingName.DEBUG_READY_PATTERN]: string
+  [SettingName.JAVA_USE_DOCUMENT_SYMBOLS]: boolean
   [SettingName.ADDITIONAL_INSTALL_FLAGS]: string[]
 }