Skip to content

Improve bisect script #16294

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.

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 1 commit into from
Nov 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ metals.sbt
.idea_modules
/.worksheet/

# scala-cli
.scala-build

# Partest
dotty.jar
dotty-lib.jar
Expand Down
54 changes: 40 additions & 14 deletions project/scripts/dottyCompileBisect.scala
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Usage
// > scala-cli project/scripts/dottyCompileBisect.scala -- File1.scala File2.scala
// > scala-cli project/scripts/dottyCompileBisect.scala -- [--run <main.class.name>] [<compiler-option> ...] <file1.scala> [<fileN.scala> ...]
//
// This script will bisect the compilation failure starting with a fast bisection on released nightly builds.
// Then it will bisect the commits between the last nightly that worked and the first nightly that failed.
Expand All @@ -8,20 +8,37 @@
import sys.process._
import scala.io.Source
import Releases.Release
import java.io.File
import java.nio.file.{Files, Paths, StandardCopyOption}

@main def dottyCompileBisect(files: String*): Unit =
val releaseBisect = ReleaseBisect(files.toList)
val fistBadRelease = releaseBisect.bisect(Releases.allReleases)
@main def dottyCompileBisect(args: String*): Unit =
val (mainClass, compilerArgs) = args match
case Seq("--run", mainClass, compilerArgs*) =>
(Some(mainClass), compilerArgs)
case _ =>
(None, args)

val releaseBisect = ReleaseBisect(mainClass, compilerArgs.toList)
val bisectedBadRelease = releaseBisect.bisectedBadRelease(Releases.allReleases)
println("\nFinished bisecting releases\n")
fistBadRelease.previous match
case Some(lastGoodRelease) =>
println(s"Last good release: $lastGoodRelease\nFirst bad release: $fistBadRelease\n")
val commitBisect = CommitBisect(files.toList)
commitBisect.bisect(lastGoodRelease.hash, fistBadRelease.hash)

bisectedBadRelease match
case Some(firstBadRelease) =>
firstBadRelease.previous match
case Some(lastGoodRelease) =>
println(s"Last good release: $lastGoodRelease")
println(s"First bad release: $firstBadRelease")
val commitBisect = CommitBisect(mainClass, compilerArgs.toList)
commitBisect.bisect(lastGoodRelease.hash, firstBadRelease.hash)
case None =>
println(s"No good release found")
case None =>
println(s"No good release found")
println(s"No bad release found")

class ReleaseBisect(files: List[String]):
class ReleaseBisect(mainClass: Option[String], compilerArgs: List[String]):
def bisectedBadRelease(releases: Vector[Release]): Option[Release] =
Some(bisect(releases: Vector[Release]))
.filter(!isGoodRelease(_))

def bisect(releases: Vector[Release]): Release =
assert(releases.length > 1, "Need at least 2 releases to bisect")
Expand All @@ -35,7 +52,12 @@ class ReleaseBisect(files: List[String]):

private def isGoodRelease(release: Release): Boolean =
println(s"Testing ${release.version}")
val res = s"""scala-cli compile ${files.mkString(" ")} -S "${release.version}"""".!
val testCommand = mainClass match
case Some(className) =>
s"run --main-class '$className'"
case None =>
"compile"
val res = s"""scala-cli $testCommand -S '${release.version}' ${compilerArgs.mkString(" ")}""".!
val isGood = res == 0
println(s"Test result: ${release.version} is a ${if isGood then "good" else "bad"} release\n")
isGood
Expand Down Expand Up @@ -64,10 +86,14 @@ object Releases:

override def toString: String = version

class CommitBisect(files: List[String]):
class CommitBisect(mainClass: Option[String], compilerArgs: List[String]):
def bisect(lastGoodHash: String, fistBadHash: String): Unit =
println(s"Starting bisecting commits $lastGoodHash..$fistBadHash\n")
val runOption = mainClass.map(className => s"--run $className").getOrElse("")
val scriptFile = Paths.get("project", "scripts", "dottyCompileBisect.sh")
val tempScriptFile = File.createTempFile("dottyCompileBisect", "sh").toPath
Files.copy(scriptFile, tempScriptFile, StandardCopyOption.REPLACE_EXISTING)
"git bisect start".!
s"git bisect bad $fistBadHash".!
s"git bisect good $lastGoodHash".!
s"git bisect run sh project/scripts/dottyCompileBisect.sh ${files.mkString(" ")}".!
s"git bisect run sh ${tempScriptFile.toAbsolutePath} ${runOption} ${compilerArgs.mkString(" ")}".!
16 changes: 12 additions & 4 deletions project/scripts/dottyCompileBisect.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,23 @@
# > git bisect start
# > git bisect bad <bad-commit>
# > git bisect good <good-commit>
# > git bisect run project/scripts/dottyCompileBisect.sh <file.scala>
# > git bisect run project/scripts/dottyCompileBisect.sh [--run <main.class.name>] [<compiler-option> ...] <file1.scala> [<fileN.scala> ...]
#
# Note: Use dottyCompileBisect.scala for faster bisection over commits that spans several days

files=$@
shift
if [ "$1" == "--run" ]; then
mainClass="$2"
shift; shift
fi

compilerArgs=$@

rm -r out
mkdir out
mkdir out/bisect

sbt "clean; scalac -d out/bisect $files"
if [ -n "$mainClass" ]; then
sbtRunCommand="scala -classpath out/bisect $mainClass"
fi

sbt "clean; scalac -d out/bisect $compilerArgs; $sbtRunCommand"