mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-12-28 23:55:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
jj/cli/tests/test_templater.rs

272 lines
7.6 KiB
Rust
Raw Normal View History

copyright: change from "Google LLC" to "The Jujutsu Authors" Let's acknowledge everyone's contributions by replacing "Google LLC" in the copyright header by "The Jujutsu Authors". If I understand correctly, it won't have any legal effect, but maybe it still helps reduce concerns from contributors (though I haven't heard any concerns). Google employees can read about Google's policy at go/releasing/contributions#copyright.
2022-11-26 23:57:50 +00:00
// Copyright 2022 The Jujutsu Authors
templater: indicate if branch needs to be pushed to a remote It's useful to know when you've modified a branch that exists on a remote. A typical case is when you have pushed a branch to a remote and then rewritten it. This commit adds an indication in the `branches` template keyword. A branch that needs to be pushed to a remote now has a `*` at the end (similar to how conflicted branches have a `?` at the end). Note that the indication only considers remotes where the branch currently exists, so there won't be an indication that the branch has not been pushed to a remote. Closes #254
2022-11-04 16:39:46 +00:00
//
// 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.
tests: extract helper that renders single commit template with no graph
2023-01-31 09:41:15 +00:00
use std::path::Path;
tests: add helper method to capture both stdout/stderr outputs This pattern is common, and should have a shorthand so that we can easily add warning messages.
2023-07-03 10:04:31 +00:00
use crate::common::TestEnvironment;
templater: indicate if branch needs to be pushed to a remote It's useful to know when you've modified a branch that exists on a remote. A typical case is when you have pushed a branch to a remote and then rewritten it. This commit adds an indication in the `branches` template keyword. A branch that needs to be pushed to a remote now has a `*` at the end (similar to how conflicted branches have a `?` at the end). Note that the indication only considers remotes where the branch currently exists, so there won't be an indication that the branch has not been pushed to a remote. Closes #254
2022-11-04 16:39:46 +00:00
templater: report syntax error, don't panic() Even though the template syntax is experimental, panicking parser makes it difficult to write tests. So let's add minimal error handling. The error types are basically copied from the revset module. I made write_commit_summary() fall back to the default template if user template had syntax error. It should be better than reporting parse error after e.g. "jj abandon" finished successfully.
2023-02-02 08:57:55 +00:00
#[test]
fn test_templater_parse_error() {
let test_env = TestEnvironment::default();
tests: replace jj_cmd_success() involving mutation to allow stderr output
2023-10-10 11:59:18 +00:00
test_env.jj_cmd_ok(test_env.env_root(), &["init", "repo", "--git"]);
templater: report syntax error, don't panic() Even though the template syntax is experimental, panicking parser makes it difficult to write tests. So let's add minimal error handling. The error types are basically copied from the revset module. I made write_commit_summary() fall back to the default template if user template had syntax error. It should be better than reporting parse error after e.g. "jj abandon" finished successfully.
2023-02-02 08:57:55 +00:00
let repo_path = test_env.env_root().join("repo");
let render_err = |template| test_env.jj_cmd_failure(&repo_path, &["log", "-T", template]);
insta::assert_snapshot!(render_err(r#"description ()"#), @r###"
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
Error: Failed to parse template: --> 1:13
templater: report syntax error, don't panic() Even though the template syntax is experimental, panicking parser makes it difficult to write tests. So let's add minimal error handling. The error types are basically copied from the revset module. I made write_commit_summary() fall back to the default template if user template had syntax error. It should be better than reporting parse error after e.g. "jj abandon" finished successfully.
2023-02-02 08:57:55 +00:00
|
1 | description ()
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
| ^---
templater: report syntax error, don't panic() Even though the template syntax is experimental, panicking parser makes it difficult to write tests. So let's add minimal error handling. The error types are basically copied from the revset module. I made write_commit_summary() fall back to the default template if user template had syntax error. It should be better than reporting parse error after e.g. "jj abandon" finished successfully.
2023-02-02 08:57:55 +00:00
|
templater: retain "++" in parsed tree to provide better error indication
2024-02-07 11:31:53 +00:00
= expected <EOI>, `++`, `||`, or `&&`
templater: report syntax error, don't panic() Even though the template syntax is experimental, panicking parser makes it difficult to write tests. So let's add minimal error handling. The error types are basically copied from the revset module. I made write_commit_summary() fall back to the default template if user template had syntax error. It should be better than reporting parse error after e.g. "jj abandon" finished successfully.
2023-02-02 08:57:55 +00:00
"###);
templater: add separate(sep, contents...) function This is a copy of Mercurial's separate() function.
2023-02-03 05:36:01 +00:00
}
templater: Upper and lowercase ids and strings
2023-02-21 04:38:52 +00:00
#[test]
fn test_templater_upper_lower() {
let test_env = TestEnvironment::default();
tests: replace jj_cmd_success() involving mutation to allow stderr output
2023-10-10 11:59:18 +00:00
test_env.jj_cmd_ok(test_env.env_root(), &["init", "repo", "--git"]);
templater: Upper and lowercase ids and strings
2023-02-21 04:38:52 +00:00
let repo_path = test_env.env_root().join("repo");
let render = |template| get_colored_template_output(&test_env, &repo_path, "@-", template);
insta::assert_snapshot!(
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
render(r#"change_id.shortest(4).upper() ++ change_id.shortest(4).upper().lower()"#),
templater: Upper and lowercase ids and strings
2023-02-21 04:38:52 +00:00
@"ZZZZzzzz");
insta::assert_snapshot!(
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
render(r#""Hello".upper() ++ "Hello".lower()"#), @"HELLOhello");
templater: Upper and lowercase ids and strings
2023-02-21 04:38:52 +00:00
}
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
#[test]
fn test_templater_alias() {
let test_env = TestEnvironment::default();
tests: replace jj_cmd_success() involving mutation to allow stderr output
2023-10-10 11:59:18 +00:00
test_env.jj_cmd_ok(test_env.env_root(), &["init", "repo", "--git"]);
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
let repo_path = test_env.env_root().join("repo");
let render = |template| get_template_output(&test_env, &repo_path, "@-", template);
let render_err = |template| test_env.jj_cmd_failure(&repo_path, &["log", "-T", template]);
test_env.add_config(
r###"
[template-aliases]
'my_commit_id' = 'commit_id.short()'
'syntax_error' = 'foo.'
'name_error' = 'unknown_id'
'recurse' = 'recurse1'
'recurse1' = 'recurse2()'
'recurse2()' = 'recurse'
'identity(x)' = 'x'
'coalesce(x, y)' = 'if(x, x, y)'
"###,
);
insta::assert_snapshot!(render("my_commit_id"), @"000000000000");
insta::assert_snapshot!(render("identity(my_commit_id)"), @"000000000000");
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
insta::assert_snapshot!(render_err("commit_id ++ syntax_error"), @r###"
Error: Failed to parse template: --> 1:14
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
|
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
1 | commit_id ++ syntax_error
| ^----------^
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
|
= Alias "syntax_error" cannot be expanded
--> 1:5
|
1 | foo.
| ^---
|
templater: translate symbol rules in error message This is simplified version of the revset change c4769e0b7c2a.
2024-02-07 03:08:03 +00:00
= expected <identifier>
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
"###);
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
insta::assert_snapshot!(render_err("commit_id ++ name_error"), @r###"
Error: Failed to parse template: --> 1:14
templater: save alias chain to report type/name error in original context Since type/name checking is made after alias substitution, we need to preserve the original context to generate a readable error message. We could instead attach a stack of (alias_id, span) to ExpressionNode, but the extra AliasExpanded node helps to capture downstream error by a single .map_err() call.
2023-02-12 12:44:33 +00:00
|
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
1 | commit_id ++ name_error
| ^--------^
templater: save alias chain to report type/name error in original context Since type/name checking is made after alias substitution, we need to preserve the original context to generate a readable error message. We could instead attach a stack of (alias_id, span) to ExpressionNode, but the extra AliasExpanded node helps to capture downstream error by a single .map_err() call.
2023-02-12 12:44:33 +00:00
|
= Alias "name_error" cannot be expanded
--> 1:1
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
|
1 | unknown_id
| ^--------^
|
= Keyword "unknown_id" doesn't exist
"###);
templater: save alias chain to report type/name error in original context Since type/name checking is made after alias substitution, we need to preserve the original context to generate a readable error message. We could instead attach a stack of (alias_id, span) to ExpressionNode, but the extra AliasExpanded node helps to capture downstream error by a single .map_err() call.
2023-02-12 12:44:33 +00:00
insta::assert_snapshot!(render_err(r#"identity(identity(commit_id.short("")))"#), @r###"
Error: Failed to parse template: --> 1:1
|
1 | identity(identity(commit_id.short("")))
| ^-------------------------------------^
|
= Alias "identity()" cannot be expanded
--> 1:10
|
1 | identity(identity(commit_id.short("")))
| ^---------------------------^
|
= Alias "identity()" cannot be expanded
--> 1:35
|
1 | identity(identity(commit_id.short("")))
| ^^
|
templater: unify variants of type error as general expression error I'm going to add a lambda expression, and the current type-error message wouldn't work for the lambda type. I also renamed "argument" to "expression" as the expect_<type>() helper may be called against any expression node.
2023-03-15 06:02:44 +00:00
= Expected expression of type "Integer"
templater: save alias chain to report type/name error in original context Since type/name checking is made after alias substitution, we need to preserve the original context to generate a readable error message. We could instead attach a stack of (alias_id, span) to ExpressionNode, but the extra AliasExpanded node helps to capture downstream error by a single .map_err() call.
2023-02-12 12:44:33 +00:00
"###);
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
insta::assert_snapshot!(render_err("commit_id ++ recurse"), @r###"
Error: Failed to parse template: --> 1:14
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
|
templater: require infix ++ operator to concatenate expressions This eliminates ambiguous parsing between "func()" and "expr ()". I chose "++" as template concatenation operator in case we want to add bit-wise negate operator. It's also easier to find/replace than "~".
2023-02-28 11:30:57 +00:00
1 | commit_id ++ recurse
| ^-----^
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
|
= Alias "recurse" cannot be expanded
--> 1:1
|
1 | recurse1
| ^------^
|
= Alias "recurse1" cannot be expanded
--> 1:1
|
1 | recurse2()
| ^--------^
|
= Alias "recurse2()" cannot be expanded
--> 1:1
|
1 | recurse
| ^-----^
|
= Alias "recurse" expanded recursively
"###);
insta::assert_snapshot!(render_err("identity()"), @r###"
Error: Failed to parse template: --> 1:10
|
1 | identity()
| ^
|
templater: unify variants of argument count error, embed function name This is similar to the structure of RevsetParseError. It's unlikely we would need to discriminate parsing errors, so let's avoid wasting time on naming things.
2023-03-15 03:22:41 +00:00
= Function "identity": Expected 1 arguments
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
"###);
insta::assert_snapshot!(render_err("identity(commit_id, commit_id)"), @r###"
Error: Failed to parse template: --> 1:10
|
1 | identity(commit_id, commit_id)
| ^------------------^
|
templater: unify variants of argument count error, embed function name This is similar to the structure of RevsetParseError. It's unlikely we would need to discriminate parsing errors, so let's avoid wasting time on naming things.
2023-03-15 03:22:41 +00:00
= Function "identity": Expected 1 arguments
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
"###);
insta::assert_snapshot!(render_err(r#"coalesce(label("x", "not boolean"), "")"#), @r###"
templater: save alias chain to report type/name error in original context Since type/name checking is made after alias substitution, we need to preserve the original context to generate a readable error message. We could instead attach a stack of (alias_id, span) to ExpressionNode, but the extra AliasExpanded node helps to capture downstream error by a single .map_err() call.
2023-02-12 12:44:33 +00:00
Error: Failed to parse template: --> 1:1
|
1 | coalesce(label("x", "not boolean"), "")
| ^-------------------------------------^
|
= Alias "coalesce()" cannot be expanded
--> 1:10
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
|
1 | coalesce(label("x", "not boolean"), "")
| ^-----------------------^
|
templater: unify variants of type error as general expression error I'm going to add a lambda expression, and the current type-error message wouldn't work for the lambda type. I also renamed "argument" to "expression" as the expect_<type>() helper may be called against any expression node.
2023-03-15 06:02:44 +00:00
= Expected expression of type "Boolean"
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
"###);
}
cli: load revset/template aliases in order of config layers Since we abuse TOML table syntax to define function aliases, an identical function alias can be found more than once in the merged config. The merged config doesn't preserve the definition order, so we need to load aliases table per layer.
2023-05-23 03:45:11 +00:00
#[test]
fn test_templater_alias_override() {
let test_env = TestEnvironment::default();
tests: replace jj_cmd_success() involving mutation to allow stderr output
2023-10-10 11:59:18 +00:00
test_env.jj_cmd_ok(test_env.env_root(), &["init", "repo", "--git"]);
cli: load revset/template aliases in order of config layers Since we abuse TOML table syntax to define function aliases, an identical function alias can be found more than once in the merged config. The merged config doesn't preserve the definition order, so we need to load aliases table per layer.
2023-05-23 03:45:11 +00:00
let repo_path = test_env.env_root().join("repo");
test_env.add_config(
cleanup: fix warnings from nightly clippy
2023-08-15 03:18:52 +00:00
r#"
cli: load revset/template aliases in order of config layers Since we abuse TOML table syntax to define function aliases, an identical function alias can be found more than once in the merged config. The merged config doesn't preserve the definition order, so we need to load aliases table per layer.
2023-05-23 03:45:11 +00:00
[template-aliases]
'f(x)' = '"user"'
cleanup: fix warnings from nightly clippy
2023-08-15 03:18:52 +00:00
"#,
cli: load revset/template aliases in order of config layers Since we abuse TOML table syntax to define function aliases, an identical function alias can be found more than once in the merged config. The merged config doesn't preserve the definition order, so we need to load aliases table per layer.
2023-05-23 03:45:11 +00:00
);
// 'f(x)' should be overridden by --config-toml 'f(a)'. If aliases were sorted
// purely by name, 'f(a)' would come first.
let stdout = test_env.jj_cmd_success(
&repo_path,
&[
"log",
"--no-graph",
"-r@",
"-T",
r#"f(_)"#,
"--config-toml",
r#"template-aliases.'f(a)' = '"arg"'"#,
],
);
insta::assert_snapshot!(stdout, @"arg");
}
cli: load [template-aliases] section and pass around aliases table
2023-02-12 08:53:09 +00:00
#[test]
fn test_templater_bad_alias_decl() {
let test_env = TestEnvironment::default();
tests: replace jj_cmd_success() involving mutation to allow stderr output
2023-10-10 11:59:18 +00:00
test_env.jj_cmd_ok(test_env.env_root(), &["init", "repo", "--git"]);
cli: load [template-aliases] section and pass around aliases table
2023-02-12 08:53:09 +00:00
let repo_path = test_env.env_root().join("repo");
test_env.add_config(
r###"
[template-aliases]
'badfn(a, a)' = 'a'
templater: implement symbol/function alias expansion Test vectors are mainly copied from revset.rs and adapted to the template syntax. Closes #1190
2023-02-12 09:41:53 +00:00
'my_commit_id' = 'commit_id.short()'
cli: load [template-aliases] section and pass around aliases table
2023-02-12 08:53:09 +00:00
"###,
);
// Invalid declaration should be warned and ignored.
tests: add helper method to capture both stdout/stderr outputs This pattern is common, and should have a shorthand so that we can easily add warning messages.
2023-07-03 10:04:31 +00:00
let (stdout, stderr) =
test_env.jj_cmd_ok(&repo_path, &["log", "--no-graph", "-r@-", "-Tmy_commit_id"]);
insta::assert_snapshot!(stdout, @"000000000000");
insta::assert_snapshot!(stderr, @r###"
cli: load [template-aliases] section and pass around aliases table
2023-02-12 08:53:09 +00:00
Failed to load "template-aliases.badfn(a, a)": --> 1:7
|
1 | badfn(a, a)
| ^--^
|
= Redefinition of function parameter
"###);
}
tests: extract helper that renders single commit template with no graph
2023-01-31 09:41:15 +00:00
fn get_template_output(
test_env: &TestEnvironment,
repo_path: &Path,
rev: &str,
template: &str,
) -> String {
test_env.jj_cmd_success(repo_path, &["log", "--no-graph", "-r", rev, "-T", template])
templater: fix parsing of parenthesized expression A "list" is a sequence of more than one "term" nodes, so it shouldn't contain a single parenthesized node. Also, a parenthesized "term" rule wasn't handled.
2023-01-28 10:23:39 +00:00
}
tests: extract helper that renders colored commit template
2023-02-03 13:13:56 +00:00
fn get_colored_template_output(
test_env: &TestEnvironment,
repo_path: &Path,
rev: &str,
template: &str,
) -> String {
test_env.jj_cmd_success(
repo_path,
&[
"log",
"--color=always",
"--no-graph",
"-r",
rev,
"-T",
template,
],
)
}
Reference in a new issue Copy permalink