forked from elastic/beats
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add tests for fileProspector in filestream input (elastic#21712)
## What does this PR do? This PR adds tests to see how `fileProspector` handles Create, Write and Delete operations. In order to make the `Prospector` testable I changed `HarvesterGroup` an interface so it can be mocked During the testing an issue with path identifier showed up when a file was deleted. The identifier generated an incorrect value for `Name`. Now it is fixed.
- Loading branch information
Showing
6 changed files
with
218 additions
and
14 deletions.
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
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,197 @@ | ||
| // 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 filestream | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| loginp "github.com/elastic/beats/v7/filebeat/input/filestream/internal/input-logfile" | ||
| input "github.com/elastic/beats/v7/filebeat/input/v2" | ||
| "github.com/elastic/beats/v7/libbeat/logp" | ||
| "github.com/elastic/beats/v7/libbeat/statestore" | ||
| "github.com/elastic/beats/v7/libbeat/statestore/storetest" | ||
| "github.com/elastic/go-concert/unison" | ||
| ) | ||
|
|
||
| func TestProspectorNewAndUpdatedFiles(t *testing.T) { | ||
| minuteAgo := time.Now().Add(-1 * time.Minute) | ||
|
|
||
| testCases := map[string]struct { | ||
| events []loginp.FSEvent | ||
| ignoreOlder time.Duration | ||
| expectedSources []string | ||
| }{ | ||
| "two new files": { | ||
| events: []loginp.FSEvent{ | ||
| loginp.FSEvent{Op: loginp.OpCreate, NewPath: "/path/to/file"}, | ||
| loginp.FSEvent{Op: loginp.OpCreate, NewPath: "/path/to/other/file"}, | ||
| }, | ||
| expectedSources: []string{"filestream::path::/path/to/file", "filestream::path::/path/to/other/file"}, | ||
| }, | ||
| "one updated file": { | ||
| events: []loginp.FSEvent{ | ||
| loginp.FSEvent{Op: loginp.OpWrite, NewPath: "/path/to/file"}, | ||
| }, | ||
| expectedSources: []string{"filestream::path::/path/to/file"}, | ||
| }, | ||
| "old files with ignore older configured": { | ||
| events: []loginp.FSEvent{ | ||
| loginp.FSEvent{ | ||
| Op: loginp.OpCreate, | ||
| NewPath: "/path/to/file", | ||
| Info: testFileInfo{"/path/to/file", 5, minuteAgo}, | ||
| }, | ||
| loginp.FSEvent{ | ||
| Op: loginp.OpWrite, | ||
| NewPath: "/path/to/other/file", | ||
| Info: testFileInfo{"/path/to/other/file", 5, minuteAgo}, | ||
| }, | ||
| }, | ||
| ignoreOlder: 10 * time.Second, | ||
| expectedSources: []string{}, | ||
| }, | ||
| "newer files with ignore older": { | ||
| events: []loginp.FSEvent{ | ||
| loginp.FSEvent{ | ||
| Op: loginp.OpCreate, | ||
| NewPath: "/path/to/file", | ||
| Info: testFileInfo{"/path/to/file", 5, minuteAgo}, | ||
| }, | ||
| loginp.FSEvent{ | ||
| Op: loginp.OpWrite, | ||
| NewPath: "/path/to/other/file", | ||
| Info: testFileInfo{"/path/to/other/file", 5, minuteAgo}, | ||
| }, | ||
| }, | ||
| ignoreOlder: 5 * time.Minute, | ||
| expectedSources: []string{"filestream::path::/path/to/file", "filestream::path::/path/to/other/file"}, | ||
| }, | ||
| } | ||
|
|
||
| for name, test := range testCases { | ||
| test := test | ||
|
|
||
| t.Run(name, func(t *testing.T) { | ||
| p := fileProspector{ | ||
| filewatcher: &mockFileWatcher{events: test.events}, | ||
| identifier: mustPathIdentifier(), | ||
| ignoreOlder: test.ignoreOlder, | ||
| } | ||
| ctx := input.Context{Logger: logp.L(), Cancelation: context.Background()} | ||
| hg := getTestHarvesterGroup() | ||
|
|
||
| p.Run(ctx, testStateStore(), hg) | ||
|
|
||
| assert.ElementsMatch(t, hg.encounteredNames, test.expectedSources) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestProspectorDeletedFile(t *testing.T) { | ||
| testCases := map[string]struct { | ||
| events []loginp.FSEvent | ||
| cleanRemoved bool | ||
| }{ | ||
| "one deleted file without clean removed": { | ||
| events: []loginp.FSEvent{ | ||
| loginp.FSEvent{Op: loginp.OpDelete, OldPath: "/path/to/file"}, | ||
| }, | ||
| cleanRemoved: false, | ||
| }, | ||
| "one deleted file with clean removed": { | ||
| events: []loginp.FSEvent{ | ||
| loginp.FSEvent{Op: loginp.OpDelete, OldPath: "/path/to/file"}, | ||
| }, | ||
| cleanRemoved: true, | ||
| }, | ||
| } | ||
|
|
||
| for name, test := range testCases { | ||
| test := test | ||
|
|
||
| t.Run(name, func(t *testing.T) { | ||
| p := fileProspector{ | ||
| filewatcher: &mockFileWatcher{events: test.events}, | ||
| identifier: mustPathIdentifier(), | ||
| cleanRemoved: test.cleanRemoved, | ||
| } | ||
| ctx := input.Context{Logger: logp.L(), Cancelation: context.Background()} | ||
|
|
||
| testStore := testStateStore() | ||
| testStore.Set("filestream::path::/path/to/file", nil) | ||
|
|
||
| p.Run(ctx, testStore, getTestHarvesterGroup()) | ||
|
|
||
| has, err := testStore.Has("filestream::path::/path/to/file") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| if test.cleanRemoved { | ||
| assert.False(t, has) | ||
| } else { | ||
| assert.True(t, has) | ||
|
|
||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| type testHarvesterGroup struct { | ||
| encounteredNames []string | ||
| } | ||
|
|
||
| func getTestHarvesterGroup() *testHarvesterGroup { return &testHarvesterGroup{make([]string, 0)} } | ||
|
|
||
| func (t *testHarvesterGroup) Run(_ input.Context, s loginp.Source) error { | ||
| t.encounteredNames = append(t.encounteredNames, s.Name()) | ||
| return nil | ||
| } | ||
|
|
||
| type mockFileWatcher struct { | ||
| nextIdx int | ||
| events []loginp.FSEvent | ||
| } | ||
|
|
||
| func (m *mockFileWatcher) Event() loginp.FSEvent { | ||
| if len(m.events) == m.nextIdx { | ||
| return loginp.FSEvent{} | ||
| } | ||
| evt := m.events[m.nextIdx] | ||
| m.nextIdx++ | ||
| return evt | ||
| } | ||
| func (m *mockFileWatcher) Run(_ unison.Canceler) { return } | ||
|
|
||
| func testStateStore() *statestore.Store { | ||
| s, _ := statestore.NewRegistry(storetest.NewMemoryStoreBackend()).Get(pluginName) | ||
| return s | ||
| } | ||
|
|
||
| func mustPathIdentifier() fileIdentifier { | ||
| pathIdentifier, err := newPathIdentifier(nil) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return pathIdentifier | ||
|
|
||
| } |