Skip to content

Make os.list, os.walk, os.exists trigger Checker#onRead #385

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 2, 2025
Merged

Make os.list, os.walk, os.exists trigger Checker#onRead #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
86ec41d
.
lihaoyi May 2, 2025
0e8cd7b
fix
lihaoyi May 2, 2025
c68c204
fmt
lihaoyi May 2, 2025
ccba425
fix
lihaoyi May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions os/src/FileOps.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@ object remove extends Function1[Path, Boolean] {
object exists extends Function1[Path, Boolean] {
def apply(p: Path): Boolean = Files.exists(p.wrapped)
def apply(p: Path, followLinks: Boolean = true): Boolean = {
checker.value.onRead(p)
val opts = if (followLinks) Array[LinkOption]() else Array(LinkOption.NOFOLLOW_LINKS)
Files.exists(p.wrapped, opts: _*)
}
Expand Down
3 changes: 2 additions & 1 deletion os/src/ListOps.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ object list extends Function1[Path, IndexedSeq[Path]] {
object stream extends Function1[Path, geny.Generator[Path]] {
def apply(arg: Path) = new Generator[Path] {
def generate(handleItem: Path => Generator.Action) = {
checker.value.onRead(arg)
val ds = Files.newDirectoryStream(arg.toNIO)
val iter = ds.iterator()
var currentAction: Generator.Action = Generator.Continue
Expand Down Expand Up @@ -196,7 +197,7 @@ object walk {
maxDepth: Int = Int.MaxValue,
includeTarget: Boolean = false
): Generator[(Path, os.StatInfo)] = {

checker.value.onRead(path)
val opts0 = if (followLinks) Array[LinkOption]() else Array(LinkOption.NOFOLLOW_LINKS)
val opts = new java.util.HashSet[FileVisitOption]
if (followLinks) opts.add(FileVisitOption.FOLLOW_LINKS)
Expand Down
91 changes: 74 additions & 17 deletions os/test/src/CheckerTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,35 @@ object CheckerTests extends TestSuite {
// restricted directory
val rd = os.Path(sys.env("OS_TEST_RESOURCE_FOLDER")) / "restricted"

test("list") - prepChecker { wd =>
os.list(wd) // ok
intercept[ReadDenied] {
os.list(rd)
}
os.list.stream(wd) // ok
intercept[ReadDenied] {
os.list.stream(rd).foreach(_ => ())
}
}
test("walk") - prepChecker { wd =>
os.walk(wd) // ok
intercept[ReadDenied] {
os.walk(rd)
}
os.walk.stream(wd) // ok
intercept[ReadDenied] {
os.walk.stream(rd)
}
os.walk.attrs(wd) // ok
intercept[ReadDenied] {
os.walk.attrs(rd)
}
os.walk.stream.attrs(wd) // ok
intercept[ReadDenied] {
os.walk.stream.attrs(rd)
}
}

test("stat") {
test("mtime") - prepChecker { wd =>
val before = os.mtime(rd / "File.txt")
Expand Down Expand Up @@ -96,12 +125,16 @@ object CheckerTests extends TestSuite {
intercept[WriteDenied] {
os.move(wd / "folder1/one.txt", rd / "folder1/File.txt")
}
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
os.checker.withValue(os.Checker.Nop) {
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
}

intercept[WriteDenied] {
os.move(wd / "folder2/nestedA", rd / "folder2/nestedC")
}
os.list(rd / "folder2") ==> Seq(rd / "folder2/nestedA", rd / "folder2/nestedB")
os.checker.withValue(os.Checker.Nop) {
os.list(rd / "folder2") ==> Seq(rd / "folder2/nestedA", rd / "folder2/nestedB")
}

os.list(wd / "folder1") ==> Seq(wd / "folder1/one.txt")
os.move(wd / "folder1/one.txt", wd / "folder1/first.txt")
Expand All @@ -128,12 +161,16 @@ object CheckerTests extends TestSuite {
intercept[WriteDenied] {
os.copy(wd / "folder1/one.txt", rd / "folder1/File.txt")
}
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
os.checker.withValue(os.Checker.Nop) {
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
}

intercept[WriteDenied] {
os.copy(wd / "folder2/nestedA", rd / "folder2/nestedC")
}
os.list(rd / "folder2") ==> Seq(rd / "folder2/nestedA", rd / "folder2/nestedB")
os.checker.withValue(os.Checker.Nop) {
os.list(rd / "folder2") ==> Seq(rd / "folder2/nestedA", rd / "folder2/nestedB")
}

os.list(wd / "folder1") ==> Seq(wd / "folder1/one.txt")
os.copy(wd / "folder1/one.txt", wd / "folder1/first.txt")
Expand Down Expand Up @@ -187,7 +224,9 @@ object CheckerTests extends TestSuite {
intercept[WriteDenied] {
os.remove(rd / "folder1")
}
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
os.checker.withValue(os.Checker.Nop) {
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
}

Unchecked.scope(os.makeDir(rd / "folder"), os.remove(rd / "folder")) {
intercept[WriteDenied] {
Expand All @@ -211,18 +250,24 @@ object CheckerTests extends TestSuite {
intercept[WriteDenied] {
os.remove(rd / "misc/file-symlink")
}
os.exists(rd / "misc/file-symlink", followLinks = false) ==> true
os.checker.withValue(os.Checker.Nop) {
os.exists(rd / "misc/file-symlink", followLinks = false) ==> true
}

intercept[WriteDenied] {
os.remove(rd / "misc/folder-symlink")
}
os.exists(rd / "misc/folder-symlink", followLinks = false) ==> true
os.checker.withValue(os.Checker.Nop) {
os.exists(rd / "misc/folder-symlink", followLinks = false) ==> true
}

intercept[WriteDenied] {
os.remove(rd / "misc/broken-symlink")
}
os.exists(rd / "misc/broken-symlink", followLinks = false) ==> true
os.exists(rd / "misc/broken-symlink") ==> true
os.checker.withValue(os.Checker.Nop) {
os.exists(rd / "misc/broken-symlink", followLinks = false) ==> true
os.exists(rd / "misc/broken-symlink") ==> true
}

os.remove(wd / "misc/file-symlink")
os.exists(wd / "misc/file-symlink", followLinks = false) ==> false
Expand All @@ -241,7 +286,9 @@ object CheckerTests extends TestSuite {
intercept[WriteDenied] {
os.remove.all(rd / "folder1")
}
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
os.checker.withValue(os.Checker.Nop) {
os.list(rd / "folder1") ==> Seq(rd / "folder1/one.txt")
}

os.exists(wd / "folder1/one.txt") ==> true
os.remove.all(wd / "folder1")
Expand All @@ -252,17 +299,23 @@ object CheckerTests extends TestSuite {
intercept[WriteDenied] {
os.remove.all(rd / "misc/file-symlink")
}
os.exists(rd / "misc/file-symlink", followLinks = false) ==> true
os.checker.withValue(os.Checker.Nop) {
os.exists(rd / "misc/file-symlink", followLinks = false) ==> true
}

intercept[WriteDenied] {
os.remove.all(rd / "misc/folder-symlink")
}
os.exists(rd / "misc/folder-symlink", followLinks = false) ==> true
os.checker.withValue(os.Checker.Nop) {
os.exists(rd / "misc/folder-symlink", followLinks = false) ==> true
}

intercept[WriteDenied] {
os.remove.all(rd / "misc/broken-symlink")
}
os.exists(rd / "misc/broken-symlink", followLinks = false) ==> true
os.checker.withValue(os.Checker.Nop) {
os.exists(rd / "misc/broken-symlink", followLinks = false) ==> true
}

os.remove.all(wd / "misc/file-symlink")
os.exists(wd / "misc/file-symlink", followLinks = false) ==> false
Expand Down Expand Up @@ -332,23 +385,27 @@ object CheckerTests extends TestSuite {
}
test("temp") {
test - prepChecker { wd =>
val before = os.walk(rd)
val before = os.checker.withValue(os.Checker.Nop) { os.walk(rd) }
intercept[WriteDenied] {
os.temp("default content", dir = rd)
}
os.walk(rd) ==> before
os.checker.withValue(os.Checker.Nop) {
os.walk(rd) ==> before
}

val tempOne = os.temp("default content", dir = wd)
os.read(tempOne) ==> "default content"
os.write.over(tempOne, "Hello")
os.read(tempOne) ==> "Hello"
}
test("dir") - prepChecker { wd =>
val before = os.walk(rd)
val before = os.checker.withValue(os.Checker.Nop) { os.walk(rd) }
intercept[WriteDenied] {
os.temp.dir(dir = rd)
}
os.walk(rd) ==> before
os.checker.withValue(os.Checker.Nop) {
os.walk(rd) ==> before
}

val tempDir = os.temp.dir(dir = wd)
os.list(tempDir) ==> Nil
Expand Down
Loading