Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cluster: fail when no private address can be found #1437

Merged
merged 2 commits into from
Jul 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions cluster/advertise.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ import (
"github.com/pkg/errors"
)

type getPrivateIPFunc func() (string, error)

// This is overriden in unit tests to mock the sockaddr.GetPrivateIP function.
var getPrivateAddress getPrivateIPFunc = sockaddr.GetPrivateIP

// calculateAdvertiseAddress attempts to clone logic from deep within memberlist
// (NetTransport.FinalAdvertiseAddr) in order to surface its conclusions to the
// application, so we can provide more actionable error messages if the user has
Expand All @@ -39,12 +44,12 @@ func calculateAdvertiseAddress(bindAddr, advertiseAddr string) (net.IP, error) {
}

if isAny(bindAddr) {
privateIP, err := sockaddr.GetPrivateIP()
privateIP, err := getPrivateAddress()
if err != nil {
return nil, errors.Wrap(err, "failed to get private IP")
}
if privateIP == "" {
return nil, errors.Wrap(err, "no private IP found, explicit advertise addr not provided")
Copy link
Member Author

Choose a reason for hiding this comment

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

err being nil, errors.Wrap(err, ...) was also nil.

return nil, errors.New("no private IP found, explicit advertise addr not provided")
}
ip := net.ParseIP(privateIP)
if ip == nil {
Expand Down
92 changes: 92 additions & 0 deletions cluster/advertise_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
// Copyright 2018 Prometheus Team
// 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 cluster

import (
"errors"
"net"
"testing"

"github.com/stretchr/testify/require"
)

func TestCalculateAdvertiseAddress(t *testing.T) {
old := getPrivateAddress
defer func() {
getPrivateAddress = old
}()

cases := []struct {
fn getPrivateIPFunc
bind, advertise string

expectedIP net.IP
err bool
}{
{
bind: "192.0.2.1",
advertise: "",

expectedIP: net.ParseIP("192.0.2.1"),
err: false,
},
{
bind: "192.0.2.1",
advertise: "192.0.2.2",

expectedIP: net.ParseIP("192.0.2.2"),
err: false,
},
{
fn: func() (string, error) { return "192.0.2.1", nil },
bind: "0.0.0.0",
advertise: "",

expectedIP: net.ParseIP("192.0.2.1"),
err: false,
},
{
fn: func() (string, error) { return "", errors.New("some error") },
bind: "0.0.0.0",
advertise: "",

err: true,
},
{
fn: func() (string, error) { return "invalid", nil },
bind: "0.0.0.0",
advertise: "",

err: true,
},
{
fn: func() (string, error) { return "", nil },
bind: "0.0.0.0",
advertise: "",

err: true,
},
}

for _, c := range cases {
getPrivateAddress = c.fn
got, err := calculateAdvertiseAddress(c.bind, c.advertise)
if c.err {
require.Error(t, err)
} else {
require.NoError(t, err)
require.Equal(t, c.expectedIP.String(), got.String())
}
}
}