@backstage-community/plugin-allure 0.1.51

package/README.md

@@ -0,0 +1,40 @@
+# [Allure](https://docs.qameta.io/allure/)
+
+Welcome to the Backstage Allure plugin. This plugin add an entity service page to display Allure test reports related to the service.
+
+## Install
+
+```shell
+# From your Backstage root directory
+yarn --cwd packages/app add @backstage-community/plugin-allure
+```
+
+## Configure
+
+### Configure Allure service
+
+Add below configuration in the `app-config.yaml`.
+
+```yaml
+allure:
+  baseUrl: <ALLURE_SERVICE_BASE_URL> # Example: https://allure.my-company.net or when running allure locally, http://localhost:5050/allure-docker-service
+```
+
+### Setup entity service page
+
+Add `EntityAllureReportContent` in the `EntityPage.tsx` like below:
+
+```diff
++ import { EntityAllureReportContent } from '@backstage-community/plugin-allure';
+
+...
+
+const serviceEntityPage = (
+  <EntityLayoutWrapper>
+    ...
++    <EntityLayout.Route path="/allure" title="Allure Report">
++        <EntityAllureReportContent />
++    </EntityLayout.Route>
+  </EntityLayoutWrapper>
+);
+```

package/dist/esm/index-DMPeCQyc.esm.js

@@ -0,0 +1,40 @@
+import React from 'react';
+import { useApi } from '@backstage/core-plugin-api';
+import { i as isAllureReportAvailable, A as ALLURE_PROJECT_ID_ANNOTATION, a as allureApiRef, g as getAllureProjectId } from './index-i1EiZshE.esm.js';
+import { useEntity, MissingAnnotationEmptyState } from '@backstage/plugin-catalog-react';
+import { Progress } from '@backstage/core-components';
+import useAsync from 'react-use/esm/useAsync';
+
+const AllureReport = (props) => {
+  const allureApi = useApi(allureApiRef);
+  const allureProjectId = getAllureProjectId(props.entity);
+  const { value, loading } = useAsync(async () => {
+    const url = await allureApi.getReportUrl(allureProjectId);
+    return url;
+  });
+  if (loading) {
+    return /* @__PURE__ */ React.createElement(Progress, null);
+  }
+  return /* @__PURE__ */ React.createElement(
+    "iframe",
+    {
+      style: {
+        display: "table",
+        width: "100%",
+        height: "100%"
+      },
+      title: "Allure Report",
+      src: value
+    }
+  );
+};
+const AllureReportComponent = () => {
+  const { entity } = useEntity();
+  const isReportAvailable = entity && isAllureReportAvailable(entity);
+  if (isReportAvailable)
+    return /* @__PURE__ */ React.createElement(AllureReport, { entity });
+  return /* @__PURE__ */ React.createElement(MissingAnnotationEmptyState, { annotation: ALLURE_PROJECT_ID_ANNOTATION });
+};
+
+export { AllureReportComponent };
+//# sourceMappingURL=index-DMPeCQyc.esm.js.map

package/dist/esm/index-DMPeCQyc.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-DMPeCQyc.esm.js","sources":["../../src/components/AllureReportComponent/AllureReportComponent.tsx"],"sourcesContent":["/*\n * Copyright 2021 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 */\nimport React from 'react';\nimport { useApi } from '@backstage/core-plugin-api';\nimport { allureApiRef } from '../../api';\nimport {\n  useEntity,\n  MissingAnnotationEmptyState,\n} from '@backstage/plugin-catalog-react';\nimport {\n  ALLURE_PROJECT_ID_ANNOTATION,\n  isAllureReportAvailable,\n  getAllureProjectId,\n} from '../annotationHelpers';\nimport { Progress } from '@backstage/core-components';\nimport useAsync from 'react-use/esm/useAsync';\nimport { Entity } from '@backstage/catalog-model';\n\nconst AllureReport = (props: { entity: Entity }) => {\n  const allureApi = useApi(allureApiRef);\n\n  const allureProjectId = getAllureProjectId(props.entity);\n  const { value, loading } = useAsync(async () => {\n    const url = await allureApi.getReportUrl(allureProjectId);\n    return url;\n  });\n\n  if (loading) {\n    return <Progress />;\n  }\n  return (\n    <iframe\n      style={{\n        display: 'table',\n        width: '100%',\n        height: '100%',\n      }}\n      title=\"Allure Report\"\n      src={value}\n    />\n  );\n};\n\nexport const AllureReportComponent = () => {\n  const { entity } = useEntity();\n  const isReportAvailable = entity && isAllureReportAvailable(entity);\n\n  if (isReportAvailable) return <AllureReport entity={entity} />;\n  return (\n    <MissingAnnotationEmptyState annotation={ALLURE_PROJECT_ID_ANNOTATION} />\n  );\n};\n"],"names":[],"mappings":";;;;;;;AA+BA,MAAM,YAAA,GAAe,CAAC,KAA8B,KAAA;AAClD,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA,CAAA;AAErC,EAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,KAAA,CAAM,MAAM,CAAA,CAAA;AACvD,EAAA,MAAM,EAAE,KAAA,EAAO,OAAQ,EAAA,GAAI,SAAS,YAAY;AAC9C,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,YAAA,CAAa,eAAe,CAAA,CAAA;AACxD,IAAO,OAAA,GAAA,CAAA;AAAA,GACR,CAAA,CAAA;AAED,EAAA,IAAI,OAAS,EAAA;AACX,IAAA,2CAAQ,QAAS,EAAA,IAAA,CAAA,CAAA;AAAA,GACnB;AACA,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,QAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA;AAAA,QACL,OAAS,EAAA,OAAA;AAAA,QACT,KAAO,EAAA,MAAA;AAAA,QACP,MAAQ,EAAA,MAAA;AAAA,OACV;AAAA,MACA,KAAM,EAAA,eAAA;AAAA,MACN,GAAK,EAAA,KAAA;AAAA,KAAA;AAAA,GACP,CAAA;AAEJ,CAAA,CAAA;AAEO,MAAM,wBAAwB,MAAM;AACzC,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAU,EAAA,CAAA;AAC7B,EAAM,MAAA,iBAAA,GAAoB,MAAU,IAAA,uBAAA,CAAwB,MAAM,CAAA,CAAA;AAElE,EAAI,IAAA,iBAAA;AAAmB,IAAO,uBAAA,KAAA,CAAA,aAAA,CAAC,gBAAa,MAAgB,EAAA,CAAA,CAAA;AAC5D,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,2BAA4B,EAAA,EAAA,UAAA,EAAY,4BAA8B,EAAA,CAAA,CAAA;AAE3E;;;;"}

package/dist/esm/index-i1EiZshE.esm.js

@@ -0,0 +1,63 @@
+import { createApiRef, createRouteRef, createPlugin, createApiFactory, configApiRef, createRoutableExtension } from '@backstage/core-plugin-api';
+
+const allureApiRef = createApiRef({
+  id: "allure-api"
+});
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class AllureApiClient {
+  constructor(options) {
+    __publicField(this, "configApi");
+    this.configApi = options.configApi;
+  }
+  async getReportUrl(projectId) {
+    const baseUrl = this.configApi.getString("allure.baseUrl");
+    return `${baseUrl}/projects/${projectId}/reports/latest/index.html`;
+  }
+}
+
+const allureRouteRef = createRouteRef({
+  id: "allure"
+});
+const allurePlugin = createPlugin({
+  id: "allure",
+  apis: [
+    createApiFactory({
+      api: allureApiRef,
+      deps: {
+        configApi: configApiRef
+      },
+      factory: ({ configApi }) => new AllureApiClient({ configApi })
+    })
+  ],
+  routes: {
+    root: allureRouteRef
+  }
+});
+const EntityAllureReportContent = allurePlugin.provide(
+  createRoutableExtension({
+    name: "EntityAllureReportContent",
+    component: () => import('./index-DMPeCQyc.esm.js').then(
+      (m) => m.AllureReportComponent
+    ),
+    mountPoint: allureRouteRef
+  })
+);
+
+const ALLURE_PROJECT_ID_ANNOTATION = "qameta.io/allure-project";
+const isAllureReportAvailable = (entity) => {
+  var _a;
+  return Boolean((_a = entity.metadata.annotations) == null ? void 0 : _a[ALLURE_PROJECT_ID_ANNOTATION]);
+};
+const getAllureProjectId = (entity) => {
+  var _a, _b;
+  return (_b = (_a = entity == null ? void 0 : entity.metadata.annotations) == null ? void 0 : _a[ALLURE_PROJECT_ID_ANNOTATION]) != null ? _b : "";
+};
+
+export { ALLURE_PROJECT_ID_ANNOTATION as A, EntityAllureReportContent as E, allureApiRef as a, allurePlugin as b, getAllureProjectId as g, isAllureReportAvailable as i };
+//# sourceMappingURL=index-i1EiZshE.esm.js.map

package/dist/esm/index-i1EiZshE.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-i1EiZshE.esm.js","sources":["../../src/api/AllureApi.ts","../../src/api/AllureApiClient.ts","../../src/plugin.ts","../../src/components/annotationHelpers.ts"],"sourcesContent":["/*\n * Copyright 2021 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 */\nimport { createApiRef } from '@backstage/core-plugin-api';\n\nexport type AllureApi = {\n  getReportUrl(projectId: string): Promise<string>;\n};\n\nexport const allureApiRef = createApiRef<AllureApi>({\n  id: 'allure-api',\n});\n","/*\n * Copyright 2021 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 */\nimport { ConfigApi } from '@backstage/core-plugin-api';\nimport { AllureApi } from './AllureApi';\n\nexport class AllureApiClient implements AllureApi {\n  readonly configApi: ConfigApi;\n\n  constructor(options: { configApi: ConfigApi }) {\n    this.configApi = options.configApi;\n  }\n\n  async getReportUrl(projectId: string): Promise<string> {\n    const baseUrl = this.configApi.getString('allure.baseUrl');\n    return `${baseUrl}/projects/${projectId}/reports/latest/index.html`;\n  }\n}\n","/*\n * Copyright 2021 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 */\nimport {\n  configApiRef,\n  createApiFactory,\n  createPlugin,\n  createRoutableExtension,\n  createRouteRef,\n} from '@backstage/core-plugin-api';\nimport { AllureApiClient, allureApiRef } from './api';\n\nexport const allureRouteRef = createRouteRef({\n  id: 'allure',\n});\n\n/** @public */\nexport const allurePlugin = createPlugin({\n  id: 'allure',\n  apis: [\n    createApiFactory({\n      api: allureApiRef,\n      deps: {\n        configApi: configApiRef,\n      },\n      factory: ({ configApi }) => new AllureApiClient({ configApi }),\n    }),\n  ],\n  routes: {\n    root: allureRouteRef,\n  },\n});\n\n/** @public */\nexport const EntityAllureReportContent = allurePlugin.provide(\n  createRoutableExtension({\n    name: 'EntityAllureReportContent',\n    component: () =>\n      import('./components/AllureReportComponent').then(\n        m => m.AllureReportComponent,\n      ),\n    mountPoint: allureRouteRef,\n  }),\n);\n","/*\n * Copyright 2021 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 */\nimport { Entity } from '@backstage/catalog-model';\n\n/** @public */\nexport const ALLURE_PROJECT_ID_ANNOTATION = 'qameta.io/allure-project';\n\n/** @public */\nexport const isAllureReportAvailable = (entity: Entity) =>\n  Boolean(entity.metadata.annotations?.[ALLURE_PROJECT_ID_ANNOTATION]);\n\nexport const getAllureProjectId = (entity: Entity) => {\n  return entity?.metadata.annotations?.[ALLURE_PROJECT_ID_ANNOTATION] ?? '';\n};\n"],"names":[],"mappings":";;AAqBO,MAAM,eAAe,YAAwB,CAAA;AAAA,EAClD,EAAI,EAAA,YAAA;AACN,CAAC;;;;;;;;ACLM,MAAM,eAAqC,CAAA;AAAA,EAGhD,YAAY,OAAmC,EAAA;AAF/C,IAAS,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AAGP,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,MAAM,aAAa,SAAoC,EAAA;AACrD,IAAA,MAAM,OAAU,GAAA,IAAA,CAAK,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA,CAAA;AACzD,IAAO,OAAA,CAAA,EAAG,OAAO,CAAA,UAAA,EAAa,SAAS,CAAA,0BAAA,CAAA,CAAA;AAAA,GACzC;AACF;;ACLO,MAAM,iBAAiB,cAAe,CAAA;AAAA,EAC3C,EAAI,EAAA,QAAA;AACN,CAAC,CAAA,CAAA;AAGM,MAAM,eAAe,YAAa,CAAA;AAAA,EACvC,EAAI,EAAA,QAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,YAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,OACb;AAAA,MACA,OAAA,EAAS,CAAC,EAAE,SAAA,OAAgB,IAAI,eAAA,CAAgB,EAAE,SAAA,EAAW,CAAA;AAAA,KAC9D,CAAA;AAAA,GACH;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,cAAA;AAAA,GACR;AACF,CAAC,EAAA;AAGM,MAAM,4BAA4B,YAAa,CAAA,OAAA;AAAA,EACpD,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,2BAAA;AAAA,IACN,SAAW,EAAA,MACT,OAAO,yBAAoC,CAAE,CAAA,IAAA;AAAA,MAC3C,OAAK,CAAE,CAAA,qBAAA;AAAA,KACT;AAAA,IACF,UAAY,EAAA,cAAA;AAAA,GACb,CAAA;AACH;;ACrCO,MAAM,4BAA+B,GAAA,2BAAA;AAG/B,MAAA,uBAAA,GAA0B,CAAC,MAAgB,KAAA;AArBxD,EAAA,IAAA,EAAA,CAAA;AAsBE,EAAA,OAAA,OAAA,CAAA,CAAQ,EAAO,GAAA,MAAA,CAAA,QAAA,CAAS,WAAhB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA8B,4BAA6B,CAAA,CAAA,CAAA;AAAA,EAAA;AAExD,MAAA,kBAAA,GAAqB,CAAC,MAAmB,KAAA;AAxBtD,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyBE,EAAA,OAAA,CAAO,EAAQ,GAAA,CAAA,EAAA,GAAA,MAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,MAAA,CAAA,QAAA,CAAS,WAAjB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA+B,kCAA/B,IAAgE,GAAA,EAAA,GAAA,EAAA,CAAA;AACzE;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import * as react from 'react';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { Entity } from '@backstage/catalog-model';
+
+/** @public */
+declare const allurePlugin: _backstage_core_plugin_api.BackstagePlugin<{
+    root: _backstage_core_plugin_api.RouteRef<undefined>;
+}, {}, {}>;
+/** @public */
+declare const EntityAllureReportContent: () => react.JSX.Element;
+
+/** @public */
+declare const ALLURE_PROJECT_ID_ANNOTATION = "qameta.io/allure-project";
+/** @public */
+declare const isAllureReportAvailable: (entity: Entity) => boolean;
+
+export { ALLURE_PROJECT_ID_ANNOTATION, EntityAllureReportContent, allurePlugin, isAllureReportAvailable };

package/dist/index.esm.js

@@ -0,0 +1,3 @@
+export { A as ALLURE_PROJECT_ID_ANNOTATION, E as EntityAllureReportContent, b as allurePlugin, i as isAllureReportAvailable } from './esm/index-i1EiZshE.esm.js';
+import '@backstage/core-plugin-api';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@backstage-community/plugin-allure",
+  "version": "0.1.51",
+  "description": "A Backstage plugin that integrates with Allure",
+  "backstage": {
+    "role": "frontend-plugin"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/allure/plugins/allure"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/catalog-model": "^1.4.5",
+    "@backstage/core-components": "^0.14.4",
+    "@backstage/core-plugin-api": "^1.9.2",
+    "@backstage/plugin-catalog-react": "^1.11.3",
+    "@types/react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-use": "^17.2.4"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.26.3",
+    "@backstage/dev-utils": "^1.0.31",
+    "@backstage/test-utils": "^1.5.4",
+    "@testing-library/dom": "^10.0.0",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^15.0.0",
+    "@types/react-dom": "^18.2.19",
+    "canvas": "^2.11.2",
+    "msw": "^1.0.0",
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
+  },
+  "configSchema": {
+    "$schema": "https://backstage.io/schema/config-v1",
+    "title": "@backstage/allure",
+    "type": "object",
+    "properties": {
+      "allure": {
+        "type": "object",
+        "properties": {
+          "baseUrl": {
+            "type": "string",
+            "visibility": "frontend"
+          }
+        }
+      }
+    }
+  },
+  "module": "./dist/index.esm.js"
+}