From eecd989d4661f48c51f49565422ef11d1c231371 Mon Sep 17 00:00:00 2001 From: Matthew Leeds Date: Fri, 28 Sep 2018 15:36:49 -0700 Subject: [PATCH] ostree/config: Add an "unset" operation Currently there's a way to set a key to the empty string but there's no way to unset it completely (remove the key from the group). This might be helpful for instance if you want to temporarily set "core.lock-timeout-secs" to a specific value for the duration of one operation and then return it to the default after that operation completes. This commit implements an "unset" operation for the config command, adds a unit test, and updates the man page. Closes: #1743 Approved by: cgwalters --- man/ostree-config.xml | 30 +++++++++++++++++++++--- src/ostree/ot-builtin-config.c | 43 +++++++++++++++++++++++++++++++++- tests/test-config.sh | 26 +++++++++++++++++++- 3 files changed, 94 insertions(+), 5 deletions(-) diff --git a/man/ostree-config.xml b/man/ostree-config.xml index dc180b83..f2b41ec1 100644 --- a/man/ostree-config.xml +++ b/man/ostree-config.xml @@ -62,14 +62,37 @@ Boston, MA 02111-1307, USA. ostree config set --group=GROUPNAME KEYNAME VALUE + + ostree config unset SECTIONNAME.KEYNAME + + + ostree config unset --group=GROUPNAME KEYNAME + Description - - Displays or changes a configuration setting. - + + + ostree config get displays the value of + KEYNAME in the group GROUPNAME + (or SECTIONNAME depending on the + syntax used). + + + ostree config set sets the value of + KEYNAME in the group GROUPNAME + to VALUE. + + + ostree config unset removes the key + KEYNAME from the group GROUPNAME + so that OSTree uses the default value for it. It is not an + error for the specified GROUPNAME or + KEYNAME not to exist. + + @@ -77,5 +100,6 @@ Boston, MA 02111-1307, USA. $ ostree config get core.mode bare $ ostree config set --group='remote "myremote"' url http://example.com/repo + $ ostree config unset core.lock-timeout-secs diff --git a/src/ostree/ot-builtin-config.c b/src/ostree/ot-builtin-config.c index 4368f50c..913ed66d 100644 --- a/src/ostree/ot-builtin-config.c +++ b/src/ostree/ot-builtin-config.c @@ -73,7 +73,7 @@ ostree_builtin_config (int argc, char **argv, OstreeCommandInvocation *invocatio g_autofree char *key = NULL; GKeyFile *config = NULL; - context = g_option_context_new ("(get KEY|set KEY VALUE)"); + context = g_option_context_new ("(get KEY|set KEY VALUE|unset KEY)"); if (!ostree_option_context_parse (context, options, &argc, &argv, invocation, &repo, cancellable, error)) goto out; @@ -155,6 +155,47 @@ ostree_builtin_config (int argc, char **argv, OstreeCommandInvocation *invocatio g_print ("%s\n", value); } + else if (!strcmp (op, "unset")) + { + g_autoptr(GError) local_error = NULL; + if (opt_group) + { + if (argc < 3) + { + g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED, + "Group name and key must be specified"); + goto out; + } + section = g_strdup(opt_group); + key = g_strdup(argv[2]); + } + else + { + if (argc < 3) + { + g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED, + "KEY must be specified"); + goto out; + } + section_key = argv[2]; + if (!split_key_string (section_key, §ion, &key, error)) + goto out; + } + + config = ostree_repo_copy_config (repo); + if (!g_key_file_remove_key (config, section, key, &local_error)) + { + if (!g_error_matches (local_error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND) && + !g_error_matches (local_error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_GROUP_NOT_FOUND)) + { + g_propagate_error (error, g_steal_pointer (&local_error)); + goto out; + } + } + + if (local_error == NULL && !ostree_repo_write_config (repo, config, error)) + goto out; + } else { g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED, diff --git a/tests/test-config.sh b/tests/test-config.sh index b1ea3e5e..62f63006 100755 --- a/tests/test-config.sh +++ b/tests/test-config.sh @@ -23,7 +23,7 @@ set -euo pipefail . $(dirname $0)/libtest.sh -echo '1..2' +echo '1..3' ostree_repo_init repo ${CMD_PREFIX} ostree remote add --repo=repo --set=xa.title=Flathub --set=xa.title-is-set=true flathub https://dl.flathub.org/repo/ @@ -53,3 +53,27 @@ assert_file_has_content repo/config "Nightly Flathub" assert_file_has_content repo/config "false" assert_file_has_content repo/config "http://example.com/ostree/" echo "ok config set" + +# Check that "ostree config unset" works +${CMD_PREFIX} ostree config --repo=repo set core.lock-timeout-secs 60 +assert_file_has_content repo/config "lock-timeout-secs=60" +${CMD_PREFIX} ostree config --repo=repo unset core.lock-timeout-secs +assert_not_file_has_content repo/config "lock-timeout-secs=" + +# Check that "ostree config get" errors out on the key +if ${CMD_PREFIX} ostree config --repo=repo get core.lock-timeout-secs 2>err.txt; then + assert_not_reached "ostree config get should not work after unsetting a key" +fi +assert_file_has_content err.txt "error: Key file does not have key “lock-timeout-secs” in group “core”" + +# Check that it's idempotent +${CMD_PREFIX} ostree config --repo=repo unset core.lock-timeout-secs +assert_not_file_has_content repo/config "lock-timeout-secs=" + +# Check that the group doesn't need to exist +${CMD_PREFIX} ostree config --repo=repo unset --group='remote "aoeuhtns"' 'xa.title' + +# Check that the key doesn't need to exist +${CMD_PREFIX} ostree config --repo=repo set --group='remote "aoeuhtns"' 'xa.title-is-set' 'false' +${CMD_PREFIX} ostree config --repo=repo unset --group='remote "aoeuhtns"' 'xa.title' +echo "ok config unset"