Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Use Docker CLI socket from home #2171

Merged
merged 2 commits into from
Jul 22, 2022
Merged

Use Docker CLI socket from home #2171

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f922ff9
Use Docker CLI socket from the User's home directory
p1-0tr Jul 8, 2022
19ac0ad
Switch to using addlicense for copyright header validation
p1-0tr Jul 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions cli/metrics/conn_darwin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
//go:build darwin
// +build darwin

/*
Copyright 2022 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 metrics

import (
"net"
"path/filepath"

"github.com/docker/docker/pkg/homedir"
)

var (
socket = "/var/run/docker-cli.sock"
)

func init() {
// Attempt to retrieve the Docker CLI socket for the current user.
if home := homedir.Get(); home != "" {
socket = filepath.Join(home, "/Library/Containers/com.docker.docker/Data/docker-cli.sock")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should use a shorter Linux-style path in $HOME/.docker/desktop/docker-cli.sock even on Darwin because we've had some problems where the maximum path in the sockaddr is 104 characters (even shorter than Linux's 108 characters). We work around this in some of our binaries by calling os.Chdir("Library/Containers/com.docker.docker") and then using a relative path... but I suspect this trick doesn't work for the CLI because changing the current directory probably breaks something.

WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this is a tough one.

The best thing I can think of from the top of my head is:

pushd ...
connect with relative path
popd

but not sure that would be safe to do.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reflecting on it a bit, I'm not as concerned as I was because the socket is best-effort (and it will work probably 99% of the time). So I'm happy with it as-is.

} // else: On macOS Docker Desktop creates symlinks in /var/run, so fall back to the old default.
overrideSocket() // nop, unless built for e2e testing
}

func conn() (net.Conn, error) {
return net.Dial("unix", socket)
}
5 changes: 3 additions & 2 deletions cli/metrics/conn_e2e.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
//go:build e2e
// +build e2e

/*
Copyright 2020 Docker Compose CLI authors
Copyright 2020, 2022 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.
Expand All @@ -22,7 +23,7 @@ import (
"os"
)

func init() {
func overrideSocket() {
testSocket, defined := os.LookupEnv("TEST_METRICS_SOCKET")
if defined {
socket = testSocket
Expand Down
23 changes: 23 additions & 0 deletions cli/metrics/conn_note2e.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
//go:build !e2e
// +build !e2e

/*
Copyright 2022 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 metrics

func overrideSocket() {
}
22 changes: 18 additions & 4 deletions cli/metrics/conn_other.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// +build !windows
//go:build !windows,!darwin
// +build !windows,!darwin

/*
Copyright 2020 Docker Compose CLI authors
Copyright 2020, 2022 Docker Compose CLI authors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the validation currently doesn't allow for the years to differ between files, so all should have the same years

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah :( I even did a quick google for some more decent copyright header checker, but couldn't find one which does the right thing

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In https://github.com/docker/cli-docs-tool/, we've been trying Google addlicense, which seemed to work (a bit more "loosely" in checking); see docker/cli-docs-tool#4


Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -18,12 +19,25 @@

package metrics

import "net"
import (
"net"
"path/filepath"

"github.com/docker/docker/pkg/homedir"
)

var (
socket = "/var/run/docker-cli.sock"
socket = ""
)

func init() {
// Attempt to retrieve the Docker CLI socket for the current user.
if home := homedir.Get(); home != "" {
socket = filepath.Join(home, ".docker/desktop/docker-cli.sock")
} // else: On Linux we don't expect to have a global CLI socket, so leave it empty and let connections fail.
overrideSocket() // nop, unless built for e2e testing
}

func conn() (net.Conn, error) {
return net.Dial("unix", socket)
}
7 changes: 6 additions & 1 deletion cli/metrics/conn_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
//go:build windows
// +build windows

/*
Copyright 2020 Docker Compose CLI authors
Copyright 2020, 2022 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.
Expand Down Expand Up @@ -30,6 +31,10 @@ var (
socket = `\\.\pipe\docker_cli`
)

func init() {
overrideSocket() // no-op, unless built for e2e testing
}

func conn() (net.Conn, error) {
if strings.HasPrefix(socket, `\\.\pipe\`) {
timeout := 200 * time.Millisecond
Expand Down