debian-mirror-gitlab/spec/lib/gitlab/diff/position_spec.rb

814 lines
23 KiB
Ruby
Raw Normal View History

2019-10-12 21:52:04 +05:30
# frozen_string_literal: true
2016-08-24 12:49:21 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe Gitlab::Diff::Position do
2016-08-24 12:49:21 +05:30
include RepoHelpers
2017-08-17 22:00:37 +05:30
let(:project) { create(:project, :repository) }
2016-08-24 12:49:21 +05:30
2018-11-20 20:47:30 +05:30
let(:args_for_img) do
{
old_path: "files/any.img",
new_path: "files/any.img",
base_sha: nil,
head_sha: nil,
start_sha: nil,
width: 100,
height: 100,
x: 1,
y: 100,
position_type: "image"
}
end
let(:args_for_text) do
{
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: nil,
new_line: 14,
2020-04-22 19:07:51 +05:30
line_range: nil,
2018-11-20 20:47:30 +05:30
base_sha: nil,
head_sha: nil,
start_sha: nil,
position_type: "text"
}
end
2020-03-13 15:44:24 +05:30
describe 'factory' do
it 'produces a complete text position' do
position = build(:text_diff_position)
expect(position).to be_complete
expect(position).to have_attributes(position_type: 'text')
end
it 'produces a complete image position' do
position = build(:image_diff_position)
expect(position).to be_complete
expect(position).to have_attributes(position_type: 'image')
end
it 'allows the diff_refs to be passed as a single object' do
head_sha = Digest::SHA1.hexdigest(SecureRandom.hex)
base_sha = Digest::SHA1.hexdigest(SecureRandom.hex)
start_sha = Digest::SHA1.hexdigest(SecureRandom.hex)
refs = ::Gitlab::Diff::DiffRefs.new(base_sha: base_sha, start_sha: start_sha, head_sha: head_sha)
expect(build(:diff_position, diff_refs: refs).diff_refs).to eq(refs)
end
end
2018-03-17 18:26:18 +05:30
describe "position for an added text file" do
2016-08-24 12:49:21 +05:30
let(:commit) { project.commit("2ea1f3dec713d940208fb5ce4a38765ecb5d3f73") }
subject do
described_class.new(
old_path: "files/images/wm.svg",
new_path: "files/images/wm.svg",
old_line: nil,
new_line: 5,
diff_refs: commit.diff_refs
)
end
2019-09-04 21:01:54 +05:30
it { is_expected.to be_on_text }
it { is_expected.not_to be_on_image }
2016-08-24 12:49:21 +05:30
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
2017-09-10 17:25:29 +05:30
expect(diff_file.new_file?).to be true
2016-08-24 12:49:21 +05:30
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.added?).to be true
expect(diff_line.new_line).to eq(subject.new_line)
expect(diff_line.text).to eq("+ <desc>Created with Sketch.</desc>")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, subject.new_line, 0)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
2018-03-17 18:26:18 +05:30
describe "position for an added image file" do
let(:commit) { project.commit("33f3729a45c02fc67d00adb1b8bca394b0e761d9") }
subject do
described_class.new(
old_path: "files/images/6049019_460s.jpg",
new_path: "files/images/6049019_460s.jpg",
width: 100,
height: 100,
x: 1,
y: 100,
diff_refs: commit.diff_refs,
position_type: "image"
)
end
2019-09-04 21:01:54 +05:30
it { is_expected.not_to be_on_text }
it { is_expected.to be_on_image }
2018-03-17 18:26:18 +05:30
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.new_file?).to be true
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
2016-08-24 12:49:21 +05:30
describe "position for a changed file" do
let(:commit) { project.commit("570e7b2abdd848b95f2f578043fc23bd6f6fd24d") }
describe "position for an added line" do
subject do
described_class.new(
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: nil,
new_line: 14,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
2019-12-21 20:55:43 +05:30
context 'different folded positions in the same diff file' do
def diff_file(args = {})
described_class
.new(args_for_text.merge(args))
.diff_file(project.repository)
end
it 'expands the diff file', :request_store do
expect_any_instance_of(Gitlab::Diff::File)
.to receive(:unfold_diff_lines).and_call_original
diff_file(old_line: 1, new_line: 1, diff_refs: commit.diff_refs)
expect_any_instance_of(Gitlab::Diff::File)
.to receive(:unfold_diff_lines).and_call_original
diff_file(old_line: 5, new_line: 5, diff_refs: commit.diff_refs)
end
end
2016-08-24 12:49:21 +05:30
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.added?).to be true
expect(diff_line.new_line).to eq(subject.new_line)
expect(diff_line.text).to eq("+ vars = {")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, subject.new_line, 15)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
describe "position for an unchanged line" do
subject do
described_class.new(
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: 16,
new_line: 22,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.unchanged?).to be true
expect(diff_line.old_line).to eq(subject.old_line)
expect(diff_line.new_line).to eq(subject.new_line)
expect(diff_line.text).to eq(" unless File.directory?(path)")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, subject.new_line, subject.old_line)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
describe "position for a removed line" do
subject do
described_class.new(
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: 14,
new_line: nil,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.removed?).to be true
expect(diff_line.old_line).to eq(subject.old_line)
expect(diff_line.text).to eq("- options = { chdir: path }")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, 13, subject.old_line)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
end
describe "position for a renamed file" do
let(:commit) { project.commit("6907208d755b60ebeacb2e9dfea74c92c3449a1f") }
describe "position for an added line" do
subject do
described_class.new(
old_path: "files/js/commit.js.coffee",
new_path: "files/js/commit.coffee",
old_line: nil,
new_line: 4,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.added?).to be true
expect(diff_line.new_line).to eq(subject.new_line)
expect(diff_line.text).to eq("+ new CommitFile(@)")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, subject.new_line, 5)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
describe "position for an unchanged line" do
subject do
described_class.new(
old_path: "files/js/commit.js.coffee",
new_path: "files/js/commit.coffee",
old_line: 3,
new_line: 3,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.unchanged?).to be true
expect(diff_line.old_line).to eq(subject.old_line)
expect(diff_line.new_line).to eq(subject.new_line)
expect(diff_line.text).to eq(" $('.files .diff-file').each ->")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, subject.new_line, subject.old_line)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
describe "position for a removed line" do
subject do
described_class.new(
old_path: "files/js/commit.js.coffee",
new_path: "files/js/commit.coffee",
old_line: 4,
new_line: nil,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.removed?).to be true
expect(diff_line.old_line).to eq(subject.old_line)
expect(diff_line.text).to eq("- new CommitFile(this)")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, 4, subject.old_line)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
end
describe "position for a deleted file" do
let(:commit) { project.commit("8634272bfad4cf321067c3e94d64d5a253f8321d") }
subject do
described_class.new(
old_path: "LICENSE",
new_path: "LICENSE",
old_line: 3,
new_line: nil,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
2017-09-10 17:25:29 +05:30
expect(diff_file.deleted_file?).to be true
2016-08-24 12:49:21 +05:30
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.removed?).to be true
expect(diff_line.old_line).to eq(subject.old_line)
expect(diff_line.text).to eq("-Copyright (c) 2014 gitlabhq")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, 0, subject.old_line)
2016-08-24 12:49:21 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
2018-03-17 18:26:18 +05:30
describe "position for a missing ref" do
let(:diff_refs) do
Gitlab::Diff::DiffRefs.new(
base_sha: "not_existing_sha",
head_sha: "existing_sha"
)
end
subject do
described_class.new(
old_path: "files/ruby/feature.rb",
new_path: "files/ruby/feature.rb",
old_line: 3,
new_line: nil,
diff_refs: diff_refs
)
end
describe "#diff_file" do
it "does not raise exception" do
expect { subject.diff_file(project.repository) }.not_to raise_error
end
end
describe "#diff_line" do
it "does not raise exception" do
expect { subject.diff_line(project.repository) }.not_to raise_error
end
end
describe "#line_code" do
it "does not raise exception" do
expect { subject.line_code(project.repository) }.not_to raise_error
end
end
end
2016-09-13 17:45:13 +05:30
describe "position for a file in the initial commit" do
let(:commit) { project.commit("1a0b36b3cdad1d2ee32457c102a8c0b7056fa863") }
subject do
described_class.new(
old_path: "README.md",
new_path: "README.md",
old_line: nil,
new_line: 1,
diff_refs: commit.diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
2017-09-10 17:25:29 +05:30
expect(diff_file.new_file?).to be true
2016-09-13 17:45:13 +05:30
expect(diff_file.new_path).to eq(subject.new_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.added?).to be true
expect(diff_line.new_line).to eq(subject.new_line)
expect(diff_line.text).to eq("+testme")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, subject.new_line, 0)
2016-09-13 17:45:13 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
2017-09-10 17:25:29 +05:30
describe "position for a file in a straight comparison" do
let(:diff_refs) do
Gitlab::Diff::DiffRefs.new(
start_sha: '0b4bc9a49b562e85de7cc9e834518ea6828729b9', # feature
base_sha: '0b4bc9a49b562e85de7cc9e834518ea6828729b9',
head_sha: 'e63f41fe459e62e1228fcef60d7189127aeba95a' # master
)
end
subject do
described_class.new(
old_path: "files/ruby/feature.rb",
new_path: "files/ruby/feature.rb",
old_line: 3,
new_line: nil,
diff_refs: diff_refs
)
end
describe "#diff_file" do
it "returns the correct diff file" do
diff_file = subject.diff_file(project.repository)
expect(diff_file.deleted_file?).to be true
expect(diff_file.old_path).to eq(subject.old_path)
expect(diff_file.diff_refs).to eq(subject.diff_refs)
end
end
describe "#diff_line" do
it "returns the correct diff line" do
diff_line = subject.diff_line(project.repository)
expect(diff_line.removed?).to be true
expect(diff_line.old_line).to eq(subject.old_line)
expect(diff_line.text).to eq("- puts 'bar'")
end
end
describe "#line_code" do
it "returns the correct line code" do
2018-03-17 18:26:18 +05:30
line_code = Gitlab::Git.diff_line_code(subject.file_path, 0, subject.old_line)
2017-09-10 17:25:29 +05:30
expect(subject.line_code(project.repository)).to eq(line_code)
end
end
end
2020-06-23 00:09:42 +05:30
describe '#find_diff_file_from' do
context "position for a diff file that has changed from symlink to regular file" do
let(:commit) { project.commit("81e6355ce4e1544a3524b230952c12455de0777b") }
let(:old_symlink_file_identifier_hash) { "bfa430463f33619872d52a6b85ced59c973e42dc" }
let(:new_regular_file_identifier_hash) { "e25b60c2e5ffb977d2b1431b96c6f7800c3c3529" }
let(:file_identifier_hash) { new_regular_file_identifier_hash }
let(:args) do
{
file_identifier_hash: file_identifier_hash,
old_path: "symlink",
new_path: "symlink",
old_line: nil,
new_line: 1,
diff_refs: commit.diff_refs
}
end
let(:diffable) { commit.diff_refs.compare_in(project) }
subject(:diff_file) { described_class.new(args).find_diff_file_from(diffable) }
context 'when file_identifier_hash is disabled' do
before do
stub_feature_flags(file_identifier_hash: false)
end
it "returns the first diff file" do
expect(diff_file.file_identifier_hash).to eq(old_symlink_file_identifier_hash)
end
end
context 'when file_identifier_hash is enabled' do
before do
stub_feature_flags(file_identifier_hash: true)
end
context 'for new regular file' do
it "returns the correct diff file" do
expect(diff_file.file_identifier_hash).to eq(new_regular_file_identifier_hash)
end
end
context 'for old symlink file' do
let(:args) do
{
file_identifier_hash: old_symlink_file_identifier_hash,
old_path: "symlink",
new_path: "symlink",
old_line: 1,
new_line: nil,
diff_refs: commit.diff_refs
}
end
it "returns the correct diff file" do
expect(diff_file.file_identifier_hash).to eq(old_symlink_file_identifier_hash)
end
end
context 'when file_identifier_hash is missing' do
let(:file_identifier_hash) { nil }
it "returns the first diff file" do
expect(diff_file.file_identifier_hash).to eq(old_symlink_file_identifier_hash)
end
end
context 'when file_identifier_hash cannot be found' do
let(:file_identifier_hash) { "missingidentifier" }
it "returns nil" do
expect(diff_file).to be_nil
end
end
end
end
end
2018-03-17 18:26:18 +05:30
describe '#==' do
let(:commit) { project.commit("570e7b2abdd848b95f2f578043fc23bd6f6fd24d") }
subject do
described_class.new(
2016-08-24 12:49:21 +05:30
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: nil,
new_line: 14,
2018-03-17 18:26:18 +05:30
diff_refs: commit.diff_refs
)
end
context 'when positions are equal' do
let(:other) { described_class.new(subject.to_h) }
it 'returns true' do
expect(subject).to eq(other)
end
end
context 'when positions are equal, except for truncated shas' do
let(:other) { described_class.new(subject.to_h.merge(start_sha: subject.start_sha[0, 10])) }
it 'returns true' do
expect(subject).to eq(other)
end
2016-08-24 12:49:21 +05:30
end
2018-03-17 18:26:18 +05:30
context 'when positions are unequal' do
let(:other) { described_class.new(subject.to_h.merge(start_sha: subject.start_sha.reverse)) }
it 'returns false' do
expect(subject).not_to eq(other)
end
end
end
2018-11-20 20:47:30 +05:30
describe "#as_json" do
shared_examples "diff position json" do
let(:diff_position) { described_class.new(args) }
it "returns the position as JSON" do
expect(diff_position.as_json).to eq(args.stringify_keys)
end
end
2018-12-13 13:39:08 +05:30
context "for text position" do
2018-11-20 20:47:30 +05:30
let(:args) { args_for_text }
it_behaves_like "diff position json"
end
2018-12-13 13:39:08 +05:30
context "for image position" do
2018-11-20 20:47:30 +05:30
let(:args) { args_for_img }
it_behaves_like "diff position json"
end
end
2018-03-17 18:26:18 +05:30
describe "#to_json" do
shared_examples "diff position json" do
2018-11-20 20:47:30 +05:30
let(:diff_position) { described_class.new(args) }
2018-03-17 18:26:18 +05:30
it "returns the position as JSON" do
2020-05-24 23:13:21 +05:30
expect(Gitlab::Json.parse(diff_position.to_json)).to eq(args.stringify_keys)
2018-03-17 18:26:18 +05:30
end
it "works when nested under another hash" do
2020-05-24 23:13:21 +05:30
expect(Gitlab::Json.parse(Gitlab::Json.generate(pos: diff_position))).to eq('pos' => args.stringify_keys)
2018-03-17 18:26:18 +05:30
end
end
2018-12-13 13:39:08 +05:30
context "for text position" do
2018-11-20 20:47:30 +05:30
let(:args) { args_for_text }
2016-08-24 12:49:21 +05:30
2018-03-17 18:26:18 +05:30
it_behaves_like "diff position json"
2016-08-24 12:49:21 +05:30
end
2018-12-13 13:39:08 +05:30
context "for image position" do
2018-11-20 20:47:30 +05:30
let(:args) { args_for_img }
2018-03-17 18:26:18 +05:30
it_behaves_like "diff position json"
2016-08-24 12:49:21 +05:30
end
end
2019-09-30 21:07:59 +05:30
describe "#file_hash" do
subject do
described_class.new(
old_path: "image.jpg",
new_path: "image.jpg"
)
end
it "returns SHA1 representation of the file_path" do
expect(subject.file_hash).to eq(Digest::SHA1.hexdigest(subject.file_path))
end
end
2021-03-08 18:12:59 +05:30
describe '#multiline?' do
let(:end_line_code) { "ab09011fa121d0a2bb9fa4ca76094f2482b902b7_#{end_old_line}_#{end_new_line}" }
let(:line_range) do
{
"start" => {
"line_code" => "ab09011fa121d0a2bb9fa4ca76094f2482b902b7_18_18",
"type" => nil,
"old_line" => 18,
"new_line" => 18
},
"end" => {
"line_code" => end_line_code,
"type" => nil,
"old_line" => end_old_line,
"new_line" => end_new_line
}
}
end
subject(:multiline) do
described_class.new(
line_range: line_range,
position_type: position_type
)
end
let(:end_old_line) { 20 }
let(:end_new_line) { 20 }
context 'when the position type is text' do
let(:position_type) { "text" }
context 'when the start lines equal the end lines' do
let(:end_old_line) { 18 }
let(:end_new_line) { 18 }
it "returns true" do
expect(subject.multiline?).to be_falsey
end
end
context 'when the start lines do not equal the end lines' do
it "returns true" do
expect(subject.multiline?).to be_truthy
end
end
end
context 'when the position type is not text' do
let(:position_type) { "image" }
it "returns false" do
expect(subject.multiline?).to be_falsey
end
end
end
2016-08-24 12:49:21 +05:30
end