@front10/danger-plugins 0.11.0-rc.4 → 1.0.0

package/src/plugin-jest.ts

@@ -1,202 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-
-import stripANSI from "strip-ansi";
-
-import { run } from "jest";
-import { DangerDSLType } from "danger";
-
-declare const danger: DangerDSLType;
-declare function fail(message?: string): void;
-declare function message(message?: string): void;
-
-interface Snapshot {
-  added: number;
-  didUpdate: boolean;
-  failure: boolean;
-  filesAdded: number;
-  filesRemoved: number;
-  filesUnmatched: number;
-  filesUpdated: number;
-  matched: number;
-  total: number;
-  unchecked: number;
-  uncheckedKeysByFile: any[];
-  unmatched: number;
-  updated: number;
-}
-
-interface FileTestResult {
-  endTime: number;
-  message: string;
-  name: string;
-  startTime: number;
-  status: string;
-  summary: string;
-  assertionResults: AssertionResult[];
-}
-
-interface JestTestResults {
-  numFailedTestSuites: number;
-  numFailedTests: number;
-  numPassedTestSuites: number;
-  numPassedTests: number;
-  numPendingTestSuites: number;
-  numPendingTests: number;
-  numRuntimeErrorTestSuites: number;
-  numTotalTestSuites: number;
-  numTotalTests: number;
-  snapshot: Snapshot;
-  startTime: number;
-  success: boolean;
-  testResults: FileTestResult[];
-  wasInterrupted: boolean;
-}
-
-interface AssertionResult {
-  ancestorTitles: string[];
-  failureMessages: string[];
-  fullName: string;
-  location: string | null;
-  status: string;
-  title: string;
-}
-
-const jestSuccessFeedback = (
-  jsonResults: JestTestResults,
-  showSuccessMessage: boolean
-): void => {
-  if (!showSuccessMessage) {
-    // tslint:disable-next-line:no-console
-    console.log(":+1: Jest tests passed");
-  } else {
-    message(
-      `:+1: Jest tests passed: ${jsonResults.numPassedTests}/${jsonResults.numTotalTests} (${jsonResults.numPendingTests} skipped)`
-    );
-  }
-};
-
-function getUrl(file: string, line: number | null) {
-  const gitlab = danger.gitlab;
-  if (gitlab) {
-    const headSha = danger.gitlab.mr.diff_refs.head_sha;
-    const repoSlug = gitlab.metadata.repoSlug;
-    const baseUrl = `https://gitlab.com/${repoSlug}/-/blob`;
-    return `${baseUrl}/${headSha}/${file}${line ? `#L${line}` : ""}`;
-  }
-  return "#";
-}
-
-const lineOfError = (msg: string, filePath: string): number | null => {
-  const filename = path.basename(filePath);
-  const restOfTrace = msg.split(filename, 2)[1];
-  return restOfTrace ? parseInt(restOfTrace.split(":")[1], 10) : null;
-};
-
-const sanitizeShortErrorMessage = (msg: string): string => {
-  if (msg.includes("does not match stored snapshot")) {
-    return "Snapshot has changed";
-  }
-
-  return msg
-    .split("   at", 1)[0]
-    .trim()
-    .split("\n")
-    .splice(2)
-    .join("")
-    .replace(/\s\s+/g, " ")
-    .replace("Received:", ", received:")
-    .replace("., received", ", received")
-    .split("Difference:")[0];
-};
-
-// e.g. https://gitlab.com/carburo/danger/-/blob/802af5c0b057c4439ef465a75009f017423fbf98/simple.test.js#L6
-const linkToTest = (file: string, msg: string, title: string) => {
-  const line = lineOfError(msg, file);
-
-  return `<a href='${getUrl(file, line)}'>${title}</a>`;
-};
-
-const assertionFailString = (file: string, status: AssertionResult): string => `
-  <li>
-  ${linkToTest(
-    file,
-    status.failureMessages && status.failureMessages[0],
-    status.title
-  )}
-  <br/>
-  ${sanitizeShortErrorMessage(
-    status.failureMessages && stripANSI(status.failureMessages[0])
-  )}
-  
-  <details>
-  <summary>Full message</summary>
-  <pre><code>
-  ${status.failureMessages && stripANSI(status.failureMessages.join("\n"))}
-  </code></pre>
-  </details>
-  </li>
-  <br/>
-  `;
-
-const fileToFailString = (
-  // tslint:disable-next-line:no-shadowed-variable
-  path: string,
-  failedAssertions: AssertionResult[]
-): string => `
-  <b>:black_joker: FAIL</b> in ${path}
-  
-  ${failedAssertions.map((a) => assertionFailString(path, a)).join("\n\n")}
-  `;
-
-const presentErrors = (jsonResults: JestTestResults) => {
-  const failing = jsonResults.testResults.filter(
-    (tr) => tr.status === "failed"
-  );
-
-  failing.forEach((results) => {
-    const relativeFilePath = path.relative(process.cwd(), results.name);
-    const failedAssertions = results.assertionResults.filter(
-      (r) => r.status === "failed"
-    );
-    const failMessage = fileToFailString(relativeFilePath, failedAssertions);
-    fail(failMessage);
-  });
-};
-
-interface PluginConfig {
-  testResultsJsonPath: string;
-  showSuccessMessage: boolean;
-  runJest: boolean;
-}
-
-export async function jest(config: Partial<PluginConfig> = {}) {
-  const {
-    testResultsJsonPath = "test-results.json",
-    showSuccessMessage = true,
-    runJest = true,
-  } = config;
-  if (runJest) {
-    try {
-      await run(["--outputFile", "test-results.json", "--json"]);
-    } catch (e) {
-      console.error(e);
-    }
-  }
-  try {
-    const jsonFileContents = fs.readFileSync(testResultsJsonPath, "utf8");
-    const jsonResults: JestTestResults = JSON.parse(jsonFileContents);
-    if (jsonResults.success) {
-      jestSuccessFeedback(jsonResults, showSuccessMessage);
-      return;
-    }
-
-    presentErrors(jsonResults);
-  } catch (e) {
-    // tslint:disable-next-line:no-console
-    console.error(e);
-    fail(
-      "[danger-plugin-jest] Could not read test results. Danger cannot pass or fail the build."
-    );
-  }
-}