| /** | |
| * @license | |
| * Copyright 2022 Google LLC | |
| * SPDX-License-Identifier: Apache-2.0 | |
| */ | |
| import {assert} from '@open-wc/testing'; | |
| import {DiffInfo, Side} from '../api/diff'; | |
| import '../test/common-test-setup'; | |
| import {createDiff} from '../test/test-data-generators'; | |
| import {FileInfoStatus, SpecialFilePath} from '../constants/constants'; | |
| import { | |
| canBlameFile, | |
| getContentFromDiff, | |
| isFileUnchanged, | |
| isLineUnchanged, | |
| isMarkdownDiff, | |
| } from './diff-util'; | |
| suite('diff-util tests', () => { | |
| test('isFileUnchanged', () => { | |
| let diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [ | |
| {a: ['abcd'], ab: ['ef']}, | |
| {b: ['ancd'], a: ['xx']}, | |
| ], | |
| }; | |
| assert.equal(isFileUnchanged(diff), false); | |
| diff = { | |
| ...createDiff(), | |
| content: [{ab: ['abcd']}, {ab: ['ancd']}], | |
| }; | |
| assert.equal(isFileUnchanged(diff), true); | |
| diff = { | |
| ...createDiff(), | |
| content: [ | |
| {a: ['abcd'], ab: ['ef'], common: true}, | |
| {b: ['ancd'], ab: ['xx']}, | |
| ], | |
| }; | |
| assert.equal(isFileUnchanged(diff), false); | |
| diff = { | |
| ...createDiff(), | |
| content: [ | |
| {a: ['abcd'], ab: ['ef'], common: true}, | |
| {b: ['ancd'], ab: ['xx'], common: true}, | |
| ], | |
| }; | |
| assert.equal(isFileUnchanged(diff), true); | |
| }); | |
| suite('isLineUnchanged()', () => { | |
| test('all lines changed', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [{a: ['abcd']}, {b: ['wxyz']}], | |
| }; | |
| assert.isFalse(isLineUnchanged(diff, Side.LEFT, 0)); | |
| assert.isFalse(isLineUnchanged(diff, Side.LEFT, 1)); | |
| assert.isFalse(isLineUnchanged(diff, Side.LEFT, 2)); | |
| assert.isFalse(isLineUnchanged(diff, Side.LEFT, 3)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 0)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 1)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 2)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 3)); | |
| }); | |
| test('line 2 unchanged', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [ | |
| {a: ['abcd']}, | |
| {b: ['wxyz']}, | |
| {ab: ['qwer']}, | |
| {a: ['abcd']}, | |
| {b: ['wxyz']}, | |
| ], | |
| }; | |
| assert.isFalse(isLineUnchanged(diff, Side.LEFT, 1)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 2)); | |
| assert.isFalse(isLineUnchanged(diff, Side.LEFT, 3)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 1)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 2)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 3)); | |
| }); | |
| test('common chunk', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [ | |
| {ab: ['qwer']}, | |
| {a: [' qwer'], b: ['qwer '], common: true}, | |
| {ab: ['qwer']}, | |
| ], | |
| }; | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 1)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 2)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 3)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 1)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 2)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 3)); | |
| }); | |
| test('4 lines unchanged, then 1 line on the RIGHT changed', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| }; | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 1)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 2)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 3)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 4)); | |
| assert.isTrue(isLineUnchanged(diff, Side.LEFT, 5)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 1)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 2)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 3)); | |
| assert.isTrue(isLineUnchanged(diff, Side.RIGHT, 4)); | |
| assert.isFalse(isLineUnchanged(diff, Side.RIGHT, 5)); | |
| }); | |
| }); | |
| suite('getContentFromDiff', () => { | |
| test('one changed line', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [{a: ['abcd']}, {b: ['wxyz']}], | |
| }; | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.LEFT), 'bc'); | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.RIGHT), 'xy'); | |
| }); | |
| test('one common line', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [{ab: ['abcd']}], | |
| }; | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.LEFT), 'bc'); | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.RIGHT), 'bc'); | |
| }); | |
| test('multiple lines', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [ | |
| {a: ['l1-asdf', 'l2-asdf']}, | |
| {b: ['r1-wxyz']}, | |
| {ab: ['l3-r2-qwer', 'l4-r3-uiop']}, | |
| {b: ['r4-hjkl']}, | |
| {ab: ['l5-r5-bnm,']}, | |
| ], | |
| }; | |
| assert.equal( | |
| getContentFromDiff(diff, 1, 0, 5, 10, Side.LEFT), | |
| 'l1-asdf\nl2-asdf\nl3-r2-qwer\nl4-r3-uiop\nl5-r5-bnm,' | |
| ); | |
| assert.equal( | |
| getContentFromDiff(diff, 1, 0, 5, 10, Side.RIGHT), | |
| 'r1-wxyz\nl3-r2-qwer\nl4-r3-uiop\nr4-hjkl\nl5-r5-bnm,' | |
| ); | |
| }); | |
| test('one skip chunk', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [{skip: 5}, {ab: ['abcd']}], | |
| }; | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.LEFT), ''); | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.RIGHT), ''); | |
| assert.equal(getContentFromDiff(diff, 6, 1, 6, 3, Side.LEFT), 'bc'); | |
| assert.equal(getContentFromDiff(diff, 6, 1, 6, 3, Side.RIGHT), 'bc'); | |
| }); | |
| test('multiple skip chunks', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| content: [ | |
| {skip: 5}, | |
| {ab: ['abcd']}, | |
| {skip: 5}, | |
| {ab: ['qwer']}, | |
| {skip: 5}, | |
| {ab: ['zxcv']}, | |
| ], | |
| }; | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.LEFT), ''); | |
| assert.equal(getContentFromDiff(diff, 1, 1, 1, 3, Side.RIGHT), ''); | |
| assert.equal(getContentFromDiff(diff, 6, 1, 6, 3, Side.LEFT), 'bc'); | |
| assert.equal(getContentFromDiff(diff, 6, 1, 6, 3, Side.RIGHT), 'bc'); | |
| assert.equal(getContentFromDiff(diff, 12, 1, 12, 3, Side.LEFT), 'we'); | |
| assert.equal(getContentFromDiff(diff, 12, 1, 12, 3, Side.RIGHT), 'we'); | |
| assert.equal(getContentFromDiff(diff, 18, 1, 18, 3, Side.LEFT), 'xc'); | |
| assert.equal(getContentFromDiff(diff, 18, 1, 18, 3, Side.RIGHT), 'xc'); | |
| }); | |
| }); | |
| suite('isMarkdownDiff()', () => { | |
| test('detects markdown extensions', () => { | |
| assert.isTrue(isMarkdownDiff('foo/bar/README.md')); | |
| assert.isTrue(isMarkdownDiff('SKILL.md')); | |
| assert.isTrue(isMarkdownDiff('doc.markdown')); | |
| assert.isTrue(isMarkdownDiff('notes.mdown')); | |
| assert.isTrue(isMarkdownDiff('file.mkd')); | |
| assert.isFalse(isMarkdownDiff('code.ts')); | |
| assert.isFalse(isMarkdownDiff('image.png')); | |
| assert.isFalse(isMarkdownDiff(undefined)); | |
| }); | |
| test('detects markdown content types', () => { | |
| const diff: DiffInfo = { | |
| ...createDiff(), | |
| meta_a: { | |
| name: 'doc', | |
| content_type: 'text/x-markdown', | |
| lines: 10, | |
| }, | |
| }; | |
| assert.isTrue(isMarkdownDiff('doc', diff)); | |
| const diffB: DiffInfo = { | |
| ...createDiff(), | |
| meta_b: { | |
| name: 'doc', | |
| content_type: 'text/markdown', | |
| lines: 10, | |
| }, | |
| }; | |
| assert.isTrue(isMarkdownDiff('doc', diffB)); | |
| const diffCharset: DiffInfo = { | |
| ...createDiff(), | |
| meta_b: { | |
| name: 'doc', | |
| content_type: 'text/markdown; charset=utf-8', | |
| lines: 10, | |
| }, | |
| }; | |
| assert.isTrue(isMarkdownDiff('doc', diffCharset)); | |
| const diffXCharset: DiffInfo = { | |
| ...createDiff(), | |
| meta_a: { | |
| name: 'doc', | |
| content_type: 'text/x-markdown; charset=utf-8', | |
| lines: 10, | |
| }, | |
| }; | |
| assert.isTrue(isMarkdownDiff('doc', diffXCharset)); | |
| const diffOther: DiffInfo = { | |
| ...createDiff(), | |
| meta_a: { | |
| name: 'code', | |
| content_type: 'text/plain', | |
| lines: 10, | |
| }, | |
| }; | |
| assert.isFalse(isMarkdownDiff('code', diffOther)); | |
| }); | |
| }); | |
| suite('canBlameFile()', () => { | |
| const imageDiff: DiffInfo = { | |
| ...createDiff(), | |
| meta_a: {name: 'a.png', content_type: 'image/png', lines: 0}, | |
| }; | |
| test('allows a modified text file when the server allows blame', () => { | |
| assert.isTrue(canBlameFile(true, 'a.txt', {}, createDiff())); | |
| assert.isTrue(canBlameFile(true, 'a.txt')); | |
| }); | |
| test('rejects files without a blameable left side', () => { | |
| assert.isFalse(canBlameFile(false, 'a.txt')); | |
| assert.isFalse(canBlameFile(true, undefined)); | |
| assert.isFalse(canBlameFile(true, SpecialFilePath.COMMIT_MESSAGE)); | |
| assert.isFalse(canBlameFile(true, 'a.png', {}, imageDiff)); | |
| assert.isFalse(canBlameFile(true, 'a.bin', {binary: true})); | |
| assert.isFalse( | |
| canBlameFile(true, 'a.txt', {diffs_too_expensive_to_compute: true}) | |
| ); | |
| assert.isFalse( | |
| canBlameFile(true, 'a.txt', {status: FileInfoStatus.ADDED}) | |
| ); | |
| }); | |
| }); | |
| }); |