APIMF-2997: add scalatest, refactor all scala tests

Author: arielmirra

Diff for: .scalafmt.conf

@@ -1 +1,2 @@
-version = 2.5.0
+version = 2.5.0
+maxColumn = 100

Diff for: AMF5/build.gradle

@@ -2,6 +2,7 @@ plugins {
     id "com.moowork.node" version "1.3.1"
     id 'java'
     id 'scala'
+    id "com.github.maiflai.scalatest" version "0.31"
 }
 
 sourceCompatibility = 1.8
@@ -29,6 +30,14 @@ dependencies {
     testCompile group: 'org.assertj', name: 'assertj-core', version: '3.18.1'
     // https://mvnrepository.com/artifact/junit/junit
     testCompile group: 'junit', name: 'junit', version: '4.13.1'
+    // gradle-scalatest
+    testCompile 'org.scalatest:scalatest_2.12:3.2.0'
+    testRuntime 'com.vladsch.flexmark:flexmark-all:0.35.10'
+}
+
+task testAll {
+    dependsOn test
+    dependsOn scalatest
 }
 
 tasks.test.dependsOn(tasks.npm_test)

Diff for: AMF5/gradle.properties

@@ -1,45 +1,28 @@
+import amf.client.environment.WebAPIConfiguration
 import amf.plugins.document.apicontract.resolution.pipelines.compatibility.{Oas20CompatibilityPipeline, Raml10CompatibilityPipeline}
-import org.junit.Assert._
-import org.junit.Test
+import org.scalatest.flatspec.AsyncFlatSpec
+import org.scalatest.matchers.should
 
-import scala.concurrent.Await
-import scala.concurrent.duration.Duration
+class ConversionTestScala extends AsyncFlatSpec with should.Matchers {
 
-class ConversionTestScala {
-
-  import amf.client.environment.WebAPIConfiguration
-
-  import scala.concurrent.ExecutionContext.Implicits.global
-
-  @Test def Raml10ToOas20Conversion(): Unit = {
+  "AMF" should "convert a RAML 1.0 API to OAS 2.0" in {
     val client = WebAPIConfiguration.WebAPI().createClient()
-    val parseResult = Await.result(
-      client.parse("file://resources/examples/banking-api.raml"),
-      Duration.Inf
-    )
-    val transformResult =
-      client.transform(parseResult.bu, Oas20CompatibilityPipeline.name)
-    val renderResult =
-      client.render(transformResult.bu, "application/oas20+json")
-    val readApi = getStrFromFile(
-      "resources/expected/converted-banking-api.json"
-    )
-    assertEquals(readApi, renderResult)
+    client.parse("file://AMF5/resources/examples/banking-api.raml") map { parseResult =>
+      val transformResult = client.transform(parseResult.bu, Oas20CompatibilityPipeline.name)
+      val renderResult = client.render(transformResult.bu, "application/oas20+json")
+      val readApi = getStrFromFile("AMF5/resources/expected/converted-banking-api.json")
+      renderResult shouldEqual readApi
+    }
   }
 
-  @Test def Oas20ToRaml10Conversion(): Unit = {
+  "AMF" should "convert an OAS 2.0 API to RAML 1.0" in {
     val client = WebAPIConfiguration.WebAPI().createClient()
-    client
-      .parse("file://resources/examples/banking-api.json")
-      .map(parseResult => {
-        val transformResult =
-          client.transform(parseResult.bu, Raml10CompatibilityPipeline.name)
-        val renderResult =
-          client.render(transformResult.bu, "application/raml10+yaml")
-        val readApi =
-          getStrFromFile("resources/expected/converted-banking-api.raml")
-        assertEquals(readApi, renderResult)
-      })
+    client.parse("file://AMF5/resources/examples/banking-api.json") map { parseResult =>
+      val transformResult = client.transform(parseResult.bu, Raml10CompatibilityPipeline.name)
+      val renderResult = client.render(transformResult.bu, "application/raml10+yaml")
+      val readApi = getStrFromFile("AMF5/resources/expected/converted-banking-api.raml")
+      renderResult shouldEqual readApi
+    }
   }
 
   private def getStrFromFile(path: String): String = {

Diff for: AMF5/src/test/scala/ConversionTestScala.scala

@@ -1,26 +1,24 @@
 import amf.client.environment.RAMLConfiguration
 import amf.core.errorhandling.UnhandledErrorHandler
 import amf.plugins.document.apicontract.resolution.pipelines.Raml10TransformationPipeline
-import org.junit.Test
+import org.scalatest.flatspec.AsyncFlatSpec
+import org.scalatest.matchers.should
 
-import scala.concurrent.Await
-import scala.concurrent.duration.Duration
+class ErrorHandlerTestScala extends AsyncFlatSpec with should.Matchers {
 
-class ErrorHandlerTestScala {
-
-  @Test(expected = classOf[java.lang.Exception])
-  def customErrorHandler(): Unit = {
+  "AMF client" should "use a custom error handler provider" in {
     val client =
       RAMLConfiguration
         .RAML10()
-        .withErrorHandlerProvider(() => UnhandledErrorHandler)
+        .withErrorHandlerProvider(() =>
+          UnhandledErrorHandler
+        ) // throws an exception when an error is found
         .createClient()
 
-    val parseResult = Await.result(
-      client.parse("file://resources/examples/resolution-error.raml"),
-      Duration.Inf
-    )
-
-    client.transform(parseResult.bu, Raml10TransformationPipeline.name)
+    client.parse("file://AMF5/resources/examples/resolution-error.raml") map { parseResult =>
+      assertThrows[java.lang.Exception] {
+        client.transform(parseResult.bu, Raml10TransformationPipeline.name)
+      }
+    }
   }
 }

Diff for: AMF5/src/test/scala/ErrorHandlerTestScala.scala

@@ -2,15 +2,16 @@ import amf.client.exported.RAMLConfiguration
 import amf.client.model.document.Document
 import amf.client.model.domain.{Request, WebApi}
 import org.junit.Assert.assertTrue
-import org.junit.Test
+import org.scalatest.flatspec.AsyncFlatSpec
+import org.scalatest.matchers.should
 
 import java.util.Collections
 
-class ModelBuilderTestScala {
+class ModelBuilderTestScala extends AsyncFlatSpec with should.Matchers {
 
-  @Test def buildWebApiTest(): Unit = {
+  "AMF" should "create a valid model in memory" in {
     val stringDataType = "http://www.w3.org/2001/XMLSchema#string"
-
+    val client = RAMLConfiguration.RAML().createClient()
     val api = new WebApi()
       .withName("Music Service API")
       .withVersion("v1")
@@ -102,11 +103,8 @@ class ModelBuilderTestScala {
     model.withEncodes(api)
 
     // Run RAML default validations on parsed unit (expects one error -> invalid protocols value)
-    val client = RAMLConfiguration.RAML().createClient()
     val validationReport = client.validate(model).get()
-    assertTrue(
-      "Created model in memory should be valid",
-      validationReport.conforms
-    )
+    validationReport.conforms shouldBe true
+    validationReport.results.size() shouldBe 0
   }
 }

Diff for: AMF5/src/test/scala/ModelBuilderTestScala.scala

@@ -1,17 +1,15 @@
-import amf.client.exported.{OASConfiguration, RAMLConfiguration}
-import org.junit.Assert._
-import org.junit.Test
+import amf.client.environment.{OASConfiguration, RAMLConfiguration}
+import org.scalatest.flatspec.AsyncFlatSpec
+import org.scalatest.matchers.should
 
+class ParsingTestScala extends AsyncFlatSpec with should.Matchers {
 
-class ParsingTestScala {
-
-  @Test def parseOas20(): Unit = {
+  "AMF client" should "parse an OAS 2.0 API" in {
     val client = OASConfiguration.OAS20().createClient()
-    val parsingResult = client.parse("file://resources/examples/banking-api.json").get()
-    assertTrue(parsingResult.conforms)
+    client.parse("file://AMF5/resources/examples/banking-api.json") map (_.conforms shouldBe true)
   }
 
-  @Test def parseOas20String(): Unit = {
+  it should "parse an OAS 2.0 API from a string" in {
     val client = OASConfiguration.OAS20().createClient()
     val api =
       """{
@@ -22,63 +20,45 @@ class ParsingTestScala {
         |    },
         |    "host": "acme-banking.com"
         |}""".stripMargin
-    val parsingResult = client.parseContent(api).get();
-    assertTrue(parsingResult.conforms)
+    client.parseContent(api) map (_.conforms shouldBe true)
   }
 
-  @Test def parseOas30(): Unit = {
-    val parsingResult = OASConfiguration
-      .OAS30()
-      .createClient()
-      .parse("file://resources/examples/banking-api-oas30.json")
-      .get()
-    assertTrue(parsingResult.conforms)
+  it should "parse an OAS 3.0 API" in {
+    val client = OASConfiguration.OAS30().createClient()
+    client.parse(
+      "file://AMF5/resources/examples/banking-api-oas30.json"
+    ) map (_.conforms shouldBe true)
   }
 
-  @Test def parseRaml10(): Unit = {
-    val parsingResult = RAMLConfiguration
-      .RAML10()
-      .createClient()
-      .parse("file://resources/examples/banking-api.raml")
-      .get()
-    assertTrue(parsingResult.conforms)
+  it should "parse an RAML 1.0 API" in {
+    val client = RAMLConfiguration.RAML10().createClient()
+    client.parse("file://AMF5/resources/examples/banking-api.raml") map (_.conforms shouldBe true)
   }
 
-  @Test def parseRaml10String(): Unit = {
+  it should "parse an RAML 1.0 API from a string" in {
+    val client = RAMLConfiguration.RAML10().createClient()
     val api =
       """#%RAML 1.0
         |
         |title: ACME Banking HTTP API
         |version: 1.0""".stripMargin
-    val parsingResult = RAMLConfiguration
-      .RAML10()
-      .createClient()
-      .parseContent(api)
-      .get()
-    assertTrue(parsingResult.conforms)
+    client.parseContent(api) map (_.conforms shouldBe true)
   }
 
-  @Test def parseRaml08(): Unit = {
-    val parsingResult = RAMLConfiguration
-      .RAML08()
-      .createClient()
-      .parse("file://resources/examples/banking-api-08.raml")
-      .get()
-    assertTrue(parsingResult.conforms)
+  it should "parse an RAML 0.8 API" in {
+    val client = RAMLConfiguration.RAML08().createClient()
+    client.parse(
+      "file://AMF5/resources/examples/banking-api-08.raml"
+    ) map (_.conforms shouldBe true)
   }
 
-  @Test def parseRaml08String(): Unit = {
+  it should "parse an RAML 0.8 API from a string" in {
+    val client = RAMLConfiguration.RAML08().createClient()
     val api =
       """#%RAML 0.8
         |
         |title: ACME Banking HTTP API
         |version: 1.0""".stripMargin
-    val parsingResult = RAMLConfiguration
-      .RAML08()
-      .createClient()
-      .parseContent(api)
-      .get()
-    assertTrue(parsingResult.conforms)
+    client.parseContent(api) map (_.conforms shouldBe true)
   }
-  // TODO: add graph parse
 }