tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-04-08 17:05:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request from gtardif/help_metrics

Browse Source 
Collect metrics --help flag
This commit is contained in:
Guillaume Tardif 2020-11-13 15:10:26 +01:00 committed by GitHub
commit 0ae42dea04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 45 additions and 33 deletions

1
metrics/commands.go

@ -23,6 +23,7 @@ var commandFlags = []string{
// Generated with generatecommands/main.go
var managementCommands = []string{
"help",
"ecs",
"scan",
"app",

1
metrics/generatecommands/main.go

@ -35,6 +35,7 @@ func main() {
fmt.Printf(`
var managementCommands = []string{
"help",
"%s",
}

13
metrics/metrics.go

@ -17,6 +17,8 @@
package metrics
import (
"strings"
"github.com/docker/compose-cli/utils"
)
@ -52,18 +54,15 @@ func GetCommand(args []string) string {
onlyFlags := false
for _, arg := range args {
if arg == "--help" {
return ""
result = strings.TrimSpace(arg + " " + result)
continue
}
if arg == "--" {
break
}
if isCommandFlag(arg) || (!onlyFlags && isCommand(arg)) {
if result == "" {
result = arg
} else {
result = result + " " + arg
}
if !isManagementCommand(arg) {
result = strings.TrimSpace(result + " " + arg)
if isCommand(arg) && !isManagementCommand(arg) {
onlyFlags = true
}
}

27
metrics/metrics_test.go

@ -153,26 +153,31 @@ func TestGetCommand(t *testing.T) {
}
}
func TestIgnoreHelpCommands(t *testing.T) {
func TestKeepHelpCommands(t *testing.T) {
testCases := []struct {
name string
args []string
expected string
}{
{
name: "help",
args: []string{"--help"},
expected: "",
},
{
name: "help on run",
name: "run with help flag",
args: []string{"run", "--help"},
expected: "",
expected: "--help run",
},
{
name: "help on compose up",
args: []string{"compose", "up", "--help"},
expected: "",
name: "with help flag before-after commands",
args: []string{"compose", "--help", "up"},
expected: "--help compose up",
},
{
name: "help flag",
args: []string{"--help"},
expected: "--help",
},
{
name: "help commands",
args: []string{"help", "run"},
expected: "help run",
},
}

36
tests/e2e/e2e_test.go

@ -161,15 +161,19 @@ func TestContextMetrics(t *testing.T) {
s.Start()
defer s.Stop()
t.Run("do not send metrics on help commands", func(t *testing.T) {
t.Run("send metrics on help commands", func(t *testing.T) {
s.ResetUsage()
c.RunDockerCmd("help", "run")
c.RunDockerCmd("--help")
c.RunDockerCmd("ps", "--help")
c.RunDockerCmd("run", "--help")
usage := s.GetUsage()
assert.Equal(t, 0, len(usage))
assert.DeepEqual(t, []string{
`{"command":"help run","context":"moby","source":"cli","status":"success"}`,
`{"command":"--help","context":"moby","source":"cli","status":"success"}`,
`{"command":"--help run","context":"moby","source":"cli","status":"success"}`,
}, usage)
})
t.Run("metrics on default context", func(t *testing.T) {
@ -180,10 +184,11 @@ func TestContextMetrics(t *testing.T) {
c.RunDockerOrExitError("version", "--xxx")
usage := s.GetUsage()
assert.Equal(t, 3, len(usage))
assert.Equal(t, `{"command":"ps","context":"moby","source":"cli","status":"success"}`, usage[0])
assert.Equal(t, `{"command":"version","context":"moby","source":"cli","status":"success"}`, usage[1])
assert.Equal(t, `{"command":"version","context":"moby","source":"cli","status":"failure"}`, usage[2])
assert.DeepEqual(t, []string{
`{"command":"ps","context":"moby","source":"cli","status":"success"}`,
`{"command":"version","context":"moby","source":"cli","status":"success"}`,
`{"command":"version","context":"moby","source":"cli","status":"failure"}`,
}, usage)
})
t.Run("metrics on other context type", func(t *testing.T) {
@ -198,14 +203,15 @@ func TestContextMetrics(t *testing.T) {
c.RunDockerCmd("--context", "test-example", "ps")
usage := s.GetUsage()
assert.Equal(t, 7, len(usage))
assert.Equal(t, `{"command":"context create","context":"moby","source":"cli","status":"success"}`, usage[0])
assert.Equal(t, `{"command":"ps","context":"moby","source":"cli","status":"success"}`, usage[1])
assert.Equal(t, `{"command":"context use","context":"moby","source":"cli","status":"success"}`, usage[2])
assert.Equal(t, `{"command":"ps","context":"example","source":"cli","status":"success"}`, usage[3])
assert.Equal(t, `{"command":"stop","context":"example","source":"cli","status":"failure"}`, usage[4])
assert.Equal(t, `{"command":"context use","context":"example","source":"cli","status":"success"}`, usage[5])
assert.Equal(t, `{"command":"ps","context":"example","source":"cli","status":"success"}`, usage[6])
assert.DeepEqual(t, []string{
`{"command":"context create","context":"moby","source":"cli","status":"success"}`,
`{"command":"ps","context":"moby","source":"cli","status":"success"}`,
`{"command":"context use","context":"moby","source":"cli","status":"success"}`,
`{"command":"ps","context":"example","source":"cli","status":"success"}`,
`{"command":"stop","context":"example","source":"cli","status":"failure"}`,
`{"command":"context use","context":"example","source":"cli","status":"success"}`,
`{"command":"ps","context":"example","source":"cli","status":"success"}`,
}, usage)
})
}