Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Napkin.Spec.CliReporter

Description

Synopsis

type Success = Bool
data TableState
- = Pending
- | Processing
- | Skipped
- | Done
- | Failed
data UIName
- = SpecListViewportName
- | SpecListViewName
data PreviousStates = PreviousStates {
- _previousStates_processingTime :: Maybe ElapsedSeconds
- _previousStates_finishedTime :: Maybe ElapsedSeconds
- _previousStates_info :: Maybe String
}
freshPreviousStates :: PreviousStates
prevStatesFinishedTime :: PreviousStates -> Maybe ElapsedSeconds
type ElapsedSeconds = Integer
type TableStates = Map String (TableState, PreviousStates)
data DrawState = DrawState {
- startTime :: UTCTime
- tableStates :: TableStates
- elapsedTime :: ElapsedSeconds
- processingTime :: ElapsedSeconds
- runDone :: Bool
- wantsToQuit :: Bool
- eta :: EtaType
- trackingQueryStats :: TrackingQueryStats
- showError :: Bool
- specListView :: SpecListView
}
type SpecListView = GenericList UIName Vector TableStateLine
data SpecList = SpecList
allTablesProcessed :: TableStates -> Bool
type TableName = Ref Table
type ErrorInfo = String
type SuccessInfo = String
data UpdateEvent
- = TableProcessingEvent TableName
- | TableDoneEvent TableName TrackingQueryStats
- | TableFailedEvent TableName ErrorInfo
- | TableSkippedEvent TableName
- | RunDone TrackingQueryStats
- | FinishFatal
- | Tick
eventHandler :: DrawState -> BrickEvent UIName UpdateEvent -> EventM UIName (Next DrawState)
cliReporter :: RuntimeEventQueue -> [Ref Table] -> EtaType -> IO Success
success :: DrawState -> Success
prettyElapsedTime :: Integer -> String
printFinalReport :: DrawState -> IO ()
filterByState :: (TableState -> Bool) -> TableStates -> TableStates
drawScreen :: DrawState -> [Widget UIName]
prettyUTCTime :: UTCTime -> String
data TableStateLine = TableStateLine String TableState PreviousStates
sortedStatesList :: TableStates -> [TableStateLine]
renderOneState :: Bool -> ElapsedSeconds -> TableStateLine -> Widget UIName
cliAttrMap :: AttrMap
tableRowSelected :: AttrName
successStateLine :: AttrName
skippedStateLine :: AttrName
failureStateLine :: AttrName
processingStateLine :: AttrName
pendingStateLine :: AttrName
introBox :: AttrName
errorBox :: AttrName
tableStatus :: AttrName
tableStatusError :: AttrName
napkinText :: [String]

Documentation

type Success = Bool #

data TableState #

Constructors

Pending
Processing
Skipped
Done
Failed

Instances

Instances details

Eq TableState #
Instance details Defined in Napkin.Spec.CliReporter Methods (==) :: TableState -> TableState -> Bool # (/=) :: TableState -> TableState -> Bool #
Show TableState #
Instance details Defined in Napkin.Spec.CliReporter Methods showsPrec :: Int -> TableState -> ShowS # show :: TableState -> String # showList :: [TableState] -> ShowS #

data UIName #

Unique names for user interface elements necessary for brick.

Constructors

SpecListViewportName
SpecListViewName

Instances

Instances details

Eq UIName #
Instance details Defined in Napkin.Spec.CliReporter Methods (==) :: UIName -> UIName -> Bool # (/=) :: UIName -> UIName -> Bool #
Ord UIName #
Instance details Defined in Napkin.Spec.CliReporter Methods compare :: UIName -> UIName -> Ordering # (<) :: UIName -> UIName -> Bool # (<=) :: UIName -> UIName -> Bool # (>) :: UIName -> UIName -> Bool # (>=) :: UIName -> UIName -> Bool # max :: UIName -> UIName -> UIName # min :: UIName -> UIName -> UIName #
Show UIName #
Instance details Defined in Napkin.Spec.CliReporter Methods showsPrec :: Int -> UIName -> ShowS # show :: UIName -> String # showList :: [UIName] -> ShowS #

data PreviousStates #

Constructors

PreviousStates
Fields _previousStates_processingTime :: Maybe ElapsedSeconds _previousStates_finishedTime :: Maybe ElapsedSeconds _previousStates_info :: Maybe String

freshPreviousStates :: PreviousStates #

prevStatesFinishedTime :: PreviousStates -> Maybe ElapsedSeconds #

type ElapsedSeconds = Integer #

type TableStates = Map String (TableState, PreviousStates) #

data DrawState #

Constructors

DrawState
Fields startTime :: UTCTime tableStates :: TableStates elapsedTime :: ElapsedSeconds processingTime :: ElapsedSeconds runDone :: Bool wantsToQuit :: Bool eta :: EtaType trackingQueryStats :: TrackingQueryStats showError :: Bool specListView :: SpecListView

type SpecListView = GenericList UIName Vector TableStateLine #

data SpecList #

Constructors

SpecList

Instances

Instances details

Eq SpecList #
Instance details Defined in Napkin.Spec.CliReporter Methods (==) :: SpecList -> SpecList -> Bool # (/=) :: SpecList -> SpecList -> Bool #
Ord SpecList #
Instance details Defined in Napkin.Spec.CliReporter Methods compare :: SpecList -> SpecList -> Ordering # (<) :: SpecList -> SpecList -> Bool # (<=) :: SpecList -> SpecList -> Bool # (>) :: SpecList -> SpecList -> Bool # (>=) :: SpecList -> SpecList -> Bool # max :: SpecList -> SpecList -> SpecList # min :: SpecList -> SpecList -> SpecList #

allTablesProcessed :: TableStates -> Bool #

True iff all tables have been serviced so that the elapsed time can stop ticking.

type TableName = Ref Table #

type ErrorInfo = String #

type SuccessInfo = String #

data UpdateEvent #

Constructors

TableProcessingEvent TableName
TableDoneEvent TableName TrackingQueryStats
TableFailedEvent TableName ErrorInfo
TableSkippedEvent TableName
RunDone TrackingQueryStats
FinishFatal
Tick

Instances

Instances details

Eq UpdateEvent #
Instance details Defined in Napkin.Spec.CliReporter Methods (==) :: UpdateEvent -> UpdateEvent -> Bool # (/=) :: UpdateEvent -> UpdateEvent -> Bool #
Show UpdateEvent #
Instance details Defined in Napkin.Spec.CliReporter Methods showsPrec :: Int -> UpdateEvent -> ShowS # show :: UpdateEvent -> String # showList :: [UpdateEvent] -> ShowS #