Add failing test case

Author: skovhus

server/src/__tests__/analyzer.test.ts

@@ -18,7 +18,7 @@ let analyzer: Analyzer
 const CURRENT_URI = 'dummy-uri.sh'
 
 // if you add a .sh file to testing/fixtures, update this value
-const FIXTURE_FILES_MATCHING_GLOB = 16
+const FIXTURE_FILES_MATCHING_GLOB = 17
 
 const defaultConfig = getDefaultConfiguration()
 
@@ -28,12 +28,33 @@ jest.spyOn(Logger.prototype, 'log').mockImplementation(() => {
 const loggerInfo = jest.spyOn(Logger.prototype, 'info')
 const loggerWarn = jest.spyOn(Logger.prototype, 'warn')
 
-beforeAll(async () => {
+async function getAnalyzer({
+  includeAllWorkspaceSymbols = false,
+  workspaceFolder = FIXTURE_FOLDER,
+  runBackgroundAnalysis = false,
+}: {
+  includeAllWorkspaceSymbols?: boolean
+  workspaceFolder?: string
+  runBackgroundAnalysis?: boolean
+}) {
   const parser = await initializeParser()
-  analyzer = new Analyzer({
+
+  const analyzer = new Analyzer({
     parser,
-    workspaceFolder: FIXTURE_FOLDER,
+    includeAllWorkspaceSymbols,
+    workspaceFolder,
   })
+  if (runBackgroundAnalysis) {
+    await analyzer.initiateBackgroundAnalysis({
+      backgroundAnalysisMaxFiles: defaultConfig.backgroundAnalysisMaxFiles,
+      globPattern: defaultConfig.globPattern,
+    })
+  }
+  return analyzer
+}
+
+beforeAll(async () => {
+  analyzer = await getAnalyzer({})
 })
 
 describe('analyze', () => {
@@ -355,7 +376,6 @@ describe('findAllSourcedUris', () => {
       new Set([
         `file://${FIXTURE_FOLDER}extension.inc`,
         `file://${FIXTURE_FOLDER}issue101.sh`,
-        `file://${FIXTURE_FOLDER}sourcing.sh`,
       ]),
     )
   })
@@ -578,6 +598,27 @@ describe('findDeclarationsMatchingWord', () => {
     `)
   })
 
+  it('resolves sourced file not covered by the background analysis glob', async () => {
+    async function expectThatSourcingWorksWhenIncludeAllWorkspaceSymbolsIs(v: boolean) {
+      const analyzer = await getAnalyzer({
+        runBackgroundAnalysis: true,
+        includeAllWorkspaceSymbols: v,
+      })
+
+      expect(
+        analyzer.findDeclarationsMatchingWord({
+          word: 'XXX',
+          uri: FIXTURE_URI.SOURCING2,
+          exactMatch: true,
+          position: { line: 2, character: 21 }, // XXX
+        }),
+      ).toHaveLength(1)
+    }
+
+    await expectThatSourcingWorksWhenIncludeAllWorkspaceSymbolsIs(false)
+    await expectThatSourcingWorksWhenIncludeAllWorkspaceSymbolsIs(true)
+  })
+
   it('returns symbols depending on the scope', async () => {
     const parser = await initializeParser()
 

testing/fixtures.ts

@@ -30,6 +30,7 @@ export const FIXTURE_URI = {
   SCOPE: `file://${path.join(FIXTURE_FOLDER, 'scope.sh')}`,
   SHELLCHECK_SOURCE: `file://${path.join(FIXTURE_FOLDER, 'shellcheck', 'source.sh')}`,
   SOURCING: `file://${path.join(FIXTURE_FOLDER, 'sourcing.sh')}`,
+  SOURCING2: `file://${path.join(FIXTURE_FOLDER, 'sourcing2.sh')}`,
 }
 
 export const FIXTURE_DOCUMENT: Record<FIXTURE_KEY, TextDocument> = (

testing/fixtures/extension

@@ -1,5 +1,8 @@
 #!/bin/sh
 
-. sourcing.sh
+. ./extension.inc
 
 echo "It works, but is not parsed initially"
+
+# A little variable
+export XXX=1

testing/fixtures/sourcing2.sh

@@ -0,0 +1,3 @@
+. ./extension  # notice no file extension meaning it isn't found by the background analysis
+
+echo "It resolves ${XXX} in the sourced file"