jj/lib/tests/test_conflicts.rs
Martin von Zweigbergk cea6061f3d conflicts: add a function for parsing a materialized conflict
I initially made the working copy materialize conflicts in its
`check_out()` method. Then I changed it later (exactly a year ago, on
Halloween of 2020, actually) so that the working copy expected
conflicts to already have been materalized, which happens in
`MutableRepo::check_out`().

I think my reasoning then was that the file system cannot represent a
conflict. While it's true that the file system itself doesn't have
information to know whether a file represents a conflict, we can
record that ourselves. We already record whether a file is executable
or not and then preserve that if we're on a file system that isn't
able to record it. It's not that different to do the same for
conflicts if we're on a file system that doesn't understand conflicts
(i.e. all file systems).

The plan is to have the working copy remember whether a file
represents a conflict. When we check if it has changed, we parse the
file, including conflict markers, and recreate the conflict from
it. We should be able to do that losslessly (and we should adjust
formats to make it possible if we find cases where it's not).

Having the working copy preserve conflict states has several
advantages:

 * Because conflicts are not materialized in the working copy, you can
   rebase the conflicted commit and the working copy without causing
   more conflicts (that's currently a UX bug I run into every now and
   then).

 * If you don't change anything in the working copy, it will be
   unchanged compared to its parent, which means we'll automatically
   abandon it if you update away from it.

 * The user can choose to resolve only some of the conflicts in a file
   and squash those in, and it'll work they way you'd hope.

 * It should make it easier to implement support for external merge
   tools (#18) without having them treat the working copy differently.

This patch prepares for that work by adding support for parsing
materialized conflicts.
2021-11-07 15:17:51 -08:00

419 lines
7.7 KiB
Rust

// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use jujutsu_lib::backend::{Conflict, ConflictPart, TreeValue};
use jujutsu_lib::conflicts::{materialize_conflict, parse_conflict};
use jujutsu_lib::files::MergeHunk;
use jujutsu_lib::repo_path::RepoPath;
use jujutsu_lib::testutils;
#[test]
fn test_materialize_conflict_basic() {
let settings = testutils::user_settings();
let (_temp_dir, repo) = testutils::init_repo(&settings, false);
let path = RepoPath::from_internal_string("file");
let base_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
line 3
line 4
line 5
",
);
let left_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
left
line 4
line 5
",
);
let right_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
right
line 4
line 5
",
);
let conflict = Conflict {
removes: vec![ConflictPart {
value: TreeValue::Normal {
id: base_id,
executable: false,
},
}],
adds: vec![
ConflictPart {
value: TreeValue::Normal {
id: left_id,
executable: false,
},
},
ConflictPart {
value: TreeValue::Normal {
id: right_id,
executable: false,
},
},
],
};
let mut result: Vec<u8> = vec![];
materialize_conflict(repo.store(), &path, &conflict, &mut result).unwrap();
assert_eq!(
String::from_utf8(result).unwrap().as_str(),
"line 1
line 2
<<<<<<<
-------
+++++++
-line 3
+left
+++++++
right
>>>>>>>
line 4
line 5
"
);
}
#[test]
fn test_materialize_conflict_modify_delete() {
let settings = testutils::user_settings();
let (_temp_dir, repo) = testutils::init_repo(&settings, false);
let path = RepoPath::from_internal_string("file");
let base_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
line 3
line 4
line 5
",
);
let left_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
left
line 4
line 5
",
);
let right_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
line 4
line 5
",
);
let conflict = Conflict {
removes: vec![ConflictPart {
value: TreeValue::Normal {
id: base_id,
executable: false,
},
}],
adds: vec![
ConflictPart {
value: TreeValue::Normal {
id: left_id,
executable: false,
},
},
ConflictPart {
value: TreeValue::Normal {
id: right_id,
executable: false,
},
},
],
};
let mut result: Vec<u8> = vec![];
materialize_conflict(repo.store(), &path, &conflict, &mut result).unwrap();
assert_eq!(
String::from_utf8(result).unwrap().as_str(),
"line 1
line 2
<<<<<<<
-------
+++++++
-line 3
+left
+++++++
>>>>>>>
line 4
line 5
"
);
}
#[test]
fn test_materialize_conflict_delete_modify() {
let settings = testutils::user_settings();
let (_temp_dir, repo) = testutils::init_repo(&settings, false);
let path = RepoPath::from_internal_string("file");
let base_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
line 3
line 4
line 5
",
);
let left_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
line 4
line 5
",
);
let right_id = testutils::write_file(
repo.store(),
&path,
"line 1
line 2
right
line 4
line 5
",
);
let conflict = Conflict {
removes: vec![ConflictPart {
value: TreeValue::Normal {
id: base_id,
executable: false,
},
}],
adds: vec![
ConflictPart {
value: TreeValue::Normal {
id: left_id,
executable: false,
},
},
ConflictPart {
value: TreeValue::Normal {
id: right_id,
executable: false,
},
},
],
};
let mut result: Vec<u8> = vec![];
materialize_conflict(repo.store(), &path, &conflict, &mut result).unwrap();
assert_eq!(
String::from_utf8(result).unwrap().as_str(),
"line 1
line 2
<<<<<<<
-------
+++++++
-line 3
+++++++
right
>>>>>>>
line 4
line 5
"
);
}
#[test]
fn test_parse_conflict_resolved() {
assert_eq!(
parse_conflict(
b"line 1
line 2
line 3
line 4
line 5
",
1,
2
),
None
)
}
#[test]
fn test_parse_conflict_simple() {
assert_eq!(
parse_conflict(
b"line 1
<<<<<<<
-------
+++++++
line 2
-line 3
+left
line 4
+++++++
right
>>>>>>>
line 5
",
1,
2
),
Some(vec![
MergeHunk::Resolved(b"line 1\n".to_vec()),
MergeHunk::Conflict {
removes: vec![b"line 2\nline 3\nline 4\n".to_vec()],
adds: vec![b"line 2\nleft\nline 4\n".to_vec(), b"right\n".to_vec()]
},
MergeHunk::Resolved(b"line 5\n".to_vec())
])
)
}
#[test]
fn test_parse_conflict_multi_way() {
assert_eq!(
parse_conflict(
b"line 1
<<<<<<<
-------
+++++++
line 2
-line 3
+left
line 4
+++++++
right
-------
+++++++
line 2
+forward
line 3
line 4
>>>>>>>
line 5
",
2,
3
),
Some(vec![
MergeHunk::Resolved(b"line 1\n".to_vec()),
MergeHunk::Conflict {
removes: vec![
b"line 2\nline 3\nline 4\n".to_vec(),
b"line 2\nline 3\nline 4\n".to_vec()
],
adds: vec![
b"line 2\nleft\nline 4\n".to_vec(),
b"right\n".to_vec(),
b"line 2\nforward\nline 3\nline 4\n".to_vec()
]
},
MergeHunk::Resolved(b"line 5\n".to_vec())
])
)
}
#[test]
fn test_parse_conflict_different_wrong_arity() {
assert_eq!(
parse_conflict(
b"line 1
<<<<<<<
-------
+++++++
line 2
-line 3
+left
line 4
+++++++
right
>>>>>>>
line 5
",
2,
3
),
None
)
}
#[test]
fn test_parse_conflict_malformed_marker() {
// The conflict marker is missing `-------` and `+++++++` (it needs at least one
// of them)
assert_eq!(
parse_conflict(
b"line 1
<<<<<<<
line 2
-line 3
+left
line 4
+++++++
right
>>>>>>>
line 5
",
1,
2
),
None
)
}
#[test]
fn test_parse_conflict_malformed_diff() {
// The diff part is invalid (missing space before "line 4")
assert_eq!(
parse_conflict(
b"line 1
<<<<<<<
-------
+++++++
line 2
-line 3
+left
line 4
+++++++
right
>>>>>>>
line 5
",
1,
2
),
None
)
}