Jakob BorgandSimon Frei
3297624037
This improves the ignore handling so that directories can be fully
ignored (skipped in the watcher) in more cases. Specifically, where the
previous rule was that any complex `!`-pattern would disable skipping
directories, the new rule is that only matches on patterns *after* such
a `!`-pattern disable skipping. That is, the following now does the
intuitive thing:
```
/foo
/bar
!whatever
*
```
- `/foo/**` and `/bar/**` are completely skipped, since there is no
chance anything underneath them could ever be not-ignored
- `!whatever` toggles the "can't skip directories any more" flag
- Anything that matches `*` can't skip directories, because it's
possible we can have `whatever` match something deeper.
To enable this, some refactoring was necessary:
- The "can skip dirs" flag is now a property of the match result, not of
the pattern set as a whole.
- That meant returning a boolean is not good enough, we need to actually
return the entire `Result` (or, like, two booleans but that seemed
uglier and more annoying to use)
- `ShouldIgnore(string) boolean` went away with
`Match(string).IsIgnored()` being the obvious replacement (API
simplification!)
- The watcher then needed to import the `ignore` package (for the
`Result` type), but `fs` imports the watcher and `ignore` imports `fs`.
That's a cycle, so I broke out `Result` into a package of its own so
that it can be safely imported everywhere in things like `type Matcher
interface { Match(string) result.Result }`. There's a fair amount of
stuttering in `result.Result` and maybe we should go with something like
`ignoreresult.R` or so, leaving this open for discussion.
Tests refactored to suit, I think this change is in fact quite well
covered by the existing ones...
Also some noise because a few of the changed files were quite old and
got the `gofumpt` treatment by my editor. Sorry not sorry.
---------
Co-authored-by: Simon Frei <freisim93@gmail.com>
39 lines
1.1 KiB
Go
39 lines
1.1 KiB
Go
// Copyright (C) 2024 The Syncthing Authors.
|
|
//
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
// You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
package ignoreresult_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/syncthing/syncthing/lib/ignore/ignoreresult"
|
|
)
|
|
|
|
func TestFlagCanSkipDir(t *testing.T) {
|
|
// Verify that CanSkipDir() means that something is both ignored and can
|
|
// be skipped as a directory, so that it's legitimate to say
|
|
// Match(...).CanSkipDir() instead of having to create a temporary
|
|
// variable and check both Match(...).IsIgnored() and
|
|
// Match(...).CanSkipDir().
|
|
|
|
cases := []struct {
|
|
res ignoreresult.R
|
|
canSkipDir bool
|
|
}{
|
|
{0, false},
|
|
{ignoreresult.NotIgnored, false},
|
|
{ignoreresult.NotIgnored.WithSkipDir(), false},
|
|
{ignoreresult.Ignored, false},
|
|
{ignoreresult.IgnoreAndSkip, true},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
if tc.res.CanSkipDir() != tc.canSkipDir {
|
|
t.Errorf("%v.CanSkipDir() != %v", tc.res, tc.canSkipDir)
|
|
}
|
|
}
|
|
}
|