SCM-Manager/scm-ui/ui-components/src/repos/DiffExpander.test.ts

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
import fetchMock from "fetch-mock";
import DiffExpander from "./DiffExpander";

const HUNK_0 = {
  content: "@@ -1,8 +1,8 @@",
  oldStart: 1,
  newStart: 1,
  oldLines: 8,
  newLines: 8,
  changes: [
    {
      content: "// @flow",
      type: "normal",
      oldLineNumber: 1,
      newLineNumber: 1,
      isNormal: true
    },
    {
      content: 'import React from "react";',
      type: "normal",
      oldLineNumber: 2,
      newLineNumber: 2,
      isNormal: true
    },
    {
      content: 'import { translate } from "react-i18next";',
      type: "delete",
      lineNumber: 3,
      isDelete: true
    },
    {
      content: 'import { Textarea } from "@scm-manager/ui-components";',
      type: "delete",
      lineNumber: 4,
      isDelete: true
    },
    {
      content: 'import type { Me } from "@scm-manager/ui-types";',
      type: "delete",
      lineNumber: 5,
      isDelete: true
    },
    {
      content: 'import {translate} from "react-i18next";',
      type: "insert",
      lineNumber: 3,
      isInsert: true
    },
    {
      content: 'import {Textarea} from "@scm-manager/ui-components";',
      type: "insert",
      lineNumber: 4,
      isInsert: true
    },
    {
      content: 'import type {Me} from "@scm-manager/ui-types";',
      type: "insert",
      lineNumber: 5,
      isInsert: true
    },
    {
      content: 'import injectSheet from "react-jss";',
      type: "normal",
      oldLineNumber: 6,
      newLineNumber: 6,
      isNormal: true
    },
    {
      content: "",
      type: "normal",
      oldLineNumber: 7,
      newLineNumber: 7,
      isNormal: true
    },
    {
      content: "const styles = {",
      type: "normal",
      oldLineNumber: 8,
      newLineNumber: 8,
      isNormal: true
    }
  ]
};
const HUNK_1 = {
  content: "@@ -14,6 +14,7 @@",
  oldStart: 14,
  newStart: 14,
  oldLines: 6,
  newLines: 7,
  changes: [
    {
      content: "type Props = {",
      type: "normal",
      oldLineNumber: 14,
      newLineNumber: 14,
      isNormal: true
    },
    {
      content: "  me: Me,",
      type: "normal",
      oldLineNumber: 15,
      newLineNumber: 15,
      isNormal: true
    },
    {
      content: "  onChange: string => void,",
      type: "normal",
      oldLineNumber: 16,
      newLineNumber: 16,
      isNormal: true
    },
    {
      content: "  disabled: boolean,",
      type: "insert",
      lineNumber: 17,
      isInsert: true
    },
    {
      content: "  //context props",
      type: "normal",
      oldLineNumber: 17,
      newLineNumber: 18,
      isNormal: true
    },
    {
      content: "  t: string => string,",
      type: "normal",
      oldLineNumber: 18,
      newLineNumber: 19,
      isNormal: true
    },
    {
      content: "  classes: any",
      type: "normal",
      oldLineNumber: 19,
      newLineNumber: 20,
      isNormal: true
    }
  ]
};
const HUNK_2 = {
  content: "@@ -21,7 +22,7 @@",
  oldStart: 21,
  newStart: 22,
  oldLines: 7,
  newLines: 7,
  changes: [
    {
      content: "",
      type: "normal",
      oldLineNumber: 21,
      newLineNumber: 22,
      isNormal: true
    },
    {
      content: "class CommitMessage extends React.Component<Props> {",
      type: "normal",
      oldLineNumber: 22,
      newLineNumber: 23,
      isNormal: true
    },
    {
      content: "  render() {",
      type: "normal",
      oldLineNumber: 23,
      newLineNumber: 24,
      isNormal: true
    },
    {
      content: "    const { t, classes, me, onChange } = this.props;",
      type: "delete",
      lineNumber: 24,
      isDelete: true
    },
    {
      content: "    const {t, classes, me, onChange, disabled} = this.props;",
      type: "insert",
      lineNumber: 25,
      isInsert: true
    },
    {
      content: "    return (",
      type: "normal",
      oldLineNumber: 25,
      newLineNumber: 26,
      isNormal: true
    },
    {
      content: "      <>",
      type: "normal",
      oldLineNumber: 26,
      newLineNumber: 27,
      isNormal: true
    },
    {
      content: "        <div className={classes.marginBottom}>",
      type: "normal",
      oldLineNumber: 27,
      newLineNumber: 28,
      isNormal: true
    }
  ]
};
const HUNK_3 = {
  content: "@@ -33,6 +34,7 @@",
  oldStart: 33,
  newStart: 34,
  oldLines: 6,
  newLines: 7,
  changes: [
    {
      content: "        <Textarea",
      type: "normal",
      oldLineNumber: 33,
      newLineNumber: 34,
      isNormal: true
    },
    {
      content: '          placeholder={t("scm-editor-plugin.commit.placeholder")}',
      type: "normal",
      oldLineNumber: 34,
      newLineNumber: 35,
      isNormal: true
    },
    {
      content: "          onChange={message => onChange(message)}",
      type: "normal",
      oldLineNumber: 35,
      newLineNumber: 36,
      isNormal: true
    },
    {
      content: "          disabled={disabled}",
      type: "insert",
      lineNumber: 37,
      isInsert: true
    },
    {
      content: "        />",
      type: "normal",
      oldLineNumber: 36,
      newLineNumber: 38,
      isNormal: true
    },
    {
      content: "      </>",
      type: "normal",
      oldLineNumber: 37,
      newLineNumber: 39,
      isNormal: true
    },
    {
      content: "    );",
      type: "normal",
      oldLineNumber: 38,
      newLineNumber: 40,
      isNormal: true
    }
  ]
};
const TEST_CONTENT_WITH_HUNKS = {
  oldPath: "src/main/js/CommitMessage.js",
  newPath: "src/main/js/CommitMessage.js",
  oldEndingNewLine: true,
  newEndingNewLine: true,
  oldRevision: "e05c8495bb1dc7505d73af26210c8ff4825c4500",
  newRevision: "4305a8df175b7bec25acbe542a13fbe2a718a608",
  type: "modify",
  language: "javascript",
  hunks: [HUNK_0, HUNK_1, HUNK_2, HUNK_3],
  _links: {
    lines: {
      href:
        "http://localhost:8081/scm/api/v2/content/abc/CommitMessage.js?start={start}&end={end}",
      templated: true
    }
  }
};

const TEST_CONTENT_WIT_NEW_BINARY_FILE = {
  oldPath: "/dev/null",
  newPath: "src/main/fileUploadV2.png",
  oldEndingNewLine: true,
  newEndingNewLine: true,
  oldRevision: "0000000000000000000000000000000000000000",
  newRevision: "86c370aae0727d628a5438f79a5cdd45752b9d99",
  type: "add"
};

const TEST_CONTENT_WITH_NEW_TEXT_FILE = {
  oldPath: "/dev/null",
  newPath: "src/main/markdown/README.md",
  oldEndingNewLine: true,
  newEndingNewLine: true,
  oldRevision: "0000000000000000000000000000000000000000",
  newRevision: "4e173d365d796b9a9e7562fcd0ef90398ae37046",
  type: "add",
  language: "markdown",
  hunks: [
    {
      content: "@@ -0,0 +1,2 @@",
      newStart: 1,
      newLines: 2,
      changes: [
        { content: "line 1", type: "insert", lineNumber: 1, isInsert: true },
        { content: "line 2", type: "insert", lineNumber: 2, isInsert: true }
      ]
    }
  ],
  _links: {
    lines: {
      href:
        "http://localhost:8081/scm/api/v2/repositories/scm-manager/scm-editor-plugin/content/c63898d35520ee47bcc3a8291660979918715762/src/main/markdown/README.md?start={start}&end={end}",
      templated: true
    }
  }
};

const TEST_CONTENT_WITH_DELETED_TEXT_FILE = {
  oldPath: "README.md",
  newPath: "/dev/null",
  oldEndingNewLine: true,
  newEndingNewLine: true,
  oldRevision: "4875ab3b7a1bb117e1948895148557fc5c0b6f75",
  newRevision: "0000000000000000000000000000000000000000",
  type: "delete",
  language: "markdown",
  hunks: [
    {
      content: "@@ -1 +0,0 @@",
      oldStart: 1,
      oldLines: 1,
      changes: [{ content: "# scm-editor-plugin", type: "delete", lineNumber: 1, isDelete: true }]
    }
  ],
  _links: { lines: { href: "http://localhost:8081/dev/null?start={start}&end={end}", templated: true } }
};

describe("with hunks the diff expander", () => {
  const diffExpander = new DiffExpander(TEST_CONTENT_WITH_HUNKS);

  afterEach(() => {
    fetchMock.reset();
    fetchMock.restore();
  });

  it("should have hunk count from origin", () => {
    expect(diffExpander.hunkCount()).toBe(4);
  });

  it("should return correct hunk", () => {
    expect(diffExpander.getHunk(1).hunk).toBe(HUNK_1);
  });

  it("should return max expand head range for first hunk", () => {
    expect(diffExpander.getHunk(0).maxExpandHeadRange).toBe(0);
  });

  it("should return max expand head range for hunks in the middle", () => {
    expect(diffExpander.getHunk(1).maxExpandHeadRange).toBe(5);
  });

  it("should return max expand bottom range for hunks in the middle", () => {
    expect(diffExpander.getHunk(1).maxExpandBottomRange).toBe(1);
  });

  it("should return a really bix number for the expand bottom range of the last hunk", () => {
    expect(diffExpander.getHunk(3).maxExpandBottomRange).toBeGreaterThan(99999);
  });
  it("should expand hunk with new line from api client at the bottom", async () => {
    expect(diffExpander.getHunk(1).hunk.changes.length).toBe(7);
    fetchMock.get("http://localhost:8081/scm/api/v2/content/abc/CommitMessage.js?start=22&end=22", "new line 1\nnew line 2");
    let newFile;
    diffExpander.getHunk(1).expandBottom(file => {
      newFile = file;
    });
    await fetchMock.flush(true);
    expect(fetchMock.done()).toBe(true);
    expect(newFile.hunks[1].changes.length).toBe(9);
    expect(newFile.hunks[1].changes[7].content).toBe("new line 1");
    expect(newFile.hunks[1].changes[8].content).toBe("new line 2");
  });
  it("should expand hunk with new line from api client at the top", async () => {
    expect(diffExpander.getHunk(1).hunk.changes.length).toBe(7);
    fetchMock.get("http://localhost:8081/scm/api/v2/content/abc/CommitMessage.js?start=9&end=13", "new line 1\nnew line 2");
    let newFile;
    diffExpander.getHunk(1).expandHead(file => {
      newFile = file;
    });
    await fetchMock.flush(true);
    expect(fetchMock.done()).toBe(true);
    expect(newFile.hunks[1].changes.length).toBe(9);
    expect(newFile.hunks[1].changes[0].content).toBe("new line 1");
    expect(newFile.hunks[1].changes[0].oldLineNumber).toBe(12);
    expect(newFile.hunks[1].changes[0].newLineNumber).toBe(12);
    expect(newFile.hunks[1].changes[1].content).toBe("new line 2");
    expect(newFile.hunks[1].changes[1].oldLineNumber).toBe(13);
    expect(newFile.hunks[1].changes[1].newLineNumber).toBe(13);
  });
});

describe("for a new file with text input the diff expander", () => {
  const diffExpander = new DiffExpander(TEST_CONTENT_WITH_NEW_TEXT_FILE);
  it("should create answer for single hunk", () => {
    expect(diffExpander.hunkCount()).toBe(1);
  });
  it("should neither give expandable lines for top nor bottom", () => {
    const hunk = diffExpander.getHunk(0);
    expect(hunk.maxExpandHeadRange).toBe(0);
    expect(hunk.maxExpandBottomRange).toBe(0);
  });
});

describe("for a deleted file with text input the diff expander", () => {
  const diffExpander = new DiffExpander(TEST_CONTENT_WITH_DELETED_TEXT_FILE);
  it("should create answer for single hunk", () => {
    expect(diffExpander.hunkCount()).toBe(1);
  });
  it("should neither give expandable lines for top nor bottom", () => {
    const hunk = diffExpander.getHunk(0);
    expect(hunk.maxExpandHeadRange).toBe(0);
    expect(hunk.maxExpandBottomRange).toBe(0);
  });
});

describe("for a new file with binary input the diff expander", () => {
  const diffExpander = new DiffExpander(TEST_CONTENT_WIT_NEW_BINARY_FILE);
  it("should create answer for no hunk", () => {
    expect(diffExpander.hunkCount()).toBe(0);
  });
});