From c7c8bb550078e31bbc6341fab51f2c1c93468d44 Mon Sep 17 00:00:00 2001
From: Tomasz Godzik <tgodzik@virtuslab.com>
Date: Mon, 9 Sep 2024 18:28:31 +0200
Subject: [PATCH] improvement: Make sure Scala CLI tests are less flaky

The expected list should be stable and we only check if the expected subset is contained
---
 .../completion/CompletionScalaCliSuite.scala  | 42 +++++++++++++------
 1 file changed, 30 insertions(+), 12 deletions(-)

diff --git a/presentation-compiler/test/dotty/tools/pc/tests/completion/CompletionScalaCliSuite.scala b/presentation-compiler/test/dotty/tools/pc/tests/completion/CompletionScalaCliSuite.scala
index 360607367db3..b542e4ba84e3 100644
--- a/presentation-compiler/test/dotty/tools/pc/tests/completion/CompletionScalaCliSuite.scala
+++ b/presentation-compiler/test/dotty/tools/pc/tests/completion/CompletionScalaCliSuite.scala
@@ -8,7 +8,7 @@ import org.junit.Ignore
 class CompletionScalaCliSuite extends BaseCompletionSuite:
 
   @Test def `simple` =
-    check(
+    checkSubset(
       """|//> using lib "io.cir@@
          |package A
          |""".stripMargin,
@@ -30,11 +30,12 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
          |//> using lib io.circe::circe-core_native0.4
          |package A
          |""".stripMargin,
-      assertSingleItem = false
+      assertSingleItem = false,
+      filter = _.contains("circe-core_native0.4")
     )
 
   @Test def `version-sort` =
-    check(
+    checkSubset(
       """|//> using dep "com.lihaoyi::pprint:0.7@@"
          |package A
          |""".stripMargin,
@@ -42,12 +43,12 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
          |0.7.2
          |0.7.1
          |0.7.0
-         |""".stripMargin,
+         |""".stripMargin
     )
 
   @Ignore
   @Test def `single-colon` =
-    check(
+    checkSubset(
       """|//> using lib "io.circe:circe-core_na@@
          |package A
          |""".stripMargin,
@@ -58,7 +59,7 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
     )
 
   @Test def `version` =
-    check(
+    checkSubset(
       """|//> using lib "io.circe::circe-core_sjs1:0.14.10@@"
          |package A
          |""".stripMargin,
@@ -74,11 +75,12 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
       """|//> using lib "io.circe::circe-core_sjs1:0.14.10"
          |package A
          |""".stripMargin,
+      filter = _.endsWith("0.14.10")
     )
 
   @Ignore
   @Test def `multiple-libs` =
-    check(
+    checkSubset(
       """|//> using lib "io.circe::circe-core:0.14.0", "io.circe::circe-core_na@@"
          |package A
          |""".stripMargin,
@@ -87,7 +89,7 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
 
   @Ignore
   @Test def `script` =
-    check(
+    checkSubset(
       scriptWrapper(
         """|//> using lib "io.circe:circe-core_na@@
            |
@@ -103,7 +105,7 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
     )
 
   @Test def `closing-quote` =
-    check(
+    checkSubset(
       """|//> using lib "io.circe::circe-core:0.14.0"@@
          |package A
          |""".stripMargin,
@@ -111,7 +113,7 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
     )
 
   @Test def `whitespace` =
-    check(
+    checkSubset(
       """|//> using lib "io.circe::circe-co @@
          |package A
          |""".stripMargin,
@@ -130,7 +132,7 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
     )
 
   @Test def `dep` =
-    check(
+    checkSubset(
       """|//> using dep "io.cir@@
          |package A
          |""".stripMargin,
@@ -140,13 +142,29 @@ class CompletionScalaCliSuite extends BaseCompletionSuite:
 
   @Ignore
   @Test def `multiple-deps2` =
-    check(
+    checkSubset(
       """|//> using libs "io.circe::circe-core:0.14.0", "io.circe::circe-core_na@@"
          |package A
          |""".stripMargin,
       "circe-core_native0.4"
     )
 
+  def checkSubset(
+      original: String,
+      expected: String,
+      filename: String = "A.scala",
+      enablePackageWrap: Boolean = true
+  ) = {
+    val expectedAtLeast = expected.linesIterator.toSet
+    check(
+      original,
+      expected,
+      filter = expectedAtLeast,
+      filename = filename,
+      enablePackageWrap = enablePackageWrap
+    )
+  }
+
   private def scriptWrapper(code: String, filename: String): String =
     // Vaguely looks like a scala file that ScalaCLI generates
     // from a sc file.