feature(report): adds support for 'via' type rules in the azure-devop…

…s reporter
sverweij · Jul 8, 2023 · 83c7930 · 83c7930
1 parent 360371d
commit 83c7930
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 13 deletions.
diff --git a/src/report/azure-devops.mjs b/src/report/azure-devops.mjs
@@ -14,13 +14,17 @@ const SEVERITY2VSO_TYPE = new Map([
 ]);
 
 /**
- *
  * @param {import("../../types/shared-types.js").SeverityType} pSeverity
+ * @returns {string}
  */
 function formatSeverity(pSeverity) {
  return SEVERITY2VSO_TYPE.get(pSeverity) ?? "warning";
 }
 
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
 function formatModuleViolation(pViolation) {
  return `${pViolation.rule.name}: ${pViolation.from}`;
 }
@@ -34,22 +38,36 @@ function formatDependencyViolation(pViolation) {
  return `${pViolation.rule.name}: ${pViolation.from} -> ${pViolation.to}`;
 }
 
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
 function formatCycleViolation(pViolation) {
  return `${pViolation.rule.name}: ${
  pViolation.from
  } -> ${pViolation.cycle.join(" -> ")}`;
 }
 
 /**
- *
  * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
+function formatReachabilityViolation(pViolation) {
+ return `${pViolation.rule.name}: ${pViolation.from} -> ${
+ pViolation.to
+ } (via ${pViolation.via.join(" -> ")})`;
+}
+
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
  */
 function formatViolation(pViolation) {
  const lViolationType2Formatter = {
  module: formatModuleViolation,
  dependency: formatDependencyViolation,
  cycle: formatCycleViolation,
- // reachability: formatReachabilityViolation,
+ reachability: formatReachabilityViolation,
  // instability: formatInstabilityViolation,
  };
  let lFormattedViolators = _formatViolation(

diff --git a/test/report/azure-devops/__mocks__/via-deps-azure-devops-format.txt b/test/report/azure-devops/__mocks__/via-deps-azure-devops-format.txt
@@ -0,0 +1,5 @@
+##vso[task.logissue type=error;sourcepath=src/extract/index.js]some-via-rule: src/extract/index.js -> src/utl/array-util.js (via via-one -> via-another)
+##vso[task.logissue type=error;sourcepath=src/extract/index.js]some-via-rule: src/extract/index.js -> src/utl/find-rule-by-name.js (via via-one -> via-another)
+##vso[task.logissue type=error;sourcepath=src/utl/array-util.js]some-via-rule: src/utl/array-util.js
+##vso[task.logissue type=error;sourcepath=src/utl/find-rule-by-name.js]some-via-rule: src/utl/find-rule-by-name.js
+##vso[task.complete result=Failed;]4 dependency violations (4 error, 0 warning/ informational). 8 modules, 7 dependencies cruised
diff --git a/test/report/azure-devops/__mocks__/via-deps.mjs b/test/report/azure-devops/__mocks__/via-deps.mjs
@@ -203,7 +203,7 @@ export default {
  severity: "error",
  name: "some-via-rule",
  },
- via: ["(via via)"],
+ via: ["via-one", "via-another"],
  },
  {
  type: "reachability",
@@ -213,7 +213,7 @@ export default {
  severity: "error",
  name: "some-via-rule",
  },
- via: ["(via via)"],
+ via: ["via-one", "via-another"],
  },
  {
  type: "module",

diff --git a/test/report/azure-devops/azure-devops.spec.mjs b/test/report/azure-devops/azure-devops.spec.mjs
@@ -9,7 +9,7 @@ import errdeps from "./__mocks__/there-are-errors.mjs";
 import moduleErrs from "./__mocks__/module-errors.mjs";
 import requiredErrs from "./__mocks__/required-errors.mjs";
 import circulars from "./__mocks__/circular-deps.mjs";
-// import vias from "./__mocks__/via-deps.mjs";
+import vias from "./__mocks__/via-deps.mjs";
 // import unsupportedErrorLevels from "./__mocks__/unsupported-severity.mjs";
 // import knownViolations from "./__mocks__/known-violations.mjs";
 // import instabilities from "./__mocks__/instabilities.mjs";
@@ -94,14 +94,16 @@ describe("[I] report/azure-devops", () => {
  expect(lResult.exitCode).to.equal(3);
  });
 
- // it("renders via transgressions", () => {
- //  const lFixture = readFixture("__mocks__/via-deps-azure-devops-format.txt");
- //  const lResult = render(vias);
+ it("renders via transgressions", () => {
+ const lFixture = readFixture("__mocks__/via-deps-azure-devops-format.txt");
+ const lResult = render(vias);
 
- // expect(lResult.output).to.equal(lFixture);
- // // eslint-disable-next-line no-magic-numbers
- // expect(lResult.exitCode).to.equal(4);
- // });
+ expect(normalizeNewline(lResult.output)).to.equal(
+ normalizeNewline(lFixture)
+ );
+ // eslint-disable-next-line no-magic-numbers
+ expect(lResult.exitCode).to.equal(4);
+ });
 
  // it("renders instability transgressions", () => {
  // const lFixture = readFixture(