blob: dcbd9d9caf7ded63aacc31bdb37ecabdd8f86b44 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
// SPDX-License-Identifier: Apache-2.0
package firrtlTests.options
import firrtl.AnnotationSeq
import firrtl.annotations.{Annotation, NoTargetAnnotation}
import firrtl.options.{DoNotTerminateOnExit, DuplicateHandling, ExceptOnError, OptionsException}
import scopt.OptionParser
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers
class OptionParserSpec extends AnyFlatSpec with Matchers with firrtl.testutils.Utils {
case class IntAnnotation(x: Int) extends NoTargetAnnotation {
def extract: Int = x
}
/* An option parser that prepends to a Seq[Int] */
class IntParser extends OptionParser[AnnotationSeq]("Int Parser") {
opt[Int]("integer").abbr("n").unbounded.action((x, c) => IntAnnotation(x) +: c)
help("help")
}
trait DuplicateShortOption { this: OptionParser[AnnotationSeq] =>
opt[Int]("not-an-integer").abbr("n").unbounded.action((x, c) => IntAnnotation(x) +: c)
}
trait DuplicateLongOption { this: OptionParser[AnnotationSeq] =>
opt[Int]("integer").abbr("m").unbounded.action((x, c) => IntAnnotation(x) +: c)
}
trait WithIntParser { val parser = new IntParser }
behavior.of("A default OptionsParser")
it should "call sys.exit if terminate is called" in new WithIntParser {
info("exit status of 1 for failure")
catchStatus { parser.terminate(Left("some message")) } should be(Left(1))
info("exit status of 0 for success")
catchStatus { parser.terminate(Right(())) } should be(Left(0))
}
it should "print to stderr on an invalid option" in new WithIntParser {
grabStdOutErr { parser.parse(Array("--foo"), Seq[Annotation]()) }._2 should include("Unknown option --foo")
}
behavior.of("An OptionParser with DoNotTerminateOnExit mixed in")
it should "disable sys.exit for terminate method" in {
val parser = new IntParser with DoNotTerminateOnExit
info("no exit for failure")
catchStatus { parser.terminate(Left("some message")) } should be(Right(()))
info("no exit for success")
catchStatus { parser.terminate(Right(())) } should be(Right(()))
}
behavior.of("An OptionParser with DuplicateHandling mixed in")
it should "detect short duplicates" in {
val parser = new IntParser with DuplicateHandling with DuplicateShortOption
intercept[OptionsException] { parser.parse(Array[String](), Seq[Annotation]()) }.getMessage should startWith(
"Duplicate short option"
)
}
it should "detect long duplicates" in {
val parser = new IntParser with DuplicateHandling with DuplicateLongOption
intercept[OptionsException] { parser.parse(Array[String](), Seq[Annotation]()) }.getMessage should startWith(
"Duplicate long option"
)
}
behavior.of("An OptionParser with ExceptOnError mixed in")
it should "cause an OptionsException on an invalid option" in {
val parser = new IntParser with ExceptOnError
intercept[OptionsException] { parser.parse(Array("--foo"), Seq[Annotation]()) }.getMessage should include(
"Unknown option"
)
}
}
|
