-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Fix leak caused by input runners created when checking their configuration #23722
Merged
jsoriano
merged 9 commits into
elastic:master
from
jsoriano:stop-runners-autodiscover-check-config
Feb 2, 2021
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
eba6805
Stop runners created when checking their configuration
jsoriano 18d5e08
Use CheckConfig for individual inputs in filesets
jsoriano 4afe023
Add tests to check that v1 inputs don't leak goroutines on check config
jsoriano bd6d8b5
Merge remote-tracking branch 'origin/master' into stop-runners-autodi…
jsoriano df2bcfe
Rename input testing module to inputtest
jsoriano 7f2131e
Fix license headers
jsoriano 92f11a0
Fix GCP test
jsoriano 526df51
Merge remote-tracking branch 'origin/master' into stop-runners-autodi…
jsoriano 904ec10
Fix error messages
jsoriano 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
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,36 @@ | ||
// 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. | ||
|
||
// +build !integration | ||
|
||
package container | ||
|
||
import ( | ||
"os" | ||
"path" | ||
"testing" | ||
|
||
"github.com/elastic/beats/v7/filebeat/input/inputtest" | ||
"github.com/elastic/beats/v7/libbeat/common" | ||
) | ||
|
||
func TestNewInputDone(t *testing.T) { | ||
config := common.MapStr{ | ||
"paths": path.Join(os.TempDir(), "logs", "*.log"), | ||
} | ||
inputtest.AssertNotStartedInputCanBeDone(t, NewInput, &config) | ||
} |
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,34 @@ | ||
// 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. | ||
|
||
// +build !integration | ||
|
||
package docker | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/elastic/beats/v7/filebeat/input/inputtest" | ||
"github.com/elastic/beats/v7/libbeat/common" | ||
) | ||
|
||
func TestNewInputDone(t *testing.T) { | ||
config := common.MapStr{ | ||
"containers.ids": "fad130edd3d2", | ||
} | ||
inputtest.AssertNotStartedInputCanBeDone(t, NewInput, &config) | ||
} |
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,65 @@ | ||
// 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 inputtest | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
|
||
"github.com/elastic/beats/v7/filebeat/channel" | ||
"github.com/elastic/beats/v7/filebeat/input" | ||
"github.com/elastic/beats/v7/libbeat/beat" | ||
"github.com/elastic/beats/v7/libbeat/common" | ||
"github.com/elastic/beats/v7/libbeat/tests/resources" | ||
) | ||
|
||
// Outlet is an empty outlet for testing. | ||
type Outlet struct{} | ||
|
||
func (o Outlet) OnEvent(event beat.Event) bool { return true } | ||
func (o Outlet) Close() error { return nil } | ||
func (o Outlet) Done() <-chan struct{} { return nil } | ||
|
||
// Connector is a connector to a test empty outlet. | ||
var Connector = channel.ConnectorFunc( | ||
func(_ *common.Config, _ beat.ClientConfig) (channel.Outleter, error) { | ||
return Outlet{}, nil | ||
}, | ||
) | ||
|
||
// AssertNotStartedInputCanBeDone checks that the context of an input can be | ||
// done before starting the input, and it doesn't leak goroutines. This is | ||
// important to confirm that leaks don't happen with CheckConfig. | ||
func AssertNotStartedInputCanBeDone(t *testing.T, factory input.Factory, configMap *common.MapStr) { | ||
goroutines := resources.NewGoroutinesChecker() | ||
defer goroutines.Check(t) | ||
|
||
config, err := common.NewConfigFrom(configMap) | ||
require.NoError(t, err) | ||
|
||
context := input.Context{ | ||
Done: make(chan struct{}), | ||
} | ||
|
||
_, err = factory(config, Connector, context) | ||
assert.NoError(t, err) | ||
|
||
close(context.Done) | ||
} |
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,36 @@ | ||
// 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. | ||
|
||
// +build !integration | ||
|
||
package kafka | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/elastic/beats/v7/filebeat/input/inputtest" | ||
"github.com/elastic/beats/v7/libbeat/common" | ||
) | ||
|
||
func TestNewInputDone(t *testing.T) { | ||
config := common.MapStr{ | ||
"hosts": "localhost:9092", | ||
"topics": "messages", | ||
"group_id": "filebeat", | ||
} | ||
inputtest.AssertNotStartedInputCanBeDone(t, NewInput, &config) | ||
} |
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
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,34 @@ | ||
// 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. | ||
|
||
// +build !integration | ||
|
||
package redis | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/elastic/beats/v7/filebeat/input/inputtest" | ||
"github.com/elastic/beats/v7/libbeat/common" | ||
) | ||
|
||
func TestNewInputDone(t *testing.T) { | ||
config := common.MapStr{ | ||
"hosts": "localhost:3679", | ||
} | ||
inputtest.AssertNotStartedInputCanBeDone(t, NewInput, &config) | ||
} |
Oops, something went wrong.
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.
It would be nice to have some "support" in order to create more extensive tests. e.g.
e.g. the callback can be used to 'record' events in unit tests in order to validate them afterwards.
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.
+1, but we wouldn't be using these features here by now, wdyt about adding them when there is a use case?