// SPDX-License-Identifier: Apache-2.0

package chiselTests.stage.phases

import chisel3.stage.{ChiselOutputFileAnnotation, NoRunFirrtlCompilerAnnotation, PrintFullStackTraceAnnotation}
import chisel3.stage.phases.Checks

import firrtl.AnnotationSeq
import firrtl.annotations.NoTargetAnnotation
import firrtl.options.{OptionsException, Phase}
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers

class ChecksSpec extends AnyFlatSpec with Matchers {

  def checkExceptionMessage(phase: Phase, annotations: AnnotationSeq, messageStart: String): Unit =
    intercept[OptionsException] { phase.transform(annotations) }.getMessage should startWith(messageStart)

  class Fixture { val phase: Phase = new Checks }

  behavior.of(classOf[Checks].toString)

  it should "do nothing on sane annotation sequences" in new Fixture {
    val a = Seq(NoRunFirrtlCompilerAnnotation, PrintFullStackTraceAnnotation)
    phase.transform(a).toSeq should be(a)
  }

  it should "throw an OptionsException if more than one NoRunFirrtlCompilerAnnotation is specified" in new Fixture {
    val a = Seq(NoRunFirrtlCompilerAnnotation, NoRunFirrtlCompilerAnnotation)
    checkExceptionMessage(phase, a, "At most one NoRunFirrtlCompilerAnnotation")
  }

  it should "throw an OptionsException if more than one PrintFullStackTraceAnnotation is specified" in new Fixture {
    val a = Seq(PrintFullStackTraceAnnotation, PrintFullStackTraceAnnotation)
    checkExceptionMessage(phase, a, "At most one PrintFullStackTraceAnnotation")
  }

  it should "throw an OptionsException if more than one ChiselOutputFileAnnotation is specified" in new Fixture {
    val a = Seq(ChiselOutputFileAnnotation("foo"), ChiselOutputFileAnnotation("bar"))
    checkExceptionMessage(phase, a, "At most one Chisel output file")
  }

}
