refactor: stop using getVoidLogger in tests

Signed-off-by: Camila Belo <camilaibs@gmail.com>

plugins/search-backend-node/package.json

@@ -60,6 +60,7 @@
   },
   "devDependencies": {
     "@backstage/backend-common": "workspace:^",
+    "@backstage/backend-test-utils": "workspace:^",
     "@backstage/cli": "workspace:^",
     "@types/ndjson": "^2.0.1"
   }

plugins/search-backend-node/src/IndexBuilder.test.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import { getVoidLogger } from '@backstage/backend-common';
 import { TaskInvocationDefinition, TaskRunner } from '@backstage/backend-tasks';
 import {
   DocumentCollatorFactory,
@@ -23,6 +22,7 @@ import {
 import { Readable, Transform } from 'stream';
 import { IndexBuilder } from './IndexBuilder';
 import { LunrSearchEngine, SearchEngine } from './index';
+import { mockServices } from '@backstage/backend-test-utils';
 
 class TestDocumentCollatorFactory implements DocumentCollatorFactory {
   readonly type: string = 'anything';
@@ -57,7 +57,7 @@ describe('IndexBuilder', () => {
   let testScheduledTaskRunner: TaskRunner;
 
   beforeEach(() => {
-    const logger = getVoidLogger();
+    const logger = mockServices.logger.mock();
     testScheduledTaskRunner = {
       run: async (task: TaskInvocationDefinition & { fn: () => void }) => {
         task.fn();

plugins/search-backend-node/src/Scheduler.test.ts

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-import { getVoidLogger } from '@backstage/backend-common';
 import { Scheduler } from './index';
+import { mockServices } from '@backstage/backend-test-utils';
 
 describe('Scheduler', () => {
   let testScheduler: Scheduler;
 
   beforeEach(() => {
-    const logger = getVoidLogger();
+    const logger = mockServices.logger.mock();
     testScheduler = new Scheduler({
       logger,
     });

plugins/search-backend-node/src/collators/NewlineDelimitedJsonCollatorFactory.test.ts

@@ -15,7 +15,6 @@
  */
 
 import {
-  getVoidLogger,
   ReadUrlResponse,
   UrlReader,
   UrlReaders,
@@ -24,10 +23,11 @@ import { ConfigReader } from '@backstage/config';
 import { Readable } from 'stream';
 import { NewlineDelimitedJsonCollatorFactory } from './NewlineDelimitedJsonCollatorFactory';
 import { TestPipeline } from '../test-utils';
+import { mockServices } from '@backstage/backend-test-utils';
 
 describe('DefaultCatalogCollatorFactory', () => {
   const config = new ConfigReader({});
-  const logger = getVoidLogger();
+  const logger = mockServices.logger.mock();
 
   it('has expected type', () => {
     const factory = NewlineDelimitedJsonCollatorFactory.fromConfig(config, {

plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import { getVoidLogger } from '@backstage/backend-common';
 import lunr from 'lunr';
 import { IndexableDocument } from '@backstage/plugin-search-common';
 import {
@@ -27,6 +26,7 @@ import {
 import { LunrSearchEngineIndexer } from './LunrSearchEngineIndexer';
 import { SearchEngine } from '../types';
 import { TestPipeline } from '../test-utils';
+import { mockServices } from '@backstage/backend-test-utils';
 
 /**
  * Just used to test the default translator shipped with LunrSearchEngine.
@@ -77,7 +77,9 @@ describe('LunrSearchEngine', () => {
   let testLunrSearchEngine: SearchEngine;
 
   beforeEach(() => {
-    testLunrSearchEngine = new LunrSearchEngine({ logger: getVoidLogger() });
+    testLunrSearchEngine = new LunrSearchEngine({
+      logger: mockServices.logger.mock(),
+    });
     jest.clearAllMocks();
   });
 
@@ -107,7 +109,7 @@ describe('LunrSearchEngine', () => {
 
     it('should return translated query', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       const translatorUnderTest = inspectableSearchEngine.getTranslator();
 
@@ -149,7 +151,7 @@ describe('LunrSearchEngine', () => {
 
     it('should have default offset and limit', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       const translatorUnderTest = inspectableSearchEngine.getTranslator();
 
@@ -190,7 +192,7 @@ describe('LunrSearchEngine', () => {
 
     it('should return translated query with 1 filter', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       const translatorUnderTest = inspectableSearchEngine.getTranslator();
 
@@ -235,7 +237,7 @@ describe('LunrSearchEngine', () => {
 
     it('should handle single-item array filter as scalar value', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       const translatorUnderTest = inspectableSearchEngine.getTranslator();
 
@@ -266,7 +268,7 @@ describe('LunrSearchEngine', () => {
 
     it('should return translated query with multiple filters', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       const translatorUnderTest = inspectableSearchEngine.getTranslator();
 
@@ -315,7 +317,7 @@ describe('LunrSearchEngine', () => {
 
     it('should throw if translated query references missing field', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       const translatorUnderTest = inspectableSearchEngine.getTranslator();
 
@@ -477,7 +479,7 @@ describe('LunrSearchEngine', () => {
 
     it('should perform search query and return highlight metadata on match', async () => {
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
 
       const mockDocuments = [
@@ -1012,7 +1014,7 @@ describe('LunrSearchEngine', () => {
 
       // Set up an inspectable search engine to pre-set some data.
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       inspectableSearchEngine.setDocStore({ 'existing-location': doc });
 
@@ -1047,7 +1049,7 @@ describe('LunrSearchEngine', () => {
       // Set up an inspectable search engine to pre-set some data.
       const doc = { title: 'A doc', text: 'test', location: 'some-location' };
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       inspectableSearchEngine.setDocStore({ 'existing-location': doc });
 
@@ -1073,7 +1075,7 @@ describe('LunrSearchEngine', () => {
       // Set up an inspectable search engine to pre-set some data.
       const doc = { title: 'A doc', text: 'test', location: 'some-location' };
       const inspectableSearchEngine = new LunrSearchEngineForTests({
-        logger: getVoidLogger(),
+        logger: mockServices.logger.mock(),
       });
       inspectableSearchEngine.setDocStore({ 'existing-location': doc });
 
@@ -1178,7 +1180,9 @@ describe('stopword testing', () => {
   let testLunrSearchEngine: SearchEngine;
 
   beforeEach(() => {
-    testLunrSearchEngine = new LunrSearchEngine({ logger: getVoidLogger() });
+    testLunrSearchEngine = new LunrSearchEngine({
+      logger: mockServices.logger.mock(),
+    });
     jest.clearAllMocks();
   });