Safe Haskell	Safe-Inferred
Language	Haskell2010

PbtCli.Options

Contents

Commands
Shared
Parsing

Description

The pbt-cli command line.

Synopsis

data Command
- = Suites SuitesOpts
- | Tests TestsOpts
- | Run RunOpts
- | ThreatModels ThreatModelsOpts
- | Doctor DoctorOpts
data SuitesOpts = SuitesOpts {
- suoRoot :: FilePath
- suoFormat :: SuitesFormat
- suoCompatibleOnly :: Bool
}
data TestsOpts = TestsOpts {
- tsoRoot :: FilePath
- tsoSuite :: Text
- tsoFormat :: TestsFormat
- tsoFilters :: Filters
- tsoDryRun :: Bool
}
data RunOpts = RunOpts {
- rnoRoot :: FilePath
- rnoSuites :: [Text]
- rnoCompatibleOnly :: Bool
- rnoOutput :: RunOutput
- rnoFilters :: Filters
- rnoDryRun :: Bool
}
data ThreatModelsOpts = ThreatModelsOpts {
- tmoRoot :: FilePath
- tmoSuite :: Text
- tmoJson :: Bool
- tmoDryRun :: Bool
}
newtype DoctorOpts = DoctorOpts {
- dcoRoot :: FilePath
}
data SuitesFormat
- = SuitesList
- | SuitesJson
- | SuitesJsonCompact
- | SuitesTable
- | SuitesTsv
data TestsFormat
- = TestsList
- | TestsJson
- | TestsTree
data RunOutput
- = RunConsole
- | RunStream
- | RunJson
data Filters = Filters {
- fltPattern :: Maybe String
- fltTestIds :: Maybe String
- fltThreatModelName :: Maybe String
- fltTestOption :: [String]
}
parseCommand :: Parser Command
commandParserInfo :: ParserInfo Command

Commands

data Command Source #

What pbt-cli was asked to do.

Constructors

Suites SuitesOpts
Tests TestsOpts
Run RunOpts
ThreatModels ThreatModelsOpts
Doctor DoctorOpts

Instances

Instances details

Show Command Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Eq Command Source #
Instance details Defined in PbtCli.Options Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #

data SuitesOpts Source #

Constructors

SuitesOpts
Fields suoRoot :: FilePath suoFormat :: SuitesFormat suoCompatibleOnly :: Bool

Instances

Instances details

Show SuitesOpts Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> SuitesOpts -> ShowS # show :: SuitesOpts -> String # showList :: [SuitesOpts] -> ShowS #
Eq SuitesOpts Source #
Instance details Defined in PbtCli.Options Methods (==) :: SuitesOpts -> SuitesOpts -> Bool # (/=) :: SuitesOpts -> SuitesOpts -> Bool #

data TestsOpts Source #

Constructors

TestsOpts
Fields tsoRoot :: FilePath tsoSuite :: Text tsoFormat :: TestsFormat tsoFilters :: Filters tsoDryRun :: Bool

Instances

Instances details

Show TestsOpts Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> TestsOpts -> ShowS # show :: TestsOpts -> String # showList :: [TestsOpts] -> ShowS #
Eq TestsOpts Source #
Instance details Defined in PbtCli.Options Methods (==) :: TestsOpts -> TestsOpts -> Bool # (/=) :: TestsOpts -> TestsOpts -> Bool #

data RunOpts Source #

Constructors

RunOpts
Fields rnoRoot :: FilePath rnoSuites :: [Text] empty means every discovered suite. rnoCompatibleOnly :: Bool rnoOutput :: RunOutput rnoFilters :: Filters rnoDryRun :: Bool

Instances

Instances details

Show RunOpts Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> RunOpts -> ShowS # show :: RunOpts -> String # showList :: [RunOpts] -> ShowS #
Eq RunOpts Source #
Instance details Defined in PbtCli.Options Methods (==) :: RunOpts -> RunOpts -> Bool # (/=) :: RunOpts -> RunOpts -> Bool #

data ThreatModelsOpts Source #

Constructors

ThreatModelsOpts
Fields tmoRoot :: FilePath tmoSuite :: Text tmoJson :: Bool tmoDryRun :: Bool

Instances

Instances details

Show ThreatModelsOpts Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> ThreatModelsOpts -> ShowS # show :: ThreatModelsOpts -> String # showList :: [ThreatModelsOpts] -> ShowS #
Eq ThreatModelsOpts Source #
Instance details Defined in PbtCli.Options Methods (==) :: ThreatModelsOpts -> ThreatModelsOpts -> Bool # (/=) :: ThreatModelsOpts -> ThreatModelsOpts -> Bool #

newtype DoctorOpts Source #

Constructors

DoctorOpts
Fields dcoRoot :: FilePath

Instances

Instances details

Show DoctorOpts Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> DoctorOpts -> ShowS # show :: DoctorOpts -> String # showList :: [DoctorOpts] -> ShowS #
Eq DoctorOpts Source #
Instance details Defined in PbtCli.Options Methods (==) :: DoctorOpts -> DoctorOpts -> Bool # (/=) :: DoctorOpts -> DoctorOpts -> Bool #

Shared

data SuitesFormat Source #

How to print a discovery result.

SuitesList is the default: a bare list of names is what a person scanning the output, or a shell pipeline consuming it, actually wants from a listing command. Every richer view is one flag away.

Constructors

SuitesList	one suite name per line (the default).
SuitesJson	the full document as indented JSON, in the documented field order.
SuitesJsonCompact	the full document as single-line JSON, for piping.
SuitesTable	aligned table with package, compatibility and `main-is`.
SuitesTsv	the legacy 5-column tab-separated format.

Instances

Instances details

Show SuitesFormat Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> SuitesFormat -> ShowS # show :: SuitesFormat -> String # showList :: [SuitesFormat] -> ShowS #
Eq SuitesFormat Source #
Instance details Defined in PbtCli.Options Methods (==) :: SuitesFormat -> SuitesFormat -> Bool # (/=) :: SuitesFormat -> SuitesFormat -> Bool #

data TestsFormat Source #

How to print a suite's test tree.

Constructors

TestsList	`id<TAB>path`, one test per line (the default).
TestsJson	the suite's own `suite_started` payload, verbatim.
TestsTree	nested groups with ids.

Instances

Instances details

Show TestsFormat Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> TestsFormat -> ShowS # show :: TestsFormat -> String # showList :: [TestsFormat] -> ShowS #
Eq TestsFormat Source #
Instance details Defined in PbtCli.Options Methods (==) :: TestsFormat -> TestsFormat -> Bool # (/=) :: TestsFormat -> TestsFormat -> Bool #

data RunOutput Source #

What run puts on stdout.

The default hands the child's stdio straight through, so a plain pbt-cli run looks exactly like the cabal test it wraps. The other two modes ask the suites for --streaming-json and then either render the events or forward them.

Constructors

RunConsole	cabal's and Tasty's own console output (the default).
RunStream	a live, human-readable rendering of the streaming events.
RunJson	the streaming events as NDJSON, each tagged with its suite.

Instances

Instances details

Show RunOutput Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> RunOutput -> ShowS # show :: RunOutput -> String # showList :: [RunOutput] -> ShowS #
Eq RunOutput Source #
Instance details Defined in PbtCli.Options Methods (==) :: RunOutput -> RunOutput -> Bool # (/=) :: RunOutput -> RunOutput -> Bool #

data Filters Source #

Test-selection options common to the commands that actually run a suite.

These are forwarded to the test binary rather than interpreted here, so a suite built against a newer convex-tasty-streaming than this binary still gets them intact.

Constructors

Filters
Fields fltPattern :: Maybe String Tasty's `-p`. fltTestIds :: Maybe String `--test-id`, comma-separated. fltThreatModelName :: Maybe String `--threat-model-name`, comma-separated prefixes. fltTestOption :: [String] escape hatch: extra raw test options.

Instances

Instances details

Show Filters Source #
Instance details Defined in PbtCli.Options Methods showsPrec :: Int -> Filters -> ShowS # show :: Filters -> String # showList :: [Filters] -> ShowS #
Eq Filters Source #
Instance details Defined in PbtCli.Options Methods (==) :: Filters -> Filters -> Bool # (/=) :: Filters -> Filters -> Bool #

Parsing

parseCommand :: Parser Command Source #

commandParserInfo :: ParserInfo Command Source #

The full parser, with --help and --version attached.