mirror of
https://github.com/martinvonz/jj.git
synced 2024-12-01 11:49:01 +00:00
24ea8478cb
The motivating use-case was this `jj signoff` script: https://gist.github.com/thoughtpolice/8f2fd36ae17cd11b8e7bd93a70e31ad6 Which includes lines like this: ```sh NAME=$(jj config list user.name | awk '{split($0, a, "="); print a[2];}' | tr -d '"') MAIL=$(jj config list user.email | awk '{split($0, a, "="); print a[2];}' | tr -d '"') ``` There is no reason that we should have to clumsily parse out the config values. This `jj config get` command supports scripting use-cases like this.
500 lines
15 KiB
Rust
500 lines
15 KiB
Rust
// Copyright 2022 The Jujutsu Authors
|
|
//
|
|
// 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 itertools::Itertools;
|
|
use regex::Regex;
|
|
|
|
use crate::common::TestEnvironment;
|
|
|
|
pub mod common;
|
|
|
|
#[test]
|
|
fn test_config_list_single() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.add_config(
|
|
r###"
|
|
[test-table]
|
|
somekey = "some value"
|
|
"###,
|
|
);
|
|
|
|
let stdout = test_env.jj_cmd_success(
|
|
test_env.env_root(),
|
|
&["config", "list", "test-table.somekey"],
|
|
);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
test-table.somekey="some value"
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_list_nonexistent() {
|
|
let test_env = TestEnvironment::default();
|
|
let assert = test_env
|
|
.jj_cmd(
|
|
test_env.env_root(),
|
|
&["config", "list", "nonexistent-test-key"],
|
|
)
|
|
.assert()
|
|
.success()
|
|
.stdout("");
|
|
insta::assert_snapshot!(common::get_stderr_string(&assert), @r###"
|
|
No matching config key for nonexistent-test-key
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_list_table() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.add_config(
|
|
r###"
|
|
[test-table]
|
|
x = true
|
|
y.foo = "abc"
|
|
y.bar = 123
|
|
"###,
|
|
);
|
|
let stdout = test_env.jj_cmd_success(test_env.env_root(), &["config", "list", "test-table"]);
|
|
insta::assert_snapshot!(
|
|
stdout,
|
|
@r###"
|
|
test-table.x=true
|
|
test-table.y.bar=123
|
|
test-table.y.foo="abc"
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_list_array() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.add_config(
|
|
r###"
|
|
test-array = [1, "b", 3.4]
|
|
"###,
|
|
);
|
|
let stdout = test_env.jj_cmd_success(test_env.env_root(), &["config", "list", "test-array"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
test-array=[1, "b", 3.4]
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_list_inline_table() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.add_config(
|
|
r###"
|
|
[[test-table]]
|
|
x = 1
|
|
[[test-table]]
|
|
y = ["z"]
|
|
"###,
|
|
);
|
|
let stdout = test_env.jj_cmd_success(test_env.env_root(), &["config", "list", "test-table"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
test-table=[{x=1}, {y=["z"]}]
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_list_all() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.add_config(
|
|
r###"
|
|
test-val = [1, 2, 3]
|
|
[test-table]
|
|
x = true
|
|
y.foo = "abc"
|
|
y.bar = 123
|
|
"###,
|
|
);
|
|
let stdout = test_env.jj_cmd_success(test_env.env_root(), &["config", "list"]);
|
|
insta::assert_snapshot!(
|
|
find_stdout_lines(r"(test-val|test-table\b[^=]*)", &stdout),
|
|
@r###"
|
|
test-table.x=true
|
|
test-table.y.bar=123
|
|
test-table.y.foo="abc"
|
|
test-val=[1, 2, 3]
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_layer_override_default() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
let config_key = "merge-tools.vimdiff.program";
|
|
|
|
// Default
|
|
let stdout = test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "list", config_key, "--include-defaults"],
|
|
);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
merge-tools.vimdiff.program="vim"
|
|
"###);
|
|
|
|
// User
|
|
test_env.add_config(&format!("{config_key} = {value:?}\n", value = "user"));
|
|
let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
merge-tools.vimdiff.program="user"
|
|
"###);
|
|
|
|
// Repo
|
|
std::fs::write(
|
|
repo_path.join(".jj/repo/config.toml"),
|
|
format!("{config_key} = {value:?}\n", value = "repo"),
|
|
)
|
|
.unwrap();
|
|
let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
merge-tools.vimdiff.program="repo"
|
|
"###);
|
|
|
|
// Command argument
|
|
let stdout = test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&[
|
|
"config",
|
|
"list",
|
|
config_key,
|
|
"--config-toml",
|
|
&format!("{config_key}={value:?}", value = "command-arg"),
|
|
],
|
|
);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
merge-tools.vimdiff.program="command-arg"
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_layer_override_env() {
|
|
let mut test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
let config_key = "ui.editor";
|
|
|
|
// Environment base
|
|
test_env.add_env_var("EDITOR", "env-base");
|
|
let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="env-base"
|
|
"###);
|
|
|
|
// User
|
|
test_env.add_config(&format!("{config_key} = {value:?}\n", value = "user"));
|
|
let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="user"
|
|
"###);
|
|
|
|
// Repo
|
|
std::fs::write(
|
|
repo_path.join(".jj/repo/config.toml"),
|
|
format!("{config_key} = {value:?}\n", value = "repo"),
|
|
)
|
|
.unwrap();
|
|
let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="repo"
|
|
"###);
|
|
|
|
// Environment override
|
|
test_env.add_env_var("JJ_EDITOR", "env-override");
|
|
let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="env-override"
|
|
"###);
|
|
|
|
// Command argument
|
|
let stdout = test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&[
|
|
"config",
|
|
"list",
|
|
config_key,
|
|
"--config-toml",
|
|
&format!("{config_key}={value:?}", value = "command-arg"),
|
|
],
|
|
);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="command-arg"
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_layer_workspace() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "--git", "main"]);
|
|
let main_path = test_env.env_root().join("main");
|
|
let secondary_path = test_env.env_root().join("secondary");
|
|
let config_key = "ui.editor";
|
|
|
|
std::fs::write(main_path.join("file"), "contents").unwrap();
|
|
test_env.jj_cmd_success(&main_path, &["new"]);
|
|
test_env.jj_cmd_success(
|
|
&main_path,
|
|
&["workspace", "add", "--name", "second", "../secondary"],
|
|
);
|
|
|
|
// Repo
|
|
std::fs::write(
|
|
main_path.join(".jj/repo/config.toml"),
|
|
format!("{config_key} = {value:?}\n", value = "main-repo"),
|
|
)
|
|
.unwrap();
|
|
let stdout = test_env.jj_cmd_success(&main_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="main-repo"
|
|
"###);
|
|
let stdout = test_env.jj_cmd_success(&secondary_path, &["config", "list", config_key]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
ui.editor="main-repo"
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_set_missing_opts() {
|
|
let test_env = TestEnvironment::default();
|
|
let stderr = test_env.jj_cmd_cli_error(test_env.env_root(), &["config", "set"]);
|
|
insta::assert_snapshot!(stderr, @r###"
|
|
error: the following required arguments were not provided:
|
|
<--user|--repo>
|
|
<NAME>
|
|
<VALUE>
|
|
|
|
Usage: jj config set <--user|--repo> <NAME> <VALUE>
|
|
|
|
For more information, try '--help'.
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_set_for_user() {
|
|
let mut test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
// Point to a config file since `config set` can't handle directories.
|
|
let user_config_path = test_env.config_path().join("config.toml");
|
|
test_env.set_config_path(user_config_path.to_owned());
|
|
let repo_path = test_env.env_root().join("repo");
|
|
|
|
test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "set", "--user", "test-key", "test-val"],
|
|
);
|
|
test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "set", "--user", "test-table.foo", "true"],
|
|
);
|
|
|
|
// Ensure test-key successfully written to user config.
|
|
let user_config_toml = std::fs::read_to_string(&user_config_path)
|
|
.unwrap_or_else(|_| panic!("Failed to read file {}", user_config_path.display()));
|
|
insta::assert_snapshot!(user_config_toml, @r###"
|
|
test-key = "test-val"
|
|
|
|
[test-table]
|
|
foo = true
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_set_for_repo() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "set", "--repo", "test-key", "test-val"],
|
|
);
|
|
test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "set", "--repo", "test-table.foo", "true"],
|
|
);
|
|
// Ensure test-key successfully written to user config.
|
|
let expected_repo_config_path = repo_path.join(".jj/repo/config.toml");
|
|
let repo_config_toml =
|
|
std::fs::read_to_string(&expected_repo_config_path).unwrap_or_else(|_| {
|
|
panic!(
|
|
"Failed to read file {}",
|
|
expected_repo_config_path.display()
|
|
)
|
|
});
|
|
insta::assert_snapshot!(repo_config_toml, @r###"
|
|
test-key = "test-val"
|
|
|
|
[test-table]
|
|
foo = true
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_set_type_mismatch() {
|
|
let mut test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let user_config_path = test_env.config_path().join("config.toml");
|
|
test_env.set_config_path(user_config_path);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
|
|
test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "set", "--user", "test-table.foo", "test-val"],
|
|
);
|
|
let stderr = test_env.jj_cmd_failure(
|
|
&repo_path,
|
|
&["config", "set", "--user", "test-table", "not-a-table"],
|
|
);
|
|
insta::assert_snapshot!(stderr, @r###"
|
|
Error: Failed to set test-table: would overwrite entire non-scalar value with scalar
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_set_nontable_parent() {
|
|
let mut test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let user_config_path = test_env.config_path().join("config.toml");
|
|
test_env.set_config_path(user_config_path);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
|
|
test_env.jj_cmd_success(
|
|
&repo_path,
|
|
&["config", "set", "--user", "test-nontable", "test-val"],
|
|
);
|
|
let stderr = test_env.jj_cmd_failure(
|
|
&repo_path,
|
|
&["config", "set", "--user", "test-nontable.foo", "test-val"],
|
|
);
|
|
insta::assert_snapshot!(stderr, @r###"
|
|
Error: Failed to set test-nontable.foo: would overwrite non-table value with parent table
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_edit_missing_opt() {
|
|
let test_env = TestEnvironment::default();
|
|
let stderr = test_env.jj_cmd_cli_error(test_env.env_root(), &["config", "edit"]);
|
|
insta::assert_snapshot!(stderr, @r###"
|
|
error: the following required arguments were not provided:
|
|
<--user|--repo>
|
|
|
|
Usage: jj config edit <--user|--repo>
|
|
|
|
For more information, try '--help'.
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_edit_user() {
|
|
let mut test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
let edit_script = test_env.set_up_fake_editor();
|
|
|
|
std::fs::write(
|
|
edit_script,
|
|
format!("expectpath\n{}", test_env.config_path().to_str().unwrap()),
|
|
)
|
|
.unwrap();
|
|
test_env.jj_cmd_success(&repo_path, &["config", "edit", "--user"]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_edit_repo() {
|
|
let mut test_env = TestEnvironment::default();
|
|
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
|
|
let repo_path = test_env.env_root().join("repo");
|
|
let edit_script = test_env.set_up_fake_editor();
|
|
|
|
std::fs::write(
|
|
edit_script,
|
|
format!(
|
|
"expectpath\n{}",
|
|
repo_path.join(".jj/repo/config.toml").to_str().unwrap()
|
|
),
|
|
)
|
|
.unwrap();
|
|
test_env.jj_cmd_success(&repo_path, &["config", "edit", "--repo"]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_edit_repo_outside_repo() {
|
|
let test_env = TestEnvironment::default();
|
|
let stderr = test_env.jj_cmd_failure(test_env.env_root(), &["config", "edit", "--repo"]);
|
|
insta::assert_snapshot!(stderr, @r###"
|
|
Error: There is no jj repo in "."
|
|
"###);
|
|
}
|
|
|
|
#[test]
|
|
fn test_config_get() {
|
|
let test_env = TestEnvironment::default();
|
|
test_env.add_config(
|
|
r###"
|
|
[table]
|
|
string = "some value 1"
|
|
int = 123
|
|
list = ["list", "value"]
|
|
overridden = "foo"
|
|
"###,
|
|
);
|
|
test_env.add_config(
|
|
r###"
|
|
[table]
|
|
overridden = "bar"
|
|
"###,
|
|
);
|
|
|
|
let stdout = test_env.jj_cmd_failure(test_env.env_root(), &["config", "get", "nonexistent"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
Config error: configuration property "nonexistent" not found
|
|
For help, see https://github.com/martinvonz/jj/blob/main/docs/config.md.
|
|
"###);
|
|
|
|
let stdout = test_env.jj_cmd_success(test_env.env_root(), &["config", "get", "table.string"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
some value 1
|
|
"###);
|
|
|
|
let stdout = test_env.jj_cmd_success(test_env.env_root(), &["config", "get", "table.int"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
123
|
|
"###);
|
|
|
|
let stdout = test_env.jj_cmd_failure(test_env.env_root(), &["config", "get", "table.list"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
Config error: invalid type: sequence, expected a value convertible to a string
|
|
For help, see https://github.com/martinvonz/jj/blob/main/docs/config.md.
|
|
"###);
|
|
|
|
let stdout = test_env.jj_cmd_failure(test_env.env_root(), &["config", "get", "table"]);
|
|
insta::assert_snapshot!(stdout, @r###"
|
|
Config error: invalid type: map, expected a value convertible to a string
|
|
For help, see https://github.com/martinvonz/jj/blob/main/docs/config.md.
|
|
"###);
|
|
|
|
let stdout =
|
|
test_env.jj_cmd_success(test_env.env_root(), &["config", "get", "table.overridden"]);
|
|
insta::assert_snapshot!(stdout, @"bar");
|
|
}
|
|
|
|
fn find_stdout_lines(keyname_pattern: &str, stdout: &str) -> String {
|
|
let key_line_re = Regex::new(&format!(r"(?m)^{keyname_pattern}=.*$")).unwrap();
|
|
key_line_re
|
|
.find_iter(stdout)
|
|
.map(|m| m.as_str())
|
|
.collect_vec()
|
|
.join("\n")
|
|
}
|