-
Notifications
You must be signed in to change notification settings - Fork 91
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
Make FQDN lookup function more testable #158
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
fa8f827
Make FQDN lookup function more testable
ycombinator 3915f6b
Run goimports
ycombinator 64305ba
Add comment about potential flakiness
ycombinator 2ceb27f
Make error assertion bit more flexible
ycombinator 774c234
More flexibility
ycombinator 86045b2
Forgot the build tags on the test file
ycombinator File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
// Licensed to Elasticsearch B.V. under one or more contributor | ||
// license agreements. See the NOTICE file distributed with | ||
// this work for additional information regarding copyright | ||
// ownership. Elasticsearch B.V. licenses this file to you 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 shared | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestFQDN(t *testing.T) { | ||
tests := map[string]struct { | ||
osHostname string | ||
expectedFQDN string | ||
expectedErr error | ||
}{ | ||
"long_real_hostname": { | ||
osHostname: "elastic.co", | ||
expectedFQDN: "elastic.co", | ||
expectedErr: nil, | ||
}, | ||
"long_nonexistent_hostname": { | ||
osHostname: "foo.bar.elastic.co", | ||
expectedFQDN: "", | ||
expectedErr: makeError("foo.bar.elastic.co"), | ||
}, | ||
"short_nonexistent_hostname": { | ||
osHostname: "foobarbaz", | ||
expectedFQDN: "", | ||
expectedErr: makeError("foobarbaz"), | ||
}, | ||
} | ||
|
||
for name, test := range tests { | ||
t.Run(name, func(t *testing.T) { | ||
actualFQDN, err := fqdn(test.osHostname) | ||
require.Equal(t, test.expectedFQDN, actualFQDN) | ||
|
||
if test.expectedErr == nil { | ||
require.Nil(t, err) | ||
} else { | ||
require.Equal(t, test.expectedErr.Error(), err.Error()) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func makeError(osHostname string) error { | ||
return fmt.Errorf( | ||
"could not get FQDN, all methods failed: "+ | ||
"failed looking up CNAME: lookup %s: no such host: "+ | ||
"failed looking up IP: lookup %s: no such host", | ||
osHostname, | ||
osHostname, | ||
) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will temporary DNS errors cause this test to fail even if the logic is correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it will. Just tested it with my Internet connection turned off.
I'm hoping such network/DNS unavailability errors are extremely rare, though. Perhaps we could add a comment here and remove this test case if it starts proving to be flaky?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a comment is a good idea, it won't necessarily be obvious that this requires an internet connection without context.
I'm fine waiting and seeing if this turns out to be flaky. Anyone testing this code will need to hit the real code path anyway so mocking it out doesn't necessarily help.