@backstage/backend-test-utils 0.3.3 → 0.3.4-next.2

package/dist/index.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="jest" />
 import { Knex } from 'knex';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { ServiceFactory, ServiceRef, ExtensionPoint, BackendFeature, RootConfigService, LoggerService, TokenManagerService, IdentityService } from '@backstage/backend-plugin-api';
+import { ServiceFactory, ServiceRef, ExtensionPoint, BackendFeature, RootConfigService, LoggerService, TokenManagerService, IdentityService, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, BackstageNonePrincipal, BackstageUserPrincipal, BackstageServicePrincipal } from '@backstage/backend-plugin-api';
 import * as _backstage_backend_app_api from '@backstage/backend-app-api';
 import { Backend, ExtendedHttpServer } from '@backstage/backend-app-api';
 import { JsonObject } from '@backstage/types';
@@ -374,6 +374,68 @@ declare namespace mockServices {
         const factory: () => ServiceFactory<IdentityService, "plugin">;
         const mock: (partialImpl?: Partial<IdentityService> | undefined) => ServiceMock<IdentityService>;
     }
+    function auth(options?: {
+        pluginId?: string;
+        disableDefaultAuthPolicy?: boolean;
+    }): AuthService;
+    namespace auth {
+        const factory: () => ServiceFactory<AuthService, "plugin">;
+        const mock: (partialImpl?: Partial<AuthService> | undefined) => ServiceMock<AuthService>;
+    }
+    function discovery(): DiscoveryService;
+    namespace discovery {
+        const factory: () => ServiceFactory<DiscoveryService, "plugin">;
+        const mock: (partialImpl?: Partial<DiscoveryService> | undefined) => ServiceMock<DiscoveryService>;
+    }
+    /**
+     * Creates a mock implementation of the `HttpAuthService`.
+     *
+     * By default all requests without credentials are treated as requests from
+     * the default mock user principal. This behavior can be configured with the
+     * `defaultCredentials` option.
+     */
+    function httpAuth(options?: {
+        pluginId?: string;
+        /**
+         * The default credentials to use if there are no credentials present in the
+         * incoming request.
+         *
+         * By default all requests without credentials are treated as authenticated
+         * as the default mock user as returned from `mockCredentials.user()`.
+         */
+        defaultCredentials?: BackstageCredentials;
+    }): HttpAuthService;
+    namespace httpAuth {
+        /**
+         * Creates a mock service factory for the `HttpAuthService`.
+         *
+         * By default all requests without credentials are treated as requests from
+         * the default mock user principal. This behavior can be configured with the
+         * `defaultCredentials` option.
+         */
+        const factory: (options?: {
+            defaultCredentials?: BackstageCredentials | undefined;
+        } | undefined) => ServiceFactory<HttpAuthService, "plugin">;
+        const mock: (partialImpl?: Partial<HttpAuthService> | undefined) => ServiceMock<HttpAuthService>;
+    }
+    /**
+     * Creates a mock implementation of the `UserInfoService`.
+     *
+     * By default it extracts the user's entity ref from a user principal and
+     * returns that as the only ownership entity ref, but this can be overridden
+     * by passing in a custom set of user info.
+     */
+    function userInfo(customInfo?: Partial<BackstageUserInfo>): UserInfoService;
+    namespace userInfo {
+        /**
+         * Creates a mock service factory for the `UserInfoService`.
+         *
+         * By default it extracts the user's entity ref from a user principal and
+         * returns that as the only ownership entity ref.
+         */
+        const factory: () => ServiceFactory<UserInfoService, "plugin">;
+        const mock: (partialImpl?: Partial<UserInfoService> | undefined) => ServiceMock<UserInfoService>;
+    }
     namespace cache {
         const factory: () => ServiceFactory<_backstage_backend_plugin_api.CacheService, "plugin">;
         const mock: (partialImpl?: Partial<_backstage_backend_plugin_api.CacheService> | undefined) => ServiceMock<_backstage_backend_plugin_api.CacheService>;
@@ -416,4 +478,111 @@ declare namespace mockServices {
     }
 }
 
-export { MockDirectory, MockDirectoryContent, MockDirectoryContentCallback, MockDirectoryContentCallbackContext, MockDirectoryContentOptions, MockDirectoryOptions, ServiceFactoryTester, ServiceFactoryTesterOptions, ServiceMock, TestBackend, TestBackendOptions, TestDatabaseId, TestDatabases, createMockDirectory, isDockerDisabledForTests, mockServices, setupRequestMockHandlers, startTestBackend };
+/**
+ * @public
+ */
+declare namespace mockCredentials {
+    /**
+     * Creates a mocked credentials object for a unauthenticated principal.
+     */
+    function none(): BackstageCredentials<BackstageNonePrincipal>;
+    /**
+     * Utilities related to none credentials.
+     */
+    namespace none {
+        /**
+         * Returns an authorization header that translates to unauthenticated
+         * credentials.
+         *
+         * This is useful when one wants to explicitly test unauthenticated requests
+         * while still using the default behavior of the mock HttpAuthService where
+         * it defaults to user credentials.
+         */
+        function header(): string;
+    }
+    /**
+     * Creates a mocked credentials object for a user principal.
+     *
+     * The default user entity reference is 'user:default/mock'.
+     */
+    function user(userEntityRef?: string): BackstageCredentials<BackstageUserPrincipal>;
+    /**
+     * Utilities related to user credentials.
+     */
+    namespace user {
+        /**
+         * Creates a mocked user token. If a payload is provided it will be encoded
+         * into the token and forwarded to the credentials object when authenticated
+         * by the mock auth service.
+         */
+        function token(userEntityRef?: string): string;
+        /**
+         * Returns an authorization header with a mocked user token. If a payload is
+         * provided it will be encoded into the token and forwarded to the
+         * credentials object when authenticated by the mock auth service.
+         */
+        function header(userEntityRef?: string): string;
+        function invalidToken(): string;
+        function invalidHeader(): string;
+    }
+    /**
+     * Creates a mocked credentials object for a user principal with limited
+     * access.
+     *
+     * The default user entity reference is 'user:default/mock'.
+     */
+    function limitedUser(userEntityRef?: string): BackstageCredentials<BackstageUserPrincipal>;
+    /**
+     * Utilities related to limited user credentials.
+     */
+    namespace limitedUser {
+        /**
+         * Creates a mocked limited user token. If a payload is provided it will be
+         * encoded into the token and forwarded to the credentials object when
+         * authenticated by the mock auth service.
+         */
+        function token(userEntityRef?: string): string;
+        /**
+         * Returns an authorization header with a mocked limited user token. If a
+         * payload is provided it will be encoded into the token and forwarded to
+         * the credentials object when authenticated by the mock auth service.
+         */
+        function cookie(userEntityRef?: string): string;
+        function invalidToken(): string;
+        function invalidCookie(): string;
+    }
+    /**
+     * Creates a mocked credentials object for a service principal.
+     *
+     * The default subject is 'external:test-service'.
+     */
+    function service(subject?: string): BackstageCredentials<BackstageServicePrincipal>;
+    /**
+     * Utilities related to service credentials.
+     */
+    namespace service {
+        /**
+         * Options for the creation of mock service tokens.
+         */
+        type TokenOptions = {
+            onBehalfOf: BackstageCredentials;
+            targetPluginId: string;
+        };
+        /**
+         * Creates a mocked service token. The provided options will be encoded into
+         * the token and forwarded to the credentials object when authenticated by
+         * the mock auth service.
+         */
+        function token(options?: TokenOptions): string;
+        /**
+         * Returns an authorization header with a mocked service token. The provided
+         * options will be encoded into the token and forwarded to the credentials
+         * object when authenticated by the mock auth service.
+         */
+        function header(options?: TokenOptions): string;
+        function invalidToken(): string;
+        function invalidHeader(): string;
+    }
+}
+
+export { MockDirectory, MockDirectoryContent, MockDirectoryContentCallback, MockDirectoryContentCallbackContext, MockDirectoryContentOptions, MockDirectoryOptions, ServiceFactoryTester, ServiceFactoryTesterOptions, ServiceMock, TestBackend, TestBackendOptions, TestDatabaseId, TestDatabases, createMockDirectory, isDockerDisabledForTests, mockCredentials, mockServices, setupRequestMockHandlers, startTestBackend };

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "@backstage/backend-test-utils",
+  "version": "0.3.4-next.2",
   "description": "Test helpers library for Backstage backends",
-  "version": "0.3.3",
-  "main": "./dist/index.cjs.js",
-  "types": "./dist/index.d.ts",
+  "backstage": {
+    "role": "node-library"
+  },
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "backstage",
+    "test"
+  ],
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "packages/backend-test-utils"
+  },
+  "license": "Apache-2.0",
   "exports": {
     ".": {
       "require": "./dist/index.cjs.js",
@@ -15,57 +27,46 @@
     },
     "./package.json": "./package.json"
   },
-  "backstage": {
-    "role": "node-library"
-  },
-  "homepage": "https://backstage.io",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/backstage/backstage",
-    "directory": "packages/backend-test-utils"
-  },
-  "keywords": [
-    "backstage",
-    "test"
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
   ],
-  "license": "Apache-2.0",
   "scripts": {
     "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
     "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
     "prepack": "backstage-cli package prepack",
     "postpack": "backstage-cli package postpack",
-    "clean": "backstage-cli package clean",
-    "start": "backstage-cli package start"
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-app-api": "^0.5.14",
-    "@backstage/backend-common": "^0.21.3",
-    "@backstage/backend-plugin-api": "^0.6.13",
-    "@backstage/config": "^1.1.1",
-    "@backstage/errors": "^1.2.3",
-    "@backstage/plugin-auth-node": "^0.4.8",
+    "@backstage/backend-app-api": "^0.6.0-next.2",
+    "@backstage/backend-common": "^0.21.4-next.2",
+    "@backstage/backend-plugin-api": "^0.6.14-next.2",
+    "@backstage/config": "^1.2.0-next.1",
+    "@backstage/errors": "^1.2.4-next.0",
+    "@backstage/plugin-auth-node": "^0.4.9-next.2",
     "@backstage/types": "^1.1.1",
     "better-sqlite3": "^9.0.0",
+    "cookie": "^0.6.0",
     "express": "^4.17.1",
     "fs-extra": "^11.0.0",
     "knex": "^3.0.0",
     "msw": "^1.0.0",
-    "mysql2": "^2.2.5",
+    "mysql2": "^3.0.0",
     "pg": "^8.11.3",
-    "testcontainers": "^8.1.2",
+    "testcontainers": "^10.0.0",
     "textextensions": "^5.16.0",
-    "uuid": "^8.0.0"
-  },
-  "peerDependencies": {
-    "@types/jest": "*"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.25.2",
+    "@backstage/cli": "^0.25.3-next.2",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   },
-  "files": [
-    "dist"
-  ]
+  "peerDependencies": {
+    "@types/jest": "*"
+  }
 }