Skip to content

Add compile-time validation of literal paths containing ".." #329

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 8 commits into from
Nov 12, 2024
Merged

Add compile-time validation of literal paths containing ".." #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dc4f00b
Update Path.scala
pawelsadlo Nov 2, 2024
f470844
Update Path.scala
pawelsadlo Nov 2, 2024
d34ceaf
fix and add tests
pawelsadlo Nov 6, 2024
9cfdc2a
fmt
pawelsadlo Nov 6, 2024
de5a817
fix
pawelsadlo Nov 6, 2024
23968ac
fix
pawelsadlo Nov 6, 2024
9ae4b3b
fmt
pawelsadlo Nov 6, 2024
0b09d24
Merge branch 'main' into patch-1
lihaoyi Nov 11, 2024
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
11 changes: 9 additions & 2 deletions os/src/Path.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,17 @@ object PathChunk extends PathChunkMacros {
val splitted = strNoTrailingSeps.split('/')
splitted ++ Array.fill(trailingSeparatorsCount)("")
}

private def reduceUps(in: Array[String]): List[String] =
in.foldLeft(List.empty[String]) { case (acc, x) =>
acc match {
case h :: t if h == ".." => x :: acc
case h :: t if x == ".." => t
case _ => x :: acc
}
}.reverse
private[os] def segmentsFromStringLiteralValidation(literal: String): Array[String] = {
val stringSegments = segmentsFromString(literal)
val validSegmnts = validLiteralSegments(stringSegments)
val validSegmnts = reduceUps(validLiteralSegments(stringSegments))
val sanitizedLiteral = validSegmnts.mkString("/")
if (validSegmnts.isEmpty) throw InvalidSegment(
literal,
Expand Down
7 changes: 4 additions & 3 deletions os/test/src-jvm/ExpectyIntegration.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ object ExpectyIntegration extends TestSuite {
}
test("literals with [..]") {
expect(rel / "src" / ".." == rel / "src" / os.up)
expect(root / "src/.." == root / "src" / os.up)
expect(root / "src" / ".." == root / "src" / os.up)
expect(root / "hello" / ".." / "world" == root / "hello" / os.up / "world")
expect(root / "hello" / "../world" == root / "hello" / os.up / "world")
expect(root / "hello/../world" == root / "hello" / os.up / "world")
}
test("from issue") {
expect(Seq(os.pwd / "foo") == Seq(os.pwd / "foo"))
val path = os.Path("/") / "tmp" / "foo"
expect(path.startsWith(os.Path("/") / "tmp"))
}
test("multiple args") {
expect(rel / "src" / ".." == rel / "src" / os.up, root / "src/.." == root / "src" / os.up)
expect(
rel / "src" / ".." == rel / "src" / os.up,
root / "src" / "../foo" == root / "src" / os.up / "foo"
)
}
}
}
Expand Down
42 changes: 40 additions & 2 deletions os/test/src/PathTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,52 @@ object PathTests extends TestSuite {
test("literals with [..]") {

assert(rel / "src" / ".." == rel / "src" / os.up)
assert(root / "src/.." == root / "src" / os.up)
assert(root / "src" / ".." == root / "src" / os.up)
assert(root / "hello" / ".." / "world" == root / "hello" / os.up / "world")
assert(root / "hello" / "../world" == root / "hello" / os.up / "world")
assert(root / "hello/../world" == root / "hello" / os.up / "world")
}

test("Compile errors") {

compileError("""root / "src/../foo"""").check("", nonCanonicalLiteral("src/../foo", "foo"))
compileError("""root / "hello/../world"""").check(
"",
nonCanonicalLiteral("hello/../world", "world")
)
compileError("""root / "src/../foo/bar"""").check(
"",
nonCanonicalLiteral("src/../foo/bar", "foo/bar")
)
compileError("""root / "src/../foo/bar/.."""").check(
"",
nonCanonicalLiteral("src/../foo/bar/..", "foo")
)
compileError("""root / "src/../foo/../bar/."""").check(
"",
nonCanonicalLiteral("src/../foo/../bar/.", "bar")
)
compileError("""root / "src/foo/./.."""").check(
"",
nonCanonicalLiteral("src/foo/./..", "src")
)
compileError("""root / "src/foo//./.."""").check(
"",
nonCanonicalLiteral("src/foo//./..", "src")
)

compileError("""root / "src/.."""").check("", removeLiteralErr("src/.."))
compileError("""root / "src/../foo/.."""").check("", removeLiteralErr("src/../foo/.."))
compileError("""root / "src/foo/../.."""").check("", removeLiteralErr("src/foo/../.."))
compileError("""root / "src/foo/./../.."""").check("", removeLiteralErr("src/foo/./../.."))
compileError("""root / "src/./foo/./../.."""").check(
"",
removeLiteralErr("src/./foo/./../..")
)
compileError("""root / "src///foo/./../.."""").check(
"",
removeLiteralErr("src///foo/./../..")
)

compileError("""root / "/" """).check("", removeLiteralErr("/"))
compileError("""root / "/ " """).check("", nonCanonicalLiteral("/ ", " "))
compileError("""root / " /" """).check("", nonCanonicalLiteral(" /", " "))
Expand Down