@backstage-community/plugin-code-coverage-backend 0.3.0 → 0.3.2

package/dist/service/converter/lcov.cjs.js

@@ -0,0 +1,97 @@
+'use strict';
+
+class Lcov {
+  constructor(logger) {
+    this.logger = logger;
+    this.logger = logger;
+  }
+  /**
+   * convert lcov into shared json coverage format
+   *
+   * @param raw - raw lcov report
+   * @param scmFiles - list of files that are committed to SCM
+   */
+  convert(raw, scmFiles) {
+    const lines = raw.split(/\r?\n/);
+    const jscov = [];
+    let currentFile = null;
+    lines.forEach((line) => {
+      const [section, value] = line.split(":");
+      switch (section) {
+        // If the line starts with SF, it's a new file
+        case "SF":
+          currentFile = this.processNewFile(value, scmFiles);
+          break;
+        // If the line starts with DA, it's a line hit
+        case "DA":
+          this.processLineHit(currentFile, value);
+          break;
+        // If the line starts with BRDA, it's a branch line
+        case "BRDA":
+          this.processBranchHit(currentFile, value);
+          break;
+        // If the line starts with end_of_record, it's the end of current file
+        case "end_of_record":
+          if (currentFile) {
+            jscov.push(currentFile);
+            currentFile = null;
+          }
+          break;
+      }
+    });
+    return jscov;
+  }
+  /**
+   * Parses a new file entry
+   *
+   * @param file - file name from coverage report
+   * @param scmFiles - list of files that are committed to SCM
+   */
+  processNewFile(file, scmFiles) {
+    const filename = scmFiles.map((f) => f.trimEnd()).find((f) => file.endsWith(f));
+    this.logger.debug(`matched ${file} to ${filename}`);
+    if (scmFiles.length === 0 || filename) {
+      return {
+        filename: filename || file,
+        lineHits: {},
+        branchHits: {}
+      };
+    }
+    return null;
+  }
+  /**
+   * Parses line coverage information
+   *
+   * @param currentFile - current file entry
+   * @param value - line coverage information
+   */
+  processLineHit(currentFile, value) {
+    if (!currentFile) return;
+    const [lineNumber, hits] = value.split(",");
+    currentFile.lineHits[Number(lineNumber)] = Number(hits);
+  }
+  /**
+   * Parses branch coverage information
+   *
+   * @param currentFile - current file entry
+   * @param value - branch coverage information
+   */
+  processBranchHit(currentFile, value) {
+    if (!currentFile) return;
+    const [lineNumber, , , hits] = value.split(",");
+    const lineNumberNum = Number(lineNumber);
+    const isHit = Number(hits) > 0;
+    const branch = currentFile.branchHits[lineNumberNum] || {
+      covered: 0,
+      available: 0,
+      missed: 0
+    };
+    branch.available++;
+    branch.covered += isHit ? 1 : 0;
+    branch.missed += isHit ? 0 : 1;
+    currentFile.branchHits[lineNumberNum] = branch;
+  }
+}
+
+exports.Lcov = Lcov;
+//# sourceMappingURL=lcov.cjs.js.map

package/dist/service/converter/lcov.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lcov.cjs.js","sources":["../../../src/service/converter/lcov.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 { FileEntry } from '../types';\nimport { Converter } from './Converter';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nexport class Lcov implements Converter {\n  constructor(readonly logger: LoggerService) {\n    this.logger = logger;\n  }\n\n  /**\n   * convert lcov into shared json coverage format\n   *\n   * @param raw - raw lcov report\n   * @param scmFiles - list of files that are committed to SCM\n   */\n  convert(raw: string, scmFiles: string[]): FileEntry[] {\n    const lines = raw.split(/\\r?\\n/);\n    const jscov: Array<FileEntry> = [];\n    let currentFile: FileEntry | null = null;\n\n    lines.forEach(line => {\n      const [section, value] = line.split(':');\n\n      switch (section) {\n        // If the line starts with SF, it's a new file\n        case 'SF':\n          currentFile = this.processNewFile(value, scmFiles);\n          break;\n        // If the line starts with DA, it's a line hit\n        case 'DA':\n          this.processLineHit(currentFile, value);\n          break;\n        // If the line starts with BRDA, it's a branch line\n        case 'BRDA':\n          this.processBranchHit(currentFile, value);\n          break;\n        // If the line starts with end_of_record, it's the end of current file\n        case 'end_of_record':\n          if (currentFile) {\n            jscov.push(currentFile);\n            currentFile = null;\n          }\n          break;\n        default:\n          break;\n      }\n    });\n\n    return jscov;\n  }\n\n  /**\n   * Parses a new file entry\n   *\n   * @param file - file name from coverage report\n   * @param scmFiles - list of files that are committed to SCM\n   */\n  private processNewFile(file: string, scmFiles: string[]): FileEntry | null {\n    const filename = scmFiles.map(f => f.trimEnd()).find(f => file.endsWith(f));\n\n    this.logger.debug(`matched ${file} to ${filename}`);\n\n    if (scmFiles.length === 0 || filename) {\n      return {\n        filename: filename || file,\n        lineHits: {},\n        branchHits: {},\n      };\n    }\n\n    return null;\n  }\n\n  /**\n   * Parses line coverage information\n   *\n   * @param currentFile - current file entry\n   * @param value - line coverage information\n   */\n  private processLineHit(currentFile: FileEntry | null, value: string): void {\n    if (!currentFile) return;\n\n    const [lineNumber, hits] = value.split(',');\n    currentFile.lineHits[Number(lineNumber)] = Number(hits);\n  }\n\n  /**\n   * Parses branch coverage information\n   *\n   * @param currentFile - current file entry\n   * @param value - branch coverage information\n   */\n  private processBranchHit(currentFile: FileEntry | null, value: string): void {\n    if (!currentFile) return;\n\n    const [lineNumber, , , hits] = value.split(',');\n    const lineNumberNum = Number(lineNumber);\n    const isHit = Number(hits) > 0;\n    const branch = currentFile.branchHits[lineNumberNum] || {\n      covered: 0,\n      available: 0,\n      missed: 0,\n    };\n\n    branch.available++;\n    branch.covered += isHit ? 1 : 0;\n    branch.missed += isHit ? 0 : 1;\n\n    currentFile.branchHits[lineNumberNum] = branch;\n  }\n}\n"],"names":[],"mappings":";;AAmBO,MAAM,IAA0B,CAAA;AAAA,EACrC,YAAqB,MAAuB,EAAA;AAAvB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACnB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAA,CAAQ,KAAa,QAAiC,EAAA;AACpD,IAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AAC/B,IAAA,MAAM,QAA0B,EAAC,CAAA;AACjC,IAAA,IAAI,WAAgC,GAAA,IAAA,CAAA;AAEpC,IAAA,KAAA,CAAM,QAAQ,CAAQ,IAAA,KAAA;AACpB,MAAA,MAAM,CAAC,OAAS,EAAA,KAAK,CAAI,GAAA,IAAA,CAAK,MAAM,GAAG,CAAA,CAAA;AAEvC,MAAA,QAAQ,OAAS;AAAA;AAAA,QAEf,KAAK,IAAA;AACH,UAAc,WAAA,GAAA,IAAA,CAAK,cAAe,CAAA,KAAA,EAAO,QAAQ,CAAA,CAAA;AACjD,UAAA,MAAA;AAAA;AAAA,QAEF,KAAK,IAAA;AACH,UAAK,IAAA,CAAA,cAAA,CAAe,aAAa,KAAK,CAAA,CAAA;AACtC,UAAA,MAAA;AAAA;AAAA,QAEF,KAAK,MAAA;AACH,UAAK,IAAA,CAAA,gBAAA,CAAiB,aAAa,KAAK,CAAA,CAAA;AACxC,UAAA,MAAA;AAAA;AAAA,QAEF,KAAK,eAAA;AACH,UAAA,IAAI,WAAa,EAAA;AACf,YAAA,KAAA,CAAM,KAAK,WAAW,CAAA,CAAA;AACtB,YAAc,WAAA,GAAA,IAAA,CAAA;AAAA,WAChB;AACA,UAAA,MAAA;AAEA,OACJ;AAAA,KACD,CAAA,CAAA;AAED,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,cAAA,CAAe,MAAc,QAAsC,EAAA;AACzE,IAAA,MAAM,QAAW,GAAA,QAAA,CAAS,GAAI,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAA,EAAS,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,KAAK,IAAK,CAAA,QAAA,CAAS,CAAC,CAAC,CAAA,CAAA;AAE1E,IAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,QAAA,EAAW,IAAI,CAAA,IAAA,EAAO,QAAQ,CAAE,CAAA,CAAA,CAAA;AAElD,IAAI,IAAA,QAAA,CAAS,MAAW,KAAA,CAAA,IAAK,QAAU,EAAA;AACrC,MAAO,OAAA;AAAA,QACL,UAAU,QAAY,IAAA,IAAA;AAAA,QACtB,UAAU,EAAC;AAAA,QACX,YAAY,EAAC;AAAA,OACf,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,cAAA,CAAe,aAA+B,KAAqB,EAAA;AACzE,IAAA,IAAI,CAAC,WAAa,EAAA,OAAA;AAElB,IAAA,MAAM,CAAC,UAAY,EAAA,IAAI,CAAI,GAAA,KAAA,CAAM,MAAM,GAAG,CAAA,CAAA;AAC1C,IAAA,WAAA,CAAY,SAAS,MAAO,CAAA,UAAU,CAAC,CAAA,GAAI,OAAO,IAAI,CAAA,CAAA;AAAA,GACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,gBAAA,CAAiB,aAA+B,KAAqB,EAAA;AAC3E,IAAA,IAAI,CAAC,WAAa,EAAA,OAAA;AAElB,IAAM,MAAA,CAAC,gBAAgB,IAAI,CAAI,GAAA,KAAA,CAAM,MAAM,GAAG,CAAA,CAAA;AAC9C,IAAM,MAAA,aAAA,GAAgB,OAAO,UAAU,CAAA,CAAA;AACvC,IAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AAC7B,IAAA,MAAM,MAAS,GAAA,WAAA,CAAY,UAAW,CAAA,aAAa,CAAK,IAAA;AAAA,MACtD,OAAS,EAAA,CAAA;AAAA,MACT,SAAW,EAAA,CAAA;AAAA,MACX,MAAQ,EAAA,CAAA;AAAA,KACV,CAAA;AAEA,IAAO,MAAA,CAAA,SAAA,EAAA,CAAA;AACP,IAAO,MAAA,CAAA,OAAA,IAAW,QAAQ,CAAI,GAAA,CAAA,CAAA;AAC9B,IAAO,MAAA,CAAA,MAAA,IAAU,QAAQ,CAAI,GAAA,CAAA,CAAA;AAE7B,IAAY,WAAA,CAAA,UAAA,CAAW,aAAa,CAAI,GAAA,MAAA,CAAA;AAAA,GAC1C;AACF;;;;"}

package/dist/service/router.cjs.js

@@ -0,0 +1,196 @@
+'use strict';
+
+var express = require('express');
+var Router = require('express-promise-router');
+var BodyParser = require('body-parser');
+var bodyParserXml = require('body-parser-xml');
+var catalogClient = require('@backstage/catalog-client');
+var backendCommon = require('@backstage/backend-common');
+var errors = require('@backstage/errors');
+var integration = require('@backstage/integration');
+var CodeCoverageDatabase = require('./CodeCoverageDatabase.cjs.js');
+var CoverageUtils = require('./CoverageUtils.cjs.js');
+var cobertura = require('./converter/cobertura.cjs.js');
+var jacoco = require('./converter/jacoco.cjs.js');
+var lcov = require('./converter/lcov.cjs.js');
+var catalogModel = require('@backstage/catalog-model');
+var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+var BodyParser__default = /*#__PURE__*/_interopDefaultCompat(BodyParser);
+var bodyParserXml__default = /*#__PURE__*/_interopDefaultCompat(bodyParserXml);
+
+const makeRouter = async (options) => {
+  const { config, logger, discovery, database, urlReader } = options;
+  const codeCoverageDatabase = await CodeCoverageDatabase.CodeCoverageDatabase.create(database);
+  const codecovUrl = await discovery.getExternalBaseUrl("code-coverage");
+  const catalogApi = options.catalogApi ?? new catalogClient.CatalogClient({ discoveryApi: discovery });
+  const scm = integration.ScmIntegrations.fromConfig(config);
+  const { auth, httpAuth } = backendCommon.createLegacyAuthAdapters(options);
+  const bodySizeLimit = config.getOptionalString("codeCoverage.bodySizeLimit") ?? "100kb";
+  bodyParserXml__default.default(BodyParser__default.default);
+  const router = Router__default.default();
+  router.use(
+    BodyParser__default.default.xml({
+      limit: bodySizeLimit
+    })
+  );
+  router.use(
+    BodyParser__default.default.text({
+      limit: bodySizeLimit
+    })
+  );
+  router.use(express__default.default.json());
+  const utils = new CoverageUtils.CoverageUtils(scm, urlReader);
+  router.get("/health", async (_req, res) => {
+    res.status(200).json({ status: "ok" });
+  });
+  router.get("/report", async (req, res) => {
+    const { entity } = req.query;
+    const entityLookup = await catalogApi.getEntityByRef(
+      entity,
+      await auth.getPluginRequestToken({
+        onBehalfOf: await httpAuth.credentials(req),
+        targetPluginId: "catalog"
+      })
+    );
+    if (!entityLookup) {
+      throw new errors.NotFoundError(`No entity found matching ${entity}`);
+    }
+    const stored = await codeCoverageDatabase.getCodeCoverage(entity);
+    const aggregate = CoverageUtils.aggregateCoverage(stored);
+    res.status(200).json({
+      ...stored,
+      aggregate: {
+        line: aggregate.line,
+        branch: aggregate.branch
+      }
+    });
+  });
+  router.get("/history", async (req, res) => {
+    const { entity } = req.query;
+    const entityLookup = await catalogApi.getEntityByRef(
+      entity,
+      await auth.getPluginRequestToken({
+        onBehalfOf: await httpAuth.credentials(req),
+        targetPluginId: "catalog"
+      })
+    );
+    if (!entityLookup) {
+      throw new errors.NotFoundError(`No entity found matching ${entity}`);
+    }
+    const { limit } = req.query;
+    const history = await codeCoverageDatabase.getHistory(
+      entity,
+      parseInt(limit?.toString() || "10", 10)
+    );
+    res.status(200).json(history);
+  });
+  router.get("/file-content", async (req, res) => {
+    const { entity, path } = req.query;
+    const entityLookup = await catalogApi.getEntityByRef(
+      entity,
+      await auth.getPluginRequestToken({
+        onBehalfOf: await httpAuth.credentials(req),
+        targetPluginId: "catalog"
+      })
+    );
+    if (!entityLookup) {
+      throw new errors.NotFoundError(`No entity found matching ${entity}`);
+    }
+    if (!path) {
+      throw new errors.InputError("Need path query parameter");
+    }
+    const sourceLocation = catalogModel.getEntitySourceLocation(entityLookup);
+    if (!sourceLocation) {
+      throw new errors.InputError(
+        `No "backstage.io/source-location" annotation on entity ${entity}`
+      );
+    }
+    const vcs = scm.byUrl(sourceLocation.target);
+    if (!vcs) {
+      throw new errors.InputError(`Unable to determine SCM from ${sourceLocation}`);
+    }
+    const scmTree = await urlReader.readTree(sourceLocation.target);
+    const scmFile = (await scmTree.files()).find((f) => f.path === path);
+    if (!scmFile) {
+      res.status(404).json({
+        message: "Couldn't find file in SCM",
+        file: path,
+        scm: vcs.title
+      });
+      return;
+    }
+    const content = await scmFile?.content();
+    if (!content) {
+      res.status(400).json({
+        message: "Couldn't process content of file in SCM",
+        file: path,
+        scm: vcs.title
+      });
+      return;
+    }
+    const data = content.toString();
+    res.status(200).contentType("text/plain").send(data);
+  });
+  router.post("/report", async (req, res) => {
+    const { entity: entityRef, coverageType } = req.query;
+    const entity = await catalogApi.getEntityByRef(
+      entityRef,
+      await auth.getPluginRequestToken({
+        onBehalfOf: await httpAuth.credentials(req),
+        targetPluginId: "catalog"
+      })
+    );
+    if (!entity) {
+      throw new errors.NotFoundError(`No entity found matching ${entityRef}`);
+    }
+    let converter;
+    if (!coverageType) {
+      throw new errors.InputError("Need coverageType query parameter");
+    } else if (coverageType === "jacoco") {
+      converter = new jacoco.Jacoco(logger);
+    } else if (coverageType === "cobertura") {
+      converter = new cobertura.Cobertura(logger);
+    } else if (coverageType === "lcov") {
+      converter = new lcov.Lcov(logger);
+    } else {
+      throw new errors.InputError(`Unsupported coverage type '${coverageType}`);
+    }
+    const { sourceLocation, vcs, scmFiles, body } = await utils.processCoveragePayload(entity, req);
+    const files = converter.convert(body, scmFiles);
+    if (!files || files.length === 0) {
+      throw new errors.InputError(`Unable to parse body as ${coverageType}`);
+    }
+    const coverage = await utils.buildCoverage(
+      entity,
+      sourceLocation,
+      vcs,
+      files
+    );
+    await codeCoverageDatabase.insertCodeCoverage(coverage);
+    res.status(201).json({
+      links: [
+        {
+          rel: "coverage",
+          href: `${codecovUrl}/report?entity=${entityRef}`
+        }
+      ]
+    });
+  });
+  const middleware = rootHttpRouter.MiddlewareFactory.create({ logger, config });
+  router.use(middleware.error());
+  return router;
+};
+async function createRouter(options) {
+  const logger = options.logger;
+  logger.info("Initializing Code Coverage backend");
+  return makeRouter(options);
+}
+
+exports.createRouter = createRouter;
+exports.makeRouter = makeRouter;
+//# sourceMappingURL=router.cjs.js.map

package/dist/service/router.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.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 */\n\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport BodyParser from 'body-parser';\nimport bodyParserXml from 'body-parser-xml';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\nimport { createLegacyAuthAdapters } from '@backstage/backend-common';\nimport { InputError, NotFoundError } from '@backstage/errors';\nimport { Config } from '@backstage/config';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { CodeCoverageDatabase } from './CodeCoverageDatabase';\nimport { aggregateCoverage, CoverageUtils } from './CoverageUtils';\nimport { Cobertura, Converter, Jacoco, Lcov } from './converter';\nimport { getEntitySourceLocation } from '@backstage/catalog-model';\nimport {\n  AuthService,\n  DatabaseService,\n  DiscoveryService,\n  HttpAuthService,\n  LoggerService,\n  UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\n\n/**\n * Options for {@link createRouter}.\n *\n * @public\n */\nexport interface RouterOptions {\n  config: Config;\n  discovery: DiscoveryService;\n  database: DatabaseService;\n  urlReader: UrlReaderService;\n  logger: LoggerService;\n  catalogApi?: CatalogApi;\n  auth?: AuthService;\n  httpAuth?: HttpAuthService;\n}\n\nexport interface CodeCoverageApi {\n  name: string;\n}\n\nexport const makeRouter = async (\n  options: RouterOptions,\n): Promise<express.Router> => {\n  const { config, logger, discovery, database, urlReader } = options;\n\n  const codeCoverageDatabase = await CodeCoverageDatabase.create(database);\n  const codecovUrl = await discovery.getExternalBaseUrl('code-coverage');\n  const catalogApi =\n    options.catalogApi ?? new CatalogClient({ discoveryApi: discovery });\n  const scm = ScmIntegrations.fromConfig(config);\n  const { auth, httpAuth } = createLegacyAuthAdapters(options);\n\n  const bodySizeLimit =\n    config.getOptionalString('codeCoverage.bodySizeLimit') ?? '100kb';\n\n  bodyParserXml(BodyParser);\n  const router = Router();\n  router.use(\n    BodyParser.xml({\n      limit: bodySizeLimit,\n    }),\n  );\n  router.use(\n    BodyParser.text({\n      limit: bodySizeLimit,\n    }),\n  );\n  router.use(express.json());\n\n  const utils = new CoverageUtils(scm, urlReader);\n\n  router.get('/health', async (_req, res) => {\n    res.status(200).json({ status: 'ok' });\n  });\n\n  /**\n   * /report?entity=component:default/mycomponent\n   */\n  router.get('/report', async (req, res) => {\n    const { entity } = req.query;\n    const entityLookup = await catalogApi.getEntityByRef(\n      entity as string,\n      await auth.getPluginRequestToken({\n        onBehalfOf: await httpAuth.credentials(req),\n        targetPluginId: 'catalog',\n      }),\n    );\n    if (!entityLookup) {\n      throw new NotFoundError(`No entity found matching ${entity}`);\n    }\n    const stored = await codeCoverageDatabase.getCodeCoverage(entity as string);\n\n    const aggregate = aggregateCoverage(stored);\n\n    res.status(200).json({\n      ...stored,\n      aggregate: {\n        line: aggregate.line,\n        branch: aggregate.branch,\n      },\n    });\n  });\n\n  /**\n   * /history?entity=component:default/mycomponent\n   */\n  router.get('/history', async (req, res) => {\n    const { entity } = req.query;\n    const entityLookup = await catalogApi.getEntityByRef(\n      entity as string,\n      await auth.getPluginRequestToken({\n        onBehalfOf: await httpAuth.credentials(req),\n        targetPluginId: 'catalog',\n      }),\n    );\n    if (!entityLookup) {\n      throw new NotFoundError(`No entity found matching ${entity}`);\n    }\n    const { limit } = req.query;\n    const history = await codeCoverageDatabase.getHistory(\n      entity as string,\n      parseInt(limit?.toString() || '10', 10),\n    );\n\n    res.status(200).json(history);\n  });\n\n  /**\n   * /file-content?entity=component:default/mycomponent&path=src/some-file.go\n   */\n  router.get('/file-content', async (req, res) => {\n    const { entity, path } = req.query;\n    const entityLookup = await catalogApi.getEntityByRef(\n      entity as string,\n      await auth.getPluginRequestToken({\n        onBehalfOf: await httpAuth.credentials(req),\n        targetPluginId: 'catalog',\n      }),\n    );\n    if (!entityLookup) {\n      throw new NotFoundError(`No entity found matching ${entity}`);\n    }\n\n    if (!path) {\n      throw new InputError('Need path query parameter');\n    }\n\n    const sourceLocation = getEntitySourceLocation(entityLookup);\n\n    if (!sourceLocation) {\n      throw new InputError(\n        `No \"backstage.io/source-location\" annotation on entity ${entity}`,\n      );\n    }\n\n    const vcs = scm.byUrl(sourceLocation.target);\n    if (!vcs) {\n      throw new InputError(`Unable to determine SCM from ${sourceLocation}`);\n    }\n\n    const scmTree = await urlReader.readTree(sourceLocation.target);\n    const scmFile = (await scmTree.files()).find(f => f.path === path);\n    if (!scmFile) {\n      res.status(404).json({\n        message: \"Couldn't find file in SCM\",\n        file: path,\n        scm: vcs.title,\n      });\n      return;\n    }\n    const content = await scmFile?.content();\n    if (!content) {\n      res.status(400).json({\n        message: \"Couldn't process content of file in SCM\",\n        file: path,\n        scm: vcs.title,\n      });\n      return;\n    }\n\n    const data = content.toString();\n    res.status(200).contentType('text/plain').send(data);\n  });\n\n  /**\n   * /report?entity=component:default/mycomponent&coverageType=cobertura\n   */\n  router.post('/report', async (req, res) => {\n    const { entity: entityRef, coverageType } = req.query;\n    const entity = await catalogApi.getEntityByRef(\n      entityRef as string,\n      await auth.getPluginRequestToken({\n        onBehalfOf: await httpAuth.credentials(req),\n        targetPluginId: 'catalog',\n      }),\n    );\n    if (!entity) {\n      throw new NotFoundError(`No entity found matching ${entityRef}`);\n    }\n\n    let converter: Converter;\n    if (!coverageType) {\n      throw new InputError('Need coverageType query parameter');\n    } else if (coverageType === 'jacoco') {\n      converter = new Jacoco(logger);\n    } else if (coverageType === 'cobertura') {\n      converter = new Cobertura(logger);\n    } else if (coverageType === 'lcov') {\n      converter = new Lcov(logger);\n    } else {\n      throw new InputError(`Unsupported coverage type '${coverageType}`);\n    }\n\n    const { sourceLocation, vcs, scmFiles, body } =\n      await utils.processCoveragePayload(entity, req);\n\n    const files = converter.convert(body, scmFiles);\n    if (!files || files.length === 0) {\n      throw new InputError(`Unable to parse body as ${coverageType}`);\n    }\n\n    const coverage = await utils.buildCoverage(\n      entity,\n      sourceLocation,\n      vcs,\n      files,\n    );\n    await codeCoverageDatabase.insertCodeCoverage(coverage);\n\n    res.status(201).json({\n      links: [\n        {\n          rel: 'coverage',\n          href: `${codecovUrl}/report?entity=${entityRef}`,\n        },\n      ],\n    });\n  });\n\n  const middleware = MiddlewareFactory.create({ logger, config });\n\n  router.use(middleware.error());\n  return router;\n};\n\n/**\n * Creates a code-coverage plugin backend router.\n *\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const logger = options.logger;\n\n  logger.info('Initializing Code Coverage backend');\n\n  return makeRouter(options);\n}\n"],"names":["CodeCoverageDatabase","CatalogClient","ScmIntegrations","createLegacyAuthAdapters","bodyParserXml","BodyParser","Router","express","CoverageUtils","NotFoundError","aggregateCoverage","InputError","getEntitySourceLocation","Jacoco","Cobertura","Lcov","MiddlewareFactory"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA2Da,MAAA,UAAA,GAAa,OACxB,OAC4B,KAAA;AAC5B,EAAA,MAAM,EAAE,MAAQ,EAAA,MAAA,EAAQ,SAAW,EAAA,QAAA,EAAU,WAAc,GAAA,OAAA,CAAA;AAE3D,EAAA,MAAM,oBAAuB,GAAA,MAAMA,yCAAqB,CAAA,MAAA,CAAO,QAAQ,CAAA,CAAA;AACvE,EAAA,MAAM,UAAa,GAAA,MAAM,SAAU,CAAA,kBAAA,CAAmB,eAAe,CAAA,CAAA;AACrE,EAAM,MAAA,UAAA,GACJ,QAAQ,UAAc,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AACrE,EAAM,MAAA,GAAA,GAAMC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAC7C,EAAA,MAAM,EAAE,IAAA,EAAM,QAAS,EAAA,GAAIC,uCAAyB,OAAO,CAAA,CAAA;AAE3D,EAAA,MAAM,aACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,4BAA4B,CAAK,IAAA,OAAA,CAAA;AAE5D,EAAAC,8BAAA,CAAcC,2BAAU,CAAA,CAAA;AACxB,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA;AAAA,IACLD,4BAAW,GAAI,CAAA;AAAA,MACb,KAAO,EAAA,aAAA;AAAA,KACR,CAAA;AAAA,GACH,CAAA;AACA,EAAO,MAAA,CAAA,GAAA;AAAA,IACLA,4BAAW,IAAK,CAAA;AAAA,MACd,KAAO,EAAA,aAAA;AAAA,KACR,CAAA;AAAA,GACH,CAAA;AACA,EAAO,MAAA,CAAA,GAAA,CAAIE,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,EAAA,MAAM,KAAQ,GAAA,IAAIC,2BAAc,CAAA,GAAA,EAAK,SAAS,CAAA,CAAA;AAE9C,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,OAAO,IAAA,EAAM,GAAQ,KAAA;AACzC,IAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,MAAM,CAAA,CAAA;AAAA,GACtC,CAAA,CAAA;AAKD,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,OAAO,GAAA,EAAK,GAAQ,KAAA;AACxC,IAAM,MAAA,EAAE,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AACvB,IAAM,MAAA,YAAA,GAAe,MAAM,UAAW,CAAA,cAAA;AAAA,MACpC,MAAA;AAAA,MACA,MAAM,KAAK,qBAAsB,CAAA;AAAA,QAC/B,UAAY,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAAA,QAC1C,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA;AAAA,KACH,CAAA;AACA,IAAA,IAAI,CAAC,YAAc,EAAA;AACjB,MAAA,MAAM,IAAIC,oBAAA,CAAc,CAA4B,yBAAA,EAAA,MAAM,CAAE,CAAA,CAAA,CAAA;AAAA,KAC9D;AACA,IAAA,MAAM,MAAS,GAAA,MAAM,oBAAqB,CAAA,eAAA,CAAgB,MAAgB,CAAA,CAAA;AAE1E,IAAM,MAAA,SAAA,GAAYC,gCAAkB,MAAM,CAAA,CAAA;AAE1C,IAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,MACnB,GAAG,MAAA;AAAA,MACH,SAAW,EAAA;AAAA,QACT,MAAM,SAAU,CAAA,IAAA;AAAA,QAChB,QAAQ,SAAU,CAAA,MAAA;AAAA,OACpB;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAKD,EAAA,MAAA,CAAO,GAAI,CAAA,UAAA,EAAY,OAAO,GAAA,EAAK,GAAQ,KAAA;AACzC,IAAM,MAAA,EAAE,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AACvB,IAAM,MAAA,YAAA,GAAe,MAAM,UAAW,CAAA,cAAA;AAAA,MACpC,MAAA;AAAA,MACA,MAAM,KAAK,qBAAsB,CAAA;AAAA,QAC/B,UAAY,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAAA,QAC1C,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA;AAAA,KACH,CAAA;AACA,IAAA,IAAI,CAAC,YAAc,EAAA;AACjB,MAAA,MAAM,IAAID,oBAAA,CAAc,CAA4B,yBAAA,EAAA,MAAM,CAAE,CAAA,CAAA,CAAA;AAAA,KAC9D;AACA,IAAM,MAAA,EAAE,KAAM,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AACtB,IAAM,MAAA,OAAA,GAAU,MAAM,oBAAqB,CAAA,UAAA;AAAA,MACzC,MAAA;AAAA,MACA,QAAS,CAAA,KAAA,EAAO,QAAS,EAAA,IAAK,MAAM,EAAE,CAAA;AAAA,KACxC,CAAA;AAEA,IAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA,GAC7B,CAAA,CAAA;AAKD,EAAA,MAAA,CAAO,GAAI,CAAA,eAAA,EAAiB,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC9C,IAAA,MAAM,EAAE,MAAA,EAAQ,IAAK,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AAC7B,IAAM,MAAA,YAAA,GAAe,MAAM,UAAW,CAAA,cAAA;AAAA,MACpC,MAAA;AAAA,MACA,MAAM,KAAK,qBAAsB,CAAA;AAAA,QAC/B,UAAY,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAAA,QAC1C,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA;AAAA,KACH,CAAA;AACA,IAAA,IAAI,CAAC,YAAc,EAAA;AACjB,MAAA,MAAM,IAAIA,oBAAA,CAAc,CAA4B,yBAAA,EAAA,MAAM,CAAE,CAAA,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAM,MAAA,IAAIE,kBAAW,2BAA2B,CAAA,CAAA;AAAA,KAClD;AAEA,IAAM,MAAA,cAAA,GAAiBC,qCAAwB,YAAY,CAAA,CAAA;AAE3D,IAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,MAAA,MAAM,IAAID,iBAAA;AAAA,QACR,0DAA0D,MAAM,CAAA,CAAA;AAAA,OAClE,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,GAAM,GAAA,GAAA,CAAI,KAAM,CAAA,cAAA,CAAe,MAAM,CAAA,CAAA;AAC3C,IAAA,IAAI,CAAC,GAAK,EAAA;AACR,MAAA,MAAM,IAAIA,iBAAA,CAAW,CAAgC,6BAAA,EAAA,cAAc,CAAE,CAAA,CAAA,CAAA;AAAA,KACvE;AAEA,IAAA,MAAM,OAAU,GAAA,MAAM,SAAU,CAAA,QAAA,CAAS,eAAe,MAAM,CAAA,CAAA;AAC9D,IAAM,MAAA,OAAA,GAAA,CAAW,MAAM,OAAQ,CAAA,KAAA,IAAS,IAAK,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,IAAA,KAAS,IAAI,CAAA,CAAA;AACjE,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,QACnB,OAAS,EAAA,2BAAA;AAAA,QACT,IAAM,EAAA,IAAA;AAAA,QACN,KAAK,GAAI,CAAA,KAAA;AAAA,OACV,CAAA,CAAA;AACD,MAAA,OAAA;AAAA,KACF;AACA,IAAM,MAAA,OAAA,GAAU,MAAM,OAAA,EAAS,OAAQ,EAAA,CAAA;AACvC,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,QACnB,OAAS,EAAA,yCAAA;AAAA,QACT,IAAM,EAAA,IAAA;AAAA,QACN,KAAK,GAAI,CAAA,KAAA;AAAA,OACV,CAAA,CAAA;AACD,MAAA,OAAA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,GAAO,QAAQ,QAAS,EAAA,CAAA;AAC9B,IAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAE,YAAY,YAAY,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AAAA,GACpD,CAAA,CAAA;AAKD,EAAA,MAAA,CAAO,IAAK,CAAA,SAAA,EAAW,OAAO,GAAA,EAAK,GAAQ,KAAA;AACzC,IAAA,MAAM,EAAE,MAAA,EAAQ,SAAW,EAAA,YAAA,KAAiB,GAAI,CAAA,KAAA,CAAA;AAChD,IAAM,MAAA,MAAA,GAAS,MAAM,UAAW,CAAA,cAAA;AAAA,MAC9B,SAAA;AAAA,MACA,MAAM,KAAK,qBAAsB,CAAA;AAAA,QAC/B,UAAY,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAAA,QAC1C,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA;AAAA,KACH,CAAA;AACA,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,MAAM,IAAIF,oBAAA,CAAc,CAA4B,yBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAAA,KACjE;AAEA,IAAI,IAAA,SAAA,CAAA;AACJ,IAAA,IAAI,CAAC,YAAc,EAAA;AACjB,MAAM,MAAA,IAAIE,kBAAW,mCAAmC,CAAA,CAAA;AAAA,KAC1D,MAAA,IAAW,iBAAiB,QAAU,EAAA;AACpC,MAAY,SAAA,GAAA,IAAIE,cAAO,MAAM,CAAA,CAAA;AAAA,KAC/B,MAAA,IAAW,iBAAiB,WAAa,EAAA;AACvC,MAAY,SAAA,GAAA,IAAIC,oBAAU,MAAM,CAAA,CAAA;AAAA,KAClC,MAAA,IAAW,iBAAiB,MAAQ,EAAA;AAClC,MAAY,SAAA,GAAA,IAAIC,UAAK,MAAM,CAAA,CAAA;AAAA,KACtB,MAAA;AACL,MAAA,MAAM,IAAIJ,iBAAA,CAAW,CAA8B,2BAAA,EAAA,YAAY,CAAE,CAAA,CAAA,CAAA;AAAA,KACnE;AAEA,IAAM,MAAA,EAAE,cAAgB,EAAA,GAAA,EAAK,QAAU,EAAA,IAAA,KACrC,MAAM,KAAA,CAAM,sBAAuB,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAEhD,IAAA,MAAM,KAAQ,GAAA,SAAA,CAAU,OAAQ,CAAA,IAAA,EAAM,QAAQ,CAAA,CAAA;AAC9C,IAAA,IAAI,CAAC,KAAA,IAAS,KAAM,CAAA,MAAA,KAAW,CAAG,EAAA;AAChC,MAAA,MAAM,IAAIA,iBAAA,CAAW,CAA2B,wBAAA,EAAA,YAAY,CAAE,CAAA,CAAA,CAAA;AAAA,KAChE;AAEA,IAAM,MAAA,QAAA,GAAW,MAAM,KAAM,CAAA,aAAA;AAAA,MAC3B,MAAA;AAAA,MACA,cAAA;AAAA,MACA,GAAA;AAAA,MACA,KAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,oBAAA,CAAqB,mBAAmB,QAAQ,CAAA,CAAA;AAEtD,IAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,MACnB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,GAAK,EAAA,UAAA;AAAA,UACL,IAAM,EAAA,CAAA,EAAG,UAAU,CAAA,eAAA,EAAkB,SAAS,CAAA,CAAA;AAAA,SAChD;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAA,MAAM,aAAaK,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA,CAAA;AAE9D,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA,CAAA;AAC7B,EAAO,OAAA,MAAA,CAAA;AACT,EAAA;AAOA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,SAAS,OAAQ,CAAA,MAAA,CAAA;AAEvB,EAAA,MAAA,CAAO,KAAK,oCAAoC,CAAA,CAAA;AAEhD,EAAA,OAAO,WAAW,OAAO,CAAA,CAAA;AAC3B;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-code-coverage-backend",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A Backstage backend plugin that helps you keep track of your code coverage",
   "backstage": {
     "role": "backend-plugin",
@@ -38,14 +38,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.24.0",
-    "@backstage/backend-defaults": "^0.4.3",
-    "@backstage/backend-plugin-api": "^0.8.0",
-    "@backstage/catalog-client": "^1.6.6",
-    "@backstage/catalog-model": "^1.6.0",
+    "@backstage/backend-common": "^0.25.0",
+    "@backstage/backend-defaults": "^0.5.2",
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/catalog-client": "^1.7.1",
+    "@backstage/catalog-model": "^1.7.0",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/integration": "^1.14.0",
+    "@backstage/integration": "^1.15.1",
     "@types/express": "^4.17.6",
     "body-parser": "^1.20.0",
     "body-parser-xml": "^2.0.5",
@@ -56,8 +56,8 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.5.0",
-    "@backstage/cli": "^0.27.0",
+    "@backstage/backend-test-utils": "^1.0.2",
+    "@backstage/cli": "^0.28.0",
     "@types/body-parser-xml": "^2.0.2",
     "@types/supertest": "^6.0.0",
     "@types/uuid": "^9.0.0",