add setupRequestMockHandlers to backend-test-utils

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

.changeset/neat-tools-design.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-test-utils': patch
+---
+
+Add `setupRequestMockHandlers` which sets up a good `msw` server foundation, copied from `@backstage/test-utils` which is a frontend-only package and should not be used from backends.

.changeset/pink-poets-grin.md

@@ -0,0 +1,11 @@
+---
+'@backstage/backend-common': patch
+'@backstage/plugin-auth-backend': patch
+'@backstage/plugin-catalog-backend': patch
+'@backstage/plugin-catalog-backend-module-msgraph': patch
+'@backstage/plugin-rollbar-backend': patch
+'@backstage/plugin-scaffolder-backend': patch
+'@backstage/plugin-techdocs-backend': patch
+---
+
+Use `setupRequestMockHandlers` from `@backstage/backend-test-utils`

packages/backend-common/package.json

@@ -89,8 +89,8 @@
     }
   },
   "devDependencies": {
+    "@backstage/backend-test-utils": "^0.1.20",
     "@backstage/cli": "^0.15.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/archiver": "^5.1.0",
     "@types/compression": "^1.7.0",
     "@types/concat-stream": "^2.0.0",

packages/backend-common/src/reading/AzureUrlReader.test.ts

@@ -19,7 +19,7 @@ import {
   AzureIntegration,
   readAzureIntegrationConfig,
 } from '@backstage/integration';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';

packages/backend-common/src/reading/BitbucketUrlReader.test.ts

@@ -19,7 +19,7 @@ import {
   BitbucketIntegration,
   readBitbucketIntegrationConfig,
 } from '@backstage/integration';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';

packages/backend-common/src/reading/FetchUrlReader.test.ts

@@ -16,7 +16,7 @@
 
 import { ConfigReader } from '@backstage/config';
 import { NotFoundError, NotModifiedError } from '@backstage/errors';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { getVoidLogger } from '../logging';

packages/backend-common/src/reading/GithubUrlReader.test.ts

@@ -20,7 +20,7 @@ import {
   GitHubIntegration,
   readGitHubIntegrationConfig,
 } from '@backstage/integration';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';

packages/backend-common/src/reading/GitlabUrlReader.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { ConfigReader } from '@backstage/config';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';

packages/backend-test-utils/api-report.md

@@ -8,6 +8,13 @@ import { Knex } from 'knex';
 // @public (undocumented)
 export function isDockerDisabledForTests(): boolean;
 
+// @public
+export function setupRequestMockHandlers(worker: {
+  listen: (t: any) => void;
+  close: () => void;
+  resetHandlers: () => void;
+}): void;
+
 // @public
 export type TestDatabaseId =
   | 'POSTGRES_13'

packages/backend-test-utils/package.json

@@ -39,6 +39,7 @@
     "@backstage/config": "^0.1.15",
     "@vscode/sqlite3": "^5.0.7",
     "knex": "^1.0.2",
+    "msw": "^0.35.0",
     "mysql2": "^2.2.5",
     "pg": "^8.3.0",
     "testcontainers": "^8.1.2",

packages/backend-test-utils/src/index.ts

@@ -21,4 +21,5 @@
  */
 
 export * from './database';
+export * from './msw';
 export * from './util';

packages/backend-test-utils/src/msw/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { setupRequestMockHandlers } from './setupRequestMockHandlers';

packages/backend-test-utils/src/msw/setupRequestMockHandlers.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Sets up handlers for request mocking
+ * @public
+ * @param worker - service worker
+ */
+export function setupRequestMockHandlers(worker: {
+  listen: (t: any) => void;
+  close: () => void;
+  resetHandlers: () => void;
+}) {
+  beforeAll(() => worker.listen({ onUnhandledRequest: 'error' }));
+  afterAll(() => worker.close());
+  afterEach(() => worker.resetHandlers());
+}

plugins/auth-backend/package.json

@@ -76,8 +76,8 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
+    "@backstage/backend-test-utils": "^0.1.20",
     "@backstage/cli": "^0.15.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/body-parser": "^1.19.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/express-session": "^1.17.2",

plugins/auth-backend/src/providers/microsoft/provider.test.ts

@@ -20,7 +20,7 @@ import { OAuthResult } from '../../lib/oauth';
 import { getVoidLogger } from '@backstage/backend-common';
 import { TokenIssuer } from '../../identity/types';
 import { CatalogIdentityClient } from '../../lib/catalog';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 

plugins/auth-backend/src/providers/oidc/provider.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { Config, ConfigReader } from '@backstage/config';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import express from 'express';
 import { Session } from 'express-session';
 import { JWK, JWT } from 'jose';

plugins/catalog-backend-module-msgraph/package.json

@@ -47,8 +47,8 @@
   },
   "devDependencies": {
     "@backstage/backend-common": "^0.12.0",
+    "@backstage/backend-test-utils": "^0.1.20",
     "@backstage/cli": "^0.15.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/lodash": "^4.14.151",
     "msw": "^0.35.0"
   },

plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.test.ts

@@ -15,7 +15,7 @@
  */
 
 import * as msal from '@azure/msal-node';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { MicrosoftGraphClient } from './client';

plugins/catalog-backend/package.json

@@ -73,7 +73,6 @@
     "@backstage/cli": "^0.15.0",
     "@backstage/plugin-permission-common": "^0.5.2",
     "@backstage/plugin-search-backend-node": "0.5.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/core-js": "^2.5.4",
     "@types/git-url-parse": "^9.0.0",
     "@types/lodash": "^4.14.151",

plugins/catalog-backend/src/modules/azure/lib/azure.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { setupServer } from 'msw/node';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { rest } from 'msw';
 import { codeSearch, CodeSearchResponse } from './azure';
 

plugins/catalog-backend/src/modules/core/UrlReaderProcessor.test.ts

@@ -19,8 +19,8 @@ import {
   UrlReader,
   UrlReaders,
 } from '@backstage/backend-common';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { ConfigReader } from '@backstage/config';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import {

plugins/catalog-backend/src/modules/github/lib/github.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { graphql } from '@octokit/graphql';
 import { graphql as graphqlMsw } from 'msw';
 import { setupServer } from 'msw/node';

plugins/catalog-backend/src/modules/gitlab/lib/client.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { ConfigReader } from '@backstage/config';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { readGitLabIntegrationConfig } from '@backstage/integration';
 import { getVoidLogger } from '@backstage/backend-common';
 import { rest } from 'msw';

plugins/rollbar-backend/package.json

@@ -50,8 +50,8 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
+    "@backstage/backend-test-utils": "^0.1.20",
     "@backstage/cli": "^0.15.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/supertest": "^2.0.8",
     "msw": "^0.36.3",
     "supertest": "^6.1.3"

plugins/rollbar-backend/src/api/RollbarApi.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { getRequestHeaders, RollbarApi } from './RollbarApi';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { getVoidLogger } from '@backstage/backend-common';

plugins/scaffolder-backend/package.json

@@ -75,8 +75,8 @@
     "zen-observable": "^0.8.15"
   },
   "devDependencies": {
+    "@backstage/backend-test-utils": "^0.1.20",
     "@backstage/cli": "^0.15.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",

plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/bitbucket.test.ts

@@ -19,7 +19,7 @@ jest.mock('../helpers');
 import { createPublishBitbucketAction } from './bitbucket';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { ScmIntegrations } from '@backstage/integration';
 import { ConfigReader } from '@backstage/config';
 import { getVoidLogger } from '@backstage/backend-common';

plugins/techdocs-backend/package.json

@@ -55,9 +55,9 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
+    "@backstage/backend-test-utils": "^0.1.20",
     "@backstage/cli": "^0.15.0",
     "@backstage/plugin-search-backend-node": "0.5.0",
-    "@backstage/test-utils": "^0.3.0",
     "@types/dockerode": "^3.3.0",
     "msw": "^0.35.0",
     "supertest": "^6.1.3"

plugins/techdocs-backend/src/search/DefaultTechDocsCollator.test.ts

@@ -21,7 +21,7 @@ import {
 } from '@backstage/backend-common';
 import { Entity } from '@backstage/catalog-model';
 import { DefaultTechDocsCollator } from './DefaultTechDocsCollator';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { setupServer } from 'msw/node';
 import { rest } from 'msw';
 import { ConfigReader } from '@backstage/config';

plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.test.ts

@@ -21,7 +21,7 @@ import {
 import { Entity } from '@backstage/catalog-model';
 import { ConfigReader } from '@backstage/config';
 import { TestPipeline } from '@backstage/plugin-search-backend-node';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { Readable } from 'stream';