The most infamous flaky test

[som-snytt]

scala/scala#10105 (comment)

presentation/doc sees Unexpected foo method comment: None.

Personally, I am surprised that foo requires comment.

Parking it here as internal.

[som-snytt]

scala/scala#10732 (comment)

and

scala/scala#10732 (comment)

[lrytz]

i saw it locally 👻

[som-snytt]

Duplicates #72 !

I corrected the title.

[lrytz]

Looking at the code, the None probably originates here: https://github.com/scala/scala/blob/2d9e6acce8c4246e6cba5a22ff9d965ec3bd117c/src/interactive/scala/tools/nsc/interactive/Response.scala#L68

response.get is called here https://github.com/scala/scala/blob/53e1571071bf75ce6ddd6e7b4f0b84ef1bdc32f8/test/files/presentation/doc/doc.scala#L65

[som-snytt]

I forgot to investigate the suggestion from August. (Also at this comment #72 (comment))

This test completes on Windows 10, which does the loadSources (of 2 files), one run of the test (2 askDocComment), shutdown, many times.

object Test {
  def main(args: Array[String]): Unit = {
    def run(): Boolean = {
      val it = new ITest {
        loadSources()
      }
      val res =
        try it.dorun()
        finally it.askShutdown()
      res
    }
    var n = 10000
    while (n > 0 && run()) {
      n -= 1
    }
    println(s"done at $n")
  }
}

The test was turned off in 2013 scala/scala@8986ee4

then back on in 2014 scala/scala@1122e9e

then back off in 2016 for Windows scala/scala@8e52acd

I see from the OP and a year later that it persisted on Linux and also both getDocComments were susceptible to failure; I had only seen the last fail.