chore: manage CLI Hints enable/disable behaviour

- cliHints entry in config.json
- if not present, enabled by default
- can be overridden by the DOCKER_CLI_HINTS environment variable

Signed-off-by: Yves Brissaud <yves.brissaud@docker.com>

Author: eunomie

api/config/config.go

@@ -101,4 +101,5 @@ func configFilePath(dir string) string {
 // File contains the current context from the docker configuration file
 type File struct {
 	CurrentContext string `json:"currentContext,omitempty"`
+	CliHints       *bool  `json:"cliHints,omitempty"`
 }

cli/mobycli/cli_hints.go

@@ -0,0 +1,48 @@
+/*
+   Copyright 2020 Docker Compose CLI 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
+
+       http://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.
+*/
+
+package mobycli
+
+import (
+	"os"
+	"strconv"
+
+	"github.com/docker/compose-cli/api/config"
+)
+
+const (
+	cliHintsEnvVarName       = "DOCKER_CLI_HINTS"
+	cliHintsDefaultBehaviour = true
+)
+
+func CliHintsEnabled() bool {
+	if envValue, ok := os.LookupEnv(cliHintsEnvVarName); ok {
+		if enabled, err := strconv.ParseBool(envValue); err == nil {
+			return enabled
+		}
+	}
+
+	conf, err := config.LoadFile(config.Dir())
+	if err != nil {
+		// can't read the config file, use the default behaviour
+		return cliHintsDefaultBehaviour
+	}
+	if conf.CliHints != nil {
+		return *conf.CliHints
+	}
+
+	return cliHintsDefaultBehaviour
+}

cli/mobycli/cli_hints_test.go

@@ -0,0 +1,128 @@
+/*
+   Copyright 2020 Docker Compose CLI 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
+
+       http://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.
+*/
+
+package mobycli
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/docker/compose-cli/api/config"
+
+	"gotest.tools/v3/assert"
+)
+
+func TestCliHintsEnabled(t *testing.T) {
+	testCases := []struct {
+		name     string
+		setup    func()
+		expected bool
+	}{
+		{
+			"enabled by default",
+			func() {},
+			true,
+		},
+		{
+			"handle true value",
+			func() {
+				t.Setenv(cliHintsEnvVarName, "t")
+			},
+			true,
+		},
+		{
+			"handle false value",
+			func() {
+				t.Setenv(cliHintsEnvVarName, "FALSE")
+			},
+			false,
+		},
+		{
+			"handle error",
+			func() {
+				t.Setenv(cliHintsEnvVarName, "123")
+			},
+			true,
+		},
+		{
+			"enabled in config file",
+			func() {
+				d := testConfigDir(t)
+				writeSampleConfig(t, d, configEnabled)
+			},
+			true,
+		},
+		{
+			"disabled in config file",
+			func() {
+				d := testConfigDir(t)
+				writeSampleConfig(t, d, configDisabled)
+			},
+			false,
+		},
+		{
+			"enabled in config file but disabled by env var",
+			func() {
+				d := testConfigDir(t)
+				writeSampleConfig(t, d, configEnabled)
+				t.Setenv(cliHintsEnvVarName, "FALSE")
+			},
+			false,
+		},
+		{
+			"disabled in config file but enabled by env var",
+			func() {
+				d := testConfigDir(t)
+				writeSampleConfig(t, d, configDisabled)
+				t.Setenv(cliHintsEnvVarName, "true")
+			},
+			true,
+		},
+	}
+
+	for _, testCase := range testCases {
+		tc := testCase
+		t.Run(tc.name, func(t *testing.T) {
+			tc.setup()
+			assert.Equal(t, CliHintsEnabled(), tc.expected)
+		})
+	}
+}
+
+func testConfigDir(t *testing.T) string {
+	dir := config.Dir()
+	d, _ := os.MkdirTemp("", "")
+	config.WithDir(d)
+	t.Cleanup(func() {
+		_ = os.RemoveAll(d)
+		config.WithDir(dir)
+	})
+	return d
+}
+
+func writeSampleConfig(t *testing.T, d string, conf []byte) {
+	err := os.WriteFile(filepath.Join(d, config.ConfigFileName), conf, 0644)
+	assert.NilError(t, err)
+}
+
+var configEnabled = []byte(`{
+	"cliHints": true
+}`)
+
+var configDisabled = []byte(`{
+	"cliHints": false
+}`)

cli/mobycli/scout_suggest.go

@@ -19,23 +19,13 @@ package mobycli
 import (
 	"fmt"
 	"os"
-	"strconv"
 	"strings"
 
 	"github.com/docker/compose/v2/pkg/utils"
 
 	"github.com/fatih/color"
 )
 
-const (
-	scoutHintEnvVarName = "DOCKER_SCOUT_HINTS"
-)
-
-func isDockerScoutHintsEnabled() bool {
-	enabled, err := strconv.ParseBool(os.Getenv(scoutHintEnvVarName))
-	return err != nil || enabled
-}
-
 func displayScoutQuickViewSuggestMsgOnPull(args []string) {
 	image := pulledImageFromArgs(args)
 	displayScoutQuickViewSuggestMsg(image)
@@ -52,7 +42,7 @@ func displayScoutQuickViewSuggestMsgOnBuild(args []string) {
 }
 
 func displayScoutQuickViewSuggestMsg(image string) {
-	if !isDockerScoutHintsEnabled() {
+	if !CliHintsEnabled() {
 		return
 	}
 	if len(image) > 0 {