Move util to specific package location
This commit is contained in:
Ricardo Pchevuzinske Katz
parent
0cc43d5e52
commit
7304086202
11 changed files with 13 additions and 17 deletions
99
pkg/util/file/file_watcher.go
Normal file
99
pkg/util/file/file_watcher.go
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
/*
|
||||
Copyright 2016 The Kubernetes 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 file
|
||||
|
||||
import (
|
||||
"log"
|
||||
"os"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/fsnotify/fsnotify"
|
||||
)
|
||||
|
||||
// FileWatcher is an interface we use to watch changes in files
|
||||
type FileWatcher interface {
|
||||
Close() error
|
||||
}
|
||||
|
||||
// OSFileWatcher defines a watch over a file
|
||||
type OSFileWatcher struct {
|
||||
file string
|
||||
watcher *fsnotify.Watcher
|
||||
// onEvent callback to be invoked after the file being watched changes
|
||||
onEvent func()
|
||||
}
|
||||
|
||||
// NewFileWatcher creates a new FileWatcher
|
||||
func NewFileWatcher(file string, onEvent func()) (FileWatcher, error) {
|
||||
fw := OSFileWatcher{
|
||||
file: file,
|
||||
onEvent: onEvent,
|
||||
}
|
||||
err := fw.watch()
|
||||
return fw, err
|
||||
}
|
||||
|
||||
// Close ends the watch
|
||||
func (f OSFileWatcher) Close() error {
|
||||
return f.watcher.Close()
|
||||
}
|
||||
|
||||
// watch creates a fsnotify watcher for a file and create of write events
|
||||
func (f *OSFileWatcher) watch() error {
|
||||
watcher, err := fsnotify.NewWatcher()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
f.watcher = watcher
|
||||
|
||||
realFile, err := filepath.EvalSymlinks(f.file)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
dir, file := path.Split(f.file)
|
||||
go func(file string) {
|
||||
for {
|
||||
select {
|
||||
case event := <-watcher.Events:
|
||||
if event.Op&fsnotify.Create == fsnotify.Create ||
|
||||
event.Op&fsnotify.Write == fsnotify.Write {
|
||||
if finfo, err := os.Lstat(event.Name); err != nil {
|
||||
log.Printf("can not lstat file: %v\n", err)
|
||||
} else if finfo.Mode()&os.ModeSymlink != 0 {
|
||||
if currentRealFile, err := filepath.EvalSymlinks(f.file); err == nil &&
|
||||
currentRealFile != realFile {
|
||||
f.onEvent()
|
||||
realFile = currentRealFile
|
||||
}
|
||||
continue
|
||||
}
|
||||
if strings.HasSuffix(event.Name, file) {
|
||||
f.onEvent()
|
||||
}
|
||||
}
|
||||
case err := <-watcher.Errors:
|
||||
if err != nil {
|
||||
log.Printf("error watching file: %v\n", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
}(file)
|
||||
return watcher.Add(dir)
|
||||
}
|
||||
138
pkg/util/file/file_watcher_test.go
Normal file
138
pkg/util/file/file_watcher_test.go
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
/*
|
||||
Copyright 2015 The Kubernetes 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 file
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func prepareTimeout() chan bool {
|
||||
timeoutChan := make(chan bool, 1)
|
||||
go func() {
|
||||
time.Sleep(500 * time.Millisecond)
|
||||
timeoutChan <- true
|
||||
}()
|
||||
return timeoutChan
|
||||
}
|
||||
|
||||
func TestFileWatcher(t *testing.T) {
|
||||
f, err := os.CreateTemp("", "fw")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer f.Close()
|
||||
defer os.Remove(f.Name())
|
||||
count := 0
|
||||
events := make(chan bool, 10)
|
||||
fw, err := NewFileWatcher(f.Name(), func() {
|
||||
count++
|
||||
if count != 1 {
|
||||
t.Fatalf("expected 1 but returned %v", count)
|
||||
}
|
||||
events <- true
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer fw.Close()
|
||||
timeoutChan := prepareTimeout()
|
||||
select {
|
||||
case <-events:
|
||||
t.Fatalf("expected no events before writing a file")
|
||||
case <-timeoutChan:
|
||||
}
|
||||
os.WriteFile(f.Name(), []byte{}, ReadWriteByUser)
|
||||
select {
|
||||
case <-events:
|
||||
case <-timeoutChan:
|
||||
t.Fatalf("expected an event shortly after writing a file")
|
||||
}
|
||||
}
|
||||
|
||||
func TestFileWatcherWithNestedSymlink(t *testing.T) {
|
||||
target1, err := os.CreateTemp("", "t1")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer target1.Close()
|
||||
defer os.Remove(target1.Name())
|
||||
dir := path.Dir(target1.Name())
|
||||
|
||||
innerLink := path.Join(dir, "innerLink")
|
||||
if err = os.Symlink(target1.Name(), innerLink); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer os.Remove(innerLink)
|
||||
mainLink := path.Join(dir, "mainLink")
|
||||
if err = os.Symlink(innerLink, mainLink); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer os.Remove(mainLink)
|
||||
|
||||
targetName, err := filepath.EvalSymlinks(mainLink)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if targetName != target1.Name() {
|
||||
t.Fatalf("expected symlink to point to %v, not %v", target1.Name(), targetName)
|
||||
}
|
||||
|
||||
count := 0
|
||||
events := make(chan bool, 10)
|
||||
fw, err := NewFileWatcher(mainLink, func() {
|
||||
count++
|
||||
if count != 1 {
|
||||
t.Fatalf("expected 1 but returned %v", count)
|
||||
}
|
||||
if targetName, err = filepath.EvalSymlinks(mainLink); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
events <- true
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer fw.Close()
|
||||
|
||||
target2, err := os.CreateTemp("", "t2")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
defer target2.Close()
|
||||
defer os.Remove(target2.Name())
|
||||
|
||||
if err = os.Remove(innerLink); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if err = os.Symlink(target2.Name(), innerLink); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
timeoutChan := prepareTimeout()
|
||||
select {
|
||||
case <-events:
|
||||
case <-timeoutChan:
|
||||
t.Fatalf("expected an event shortly after creating a file and relinking")
|
||||
}
|
||||
if targetName != target2.Name() {
|
||||
t.Fatalf("expected symlink to point to %v, not %v", target2.Name(), targetName)
|
||||
}
|
||||
}
|
||||
102
pkg/util/sets/match.go
Normal file
102
pkg/util/sets/match.go
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
/*
|
||||
Copyright 2019 The Kubernetes 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 sets
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
)
|
||||
|
||||
type equalFunction func(e1, e2 interface{}) bool
|
||||
|
||||
// Compare checks if the parameters are iterable and contains the same elements
|
||||
func Compare(listA, listB interface{}, eq equalFunction) bool {
|
||||
ok := isIterable(listA)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
|
||||
ok = isIterable(listB)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
|
||||
a := reflect.ValueOf(listA)
|
||||
b := reflect.ValueOf(listB)
|
||||
|
||||
if a.IsNil() && b.IsNil() {
|
||||
return true
|
||||
}
|
||||
|
||||
if a.IsNil() != b.IsNil() {
|
||||
return false
|
||||
}
|
||||
|
||||
if a.Len() != b.Len() {
|
||||
return false
|
||||
}
|
||||
|
||||
visited := make([]bool, b.Len())
|
||||
|
||||
for i := 0; i < a.Len(); i++ {
|
||||
found := false
|
||||
for j := 0; j < b.Len(); j++ {
|
||||
if visited[j] {
|
||||
continue
|
||||
}
|
||||
|
||||
if eq(a.Index(i).Interface(), b.Index(j).Interface()) {
|
||||
visited[j] = true
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !found {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
var compareStrings = func(e1, e2 interface{}) bool {
|
||||
s1, ok := e1.(string)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
|
||||
s2, ok := e2.(string)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
|
||||
return s1 == s2
|
||||
}
|
||||
|
||||
// StringElementsMatch compares two string slices and returns if are equals
|
||||
func StringElementsMatch(a, b []string) bool {
|
||||
return Compare(a, b, compareStrings)
|
||||
}
|
||||
|
||||
func isIterable(obj interface{}) bool {
|
||||
switch reflect.TypeOf(obj).Kind() {
|
||||
case reflect.Slice, reflect.Array:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
60
pkg/util/sets/match_test.go
Normal file
60
pkg/util/sets/match_test.go
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
/*
|
||||
Copyright 2019 The Kubernetes 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 sets
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
var (
|
||||
testCasesElementMatch = []struct {
|
||||
listA []string
|
||||
listB []string
|
||||
expected bool
|
||||
}{
|
||||
{nil, nil, true},
|
||||
{[]string{"1"}, nil, false},
|
||||
{[]string{"1"}, []string{"1"}, true},
|
||||
{[]string{"1", "2", "1"}, []string{"1", "1", "2"}, true},
|
||||
{[]string{"1", "3", "1"}, []string{"1", "1", "2"}, false},
|
||||
{[]string{"1", "1"}, []string{"1", "2"}, false},
|
||||
}
|
||||
)
|
||||
|
||||
func TestElementsMatch(t *testing.T) {
|
||||
|
||||
for _, testCase := range testCasesElementMatch {
|
||||
result := StringElementsMatch(testCase.listA, testCase.listB)
|
||||
if result != testCase.expected {
|
||||
t.Errorf("expected %v but returned %v (%v - %v)", testCase.expected, result, testCase.listA, testCase.listB)
|
||||
}
|
||||
|
||||
sameResult := StringElementsMatch(testCase.listB, testCase.listA)
|
||||
if sameResult != testCase.expected {
|
||||
t.Errorf("expected %v but returned %v (%v - %v)", testCase.expected, sameResult, testCase.listA, testCase.listB)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkStringElementsMatchReflection(b *testing.B) {
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
for _, test := range testCasesElementMatch {
|
||||
StringElementsMatch(test.listA, test.listB)
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue