scommons.react.test.util.TestRendererUtils.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scommons-react-test_sjs0.6_2.13 Show documentation
Core Scala.js, React.js testing utilities
The newest version!
package scommons.react.test.util

import io.github.shogowada.scalajs.reactjs.elements.ReactElement
import org.scalactic.source.Position
import org.scalatest.{Assertion, Assertions, Succeeded}
import scommons.react.{ReactClass, UiComponent}
import scommons.react.test.raw
import scommons.react.test.raw.{TestInstance, TestRenderer}
import scommons.react.test.util.RendererUtils.{testInstanceUtils => utils}
import scommons.react.test.util.TestRendererUtils.UiComponentMock

import scala.scalajs.js

trait TestRendererUtils extends Assertions {
  
  def mockUiComponent[T](name: String): UiComponent[T] = UiComponentMock[T](name)

  def createTestRenderer(element: ReactElement,
                         createMock: js.Function1[TestInstance, js.Any] = null): TestRenderer = {
    
    var result: TestRenderer = null
    TestRenderer.act { () =>
      result = TestRenderer.create(
        element,
        if (createMock != null) new raw.TestRendererOptions {
          override val createNodeMock = createMock
        }
        else null
      )
    }

    result
  }
  
  def testRender(element: ReactElement,
                 createMock: js.Function1[TestInstance, js.Any] = null): TestInstance = {
    
    val root = createTestRenderer(element, createMock).root
    root.children(0)
  }

  def findComponentProps[T](renderedComp: TestInstance,
                            searchComp: UiComponent[T])(implicit pos: Position): T = {
    
    utils.findComponentProps(renderedComp, searchComp)
  }

  def findProps[T](renderedComp: TestInstance, searchComp: UiComponent[T]): List[T] = {
    utils.findProps(renderedComp, searchComp)
  }

  def findComponents(component: TestInstance, componentType: Any): List[TestInstance] = {
    utils.findComponents(component, componentType)
  }

  def assertTestComponent[T](result: TestInstance, expectedComp: UiComponent[T])
                            (assertProps: T => Assertion,
                             assertChildren: List[TestInstance] => Assertion = _ => Succeeded
                            )(implicit pos: Position): Assertion = {

    utils.assertComponent(result, expectedComp)(assertProps, assertChildren)
  }

  def assertComponents(results: js.Array[TestInstance],
                       expectedList: List[ReactElement]
                      )(implicit pos: Position): Assertion = {

    val resultCount = results.length
    val expectedCount = expectedList.size
    if (resultCount != expectedCount) {
      fail(s"Result components count($resultCount) doesn't match expected count($expectedCount)")
    }

    expectedList.foldLeft(0) { (i, expected) =>
      assertNativeComponent(results(i), expected)
      i + 1
    }
    
    Succeeded
  }

  def assertNativeComponent(result: TestInstance,
                            expectedElement: ReactElement
                           )(implicit pos: Position): Assertion = {
    
    assertNativeComponent(result, expectedElement, utils.expectNoChildren)
  }
  
  def assertNativeComponent(result: TestInstance,
                            expectedElement: ReactElement,
                            assertChildren: List[TestInstance] => Assertion
                           )(implicit pos: Position): Assertion = {

    utils.assertNativeComponent(result, expectedElement, assertChildren)
  }
}

object TestRendererUtils {

  private case class UiComponentMock[T](name: String) extends UiComponent[T] {

    protected def create(): ReactClass = name.asInstanceOf[ReactClass]
  }
}