Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Spec.CliReporter

Description

Synopsis

type Success = Bool
data State
- = 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
data EventSourceInfo
- = EventFromTable
- | EventFromHook
eventSourceInfo :: EventSource -> EventSourceInfo
data StateInfo = StateInfo {
- state :: State
- previousStates :: PreviousStates
- sourceInfo :: EventSourceInfo
}
type States = Map String StateInfo
type TableNameMap = Map String String
data DrawState b = DrawState {
- startTime :: UTCTime
- tableNames :: TableNameMap
- showPostProcessedTableRef :: Bool
- tableStates :: States
- elapsedTime :: ElapsedSeconds
- processingTime :: ElapsedSeconds
- runDone :: Bool
- wantsToQuit :: Bool
- eta :: EtaType
- trackingQueryStats :: TrackingQueryStats b
- showError :: Bool
- specListView :: SpecListView
}
specListViewL :: forall b. Lens' (DrawState b) SpecListView
type SpecListView = List UIName StateLine
data SpecList = SpecList
type ErrorInfo = String
type SuccessInfo = String
data BeforeAfterRenamerRef = BeforeAfterRenamerRef {
- beforeRef :: SpecTableName
- afterRef :: Ref Table
}
data UpdateEvent b
- = ProcessingEvent EventSource
- | DoneEvent EventSource (CreateQueryStats b) (Maybe (HookQueryStats b))
- | FailedEvent EventSource ErrorInfo
- | SkippedEvent [EventSource]
- | RunDone (QueryStats b)
- | FinishFatal
- | Tick
eventHandler :: HasBackendQueryStats b => BrickEvent UIName (UpdateEvent b) -> EventM UIName (DrawState b) ()
cliReporter :: HasBackendQueryStats b => RuntimeEventQueue b -> [BeforeAfterRenamerRef] -> EtaType -> IO Success
success :: DrawState b -> Success
prettyElapsedTime :: Integer -> String
printFinalReport :: HasBackendQueryStats b => DrawState b -> IO ()
filterByState :: (State -> Bool) -> States -> States
drawScreen :: DrawState b -> [Widget UIName]
prettyUTCTime :: UTCTime -> String
data StateLine = StateLine String State PreviousStates EventSourceInfo
sortedStatesList :: States -> [StateLine]
renderOneState :: Bool -> ElapsedSeconds -> Bool -> TableNameMap -> StateLine -> 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 State #

Constructors

Pending
Processing
Skipped
Done
Failed

Instances

Instances details

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

data UIName #

Unique names for user interface elements necessary for brick.

Constructors

SpecListViewportName
SpecListViewName

Instances

Instances details

Show UIName #
Instance details Defined in Napkin.Spec.CliReporter Methods showsPrec :: Int -> UIName -> ShowS # show :: UIName -> String # showList :: [UIName] -> ShowS #
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 #

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 #

data EventSourceInfo #

Constructors

EventFromTable
EventFromHook

Instances

Instances details

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

eventSourceInfo :: EventSource -> EventSourceInfo #

data StateInfo #

Constructors

StateInfo
Fields state :: State previousStates :: PreviousStates sourceInfo :: EventSourceInfo

type States = Map String StateInfo #

type TableNameMap = Map String String #

data DrawState b #

Constructors

DrawState
Fields startTime :: UTCTime tableNames :: TableNameMap showPostProcessedTableRef :: Bool tableStates :: States elapsedTime :: ElapsedSeconds processingTime :: ElapsedSeconds runDone :: Bool wantsToQuit :: Bool eta :: EtaType trackingQueryStats :: TrackingQueryStats b showError :: Bool specListView :: SpecListView

specListViewL :: forall b. Lens' (DrawState b) SpecListView #

type SpecListView = List UIName StateLine #

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 #

type ErrorInfo = String #

type SuccessInfo = String #

data BeforeAfterRenamerRef #

represents table naming before and after renamer processing

Constructors

BeforeAfterRenamerRef
Fields beforeRef :: SpecTableName afterRef :: Ref Table

data UpdateEvent b #

Constructors

ProcessingEvent EventSource
DoneEvent EventSource (CreateQueryStats b) (Maybe (HookQueryStats b))
FailedEvent EventSource ErrorInfo
SkippedEvent [EventSource]
RunDone (QueryStats b)
FinishFatal
Tick