"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
Go azure-blobazure-blob-storageazure-filesbackblaze-b2cloud-storagedropboxencryptionftpfuse-filesystemgogolanggoogle-cloud-storagegoogle-driveonedriveopenstack-swiftrclones3sftpsyncwebdav
fs: fix command line flag being ignored when set to its default value
Nick Craig-Wood105feca22bae
diff --git a/fs/config/flags/flags.go b/fs/config/flags/flags.goindex 912c0b2d6..5e96483e8 100644--- a/fs/config/flags/flags.go+++ b/fs/config/flags/flags.go@@ -168,6 +168,12 @@ func installFlag(flags *pflag.FlagSet, name string, groupsString string) {}fs.Debugf(nil, "Setting --%s %q from environment variable %s=%q", name, flag.Value, envKey, envValue)flag.DefValue = envValue+ // This is a default from the environment, not an explicit+ // flag on the command line, so don't let it take precedence+ // over more specific configuration sources.+ if isOption {+ opt.MarkUnset()+ }}}diff --git a/fs/configmap.go b/fs/configmap.goindex 6f5ba5d52..7711f76b2 100644--- a/fs/configmap.go+++ b/fs/configmap.go@@ -64,7 +64,11 @@ type regInfoValues struct {// the default valuesfunc (r *regInfoValues) Get(key string) (value string, ok bool) {opt := r.options.Get(key)- if opt != nil && (r.useDefault || !opt.IsDefault()) {+ // Return the value if it was explicitly set (e.g. a flag on the+ // command line, even when equal to the default) or if it differs+ // from the default (e.g. loaded from the environment as a flag+ // default by installFlag).+ if opt != nil && (r.useDefault || opt.IsSet() || !opt.IsDefault()) {return opt.String(), true}return "", falsediff --git a/fs/registry.go b/fs/registry.goindex 59e82936c..a11c57d22 100644--- a/fs/registry.go+++ b/fs/registry.go@@ -229,6 +229,7 @@ type Option struct {Provider string `json:",omitempty"` // set to filter on providerDefault any // default value, nil => "", if set (and not to nil or "") then Required does nothingValue any // value to be set by flags+ set bool // true once Set has been called, so an explicit value equal to Default is still honoured over the config fileExamples OptionExamples `json:",omitempty"` // predefined values that can be selected from list (multiple-choice option)ShortOpt string `json:",omitempty"` // the short option for this if requiredHide OptionVisibility // set this to hide the config from the configurator or the command line@@ -327,6 +328,7 @@ func (o *Option) Set(s string) (err error) {stringArray = []string{}}o.Value = append(stringArray, s)+ o.set = truereturn nil}newValue, err := configstruct.StringToInterface(v, s)@@ -334,9 +336,27 @@ func (o *Option) Set(s string) (err error) {return err}o.Value = newValue+ o.set = truereturn nil}+// IsSet returns true if Set has been called on the option, for example+// when its flag was provided on the command line. Unlike IsDefault this+// is true even when the value supplied is equal to the default.+func (o *Option) IsSet() bool {+ return o.set+}++// MarkUnset marks the option as not having been set explicitly.+//+// It is used after a value has been loaded from the environment as a+// flag default, so that the value is treated like a default rather than+// an explicit command line flag and more specific configuration sources+// still take precedence over it.+func (o *Option) MarkUnset() {+ o.set = false+}+type typer interface {Type() string}diff --git a/fs/registry_test.go b/fs/registry_test.goindex 593049c38..1f8ec58b0 100644--- a/fs/registry_test.go+++ b/fs/registry_test.go@@ -45,9 +45,31 @@ var (Name: "case_insensitive",Default: false,Value: true,+ set: true, // set as if from a flagAdvanced: true,}- testOptions = Options{nouncOption, copyLinksOption, caseInsensitiveOption}+ // setToDefaultOption has been set explicitly to a value which+ // happens to equal its default - it must still override the config+ setToDefaultOption = Option{+ Name: "set_to_default",+ Default: "deflt",+ Value: "deflt",+ set: true,+ }+ // envDefaultOption has had a value loaded as a default from the+ // environment (so set is false). It is only honoured over more+ // specific sources when it differs from the default.+ envDefaultOption = Option{+ Name: "env_default",+ Default: "deflt",+ Value: "deflt", // equal to default, so must not be surfaced+ }+ envDefaultDiffOption = Option{+ Name: "env_default_diff",+ Default: "deflt",+ Value: "fromenv", // differs from default, so must be surfaced+ }+ testOptions = Options{nouncOption, copyLinksOption, caseInsensitiveOption, setToDefaultOption, envDefaultOption, envDefaultDiffOption})func TestOptionsSetValues(t *testing.T) {@@ -266,6 +288,9 @@ func TestOptionGetters(t *testing.T) {{regInfoValuesGetterFalse, "not_found", "", false},{regInfoValuesGetterFalse, "case_insensitive", "true", true},{regInfoValuesGetterFalse, "copy_links", "", false},+ {regInfoValuesGetterFalse, "set_to_default", "deflt", true},+ {regInfoValuesGetterFalse, "env_default", "", false},+ {regInfoValuesGetterFalse, "env_default_diff", "fromenv", true},{regInfoValuesGetterTrue, "not_found", "", false},{regInfoValuesGetterTrue, "case_insensitive", "true", true},{regInfoValuesGetterTrue, "copy_links", "false", true},