@backstage/frontend-test-utils 0.6.0 → 0.6.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/frontend-test-utils
 
+## 0.6.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.17.2-next.0
+  - @backstage/core-plugin-api@1.12.7-next.0
+  - @backstage/frontend-app-api@0.16.4-next.1
+  - @backstage/plugin-app@0.4.7-next.1
+  - @backstage/plugin-app-react@0.2.4-next.0
+  - @backstage/core-app-api@1.20.2-next.0
+  - @backstage/test-utils@1.7.19-next.0
+  - @backstage/plugin-permission-react@0.5.2-next.0
+
+## 0.6.1-next.0
+
+### Patch Changes
+
+- 62dd4fc: Added a `mountPath` option to `renderInTestApp` that controls the route path pattern the test element is rendered at. When set, the element is wrapped in a `<Route>` with the given path, enabling `useParams()` to extract route parameters from the URL. Use together with `initialRouteEntries` to set a concrete URL that matches the pattern. This is useful for testing page components that depend on URL parameters, such as entity pages that use `useRouteRefParams`.
+- Updated dependencies
+  - @backstage/plugin-app@0.4.7-next.0
+  - @backstage/frontend-app-api@0.16.4-next.0
+
 ## 0.6.0
 
 ### Minor Changes

package/dist/app/renderInTestApp.esm.js

@@ -1,6 +1,6 @@
 import { jsx } from 'react/jsx-runtime';
 import { Fragment } from 'react';
-import { MemoryRouter } from 'react-router-dom';
+import { MemoryRouter, Routes, Route } from 'react-router-dom';
 import { prepareSpecializedApp } from '@backstage/frontend-app-api';
 import { render } from '@testing-library/react';
 import { ConfigReader } from '@backstage/config';
@@ -33,12 +33,18 @@ const appPluginOverride = appPlugin.withOverrides({
   ]
 });
 function renderInTestApp(element, options) {
+  const mountPath = options?.mountPath;
   const extensions = [
     createExtension({
       attachTo: { id: "app/root", input: "children" },
       output: [coreExtensionData.reactElement],
       factory: () => {
-        return [coreExtensionData.reactElement(element)];
+        let content = element;
+        if (mountPath) {
+          const routePath = mountPath === "/" || mountPath.endsWith("/*") ? mountPath : `${mountPath.replace(/\/$/, "")}/*`;
+          content = /* @__PURE__ */ jsx(Routes, { children: /* @__PURE__ */ jsx(Route, { path: routePath, element: content }) });
+        }
+        return [coreExtensionData.reactElement(content)];
       }
     })
   ];

package/dist/app/renderInTestApp.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"renderInTestApp.esm.js","sources":["../../src/app/renderInTestApp.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Fragment } from 'react';\nimport { MemoryRouter } from 'react-router-dom';\nimport { prepareSpecializedApp } from '@backstage/frontend-app-api';\nimport { RenderResult, render } from '@testing-library/react';\nimport { ConfigReader } from '@backstage/config';\nimport { JsonObject } from '@backstage/types';\nimport {\n  createExtension,\n  ExtensionDefinition,\n  coreExtensionData,\n  RouteRef,\n  createFrontendPlugin,\n  FrontendFeature,\n  createFrontendModule,\n  createApiFactory,\n  createRouteRef,\n  ExternalRouteRef,\n  type ApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { RouterBlueprint } from '@backstage/plugin-app-react';\nimport appPlugin from '@backstage/plugin-app';\nimport { getMockApiFactory } from '../apis/MockWithApiFactory';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport type { CreateSpecializedAppInternalOptions } from '../../../frontend-app-api/src/wiring/createSpecializedApp';\nimport { TestApiPairs } from '../apis/TestApiProvider';\nimport { OpaqueExternalRouteRef } from '@internal/frontend';\n\nconst DEFAULT_MOCK_CONFIG = {\n  app: { baseUrl: 'http://localhost:3000' },\n  backend: { baseUrl: 'http://localhost:7007' },\n};\n\n/**\n * Options to customize the behavior of the test app.\n * @public\n */\nexport type TestAppOptions<TApiPairs extends any[] = any[]> = {\n  /**\n   * An object of paths to mount route ref on, with the key being the path and the value\n   * being the route ref that the path will be bound to. This allows the route refs to be\n   * used by `useRouteRef` in the rendered elements.\n   *\n   * @example\n   * ```ts\n   * renderInTestApp(<MyComponent />, {\n   *   mountedRoutes: {\n   *     '/my-path': myRouteRef,\n   *   }\n   * })\n   * // ...\n   * const link = useRouteRef(myRouteRef)\n   * ```\n   */\n  mountedRoutes?: { [path: string]: RouteRef | ExternalRouteRef };\n\n  /**\n   * Additional configuration passed to the app when rendering elements inside it.\n   */\n  config?: JsonObject;\n\n  /**\n   * Additional features to add to the test app.\n   */\n  features?: FrontendFeature[];\n\n  /**\n   * Initial route entries to use for the router.\n   */\n  initialRouteEntries?: string[];\n\n  /**\n   * API overrides to provide to the test app. Use `mockApis` helpers\n   * from `@backstage/frontend-test-utils` to create mock implementations.\n   *\n   * @example\n   * ```ts\n   * import { mockApis } from '@backstage/frontend-test-utils';\n   *\n   * renderInTestApp(<MyComponent />, {\n   *   apis: [mockApis.identity({ userEntityRef: 'user:default/guest' })],\n   * })\n   * ```\n   */\n  apis?: readonly [...TestApiPairs<TApiPairs>];\n};\n\nconst appPluginOverride = appPlugin.withOverrides({\n  extensions: [\n    appPlugin.getExtension('sign-in-page:app').override({\n      disabled: true,\n    }),\n    appPlugin.getExtension('app/layout').override({\n      disabled: true,\n    }),\n    appPlugin.getExtension('app/routes').override({\n      disabled: true,\n    }),\n    appPlugin.getExtension('app/nav').override({\n      disabled: true,\n    }),\n  ],\n});\n\n/**\n * @public\n * Renders the given element in a test app, for use in unit tests.\n */\nexport function renderInTestApp<const TApiPairs extends any[] = any[]>(\n  element: JSX.Element,\n  options?: TestAppOptions<TApiPairs>,\n): RenderResult {\n  const extensions: Array<ExtensionDefinition> = [\n    createExtension({\n      attachTo: { id: 'app/root', input: 'children' },\n      output: [coreExtensionData.reactElement],\n      factory: () => {\n        return [coreExtensionData.reactElement(element)];\n      },\n    }),\n  ];\n\n  const externalBindings = new Map<ExternalRouteRef, RouteRef>();\n\n  if (options?.mountedRoutes) {\n    for (const [path, optionRef] of Object.entries(options.mountedRoutes)) {\n      let routeRef: RouteRef;\n\n      if (OpaqueExternalRouteRef.isType(optionRef)) {\n        // Create an actual route ref for the external route, then bind the external ref to it\n        routeRef = createRouteRef();\n        externalBindings.set(optionRef, routeRef);\n      } else {\n        routeRef = optionRef;\n      }\n\n      extensions.push(\n        createExtension({\n          kind: 'test-route',\n          name: path,\n          attachTo: { id: 'app/root', input: 'elements' },\n          output: [\n            coreExtensionData.reactElement,\n            coreExtensionData.routePath,\n            coreExtensionData.routeRef,\n          ],\n          factory: () => [\n            coreExtensionData.reactElement(<Fragment />),\n            coreExtensionData.routePath(path),\n            coreExtensionData.routeRef(routeRef),\n          ],\n        }),\n      );\n    }\n  }\n\n  const features: FrontendFeature[] = [\n    createFrontendModule({\n      pluginId: 'app',\n      extensions: [\n        RouterBlueprint.make({\n          params: {\n            component: ({ children }) => (\n              <MemoryRouter\n                initialEntries={options?.initialRouteEntries}\n                future={{\n                  v7_relativeSplatPath: false,\n                  v7_startTransition: false,\n                }}\n              >\n                {children}\n              </MemoryRouter>\n            ),\n          },\n        }),\n      ],\n    }),\n    createFrontendPlugin({\n      pluginId: 'test',\n      extensions,\n    }),\n    appPluginOverride,\n  ];\n\n  if (options?.features) {\n    features.push(...options.features);\n  }\n\n  const app = prepareSpecializedApp({\n    features,\n    config: ConfigReader.fromConfigs([\n      {\n        context: 'render-config',\n        data: options?.config ?? DEFAULT_MOCK_CONFIG,\n      },\n    ]),\n    __internal: options?.apis && {\n      apiFactoryOverrides: options.apis.map(entry => {\n        const mockFactory = getMockApiFactory(entry);\n        if (mockFactory) {\n          return mockFactory;\n        }\n        const [apiRef, implementation] = entry as readonly [ApiRef<any>, any];\n        return createApiFactory(apiRef, implementation);\n      }),\n    },\n    bindRoutes:\n      externalBindings.size > 0\n        ? ({ bind }) => {\n            for (const [externalRef, targetRef] of externalBindings) {\n              bind({ ref: externalRef }, { ref: targetRef });\n            }\n          }\n        : undefined,\n  } as CreateSpecializedAppInternalOptions).finalize();\n\n  return render(\n    app.tree.root.instance!.getData(coreExtensionData.reactElement),\n  );\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;AA2CA,MAAM,mBAAA,GAAsB;AAAA,EAC1B,GAAA,EAAK,EAAE,OAAA,EAAS,uBAAA,EAAwB;AAAA,EACxC,OAAA,EAAS,EAAE,OAAA,EAAS,uBAAA;AACtB,CAAA;AAwDA,MAAM,iBAAA,GAAoB,UAAU,aAAA,CAAc;AAAA,EAChD,UAAA,EAAY;AAAA,IACV,SAAA,CAAU,YAAA,CAAa,kBAAkB,CAAA,CAAE,QAAA,CAAS;AAAA,MAClD,QAAA,EAAU;AAAA,KACX,CAAA;AAAA,IACD,SAAA,CAAU,YAAA,CAAa,YAAY,CAAA,CAAE,QAAA,CAAS;AAAA,MAC5C,QAAA,EAAU;AAAA,KACX,CAAA;AAAA,IACD,SAAA,CAAU,YAAA,CAAa,YAAY,CAAA,CAAE,QAAA,CAAS;AAAA,MAC5C,QAAA,EAAU;AAAA,KACX,CAAA;AAAA,IACD,SAAA,CAAU,YAAA,CAAa,SAAS,CAAA,CAAE,QAAA,CAAS;AAAA,MACzC,QAAA,EAAU;AAAA,KACX;AAAA;AAEL,CAAC,CAAA;AAMM,SAAS,eAAA,CACd,SACA,OAAA,EACc;AACd,EAAA,MAAM,UAAA,GAAyC;AAAA,IAC7C,eAAA,CAAgB;AAAA,MACd,QAAA,EAAU,EAAE,EAAA,EAAI,UAAA,EAAY,OAAO,UAAA,EAAW;AAAA,MAC9C,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAY,CAAA;AAAA,MACvC,SAAS,MAAM;AACb,QAAA,OAAO,CAAC,iBAAA,CAAkB,YAAA,CAAa,OAAO,CAAC,CAAA;AAAA,MACjD;AAAA,KACD;AAAA,GACH;AAEA,EAAA,MAAM,gBAAA,uBAAuB,GAAA,EAAgC;AAE7D,EAAA,IAAI,SAAS,aAAA,EAAe;AAC1B,IAAA,KAAA,MAAW,CAAC,MAAM,SAAS,CAAA,IAAK,OAAO,OAAA,CAAQ,OAAA,CAAQ,aAAa,CAAA,EAAG;AACrE,MAAA,IAAI,QAAA;AAEJ,MAAA,IAAI,sBAAA,CAAuB,MAAA,CAAO,SAAS,CAAA,EAAG;AAE5C,QAAA,QAAA,GAAW,cAAA,EAAe;AAC1B,QAAA,gBAAA,CAAiB,GAAA,CAAI,WAAW,QAAQ,CAAA;AAAA,MAC1C,CAAA,MAAO;AACL,QAAA,QAAA,GAAW,SAAA;AAAA,MACb;AAEA,MAAA,UAAA,CAAW,IAAA;AAAA,QACT,eAAA,CAAgB;AAAA,UACd,IAAA,EAAM,YAAA;AAAA,UACN,IAAA,EAAM,IAAA;AAAA,UACN,QAAA,EAAU,EAAE,EAAA,EAAI,UAAA,EAAY,OAAO,UAAA,EAAW;AAAA,UAC9C,MAAA,EAAQ;AAAA,YACN,iBAAA,CAAkB,YAAA;AAAA,YAClB,iBAAA,CAAkB,SAAA;AAAA,YAClB,iBAAA,CAAkB;AAAA,WACpB;AAAA,UACA,SAAS,MAAM;AAAA,YACb,iBAAA,CAAkB,YAAA,iBAAa,GAAA,CAAC,QAAA,EAAA,EAAS,CAAE,CAAA;AAAA,YAC3C,iBAAA,CAAkB,UAAU,IAAI,CAAA;AAAA,YAChC,iBAAA,CAAkB,SAAS,QAAQ;AAAA;AACrC,SACD;AAAA,OACH;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,QAAA,GAA8B;AAAA,IAClC,oBAAA,CAAqB;AAAA,MACnB,QAAA,EAAU,KAAA;AAAA,MACV,UAAA,EAAY;AAAA,QACV,gBAAgB,IAAA,CAAK;AAAA,UACnB,MAAA,EAAQ;AAAA,YACN,SAAA,EAAW,CAAC,EAAE,QAAA,EAAS,qBACrB,GAAA;AAAA,cAAC,YAAA;AAAA,cAAA;AAAA,gBACC,gBAAgB,OAAA,EAAS,mBAAA;AAAA,gBACzB,MAAA,EAAQ;AAAA,kBACN,oBAAA,EAAsB,KAAA;AAAA,kBACtB,kBAAA,EAAoB;AAAA,iBACtB;AAAA,gBAEC;AAAA;AAAA;AACH;AAEJ,SACD;AAAA;AACH,KACD,CAAA;AAAA,IACD,oBAAA,CAAqB;AAAA,MACnB,QAAA,EAAU,MAAA;AAAA,MACV;AAAA,KACD,CAAA;AAAA,IACD;AAAA,GACF;AAEA,EAAA,IAAI,SAAS,QAAA,EAAU;AACrB,IAAA,QAAA,CAAS,IAAA,CAAK,GAAG,OAAA,CAAQ,QAAQ,CAAA;AAAA,EACnC;AAEA,EAAA,MAAM,MAAM,qBAAA,CAAsB;AAAA,IAChC,QAAA;AAAA,IACA,MAAA,EAAQ,aAAa,WAAA,CAAY;AAAA,MAC/B;AAAA,QACE,OAAA,EAAS,eAAA;AAAA,QACT,IAAA,EAAM,SAAS,MAAA,IAAU;AAAA;AAC3B,KACD,CAAA;AAAA,IACD,UAAA,EAAY,SAAS,IAAA,IAAQ;AAAA,MAC3B,mBAAA,EAAqB,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,CAAA,KAAA,KAAS;AAC7C,QAAA,MAAM,WAAA,GAAc,kBAAkB,KAAK,CAAA;AAC3C,QAAA,IAAI,WAAA,EAAa;AACf,UAAA,OAAO,WAAA;AAAA,QACT;AACA,QAAA,MAAM,CAAC,MAAA,EAAQ,cAAc,CAAA,GAAI,KAAA;AACjC,QAAA,OAAO,gBAAA,CAAiB,QAAQ,cAAc,CAAA;AAAA,MAChD,CAAC;AAAA,KACH;AAAA,IACA,YACE,gBAAA,CAAiB,IAAA,GAAO,IACpB,CAAC,EAAE,MAAK,KAAM;AACZ,MAAA,KAAA,MAAW,CAAC,WAAA,EAAa,SAAS,CAAA,IAAK,gBAAA,EAAkB;AACvD,QAAA,IAAA,CAAK,EAAE,GAAA,EAAK,WAAA,IAAe,EAAE,GAAA,EAAK,WAAW,CAAA;AAAA,MAC/C;AAAA,IACF,CAAA,GACA;AAAA,GACgC,EAAE,QAAA,EAAS;AAEnD,EAAA,OAAO,MAAA;AAAA,IACL,IAAI,IAAA,CAAK,IAAA,CAAK,QAAA,CAAU,OAAA,CAAQ,kBAAkB,YAAY;AAAA,GAChE;AACF;;;;"}
+{"version":3,"file":"renderInTestApp.esm.js","sources":["../../src/app/renderInTestApp.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Fragment } from 'react';\nimport { MemoryRouter, Route, Routes } from 'react-router-dom';\nimport { prepareSpecializedApp } from '@backstage/frontend-app-api';\nimport { RenderResult, render } from '@testing-library/react';\nimport { ConfigReader } from '@backstage/config';\nimport { JsonObject } from '@backstage/types';\nimport {\n  createExtension,\n  ExtensionDefinition,\n  coreExtensionData,\n  RouteRef,\n  createFrontendPlugin,\n  FrontendFeature,\n  createFrontendModule,\n  createApiFactory,\n  createRouteRef,\n  ExternalRouteRef,\n  type ApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { RouterBlueprint } from '@backstage/plugin-app-react';\nimport appPlugin from '@backstage/plugin-app';\nimport { getMockApiFactory } from '../apis/MockWithApiFactory';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport type { CreateSpecializedAppInternalOptions } from '../../../frontend-app-api/src/wiring/createSpecializedApp';\nimport { TestApiPairs } from '../apis/TestApiProvider';\nimport { OpaqueExternalRouteRef } from '@internal/frontend';\n\nconst DEFAULT_MOCK_CONFIG = {\n  app: { baseUrl: 'http://localhost:3000' },\n  backend: { baseUrl: 'http://localhost:7007' },\n};\n\n/**\n * Options to customize the behavior of the test app.\n * @public\n */\nexport type TestAppOptions<TApiPairs extends any[] = any[]> = {\n  /**\n   * An object of paths to mount route ref on, with the key being the path and the value\n   * being the route ref that the path will be bound to. This allows the route refs to be\n   * used by `useRouteRef` in the rendered elements.\n   *\n   * @example\n   * ```ts\n   * renderInTestApp(<MyComponent />, {\n   *   mountedRoutes: {\n   *     '/my-path': myRouteRef,\n   *   }\n   * })\n   * // ...\n   * const link = useRouteRef(myRouteRef)\n   * ```\n   */\n  mountedRoutes?: { [path: string]: RouteRef | ExternalRouteRef };\n\n  /**\n   * Additional configuration passed to the app when rendering elements inside it.\n   */\n  config?: JsonObject;\n\n  /**\n   * Additional features to add to the test app.\n   */\n  features?: FrontendFeature[];\n\n  /**\n   * The route path pattern that the test element is rendered at. When set,\n   * the element is wrapped in a `<Route>` with this path, enabling\n   * `useParams()` to extract parameters from the URL.\n   *\n   * Should be used together with `initialRouteEntries` to set a concrete\n   * URL that matches the pattern.\n   *\n   * @example\n   * ```ts\n   * renderInTestApp(<EntityPage />, {\n   *   mountPath: '/catalog/:namespace/:kind/:name',\n   *   initialRouteEntries: ['/catalog/default/component/my-entity'],\n   * })\n   * ```\n   */\n  mountPath?: string;\n\n  /**\n   * Initial route entries to use for the router.\n   */\n  initialRouteEntries?: string[];\n\n  /**\n   * API overrides to provide to the test app. Use `mockApis` helpers\n   * from `@backstage/frontend-test-utils` to create mock implementations.\n   *\n   * @example\n   * ```ts\n   * import { mockApis } from '@backstage/frontend-test-utils';\n   *\n   * renderInTestApp(<MyComponent />, {\n   *   apis: [mockApis.identity({ userEntityRef: 'user:default/guest' })],\n   * })\n   * ```\n   */\n  apis?: readonly [...TestApiPairs<TApiPairs>];\n};\n\nconst appPluginOverride = appPlugin.withOverrides({\n  extensions: [\n    appPlugin.getExtension('sign-in-page:app').override({\n      disabled: true,\n    }),\n    appPlugin.getExtension('app/layout').override({\n      disabled: true,\n    }),\n    appPlugin.getExtension('app/routes').override({\n      disabled: true,\n    }),\n    appPlugin.getExtension('app/nav').override({\n      disabled: true,\n    }),\n  ],\n});\n\n/**\n * @public\n * Renders the given element in a test app, for use in unit tests.\n */\nexport function renderInTestApp<const TApiPairs extends any[] = any[]>(\n  element: JSX.Element,\n  options?: TestAppOptions<TApiPairs>,\n): RenderResult {\n  const mountPath = options?.mountPath;\n\n  const extensions: Array<ExtensionDefinition> = [\n    createExtension({\n      attachTo: { id: 'app/root', input: 'children' },\n      output: [coreExtensionData.reactElement],\n      factory: () => {\n        let content: JSX.Element = element;\n\n        if (mountPath) {\n          const routePath =\n            mountPath === '/' || mountPath.endsWith('/*')\n              ? mountPath\n              : `${mountPath.replace(/\\/$/, '')}/*`;\n          content = (\n            <Routes>\n              <Route path={routePath} element={content} />\n            </Routes>\n          );\n        }\n\n        return [coreExtensionData.reactElement(content)];\n      },\n    }),\n  ];\n\n  const externalBindings = new Map<ExternalRouteRef, RouteRef>();\n\n  if (options?.mountedRoutes) {\n    for (const [path, optionRef] of Object.entries(options.mountedRoutes)) {\n      let routeRef: RouteRef;\n\n      if (OpaqueExternalRouteRef.isType(optionRef)) {\n        // Create an actual route ref for the external route, then bind the external ref to it\n        routeRef = createRouteRef();\n        externalBindings.set(optionRef, routeRef);\n      } else {\n        routeRef = optionRef;\n      }\n\n      extensions.push(\n        createExtension({\n          kind: 'test-route',\n          name: path,\n          attachTo: { id: 'app/root', input: 'elements' },\n          output: [\n            coreExtensionData.reactElement,\n            coreExtensionData.routePath,\n            coreExtensionData.routeRef,\n          ],\n          factory: () => [\n            coreExtensionData.reactElement(<Fragment />),\n            coreExtensionData.routePath(path),\n            coreExtensionData.routeRef(routeRef),\n          ],\n        }),\n      );\n    }\n  }\n\n  const features: FrontendFeature[] = [\n    createFrontendModule({\n      pluginId: 'app',\n      extensions: [\n        RouterBlueprint.make({\n          params: {\n            component: ({ children }) => (\n              <MemoryRouter\n                initialEntries={options?.initialRouteEntries}\n                future={{\n                  v7_relativeSplatPath: false,\n                  v7_startTransition: false,\n                }}\n              >\n                {children}\n              </MemoryRouter>\n            ),\n          },\n        }),\n      ],\n    }),\n    createFrontendPlugin({\n      pluginId: 'test',\n      extensions,\n    }),\n    appPluginOverride,\n  ];\n\n  if (options?.features) {\n    features.push(...options.features);\n  }\n\n  const app = prepareSpecializedApp({\n    features,\n    config: ConfigReader.fromConfigs([\n      {\n        context: 'render-config',\n        data: options?.config ?? DEFAULT_MOCK_CONFIG,\n      },\n    ]),\n    __internal: options?.apis && {\n      apiFactoryOverrides: options.apis.map(entry => {\n        const mockFactory = getMockApiFactory(entry);\n        if (mockFactory) {\n          return mockFactory;\n        }\n        const [apiRef, implementation] = entry as readonly [ApiRef<any>, any];\n        return createApiFactory(apiRef, implementation);\n      }),\n    },\n    bindRoutes:\n      externalBindings.size > 0\n        ? ({ bind }) => {\n            for (const [externalRef, targetRef] of externalBindings) {\n              bind({ ref: externalRef }, { ref: targetRef });\n            }\n          }\n        : undefined,\n  } as CreateSpecializedAppInternalOptions).finalize();\n\n  return render(\n    app.tree.root.instance!.getData(coreExtensionData.reactElement),\n  );\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;AA2CA,MAAM,mBAAA,GAAsB;AAAA,EAC1B,GAAA,EAAK,EAAE,OAAA,EAAS,uBAAA,EAAwB;AAAA,EACxC,OAAA,EAAS,EAAE,OAAA,EAAS,uBAAA;AACtB,CAAA;AA0EA,MAAM,iBAAA,GAAoB,UAAU,aAAA,CAAc;AAAA,EAChD,UAAA,EAAY;AAAA,IACV,SAAA,CAAU,YAAA,CAAa,kBAAkB,CAAA,CAAE,QAAA,CAAS;AAAA,MAClD,QAAA,EAAU;AAAA,KACX,CAAA;AAAA,IACD,SAAA,CAAU,YAAA,CAAa,YAAY,CAAA,CAAE,QAAA,CAAS;AAAA,MAC5C,QAAA,EAAU;AAAA,KACX,CAAA;AAAA,IACD,SAAA,CAAU,YAAA,CAAa,YAAY,CAAA,CAAE,QAAA,CAAS;AAAA,MAC5C,QAAA,EAAU;AAAA,KACX,CAAA;AAAA,IACD,SAAA,CAAU,YAAA,CAAa,SAAS,CAAA,CAAE,QAAA,CAAS;AAAA,MACzC,QAAA,EAAU;AAAA,KACX;AAAA;AAEL,CAAC,CAAA;AAMM,SAAS,eAAA,CACd,SACA,OAAA,EACc;AACd,EAAA,MAAM,YAAY,OAAA,EAAS,SAAA;AAE3B,EAAA,MAAM,UAAA,GAAyC;AAAA,IAC7C,eAAA,CAAgB;AAAA,MACd,QAAA,EAAU,EAAE,EAAA,EAAI,UAAA,EAAY,OAAO,UAAA,EAAW;AAAA,MAC9C,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAY,CAAA;AAAA,MACvC,SAAS,MAAM;AACb,QAAA,IAAI,OAAA,GAAuB,OAAA;AAE3B,QAAA,IAAI,SAAA,EAAW;AACb,UAAA,MAAM,SAAA,GACJ,SAAA,KAAc,GAAA,IAAO,SAAA,CAAU,QAAA,CAAS,IAAI,CAAA,GACxC,SAAA,GACA,CAAA,EAAG,SAAA,CAAU,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA,EAAA,CAAA;AACrC,UAAA,OAAA,mBACE,GAAA,CAAC,UACC,QAAA,kBAAA,GAAA,CAAC,KAAA,EAAA,EAAM,MAAM,SAAA,EAAW,OAAA,EAAS,SAAS,CAAA,EAC5C,CAAA;AAAA,QAEJ;AAEA,QAAA,OAAO,CAAC,iBAAA,CAAkB,YAAA,CAAa,OAAO,CAAC,CAAA;AAAA,MACjD;AAAA,KACD;AAAA,GACH;AAEA,EAAA,MAAM,gBAAA,uBAAuB,GAAA,EAAgC;AAE7D,EAAA,IAAI,SAAS,aAAA,EAAe;AAC1B,IAAA,KAAA,MAAW,CAAC,MAAM,SAAS,CAAA,IAAK,OAAO,OAAA,CAAQ,OAAA,CAAQ,aAAa,CAAA,EAAG;AACrE,MAAA,IAAI,QAAA;AAEJ,MAAA,IAAI,sBAAA,CAAuB,MAAA,CAAO,SAAS,CAAA,EAAG;AAE5C,QAAA,QAAA,GAAW,cAAA,EAAe;AAC1B,QAAA,gBAAA,CAAiB,GAAA,CAAI,WAAW,QAAQ,CAAA;AAAA,MAC1C,CAAA,MAAO;AACL,QAAA,QAAA,GAAW,SAAA;AAAA,MACb;AAEA,MAAA,UAAA,CAAW,IAAA;AAAA,QACT,eAAA,CAAgB;AAAA,UACd,IAAA,EAAM,YAAA;AAAA,UACN,IAAA,EAAM,IAAA;AAAA,UACN,QAAA,EAAU,EAAE,EAAA,EAAI,UAAA,EAAY,OAAO,UAAA,EAAW;AAAA,UAC9C,MAAA,EAAQ;AAAA,YACN,iBAAA,CAAkB,YAAA;AAAA,YAClB,iBAAA,CAAkB,SAAA;AAAA,YAClB,iBAAA,CAAkB;AAAA,WACpB;AAAA,UACA,SAAS,MAAM;AAAA,YACb,iBAAA,CAAkB,YAAA,iBAAa,GAAA,CAAC,QAAA,EAAA,EAAS,CAAE,CAAA;AAAA,YAC3C,iBAAA,CAAkB,UAAU,IAAI,CAAA;AAAA,YAChC,iBAAA,CAAkB,SAAS,QAAQ;AAAA;AACrC,SACD;AAAA,OACH;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,QAAA,GAA8B;AAAA,IAClC,oBAAA,CAAqB;AAAA,MACnB,QAAA,EAAU,KAAA;AAAA,MACV,UAAA,EAAY;AAAA,QACV,gBAAgB,IAAA,CAAK;AAAA,UACnB,MAAA,EAAQ;AAAA,YACN,SAAA,EAAW,CAAC,EAAE,QAAA,EAAS,qBACrB,GAAA;AAAA,cAAC,YAAA;AAAA,cAAA;AAAA,gBACC,gBAAgB,OAAA,EAAS,mBAAA;AAAA,gBACzB,MAAA,EAAQ;AAAA,kBACN,oBAAA,EAAsB,KAAA;AAAA,kBACtB,kBAAA,EAAoB;AAAA,iBACtB;AAAA,gBAEC;AAAA;AAAA;AACH;AAEJ,SACD;AAAA;AACH,KACD,CAAA;AAAA,IACD,oBAAA,CAAqB;AAAA,MACnB,QAAA,EAAU,MAAA;AAAA,MACV;AAAA,KACD,CAAA;AAAA,IACD;AAAA,GACF;AAEA,EAAA,IAAI,SAAS,QAAA,EAAU;AACrB,IAAA,QAAA,CAAS,IAAA,CAAK,GAAG,OAAA,CAAQ,QAAQ,CAAA;AAAA,EACnC;AAEA,EAAA,MAAM,MAAM,qBAAA,CAAsB;AAAA,IAChC,QAAA;AAAA,IACA,MAAA,EAAQ,aAAa,WAAA,CAAY;AAAA,MAC/B;AAAA,QACE,OAAA,EAAS,eAAA;AAAA,QACT,IAAA,EAAM,SAAS,MAAA,IAAU;AAAA;AAC3B,KACD,CAAA;AAAA,IACD,UAAA,EAAY,SAAS,IAAA,IAAQ;AAAA,MAC3B,mBAAA,EAAqB,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,CAAA,KAAA,KAAS;AAC7C,QAAA,MAAM,WAAA,GAAc,kBAAkB,KAAK,CAAA;AAC3C,QAAA,IAAI,WAAA,EAAa;AACf,UAAA,OAAO,WAAA;AAAA,QACT;AACA,QAAA,MAAM,CAAC,MAAA,EAAQ,cAAc,CAAA,GAAI,KAAA;AACjC,QAAA,OAAO,gBAAA,CAAiB,QAAQ,cAAc,CAAA;AAAA,MAChD,CAAC;AAAA,KACH;AAAA,IACA,YACE,gBAAA,CAAiB,IAAA,GAAO,IACpB,CAAC,EAAE,MAAK,KAAM;AACZ,MAAA,KAAA,MAAW,CAAC,WAAA,EAAa,SAAS,CAAA,IAAK,gBAAA,EAAkB;AACvD,QAAA,IAAA,CAAK,EAAE,GAAA,EAAK,WAAA,IAAe,EAAE,GAAA,EAAK,WAAW,CAAA;AAAA,MAC/C;AAAA,IACF,CAAA,GACA;AAAA,GACgC,EAAE,QAAA,EAAS;AAEnD,EAAA,OAAO,MAAA;AAAA,IACL,IAAI,IAAA,CAAK,IAAA,CAAK,QAAA,CAAU,OAAA,CAAQ,kBAAkB,YAAY;AAAA,GAChE;AACF;;;;"}

package/dist/index.d.ts

@@ -819,6 +819,23 @@ type TestAppOptions<TApiPairs extends any[] = any[]> = {
      * Additional features to add to the test app.
      */
     features?: FrontendFeature[];
+    /**
+     * The route path pattern that the test element is rendered at. When set,
+     * the element is wrapped in a `<Route>` with this path, enabling
+     * `useParams()` to extract parameters from the URL.
+     *
+     * Should be used together with `initialRouteEntries` to set a concrete
+     * URL that matches the pattern.
+     *
+     * @example
+     * ```ts
+     * renderInTestApp(<EntityPage />, {
+     *   mountPath: '/catalog/:namespace/:kind/:name',
+     *   initialRouteEntries: ['/catalog/default/component/my-entity'],
+     * })
+     * ```
+     */
+    mountPath?: string;
     /**
      * Initial route entries to use for the router.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-test-utils",
-  "version": "0.6.0",
+  "version": "0.6.1-next.1",
   "backstage": {
     "role": "web-library"
   },
@@ -31,25 +31,25 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/config": "^1.3.8",
-    "@backstage/core-app-api": "^1.20.1",
-    "@backstage/core-plugin-api": "^1.12.6",
-    "@backstage/filter-predicates": "^0.1.3",
-    "@backstage/frontend-app-api": "^0.16.3",
-    "@backstage/frontend-plugin-api": "^0.17.0",
-    "@backstage/plugin-app": "^0.4.6",
-    "@backstage/plugin-app-react": "^0.2.3",
-    "@backstage/plugin-permission-common": "^0.9.9",
-    "@backstage/plugin-permission-react": "^0.5.1",
-    "@backstage/test-utils": "^1.7.18",
-    "@backstage/types": "^1.2.2",
-    "@backstage/version-bridge": "^1.0.12",
+    "@backstage/config": "1.3.8",
+    "@backstage/core-app-api": "1.20.2-next.0",
+    "@backstage/core-plugin-api": "1.12.7-next.0",
+    "@backstage/filter-predicates": "0.1.3",
+    "@backstage/frontend-app-api": "0.16.4-next.1",
+    "@backstage/frontend-plugin-api": "0.17.2-next.0",
+    "@backstage/plugin-app": "0.4.7-next.1",
+    "@backstage/plugin-app-react": "0.2.4-next.0",
+    "@backstage/plugin-permission-common": "0.9.9",
+    "@backstage/plugin-permission-react": "0.5.2-next.0",
+    "@backstage/test-utils": "1.7.19-next.0",
+    "@backstage/types": "1.2.2",
+    "@backstage/version-bridge": "1.0.12",
     "i18next": "^22.4.15",
     "zen-observable": "^0.10.0",
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.36.2",
+    "@backstage/cli": "0.36.3-next.1",
     "@testing-library/jest-dom": "^6.0.0",
     "@types/jest": "*",
     "@types/react": "^18.0.0",