refactor: stop using getVoidLogger in tests

Signed-off-by: Camila Belo <camilaibs@gmail.com>
This commit is contained in:
Camila Belo
2024-05-15 09:09:54 +02:00
parent 819754e57e
commit eb34b87d5a
118 changed files with 533 additions and 433 deletions
+4 -3
View File
@@ -14,9 +14,10 @@
* limitations under the License.
*/
import { CacheClient, getVoidLogger } from '@backstage/backend-common';
import { CacheClient, loggerToWinstonLogger } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { CacheInvalidationError, TechDocsCache } from './TechDocsCache';
import { mockServices } from '@backstage/backend-test-utils';
const cached = (str: string): string => {
return Buffer.from(str).toString('base64');
@@ -35,7 +36,7 @@ describe('TechDocsCache', () => {
};
CacheUnderTest = TechDocsCache.fromConfig(new ConfigReader({}), {
cache: MockClient,
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
});
});
@@ -82,7 +83,7 @@ describe('TechDocsCache', () => {
}),
{
cache: MockClient,
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
},
);
+3 -2
View File
@@ -14,11 +14,12 @@
* limitations under the License.
*/
import { getVoidLogger } from '@backstage/backend-common';
import { loggerToWinstonLogger } from '@backstage/backend-common';
import express from 'express';
import request from 'supertest';
import { createCacheMiddleware } from './cacheMiddleware';
import { TechDocsCache } from './TechDocsCache';
import { mockServices } from '@backstage/backend-test-utils';
/**
* Mocks cached HTTP response.
@@ -57,7 +58,7 @@ describe('createCacheMiddleware', () => {
invalidateMultiple: jest.fn().mockResolvedValue(undefined),
} as unknown as jest.Mocked<TechDocsCache>;
const router = await createCacheMiddleware({
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
cache,
});
app = express().use(router);
@@ -16,17 +16,20 @@
import {
PluginEndpointDiscovery,
getVoidLogger,
TokenManager,
loggerToWinstonLogger,
} from '@backstage/backend-common';
import { Entity } from '@backstage/catalog-model';
import { DefaultTechDocsCollator } from './DefaultTechDocsCollator';
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import {
mockServices,
setupRequestMockHandlers,
} from '@backstage/backend-test-utils';
import { setupServer } from 'msw/node';
import { rest } from 'msw';
import { ConfigReader } from '@backstage/config';
const logger = getVoidLogger();
const logger = loggerToWinstonLogger(mockServices.logger.mock());
const mockSearchDocIndex = {
config: {
@@ -15,7 +15,7 @@
*/
import {
getVoidLogger,
loggerToWinstonLogger,
PluginEndpointDiscovery,
} from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
@@ -30,6 +30,7 @@ import * as winston from 'winston';
import { TechDocsCache } from '../cache';
import { DocsBuilder, shouldCheckForUpdate } from '../DocsBuilder';
import { DocsSynchronizer, DocsSynchronizerSyncOpts } from './DocsSynchronizer';
import { mockServices } from '@backstage/backend-test-utils';
jest.mock('../DocsBuilder');
jest.useFakeTimers();
@@ -97,7 +98,7 @@ describe('DocsSynchronizer', () => {
docsSynchronizer = new DocsSynchronizer({
publisher,
config: new ConfigReader({}),
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
buildLogTransport: mockBuildLogTransport,
scmIntegrations: ScmIntegrations.fromConfig(new ConfigReader({})),
cache,
@@ -346,7 +347,7 @@ describe('DocsSynchronizer', () => {
config: new ConfigReader({
techdocs: { legacyUseCaseSensitiveTripletPaths: true },
}),
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
buildLogTransport: new winston.transports.Stream({
stream: new PassThrough(),
}),
@@ -16,7 +16,7 @@
import {
errorHandler,
getVoidLogger,
loggerToWinstonLogger,
PluginCacheManager,
PluginEndpointDiscovery,
} from '@backstage/backend-common';
@@ -33,6 +33,7 @@ import { DocsSynchronizer, DocsSynchronizerSyncOpts } from './DocsSynchronizer';
import { CachedEntityLoader } from './CachedEntityLoader';
import { createEventStream, createRouter, RouterOptions } from './router';
import { TechDocsCache } from '../cache';
import { mockServices } from '@backstage/backend-test-utils';
jest.mock('@backstage/catalog-client');
jest.mock('@backstage/config');
@@ -126,7 +127,7 @@ describe('createRouter', () => {
generators,
publisher,
config: new ConfigReader({}),
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
discovery,
cache,
docsBuildStrategy,
@@ -134,7 +135,7 @@ describe('createRouter', () => {
const recommendedOptions = {
publisher,
config: new ConfigReader({}),
logger: getVoidLogger(),
logger: loggerToWinstonLogger(mockServices.logger.mock()),
discovery,
cache,
docsBuildStrategy,