Copyright	(c) 2026 Institute for Digital Autonomy
License	EUPL-1.2
Maintainer	IDA
Safe Haskell	Trustworthy
Language	Haskell2010

Effectful.Marionette

Contents

Orphan instances

Description

Marionette is Firefox's built-in remote-control protocol. It plays the same role as a WebDriver server, letting a test suite drive a real Firefox instance to navigate, find and interact with elements, execute scripts, and so on. In addition to WebDriver functionality, Marionette can also address Firefox's own chrome (its menus and toolbars) rather than just the content of a web page, and speaks its own lightweight length-prefixed JSON protocol directly over a TCP socket instead of HTTP.

This module lifts every command from the marionette library into the Eff monad as a Marionette effect. Run runMarionette to open the connection and discharge that effect for the duration of your action.

How to use Marionette

Starting Firefox and a session

Launch Firefox with the --marionette flag so that it listens for connections on port 2828.

Use runMarionette to connect to it and run a client program. Start a new session with newSession, and quit the session with deleteSession:

import Effectful
import Effectful.Marionette
import Effectful.Process.Typed
import System.Process.Typed (proc)

main :: IO ()
main =
  runEff . runTypedProcess $
    withProcessTerm_ (proc "firefox" ["--marionette", "--headless"]) \_process ->
      runMarionette $ do
        newSession
        quit

Finding and interacting with elements

Find elements by calling findElement with a Selector, then pass the resulting Element to other commands:

submitForm :: (HasCallStack, Marionette :> es) => Eff es ()
submitForm = do
  input <- findElement (ById "text-input")
  elementSendKeys input "hello, world"
  submit <- findElement (ByCSS "button[type=submit]")
  elementClick submit

Error handling

Catch command failures with catchError, for example to retry a command against a fallback element:

import Control.Monad.Error.Class (catchError)

clickFirstAvailable :: (HasCallStack, Marionette :> es) => Eff es ()
clickFirstAvailable =
  (elementClick =<< findElement (ById "primary-button"))
    `catchError` \_ -> elementClick =<< findElement (ById "fallback-button")

Synopsis

print :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
data Marionette (a :: Type -> Type) b
Marionette :: TQueue CommandWithCallback %1 -> StaticRep Marionette
acceptAlert :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
acceptConnections :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Bool -> Eff es ()
addCookie :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Cookie -> Eff es ()
addCredential :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Credential -> Eff es ()
addVirtualAuthenticator :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => VirtualAuthenticator -> Eff es AuthenticatorId
back :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
closeChromeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
closeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
deleteAllCookies :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
deleteCookie :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es ()
deleteSession :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
dismissAlert :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
elementClear :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es ()
elementClick :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es ()
elementSendKeys :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Text -> Eff es ()
executeAsyncScript :: forall (es :: [Effect]) f a. (HasCallStack, Marionette :> es, Foldable f, FromJSON a) => Text -> f Value -> Eff es (Maybe a)
executeScript :: forall (es :: [Effect]) f a. (HasCallStack, Marionette :> es, Foldable f, FromJSON a) => Text -> f Value -> Eff es a
findElement :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Selector -> Eff es Element
findElementFrom :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Selector -> Eff es Element
findElementFromShadowRoot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Shadow -> Selector -> Eff es Element
findElements :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Selector -> Eff es [Element]
findElementsFrom :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Selector -> Eff es [Element]
findElementsFromShadowRoot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Shadow -> Selector -> Eff es [Element]
forward :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
fullscreenWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
getAccessibilityPropertiesForAccessibilityNode :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es AccessibilityProperties
getAccessibilityPropertiesForElement :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es AccessibilityProperties
getActiveElement :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Element
getAlertText :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text
getComputedLabel :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text
getComputedRole :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text
getContext :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Context
getCookies :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es [Cookie]
getCredentials :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Eff es [Credential]
getCurrentURL :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text
getElementAttribute :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Element -> Eff es (Maybe Text)
getElementCSSValue :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Text -> Eff es (Maybe Text)
getElementProperty :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Text -> Eff es (Maybe Text)
getElementRect :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Rect
getElementTagName :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text
getElementText :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text
getPageSource :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text
getScreenOrientation :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Orientation
getShadowRoot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Shadow
getTimeouts :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Timeouts
getTitle :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text
getWindowHandle :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es WindowHandle
getWindowHandles :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es [WindowHandle]
getWindowRect :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Rect
getWindowType :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text
isElementDisplayed :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Bool
isElementEnabled :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Bool
isElementSelected :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Bool
maximizeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
minimizeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
navigate :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es ()
newSession :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
newTab :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es NewWindowResult
newWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es NewWindowResult
performActions :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
quit :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
refresh :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
registerChromeHandler :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> [RegistryEntry] -> Eff es Text
releaseActions :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
removeAllCredentials :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Eff es ()
removeCredential :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> CredentialId -> Eff es ()
removeVirtualAuthenticator :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Eff es ()
sendAlertText :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es ()
setContext :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Context -> Eff es ()
setPermission :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
setScreenOrientation :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Orientation -> Eff es ()
setTimeouts :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Timeouts -> Eff es ()
setUserVerified :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Bool -> Eff es ()
setWindowRect :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Rect -> Eff es ()
switchToFrame :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Frame -> Eff es ()
switchToParentFrame :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ()
switchToWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => WindowHandle -> Eff es ()
takeScreenshot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ByteString
unregisterChromeHandler :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es ()
runMarionette :: forall (es :: [Effect]) a. IOE :> es => Eff (Marionette ': es) a -> Eff es a
m :: forall (es' :: [Effect]) a. (HasCallStack, Marionette :> es') => Eff '[Concurrent, Reader (TQueue CommandWithCallback), Error Error, IOE] a -> Eff es' a
data AccessibilityProperties = AccessibilityProperties {
- role :: Maybe Text
- name :: Maybe Text
- value :: Maybe Text
- description :: Maybe Text
}
newtype AuthenticatorId = AuthenticatorId Text
data Context
- = ContentContext
- | ChromeContext
data Cookie = Cookie {
- name :: Text
- value :: Text
- path :: Maybe Text
- domain :: Maybe Text
- secure :: Maybe Bool
- httpOnly :: Maybe Bool
- expiry :: Maybe Int
}
data Credential = Credential {
- credentialId :: CredentialId
- isResidentCredential :: Bool
- rpId :: Text
- privateKey :: Text
- userHandle :: Maybe Text
- signCount :: Int
}
newtype CredentialId = CredentialId Text
newtype Element = Element {
- elementId :: Text
}
data Frame
- = FrameIndex Int
- | FrameElement Element
- | TopFrame
data NewWindowResult = NewWindowResult {
- newWindowHandle :: WindowHandle
- newWindowType :: WindowType
}
data Orientation
- = Portrait
- | Landscape
data Rect = Rect {
- x :: Float
- y :: Float
- width :: Float
- height :: Float
}
data RegistryEntry = RegistryEntry {
- entryType :: Text
- namespace :: Text
- directory :: Text
- options :: Maybe Text
}
data Selector
- = ById Text
- | ByName Text
- | ByClass Text
- | ByTag Text
- | ByLinkText Text
- | ByPartialLinkText Text
- | ByCSS Text
- | ByXPath Text
- | Anon Text
- | AnonAttribute Text
newtype Shadow = Shadow {
- shadowId :: Text
}
data Timeouts = Timeouts {
- script :: Maybe Int
- pageLoad :: Maybe Int
- implicit :: Maybe Int
}
data VirtualAuthenticator = VirtualAuthenticator {
- protocol :: Text
- transport :: Text
- hasResidentKey :: Bool
- hasUserVerification :: Bool
- isUserConsenting :: Bool
- isUserVerified :: Bool
- extensions :: Maybe [Text]
- uvm :: Maybe Bool
}
newtype WindowHandle = WindowHandle Text

Documentation

print :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted print.

data Marionette (a :: Type -> Type) b Source #

Instances

Instances details

type DispatchOf Marionette Source #
Instance details Defined in Effectful.Marionette type DispatchOf Marionette = 'Static 'WithSideEffects
newtype StaticRep Marionette Source #
Instance details Defined in Effectful.Marionette newtype StaticRep Marionette = Marionette (TQueue CommandWithCallback)

Marionette :: TQueue CommandWithCallback %1 -> StaticRep Marionette Source #

acceptAlert :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted acceptAlert.

acceptConnections :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Bool -> Eff es () Source #

Lifted acceptConnections.

addCookie :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Cookie -> Eff es () Source #

Lifted addCookie.

addCredential :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Credential -> Eff es () Source #

Lifted addCredential.

addVirtualAuthenticator :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => VirtualAuthenticator -> Eff es AuthenticatorId Source #

Lifted addVirtualAuthenticator.

back :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted back.

closeChromeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted closeChromeWindow.

closeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted closeWindow.

deleteAllCookies :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted deleteAllCookies.

deleteCookie :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es () Source #

Lifted deleteCookie.

deleteSession :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted deleteSession.

dismissAlert :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted dismissAlert.

elementClear :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es () Source #

Lifted elementClear.

elementClick :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es () Source #

Lifted elementClick.

elementSendKeys :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Text -> Eff es () Source #

Lifted elementSendKeys.

executeAsyncScript :: forall (es :: [Effect]) f a. (HasCallStack, Marionette :> es, Foldable f, FromJSON a) => Text -> f Value -> Eff es (Maybe a) Source #

Lifted executeAsyncScript.

executeScript :: forall (es :: [Effect]) f a. (HasCallStack, Marionette :> es, Foldable f, FromJSON a) => Text -> f Value -> Eff es a Source #

Lifted executeScript.

findElement :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Selector -> Eff es Element Source #

Lifted findElement.

findElementFrom :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Selector -> Eff es Element Source #

Lifted findElementFrom.

findElementFromShadowRoot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Shadow -> Selector -> Eff es Element Source #

Lifted findElementFromShadowRoot.

findElements :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Selector -> Eff es [Element] Source #

Lifted findElements.

findElementsFrom :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Selector -> Eff es [Element] Source #

Lifted findElementsFrom.

findElementsFromShadowRoot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Shadow -> Selector -> Eff es [Element] Source #

Lifted findElementsFromShadowRoot.

forward :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted forward.

fullscreenWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted fullscreenWindow.

getAccessibilityPropertiesForAccessibilityNode :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es AccessibilityProperties Source #

Lifted getAccessibilityPropertiesForAccessibilityNode.

getAccessibilityPropertiesForElement :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es AccessibilityProperties Source #

Lifted getAccessibilityPropertiesForElement.

getActiveElement :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Element Source #

Lifted getActiveElement.

getAlertText :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text Source #

Lifted getAlertText.

getComputedLabel :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text Source #

Lifted getComputedLabel.

getComputedRole :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text Source #

Lifted getComputedRole.

getContext :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Context Source #

Lifted getContext.

getCookies :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es [Cookie] Source #

Lifted getCookies.

getCredentials :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Eff es [Credential] Source #

Lifted getCredentials.

getCurrentURL :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text Source #

Lifted getCurrentURL.

getElementAttribute :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Element -> Eff es (Maybe Text) Source #

Lifted getElementAttribute.

getElementCSSValue :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Text -> Eff es (Maybe Text) Source #

Lifted getElementCSSValue.

getElementProperty :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Text -> Eff es (Maybe Text) Source #

Lifted getElementProperty.

getElementRect :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Rect Source #

Lifted getElementRect.

getElementTagName :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text Source #

Lifted getElementTagName.

getElementText :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Text Source #

Lifted getElementText.

getPageSource :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text Source #

Lifted getPageSource.

getScreenOrientation :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Orientation Source #

Lifted getScreenOrientation.

getShadowRoot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Shadow Source #

Lifted getShadowRoot.

getTimeouts :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Timeouts Source #

Lifted getTimeouts.

getTitle :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text Source #

Lifted getTitle.

getWindowHandle :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es WindowHandle Source #

Lifted getWindowHandle.

getWindowHandles :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es [WindowHandle] Source #

Lifted getWindowHandles.

getWindowRect :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Rect Source #

Lifted getWindowRect.

getWindowType :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es Text Source #

Lifted getWindowType.

isElementDisplayed :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Bool Source #

Lifted isElementDisplayed.

isElementEnabled :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Bool Source #

Lifted isElementEnabled.

isElementSelected :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Element -> Eff es Bool Source #

Lifted isElementSelected.

maximizeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted maximizeWindow.

minimizeWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted minimizeWindow.

navigate :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es () Source #

Lifted navigate.

newSession :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted newSession.

newTab :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es NewWindowResult Source #

Lifted newTab.

newWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es NewWindowResult Source #

Lifted newWindow.

performActions :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted performActions.

quit :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted quit.

refresh :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted refresh.

registerChromeHandler :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> [RegistryEntry] -> Eff es Text Source #

Lifted registerChromeHandler.

releaseActions :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted releaseActions.

removeAllCredentials :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Eff es () Source #

Lifted removeAllCredentials.

removeCredential :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> CredentialId -> Eff es () Source #

Lifted removeCredential.

removeVirtualAuthenticator :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Eff es () Source #

Lifted removeVirtualAuthenticator.

sendAlertText :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es () Source #

Lifted sendAlertText.

setContext :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Context -> Eff es () Source #

Lifted setContext.

setPermission :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted setPermission.

setScreenOrientation :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Orientation -> Eff es () Source #

Lifted setScreenOrientation.

setTimeouts :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Timeouts -> Eff es () Source #

Lifted setTimeouts.

setUserVerified :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => AuthenticatorId -> Bool -> Eff es () Source #

Lifted setUserVerified.

setWindowRect :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Rect -> Eff es () Source #

Lifted setWindowRect.

switchToFrame :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Frame -> Eff es () Source #

Lifted switchToFrame.

switchToParentFrame :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es () Source #

Lifted switchToParentFrame.

switchToWindow :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => WindowHandle -> Eff es () Source #

Lifted switchToWindow.

takeScreenshot :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Eff es ByteString Source #

Lifted takeScreenshot.

unregisterChromeHandler :: forall (es :: [Effect]). (HasCallStack, Marionette :> es) => Text -> Eff es () Source #

Lifted unregisterChromeHandler.

runMarionette :: forall (es :: [Effect]) a. IOE :> es => Eff (Marionette ': es) a -> Eff es a Source #

Connects to a running Firefox instance listening for Marionette connections (started with the --marionette command-line flag), and discharges the Marionette effect for the supplied action.

m :: forall (es' :: [Effect]) a. (HasCallStack, Marionette :> es') => Eff '[Concurrent, Reader (TQueue CommandWithCallback), Error Error, IOE] a -> Eff es' a Source #

data AccessibilityProperties #

Constructors

AccessibilityProperties
Fields role :: Maybe Text name :: Maybe Text value :: Maybe Text description :: Maybe Text

Instances

Instances details

FromJSON AccessibilityProperties

Instance details

Defined in Test.Marionette.AccessibilityProperties

Methods

parseJSON :: Value -> Parser AccessibilityProperties #

parseJSONList :: Value -> Parser [AccessibilityProperties] #

omittedField :: Maybe AccessibilityProperties #

Generic AccessibilityProperties

Instance details

Defined in Test.Marionette.AccessibilityProperties

Associated Types

type Rep AccessibilityProperties

Instance details

Defined in Test.Marionette.AccessibilityProperties

type Rep AccessibilityProperties = D1 ('MetaData "AccessibilityProperties" "Test.Marionette.AccessibilityProperties" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "AccessibilityProperties" 'PrefixI 'True) ((S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Methods

from :: AccessibilityProperties -> Rep AccessibilityProperties x #

to :: Rep AccessibilityProperties x -> AccessibilityProperties #

Show AccessibilityProperties

Instance details

Defined in Test.Marionette.AccessibilityProperties

Methods

showsPrec :: Int -> AccessibilityProperties -> ShowS #

show :: AccessibilityProperties -> String #

showList :: [AccessibilityProperties] -> ShowS #

Eq AccessibilityProperties

Instance details

Defined in Test.Marionette.AccessibilityProperties

Methods

(==) :: AccessibilityProperties -> AccessibilityProperties -> Bool #

(/=) :: AccessibilityProperties -> AccessibilityProperties -> Bool #

type Rep AccessibilityProperties

Instance details

Defined in Test.Marionette.AccessibilityProperties

type Rep AccessibilityProperties = D1 ('MetaData "AccessibilityProperties" "Test.Marionette.AccessibilityProperties" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "AccessibilityProperties" 'PrefixI 'True) ((S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

newtype AuthenticatorId #

Constructors

AuthenticatorId Text

Instances

Instances details

FromJSON AuthenticatorId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

parseJSON :: Value -> Parser AuthenticatorId #

parseJSONList :: Value -> Parser [AuthenticatorId] #

omittedField :: Maybe AuthenticatorId #

ToJSON AuthenticatorId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

toJSON :: AuthenticatorId -> Value #

toEncoding :: AuthenticatorId -> Encoding #

toJSONList :: [AuthenticatorId] -> Value #

toEncodingList :: [AuthenticatorId] -> Encoding #

omitField :: AuthenticatorId -> Bool #

Generic AuthenticatorId

Instance details

Defined in Test.Marionette.WebAuthn

Associated Types

type Rep AuthenticatorId
Instance details Defined in Test.Marionette.WebAuthn type Rep AuthenticatorId = D1 ('MetaData "AuthenticatorId" "Test.Marionette.WebAuthn" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'True) (C1 ('MetaCons "AuthenticatorId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: AuthenticatorId -> Rep AuthenticatorId x #

to :: Rep AuthenticatorId x -> AuthenticatorId #

Show AuthenticatorId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

showsPrec :: Int -> AuthenticatorId -> ShowS #

show :: AuthenticatorId -> String #

showList :: [AuthenticatorId] -> ShowS #

Eq AuthenticatorId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

(==) :: AuthenticatorId -> AuthenticatorId -> Bool #

(/=) :: AuthenticatorId -> AuthenticatorId -> Bool #

type Rep AuthenticatorId

Instance details

Defined in Test.Marionette.WebAuthn

type Rep AuthenticatorId = D1 ('MetaData "AuthenticatorId" "Test.Marionette.WebAuthn" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'True) (C1 ('MetaCons "AuthenticatorId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Context #

The browsing context for script execution.

Constructors

ContentContext
ChromeContext

Instances

Instances details

FromJSON Context

Instance details

Defined in Test.Marionette.Context

Methods

parseJSON :: Value -> Parser Context #

parseJSONList :: Value -> Parser [Context] #

omittedField :: Maybe Context #

ToJSON Context

Instance details

Defined in Test.Marionette.Context

Methods

toJSON :: Context -> Value #

toEncoding :: Context -> Encoding #

toJSONList :: [Context] -> Value #

toEncodingList :: [Context] -> Encoding #

omitField :: Context -> Bool #

Bounded Context

Instance details

Defined in Test.Marionette.Context

Methods

minBound :: Context #

maxBound :: Context #

Enum Context

Instance details

Defined in Test.Marionette.Context

Methods

succ :: Context -> Context #

pred :: Context -> Context #

toEnum :: Int -> Context #

fromEnum :: Context -> Int #

enumFrom :: Context -> [Context] #

enumFromThen :: Context -> Context -> [Context] #

enumFromTo :: Context -> Context -> [Context] #

enumFromThenTo :: Context -> Context -> Context -> [Context] #

Generic Context

Instance details

Defined in Test.Marionette.Context

Associated Types

type Rep Context
Instance details Defined in Test.Marionette.Context type Rep Context = D1 ('MetaData "Context" "Test.Marionette.Context" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "ContentContext" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChromeContext" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Context -> Rep Context x #

to :: Rep Context x -> Context #

Show Context

Instance details

Defined in Test.Marionette.Context

Methods

showsPrec :: Int -> Context -> ShowS #

show :: Context -> String #

showList :: [Context] -> ShowS #

Eq Context

Instance details

Defined in Test.Marionette.Context

Methods

(==) :: Context -> Context -> Bool #

(/=) :: Context -> Context -> Bool #

type Rep Context

Instance details

Defined in Test.Marionette.Context

type Rep Context = D1 ('MetaData "Context" "Test.Marionette.Context" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "ContentContext" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChromeContext" 'PrefixI 'False) (U1 :: Type -> Type))

data Cookie #

Constructors

Cookie
Fields name :: Text value :: Text path :: Maybe Text domain :: Maybe Text secure :: Maybe Bool httpOnly :: Maybe Bool expiry :: Maybe Int

Instances

data Credential #

Constructors

Credential
Fields credentialId :: CredentialId isResidentCredential :: Bool rpId :: Text privateKey :: Text userHandle :: Maybe Text signCount :: Int

Instances

Instances details

FromJSON Credential

Instance details

Defined in Test.Marionette.WebAuthn

Methods

parseJSON :: Value -> Parser Credential #

parseJSONList :: Value -> Parser [Credential] #

omittedField :: Maybe Credential #

ToJSON Credential

Instance details

Defined in Test.Marionette.WebAuthn

Methods

toJSON :: Credential -> Value #

toEncoding :: Credential -> Encoding #

toJSONList :: [Credential] -> Value #

toEncodingList :: [Credential] -> Encoding #

omitField :: Credential -> Bool #

Generic Credential

Instance details

Defined in Test.Marionette.WebAuthn

Associated Types

type Rep Credential

Instance details

Defined in Test.Marionette.WebAuthn

type Rep Credential = D1 ('MetaData "Credential" "Test.Marionette.WebAuthn" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Credential" 'PrefixI 'True) ((S1 ('MetaSel ('Just "credentialId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CredentialId) :*: (S1 ('MetaSel ('Just "isResidentCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rpId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "userHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))))

Methods

from :: Credential -> Rep Credential x #

to :: Rep Credential x -> Credential #

Show Credential

Instance details

Defined in Test.Marionette.WebAuthn

Methods

showsPrec :: Int -> Credential -> ShowS #

show :: Credential -> String #

showList :: [Credential] -> ShowS #

Eq Credential

Instance details

Defined in Test.Marionette.WebAuthn

Methods

(==) :: Credential -> Credential -> Bool #

(/=) :: Credential -> Credential -> Bool #

type Rep Credential

Instance details

Defined in Test.Marionette.WebAuthn

type Rep Credential = D1 ('MetaData "Credential" "Test.Marionette.WebAuthn" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Credential" 'PrefixI 'True) ((S1 ('MetaSel ('Just "credentialId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CredentialId) :*: (S1 ('MetaSel ('Just "isResidentCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rpId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "userHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))))

newtype CredentialId #

Constructors

CredentialId Text

Instances

Instances details

FromJSON CredentialId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

parseJSON :: Value -> Parser CredentialId #

parseJSONList :: Value -> Parser [CredentialId] #

omittedField :: Maybe CredentialId #

ToJSON CredentialId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

toJSON :: CredentialId -> Value #

toEncoding :: CredentialId -> Encoding #

toJSONList :: [CredentialId] -> Value #

toEncodingList :: [CredentialId] -> Encoding #

omitField :: CredentialId -> Bool #

Generic CredentialId

Instance details

Defined in Test.Marionette.WebAuthn

Associated Types

type Rep CredentialId
Instance details Defined in Test.Marionette.WebAuthn type Rep CredentialId = D1 ('MetaData "CredentialId" "Test.Marionette.WebAuthn" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'True) (C1 ('MetaCons "CredentialId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: CredentialId -> Rep CredentialId x #

to :: Rep CredentialId x -> CredentialId #

Show CredentialId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

showsPrec :: Int -> CredentialId -> ShowS #

show :: CredentialId -> String #

showList :: [CredentialId] -> ShowS #

Eq CredentialId

Instance details

Defined in Test.Marionette.WebAuthn

Methods

(==) :: CredentialId -> CredentialId -> Bool #

(/=) :: CredentialId -> CredentialId -> Bool #

type Rep CredentialId

Instance details

Defined in Test.Marionette.WebAuthn

type Rep CredentialId = D1 ('MetaData "CredentialId" "Test.Marionette.WebAuthn" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'True) (C1 ('MetaCons "CredentialId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype Element #

An opaque identifier for a web page element.

Constructors

Element
Fields elementId :: Text

Instances

Instances details

FromJSON Element
Instance details Defined in Test.Marionette.Element Methods parseJSON :: Value -> Parser Element # parseJSONList :: Value -> Parser [Element] # omittedField :: Maybe Element #
ToJSON Element
Instance details Defined in Test.Marionette.Element Methods toJSON :: Element -> Value # toEncoding :: Element -> Encoding # toJSONList :: [Element] -> Value # toEncodingList :: [Element] -> Encoding # omitField :: Element -> Bool #
Read Element
Instance details Defined in Test.Marionette.Element Methods readsPrec :: Int -> ReadS Element # readList :: ReadS [Element] # readPrec :: ReadPrec Element # readListPrec :: ReadPrec [Element] #
Show Element
Instance details Defined in Test.Marionette.Element Methods showsPrec :: Int -> Element -> ShowS # show :: Element -> String # showList :: [Element] -> ShowS #
Eq Element
Instance details Defined in Test.Marionette.Element Methods (==) :: Element -> Element -> Bool # (/=) :: Element -> Element -> Bool #
Ord Element
Instance details Defined in Test.Marionette.Element Methods compare :: Element -> Element -> Ordering # (<) :: Element -> Element -> Bool # (<=) :: Element -> Element -> Bool # (>) :: Element -> Element -> Bool # (>=) :: Element -> Element -> Bool # max :: Element -> Element -> Element # min :: Element -> Element -> Element #
Hashable Element
Instance details Defined in Test.Marionette.Element Methods hashWithSalt :: Int -> Element -> Int # hash :: Element -> Int #

data Frame #

Constructors

FrameIndex Int
FrameElement Element
TopFrame

Instances

Instances details

FromJSON Frame

Instance details

Defined in Test.Marionette.Frame

Methods

parseJSON :: Value -> Parser Frame #

parseJSONList :: Value -> Parser [Frame] #

omittedField :: Maybe Frame #

ToJSON Frame

Instance details

Defined in Test.Marionette.Frame

Methods

toJSON :: Frame -> Value #

toEncoding :: Frame -> Encoding #

toJSONList :: [Frame] -> Value #

toEncodingList :: [Frame] -> Encoding #

omitField :: Frame -> Bool #

Generic Frame

Instance details

Defined in Test.Marionette.Frame

Associated Types

type Rep Frame

Instance details

Defined in Test.Marionette.Frame

type Rep Frame = D1 ('MetaData "Frame" "Test.Marionette.Frame" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "FrameIndex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: (C1 ('MetaCons "FrameElement" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Element)) :+: C1 ('MetaCons "TopFrame" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Frame -> Rep Frame x #

to :: Rep Frame x -> Frame #

Show Frame

Instance details

Defined in Test.Marionette.Frame

Methods

showsPrec :: Int -> Frame -> ShowS #

show :: Frame -> String #

showList :: [Frame] -> ShowS #

Eq Frame

Instance details

Defined in Test.Marionette.Frame

Methods

(==) :: Frame -> Frame -> Bool #

(/=) :: Frame -> Frame -> Bool #

Hashable Frame

Instance details

Defined in Test.Marionette.Frame

Methods

hashWithSalt :: Int -> Frame -> Int #

hash :: Frame -> Int #

type Rep Frame

Instance details

Defined in Test.Marionette.Frame

type Rep Frame = D1 ('MetaData "Frame" "Test.Marionette.Frame" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "FrameIndex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: (C1 ('MetaCons "FrameElement" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Element)) :+: C1 ('MetaCons "TopFrame" 'PrefixI 'False) (U1 :: Type -> Type)))

data NewWindowResult #

Constructors

NewWindowResult
Fields newWindowHandle :: WindowHandle newWindowType :: WindowType

Instances

Instances details

FromJSON NewWindowResult

Instance details

Defined in Test.Marionette.Window

Methods

parseJSON :: Value -> Parser NewWindowResult #

parseJSONList :: Value -> Parser [NewWindowResult] #

omittedField :: Maybe NewWindowResult #

Generic NewWindowResult

Instance details

Defined in Test.Marionette.Window

Associated Types

type Rep NewWindowResult

Instance details

Defined in Test.Marionette.Window

type Rep NewWindowResult = D1 ('MetaData "NewWindowResult" "Test.Marionette.Window" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "NewWindowResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "newWindowHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WindowHandle) :*: S1 ('MetaSel ('Just "newWindowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WindowType)))

Methods

from :: NewWindowResult -> Rep NewWindowResult x #

to :: Rep NewWindowResult x -> NewWindowResult #

Show NewWindowResult

Instance details

Defined in Test.Marionette.Window

Methods

showsPrec :: Int -> NewWindowResult -> ShowS #

show :: NewWindowResult -> String #

showList :: [NewWindowResult] -> ShowS #

Eq NewWindowResult

Instance details

Defined in Test.Marionette.Window

Methods

(==) :: NewWindowResult -> NewWindowResult -> Bool #

(/=) :: NewWindowResult -> NewWindowResult -> Bool #

type Rep NewWindowResult

Instance details

Defined in Test.Marionette.Window

type Rep NewWindowResult = D1 ('MetaData "NewWindowResult" "Test.Marionette.Window" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "NewWindowResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "newWindowHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WindowHandle) :*: S1 ('MetaSel ('Just "newWindowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WindowType)))

data Orientation #

Constructors

Portrait
Landscape

Instances

Instances details

FromJSON Orientation

Instance details

Defined in Test.Marionette.Orientation

Methods

parseJSON :: Value -> Parser Orientation #

parseJSONList :: Value -> Parser [Orientation] #

omittedField :: Maybe Orientation #

ToJSON Orientation

Instance details

Defined in Test.Marionette.Orientation

Methods

toJSON :: Orientation -> Value #

toEncoding :: Orientation -> Encoding #

toJSONList :: [Orientation] -> Value #

toEncodingList :: [Orientation] -> Encoding #

omitField :: Orientation -> Bool #

Generic Orientation

Instance details

Defined in Test.Marionette.Orientation

Associated Types

type Rep Orientation
Instance details Defined in Test.Marionette.Orientation type Rep Orientation = D1 ('MetaData "Orientation" "Test.Marionette.Orientation" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Portrait" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Landscape" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Orientation -> Rep Orientation x #

to :: Rep Orientation x -> Orientation #

Show Orientation

Instance details

Defined in Test.Marionette.Orientation

Methods

showsPrec :: Int -> Orientation -> ShowS #

show :: Orientation -> String #

showList :: [Orientation] -> ShowS #

Eq Orientation

Instance details

Defined in Test.Marionette.Orientation

Methods

(==) :: Orientation -> Orientation -> Bool #

(/=) :: Orientation -> Orientation -> Bool #

type Rep Orientation

Instance details

Defined in Test.Marionette.Orientation

type Rep Orientation = D1 ('MetaData "Orientation" "Test.Marionette.Orientation" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Portrait" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Landscape" 'PrefixI 'False) (U1 :: Type -> Type))

data Rect #

Constructors

Rect
Fields x :: Float y :: Float width :: Float height :: Float

Instances

Instances details

FromJSON Rect

Instance details

Defined in Test.Marionette.Rect

Methods

parseJSON :: Value -> Parser Rect #

parseJSONList :: Value -> Parser [Rect] #

omittedField :: Maybe Rect #

ToJSON Rect

Instance details

Defined in Test.Marionette.Rect

Methods

toJSON :: Rect -> Value #

toEncoding :: Rect -> Encoding #

toJSONList :: [Rect] -> Value #

toEncodingList :: [Rect] -> Encoding #

omitField :: Rect -> Bool #

Generic Rect

Instance details

Defined in Test.Marionette.Rect

Associated Types

type Rep Rect

Instance details

Defined in Test.Marionette.Rect

type Rep Rect = D1 ('MetaData "Rect" "Test.Marionette.Rect" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Rect" 'PrefixI 'True) ((S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float)) :*: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :*: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))))

Methods

from :: Rect -> Rep Rect x #

to :: Rep Rect x -> Rect #

Show Rect

Instance details

Defined in Test.Marionette.Rect

Methods

showsPrec :: Int -> Rect -> ShowS #

show :: Rect -> String #

showList :: [Rect] -> ShowS #

Eq Rect

Instance details

Defined in Test.Marionette.Rect

Methods

(==) :: Rect -> Rect -> Bool #

(/=) :: Rect -> Rect -> Bool #

type Rep Rect

Instance details

Defined in Test.Marionette.Rect

type Rep Rect = D1 ('MetaData "Rect" "Test.Marionette.Rect" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Rect" 'PrefixI 'True) ((S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float)) :*: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :*: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))))

data RegistryEntry #

Constructors

RegistryEntry
Fields entryType :: Text namespace :: Text directory :: Text options :: Maybe Text

Instances

Instances details

ToJSON RegistryEntry

Instance details

Defined in Test.Marionette.Registry

Methods

toJSON :: RegistryEntry -> Value #

toEncoding :: RegistryEntry -> Encoding #

toJSONList :: [RegistryEntry] -> Value #

toEncodingList :: [RegistryEntry] -> Encoding #

omitField :: RegistryEntry -> Bool #

Generic RegistryEntry

Instance details

Defined in Test.Marionette.Registry

Associated Types

type Rep RegistryEntry

Instance details

Defined in Test.Marionette.Registry

type Rep RegistryEntry = D1 ('MetaData "RegistryEntry" "Test.Marionette.Registry" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "RegistryEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "entryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "directory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Methods

from :: RegistryEntry -> Rep RegistryEntry x #

to :: Rep RegistryEntry x -> RegistryEntry #

Show RegistryEntry

Instance details

Defined in Test.Marionette.Registry

Methods

showsPrec :: Int -> RegistryEntry -> ShowS #

show :: RegistryEntry -> String #

showList :: [RegistryEntry] -> ShowS #

Eq RegistryEntry

Instance details

Defined in Test.Marionette.Registry

Methods

(==) :: RegistryEntry -> RegistryEntry -> Bool #

(/=) :: RegistryEntry -> RegistryEntry -> Bool #

type Rep RegistryEntry

Instance details

Defined in Test.Marionette.Registry

type Rep RegistryEntry = D1 ('MetaData "RegistryEntry" "Test.Marionette.Registry" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "RegistryEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "entryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "directory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data Selector #

Specifies element(s) within a DOM tree using various selection methods.

Constructors

ById Text
ByName Text
ByClass Text	(Note: multiple classes are not allowed. For more control, use `ByCSS`)
ByTag Text
ByLinkText Text
ByPartialLinkText Text
ByCSS Text
ByXPath Text
Anon Text
AnonAttribute Text

Instances

Instances details

ToJSON Selector

Instance details

Defined in Test.Marionette.Selector

Methods

toJSON :: Selector -> Value #

toEncoding :: Selector -> Encoding #

toJSONList :: [Selector] -> Value #

toEncodingList :: [Selector] -> Encoding #

omitField :: Selector -> Bool #

Generic Selector

Instance details

Defined in Test.Marionette.Selector

Associated Types

type Rep Selector

Instance details

Defined in Test.Marionette.Selector

Methods

from :: Selector -> Rep Selector x #

to :: Rep Selector x -> Selector #

Show Selector

Instance details

Defined in Test.Marionette.Selector

Methods

showsPrec :: Int -> Selector -> ShowS #

show :: Selector -> String #

showList :: [Selector] -> ShowS #

Eq Selector

Instance details

Defined in Test.Marionette.Selector

Methods

(==) :: Selector -> Selector -> Bool #

(/=) :: Selector -> Selector -> Bool #

Hashable Selector

Instance details

Defined in Test.Marionette.Selector

Methods

hashWithSalt :: Int -> Selector -> Int #

hash :: Selector -> Int #

type Rep Selector

Instance details

Defined in Test.Marionette.Selector

newtype Shadow #

An opaque identifier for a web page element that identifies a shadow root.

Constructors

Shadow
Fields shadowId :: Text

Instances

Instances details

FromJSON Shadow
Instance details Defined in Test.Marionette.Element Methods parseJSON :: Value -> Parser Shadow # parseJSONList :: Value -> Parser [Shadow] # omittedField :: Maybe Shadow #
ToJSON Shadow
Instance details Defined in Test.Marionette.Element Methods toJSON :: Shadow -> Value # toEncoding :: Shadow -> Encoding # toJSONList :: [Shadow] -> Value # toEncodingList :: [Shadow] -> Encoding # omitField :: Shadow -> Bool #
Read Shadow
Instance details Defined in Test.Marionette.Element Methods readsPrec :: Int -> ReadS Shadow # readList :: ReadS [Shadow] # readPrec :: ReadPrec Shadow # readListPrec :: ReadPrec [Shadow] #
Show Shadow
Instance details Defined in Test.Marionette.Element Methods showsPrec :: Int -> Shadow -> ShowS # show :: Shadow -> String # showList :: [Shadow] -> ShowS #
Eq Shadow
Instance details Defined in Test.Marionette.Element Methods (==) :: Shadow -> Shadow -> Bool # (/=) :: Shadow -> Shadow -> Bool #
Ord Shadow
Instance details Defined in Test.Marionette.Element Methods compare :: Shadow -> Shadow -> Ordering # (<) :: Shadow -> Shadow -> Bool # (<=) :: Shadow -> Shadow -> Bool # (>) :: Shadow -> Shadow -> Bool # (>=) :: Shadow -> Shadow -> Bool # max :: Shadow -> Shadow -> Shadow # min :: Shadow -> Shadow -> Shadow #
Hashable Shadow
Instance details Defined in Test.Marionette.Element Methods hashWithSalt :: Int -> Shadow -> Int # hash :: Shadow -> Int #

data Timeouts #

Constructors

Timeouts
Fields script :: Maybe Int pageLoad :: Maybe Int implicit :: Maybe Int

Instances

Instances details

FromJSON Timeouts

Instance details

Defined in Test.Marionette.Timeouts

Methods

parseJSON :: Value -> Parser Timeouts #

parseJSONList :: Value -> Parser [Timeouts] #

omittedField :: Maybe Timeouts #

ToJSON Timeouts

Instance details

Defined in Test.Marionette.Timeouts

Methods

toJSON :: Timeouts -> Value #

toEncoding :: Timeouts -> Encoding #

toJSONList :: [Timeouts] -> Value #

toEncodingList :: [Timeouts] -> Encoding #

omitField :: Timeouts -> Bool #

Generic Timeouts

Instance details

Defined in Test.Marionette.Timeouts

Associated Types

type Rep Timeouts

Instance details

Defined in Test.Marionette.Timeouts

type Rep Timeouts = D1 ('MetaData "Timeouts" "Test.Marionette.Timeouts" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Timeouts" 'PrefixI 'True) (S1 ('MetaSel ('Just "script") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "pageLoad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "implicit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

Methods

from :: Timeouts -> Rep Timeouts x #

to :: Rep Timeouts x -> Timeouts #

Show Timeouts

Instance details

Defined in Test.Marionette.Timeouts

Methods

showsPrec :: Int -> Timeouts -> ShowS #

show :: Timeouts -> String #

showList :: [Timeouts] -> ShowS #

Eq Timeouts

Instance details

Defined in Test.Marionette.Timeouts

Methods

(==) :: Timeouts -> Timeouts -> Bool #

(/=) :: Timeouts -> Timeouts -> Bool #

type Rep Timeouts

Instance details

Defined in Test.Marionette.Timeouts

type Rep Timeouts = D1 ('MetaData "Timeouts" "Test.Marionette.Timeouts" "marionette-1.0.0-2rXrb754J8I8DUtJcHv2xL" 'False) (C1 ('MetaCons "Timeouts" 'PrefixI 'True) (S1 ('MetaSel ('Just "script") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "pageLoad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "implicit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

data VirtualAuthenticator #

Constructors

VirtualAuthenticator
Fields protocol :: Text "ctap1/u2f" or "ctap2" transport :: Text "usb", "nfc", "ble", "smart-card", "hybrid", or "internal" hasResidentKey :: Bool hasUserVerification :: Bool isUserConsenting :: Bool isUserVerified :: Bool extensions :: Maybe [Text] uvm :: Maybe Bool

Instances

Instances details

ToJSON VirtualAuthenticator

Instance details

Defined in Test.Marionette.WebAuthn

Methods

toJSON :: VirtualAuthenticator -> Value #

toEncoding :: VirtualAuthenticator -> Encoding #

toJSONList :: [VirtualAuthenticator] -> Value #

toEncodingList :: [VirtualAuthenticator] -> Encoding #

omitField :: VirtualAuthenticator -> Bool #

Generic VirtualAuthenticator

Instance details

Defined in Test.Marionette.WebAuthn

Associated Types

type Rep VirtualAuthenticator

Instance details

Defined in Test.Marionette.WebAuthn

Methods

from :: VirtualAuthenticator -> Rep VirtualAuthenticator x #

to :: Rep VirtualAuthenticator x -> VirtualAuthenticator #

Show VirtualAuthenticator

Instance details

Defined in Test.Marionette.WebAuthn

Methods

showsPrec :: Int -> VirtualAuthenticator -> ShowS #

show :: VirtualAuthenticator -> String #

showList :: [VirtualAuthenticator] -> ShowS #

Eq VirtualAuthenticator

Instance details

Defined in Test.Marionette.WebAuthn

Methods

(==) :: VirtualAuthenticator -> VirtualAuthenticator -> Bool #

(/=) :: VirtualAuthenticator -> VirtualAuthenticator -> Bool #

type Rep VirtualAuthenticator

Instance details

Defined in Test.Marionette.WebAuthn

newtype WindowHandle #

Constructors

WindowHandle Text

Instances

Instances details

FromJSON WindowHandle
Instance details Defined in Test.Marionette.Window Methods parseJSON :: Value -> Parser WindowHandle # parseJSONList :: Value -> Parser [WindowHandle] # omittedField :: Maybe WindowHandle #
ToJSON WindowHandle
Instance details Defined in Test.Marionette.Window Methods toJSON :: WindowHandle -> Value # toEncoding :: WindowHandle -> Encoding # toJSONList :: [WindowHandle] -> Value # toEncodingList :: [WindowHandle] -> Encoding # omitField :: WindowHandle -> Bool #
Read WindowHandle
Instance details Defined in Test.Marionette.Window Methods readsPrec :: Int -> ReadS WindowHandle # readList :: ReadS [WindowHandle] # readPrec :: ReadPrec WindowHandle # readListPrec :: ReadPrec [WindowHandle] #
Show WindowHandle
Instance details Defined in Test.Marionette.Window Methods showsPrec :: Int -> WindowHandle -> ShowS # show :: WindowHandle -> String # showList :: [WindowHandle] -> ShowS #
Eq WindowHandle
Instance details Defined in Test.Marionette.Window Methods (==) :: WindowHandle -> WindowHandle -> Bool # (/=) :: WindowHandle -> WindowHandle -> Bool #
Ord WindowHandle
Instance details Defined in Test.Marionette.Window Methods compare :: WindowHandle -> WindowHandle -> Ordering # (<) :: WindowHandle -> WindowHandle -> Bool # (<=) :: WindowHandle -> WindowHandle -> Bool # (>) :: WindowHandle -> WindowHandle -> Bool # (>=) :: WindowHandle -> WindowHandle -> Bool # max :: WindowHandle -> WindowHandle -> WindowHandle # min :: WindowHandle -> WindowHandle -> WindowHandle #
Hashable WindowHandle
Instance details Defined in Test.Marionette.Window Methods hashWithSalt :: Int -> WindowHandle -> Int # hash :: WindowHandle -> Int #

Orphan instances

Error Error :> es => MonadError Error (Eff es) Source #
Instance details Methods throwError :: Error -> Eff es a # catchError :: Eff es a -> (Error -> Eff es a) -> Eff es a #
(Concurrent :> es, Reader (TQueue CommandWithCallback) :> es, Error Error :> es, IOE :> es) => Marionette (Eff es) Source #
Instance details Methods sendCommand :: (HasCallStack, FromJSON a) => Command -> Eff es a # sendCommands :: (HasCallStack, Traversable t, FromJSON a) => t Command -> Eff es (t a) # sendCommands_ :: (HasCallStack, Traversable t) => t Command -> Eff es () # sendCommand_ :: Command -> Eff es () #