8000 convert tests to munit by mzuehlke · Pull Request #368 · circe/circe-config · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

convert tests to munit #368

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 2 commits into from
Feb 13, 2023
Merged

convert tests to munit #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c30d09
convert tests to munit
mzuehlke Feb 12, 2023
38894ea
Rename version val
fthomas Feb 13, 2023
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
18 changes: 7 additions & 11 deletions build.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,11 @@ ThisBuild / tlMimaPreviousVersions ++= Set(
)

val Versions = new {
val catsEffect = "3.4.6"
val circe = "0.14.4"
val config = "1.4.2"
val discipline = "1.4.0"
val scalaCheck = "1.15.4"
val scalaTest = "3.2.11"
val scalaTestPlus = "3.2.11.0"
val munit = "0.7.29"
val disciplineMunit = "1.0.9"
val munitCatsEffect = "1.0.7"
}

lazy val root = tlCrossRootProject.aggregate(config)
Expand All @@ -47,13 +45,11 @@ lazy val config = project
"io.circe" %% "circe-parser" % Versions.circe,
"io.circe" %% "circe-generic" % Versions.circe % Test,
"io.circe" %% "circe-testing" % Versions.circe % Test,
"org.typelevel" %% "cats-effect" % Versions.catsEffect % Test,
"org.typelevel" %% "discipline-core" % Versions.discipline % Test,
"org.scalacheck" %% "scalacheck" % Versions.scalaCheck % Test,
"org.scalatest" %% "scalatest" % Versions.scalaTest % Test,
"org.scalatestplus" %% "scalacheck-1-15" % Versions.scalaTestPlus % Test
"org.scalameta" %% "munit" % Versions.munit % Test,
"org.typelevel" %% "discipline-munit" % Versions.disciplineMunit % Test,
"org.typelevel" %% "munit-cats-effect-3" % Versions.munitCatsEffect % Test
),
doctestTestFramework := DoctestTestFramework.ScalaTest,
doctestTestFramework := DoctestTestFramework.Munit,
doctestMarkdownEnabled := true,
tlVersionIntroduced := Map(
"2.12" -> "0.3.0",
Expand Down
78 changes: 40 additions & 38 deletions config/src/test/scala-2/io.circe.config/CirceConfigSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,89 +25,91 @@
package io.circe.config

import cats.effect.IO
import cats.effect.unsafe.implicits.global
import com.typesafe.config.{parser => _, _}
import io.circe.config.syntax._
import io.circe.generic.auto._
import io.circe.{parser => _, _}
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers
import munit.CatsEffectSuite

import java.time.Period
import scala.concurrent.duration._
import scala.io.Source

class CirceConfigSpec extends AnyFlatSpec with Matchers {
class CirceConfigSpec extends CatsEffectSuite {
import CirceConfigSpec._

trait ParserTests {
def parse: Either[ParsingFailure, Json]
def decode: Either[Error, TestConfig]
def testParser(parse: Either[ParsingFailure, Json], decode: Either[Error, TestConfig]): Unit = {

assert(parse.isRight)

val Right(config) = decode

assert(config == DecodedTestConfig)
assert(config.k.getDouble("ka") == 1.1)
assert(config.k.getString("kb") == "abc")
assert(config.l.unwrapped == "localhost")
assertEquals(config, DecodedTestConfig)
assertEqualsDouble(config.k.getDouble("ka"), 1.1, 1e-6)
assertEquals(config.k.getString("kb"), "abc")
assertEquals(config.l.unwrapped, "localhost")
}

"parser" should "parse and decode config from string" in new ParserTests {
def parse = parser.parse(AppConfigString)
def decode = parser.decode[TestConfig](AppConfigString)
test("parser should parse and decode config from string") {
testParser(
parser.parse(AppConfigString),
parser.decode[TestConfig](AppConfigString)
)
}

it should "parse and decode config from object" in new ParserTests {
def parse = parser.parse(AppConfig)
def decode = parser.decode[TestConfig](AppConfig)
test("parser should parse and decode config from object") {
testParser(
parser.parse(AppConfig),
parser.decode[TestConfig](AppConfig)
)
}

it should "parse and decode config from file" in new ParserTests {
test("parser should parse and decode config from file") {
def file = resolveFile("CirceConfigSpec.conf")
def parse = parser.parseFile(file)
def decode = parser.decodeFile[TestConfig](file)
testParser(
parser.parseFile(file),
parser.decodeFile[TestConfig](file)
)
}

it should "parse and decode config from default typesafe config resolution" in {
parser.decode[AppSettings]().fold(fail(_), _ should equal(DecodedAppSettings))
test("parser should parse and decode config from default typesafe config resolution") {
assertEquals(parser.decode[AppSettings](), Right(DecodedAppSettings))
}

it should "parse and decode config from default typesafe config resolution via ApplicativeError" in {
parser.decodeF[IO, AppSettings]().unsafeRunSync() should equal(DecodedAppSettings)
test("parser should parse and decode config from default typesafe config resolution via ApplicativeError") {
assertIO(parser.decodeF[IO, AppSettings](), DecodedAppSettings)
}

it should "parse and decode config from default typesafe config resolution with path via ApplicativeError" in {
parser.decodePathF[IO 8000 , HttpSettings]("http").unsafeRunSync() should equal(DecodedAppSettings.http)
test("parser should parse and decode config from default typesafe config resolution with path via ApplicativeError") {
assertIO(parser.decodePathF[IO, HttpSettings]("http"), DecodedAppSettings.http)
}

"printer" should "print it into a config string" in {
test("printer should print it into a config string") {
val Right(json) = parser.parse(AppConfig)
val expected = readFile("CirceConfigSpec.printed.conf")
assert(printer.print(json) == expected)
assertEquals(printer.print(json), expected)
}

"syntax" should "provide Config decoder" in {
assert(AppConfig.as[TestConfig] == Right(DecodedTestConfig))
test("syntax should provide Config decoder") {
assertEquals(AppConfig.as[TestConfig], Right(DecodedTestConfig))
}

it should "provide syntax to decode at a given path" in {
assert(AppConfig.as[Nested]("e") == Right(Nested(true)))
test("syntax should provide syntax to decode at a given path") {
assertEquals(AppConfig.as[Nested]("e"), Right(Nested(true)))
}

it should "provide Config decoder via ApplicativeError" in {
assert(AppConfig.asF[IO, TestConfig].unsafeRunSync() == DecodedTestConfig)
test("syntax should provide Config decoder via ApplicativeError") {
assertIO(AppConfig.asF[IO, TestConfig], DecodedTestConfig)
}

it should "provide syntax to decode at a given path via ApplicativeError" in {
assert(AppConfig.asF[IO, Nested]("e").unsafeRunSync() == Nested(true))
test("syntax should provide syntax to decode at a given path via ApplicativeError") {
assertIO(AppConfig.asF[IO, Nested]("e"), Nested(true))
}

"round-trip" should "parse and print" in {
test("round-trip should parse and print") {
for (file <- testResourcesDir.listFiles) {
val Right(json) = parser.parseFile(file)
assert(parser.parse(printer.print(json)) == Right(json), s"round-trip failed for ${file.getName}")
assertEquals(parser.parse(printer.print(json)), Right(json), s"round-trip failed for ${file.getName}")
}
}
}
Expand Down
78 changes: 40 additions & 38 deletions config/src/test/scala-3/io.circe.config/CirceConfigSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,89 +25,91 @@
package io.circe.config

import cats.effect.IO
import cats.effect.unsafe.implicits.global
import com.typesafe.config.{parser => _, _}
import io.circe.config.syntax._
import io.circe.syntax._
import io.circe.{parser => _, _}
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers
import munit.CatsEffectSuite

import java.time.Period
import scala.concurrent.duration._
import scala.io.Source

class CirceConfigSpec extends AnyFlatSpec with Matchers {
class CirceConfigSpec extends CatsEffectSuite {
import CirceConfigSpec._

trait ParserTests {
def parse: Either[ParsingFailure, Json]
def decode: Either[Error, TestConfig]
def testParser(parse: Either[ParsingFailure, Json], decode: Either[Error, TestConfig]): Unit = {

assert(parse.isRight)

val Right(config) = decode

assert(config == DecodedTestConfig)
assert(config.k.getDouble("ka") == 1.1)
assert(config.k.getString("kb") == "abc")
assert(config.l.unwrapped == "localhost")
assertEquals(config, DecodedTestConfig)
assertEqualsDouble(config.k.getDouble("ka"), 1.1, 1e-6)
assertEquals(config.k.getString("kb"), "abc")
assertEquals(config.l.unwrapped, "localhost")
}

"parser" should "parse and decode config from string" in new ParserTests {
def parse = parser.parse(AppConfigString)
def decode = parser.decode[TestConfig](AppConfigString)
test("parser should parse and decode config from string") {
testParser(
parser.parse(AppConfigString),
parser.decode[TestConfig](AppConfigString)
)
}

it should "parse and decode config from object" in new ParserTests {
def parse = parser.parse(AppConfig)
def decode = parser.decode[TestConfig](AppConfig)
test("parser should parse and decode config from object") {
testParser(
parser.parse(AppConfig),
parser.decode[TestConfig](AppConfig)
)
}

it should "parse and decode config from file" in new ParserTests {
test("parser should parse and decode config from file") {
def file = resolveFile("CirceConfigSpec.conf")
def parse = parser.parseFile(file)
def decode = parser.decodeFile[TestConfig](file)
testParser(
parser.parseFile(file),
parser.decodeFile[TestConfig](file)
)
}

it should "parse and decode config from default typesafe config resolution" in {
parser.decode[AppSettings]().fold(fail(_), _ should equal(DecodedAppSettings))
test("parser should parse and decode config from default typesafe config resolution") {
assertEquals(parser.decode[AppSettings](), Right(DecodedAppSettings))
}

it should "parse and decode config from default typesafe config resolution via ApplicativeError" in {
parser.decodeF[IO, AppSettings]().unsafeRunSync() should equal(DecodedAppSettings)
test("parser should parse and decode config from default typesafe config resolution via ApplicativeError") {
assertIO(parser.decodeF[IO, AppSettings](), DecodedAppSettings)
}

it should "parse and decode config from default typesafe config resolution with path via ApplicativeError" in {
parser.decodePathF[IO, HttpSettings]("http").unsafeRunSync() should equal(DecodedAppSettings.http)
test("parser should parse and decode config from default typesafe config resolution with path via ApplicativeError") {
assertIO(parser.decodePathF[IO, HttpSettings]("http"), DecodedAppSettings.http)
}

"printer" should "print it into a config string" in {
test("printer should print it into a config string") {
val Right(json) = parser.parse(AppConfig)
val expected = readFile("CirceConfigSpec.printed.conf")
assert(printer.print(json) == expected)
assertEquals(printer.print(json), expected)
}

"syntax" should "provide Config decoder" in {
assert(AppConfig.as[TestConfig] == Right(DecodedTestConfig))
test("syntax should provide Config decoder") {
assertEquals(AppConfig.as[TestConfig], Right(DecodedTestConfig))
}

it should "provide syntax to decode at a given path" in {
assert(AppConfig.as[Nested]("e") == Right(Nested(true)))
test("syntax should provide syntax to decode at a given path") {
assertEquals(AppConfig.as[Nested]("e"), Right(Nested(true)))
}

it should "provide Config decoder via ApplicativeError" in {
assert(AppConfig.asF[IO, TestConfig].unsafeRunSync() == DecodedTestConfig)
test("syntax should provide Config decoder via ApplicativeError") {
assertIO(AppConfig.asF[IO, TestConfig], DecodedTestConfig)
}

it should "provide syntax to decode at a given path via ApplicativeError" in {
assert(AppConfig.asF[IO, Nested]("e").unsafeRunSync() == Nested(true))
test("syntax should provide syntax to decode at a given path via ApplicativeError") {
assertIO(AppConfig.asF[IO, Nested]("e"), Nested(true))
}

"round-trip" should "parse and print" in {
test("round-trip should parse and print") {
for (file <- testResourcesDir.listFiles) {
val Right(json) = parser.parseFile(file)
assert(parser.parse(printer.print(json)) == Right(json), s"round-trip failed for ${file.getName}")
assertEquals(parser.parse(printer.print(json)), Right(json), s"round-trip failed for ${file.getName}")
}
}
}
Expand Down
18 changes: 6 additions & 12 deletions config/src/test/scala/io.circe.config/CirceConfigLaws.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,12 @@ import io.circe.Json
import io.circe.Parser
import io.circe.ParsingFailure
import io.circe.testing.ParserTests
import munit.DisciplineSuite
import org.scalacheck.Arbitrary
import org.scalacheck.Prop
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatestplus.scalacheck.Checkers
import org.typelevel.discipline.Laws

class CirceConfigLaws extends AnyFlatSpec {
class CirceConfigLaws extends DisciplineSuite {

implicit val arbitraryConfigJson: Arbitrary[Json] = Arbitrary {
def normalize(json: Json): Json =
Expand Down Expand Up @@ -67,13 +66,8 @@ class CirceConfigLaws extends AnyFlatSpec {
yield normalize(Json.fromJsonObject(jsonObject))
}

def checkLaws(name: String, ruleSet: Laws#RuleSet): Unit = ruleSet.all.properties.zipWithIndex.foreach {
case ((id, prop), 0) => name should s"obey $id" in Checkers.check(prop)
case ((id, prop), _) => it should s"obey $id" in Checkers.check(prop)
}

checkLaws("Parser", ParserTests(parser).fromString)
checkLaws(
checkAll("Parser", ParserTests(parser).fromString)
checkAll(
"Parser",
ParserTests(parser).fromFunction[Config]("fromConfig")(
ConfigFactory.parseString,
Expand All @@ -82,8 +76,8 @@ class CirceConfigLaws extends AnyFlatSpec {
_.decodeAccumulating[Json]
)
)
checkLaws("Printer", PrinterTests(parser).fromJson)
checkLaws("Codec", CodecTests[Config](syntax.configDecoder, parser.parse).fromFunction("fromConfig"))
checkAll("Printer", PrinterTests(parser).fromJson)
checkAll("Codec", CodecTests[Config](syntax.configDecoder, parser.parse).fromFunction("fromConfig"))
}

case class PrinterTests(parser: Parser) extends Laws {
Expand Down
0