mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-02-23 07:36:12 +08:00
1472 lines
38 KiB
HTML
1472 lines
38 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Integration Testing · Nylas Mail Plugin SDK</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.2">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-anchors/plugin.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../styles/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="Windows.html" />
|
|
|
|
|
|
<link rel="prev" href="WritingSpecs.html" />
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href='../img/favicon.png' type="image/x-icon">
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" >
|
|
|
|
<span>
|
|
|
|
|
|
Nylas Mail SDK Guides
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="GettingStarted.html">
|
|
|
|
<a href="GettingStarted.html">
|
|
|
|
|
|
Getting Started
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" data-path="GettingStarted-2.html">
|
|
|
|
<a href="GettingStarted-2.html">
|
|
|
|
|
|
Getting Started Part 2
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5" data-path="PackageOverview.html">
|
|
|
|
<a href="PackageOverview.html">
|
|
|
|
|
|
Building a Package
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6" data-path="InterfaceConcepts.html">
|
|
|
|
<a href="InterfaceConcepts.html">
|
|
|
|
|
|
Interface Concepts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.7" data-path="React.html">
|
|
|
|
<a href="React.html">
|
|
|
|
|
|
UI Components
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.8" data-path="Architecture.html">
|
|
|
|
<a href="Architecture.html">
|
|
|
|
|
|
Application Architecture
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.9" data-path="Debugging.html">
|
|
|
|
<a href="Debugging.html">
|
|
|
|
|
|
Debugging Nylas Mail
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.10" data-path="Database.html">
|
|
|
|
<a href="Database.html">
|
|
|
|
|
|
Accessing the Database
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.11" data-path="ComposerExtensions.html">
|
|
|
|
<a href="ComposerExtensions.html">
|
|
|
|
|
|
Extending the Composer
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.12" data-path="WritingSpecs.html">
|
|
|
|
<a href="WritingSpecs.html">
|
|
|
|
|
|
Writing Tests
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="1.13" data-path="IntegrationTesting.html">
|
|
|
|
<a href="IntegrationTesting.html">
|
|
|
|
|
|
Integration Testing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.14" data-path="Windows.html">
|
|
|
|
<a href="Windows.html">
|
|
|
|
|
|
Developing on Windows
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.15" data-path="FAQ.html">
|
|
|
|
<a href="FAQ.html">
|
|
|
|
|
|
FAQ
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Full Class Reference</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" >
|
|
|
|
<span>
|
|
|
|
|
|
General
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.1.1" data-path="../classes/Actions.html">
|
|
|
|
<a href="../classes/Actions.html">
|
|
|
|
|
|
Actions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.2" data-path="../classes/BufferedProcess.html">
|
|
|
|
<a href="../classes/BufferedProcess.html">
|
|
|
|
|
|
BufferedProcess
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.3" data-path="../classes/ChangeFolderTask.html">
|
|
|
|
<a href="../classes/ChangeFolderTask.html">
|
|
|
|
|
|
ChangeFolderTask
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.4" data-path="../classes/ChangeLabelsTask.html">
|
|
|
|
<a href="../classes/ChangeLabelsTask.html">
|
|
|
|
|
|
ChangeLabelsTask
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.5" data-path="../classes/ChangeMailTask.html">
|
|
|
|
<a href="../classes/ChangeMailTask.html">
|
|
|
|
|
|
ChangeMailTask
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.6" data-path="../classes/Color.html">
|
|
|
|
<a href="../classes/Color.html">
|
|
|
|
|
|
Color
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.7" data-path="../classes/Config.html">
|
|
|
|
<a href="../classes/Config.html">
|
|
|
|
|
|
Config
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.8" data-path="../classes/Contenteditable.html">
|
|
|
|
<a href="../classes/Contenteditable.html">
|
|
|
|
|
|
Contenteditable
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.9" data-path="../classes/KeyCommandsRegion.html">
|
|
|
|
<a href="../classes/KeyCommandsRegion.html">
|
|
|
|
|
|
KeyCommandsRegion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.10" data-path="../classes/NylasEnvConstructor.html">
|
|
|
|
<a href="../classes/NylasEnvConstructor.html">
|
|
|
|
|
|
NylasEnvConstructor
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.11" data-path="../classes/QueryResultSet.html">
|
|
|
|
<a href="../classes/QueryResultSet.html">
|
|
|
|
|
|
QueryResultSet
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.12" data-path="../classes/QuerySubscriptionPool.html">
|
|
|
|
<a href="../classes/QuerySubscriptionPool.html">
|
|
|
|
|
|
QuerySubscriptionPool
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.13" data-path="../classes/StyleManager.html">
|
|
|
|
<a href="../classes/StyleManager.html">
|
|
|
|
|
|
StyleManager
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.14" data-path="../classes/Task.html">
|
|
|
|
<a href="../classes/Task.html">
|
|
|
|
|
|
Task
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.15" data-path="../classes/TaskQueueStatusStore.html">
|
|
|
|
<a href="../classes/TaskQueueStatusStore.html">
|
|
|
|
|
|
TaskQueueStatusStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.16" data-path="../classes/ThemeManager.html">
|
|
|
|
<a href="../classes/ThemeManager.html">
|
|
|
|
|
|
ThemeManager
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2" >
|
|
|
|
<span>
|
|
|
|
|
|
Component Kit
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.2.1" data-path="../classes/EventedIFrame.html">
|
|
|
|
<a href="../classes/EventedIFrame.html">
|
|
|
|
|
|
EventedIFrame
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.2" data-path="../classes/Flexbox.html">
|
|
|
|
<a href="../classes/Flexbox.html">
|
|
|
|
|
|
Flexbox
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.3" data-path="../classes/InjectedComponent.html">
|
|
|
|
<a href="../classes/InjectedComponent.html">
|
|
|
|
|
|
InjectedComponent
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.4" data-path="../classes/InjectedComponentSet.html">
|
|
|
|
<a href="../classes/InjectedComponentSet.html">
|
|
|
|
|
|
InjectedComponentSet
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.5" data-path="../classes/Menu.html">
|
|
|
|
<a href="../classes/Menu.html">
|
|
|
|
|
|
Menu
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.6" data-path="../classes/MenuItem.html">
|
|
|
|
<a href="../classes/MenuItem.html">
|
|
|
|
|
|
MenuItem
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.7" data-path="../classes/MenuNameEmailItem.html">
|
|
|
|
<a href="../classes/MenuNameEmailItem.html">
|
|
|
|
|
|
MenuNameEmailItem
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.8" data-path="../classes/MultiselectActionBar.html">
|
|
|
|
<a href="../classes/MultiselectActionBar.html">
|
|
|
|
|
|
MultiselectActionBar
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.9" data-path="../classes/MultiselectList.html">
|
|
|
|
<a href="../classes/MultiselectList.html">
|
|
|
|
|
|
MultiselectList
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.10" data-path="../classes/ResizableRegion.html">
|
|
|
|
<a href="../classes/ResizableRegion.html">
|
|
|
|
|
|
ResizableRegion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.11" data-path="../classes/RetinaImg.html">
|
|
|
|
<a href="../classes/RetinaImg.html">
|
|
|
|
|
|
RetinaImg
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.12" data-path="../classes/Spinner.html">
|
|
|
|
<a href="../classes/Spinner.html">
|
|
|
|
|
|
Spinner
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.13" data-path="../classes/UnsafeComponent.html">
|
|
|
|
<a href="../classes/UnsafeComponent.html">
|
|
|
|
|
|
UnsafeComponent
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3" >
|
|
|
|
<span>
|
|
|
|
|
|
Extensions
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.3.1" data-path="../classes/ComposerExtension.html">
|
|
|
|
<a href="../classes/ComposerExtension.html">
|
|
|
|
|
|
ComposerExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.2" data-path="../classes/ContenteditableExtension.html">
|
|
|
|
<a href="../classes/ContenteditableExtension.html">
|
|
|
|
|
|
ContenteditableExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.3" data-path="../classes/DraftStoreExtension.html">
|
|
|
|
<a href="../classes/DraftStoreExtension.html">
|
|
|
|
|
|
DraftStoreExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.4" data-path="../classes/MessageStoreExtension.html">
|
|
|
|
<a href="../classes/MessageStoreExtension.html">
|
|
|
|
|
|
MessageStoreExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.5" data-path="../classes/MessageViewExtension.html">
|
|
|
|
<a href="../classes/MessageViewExtension.html">
|
|
|
|
|
|
MessageViewExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4" >
|
|
|
|
<span>
|
|
|
|
|
|
Models
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.4.1" data-path="../classes/Contact.html">
|
|
|
|
<a href="../classes/Contact.html">
|
|
|
|
|
|
Contact
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4.2" data-path="../classes/Message.html">
|
|
|
|
<a href="../classes/Message.html">
|
|
|
|
|
|
Message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4.3" data-path="../classes/Model.html">
|
|
|
|
<a href="../classes/Model.html">
|
|
|
|
|
|
Model
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4.4" data-path="../classes/Thread.html">
|
|
|
|
<a href="../classes/Thread.html">
|
|
|
|
|
|
Thread
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5" >
|
|
|
|
<span>
|
|
|
|
|
|
Stores
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.5.1" data-path="../classes/AccountStore.html">
|
|
|
|
<a href="../classes/AccountStore.html">
|
|
|
|
|
|
AccountStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.2" data-path="../classes/ComponentRegistry.html">
|
|
|
|
<a href="../classes/ComponentRegistry.html">
|
|
|
|
|
|
ComponentRegistry
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.3" data-path="../classes/ContactStore.html">
|
|
|
|
<a href="../classes/ContactStore.html">
|
|
|
|
|
|
ContactStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.4" data-path="../classes/FocusedContentStore.html">
|
|
|
|
<a href="../classes/FocusedContentStore.html">
|
|
|
|
|
|
FocusedContentStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.5" data-path="../classes/TaskQueue.html">
|
|
|
|
<a href="../classes/TaskQueue.html">
|
|
|
|
|
|
TaskQueue
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.6" data-path="../classes/WorkspaceStore.html">
|
|
|
|
<a href="../classes/WorkspaceStore.html">
|
|
|
|
|
|
WorkspaceStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6" >
|
|
|
|
<span>
|
|
|
|
|
|
Database
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.6.1" data-path="../classes/Attribute.html">
|
|
|
|
<a href="../classes/Attribute.html">
|
|
|
|
|
|
Attribute
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.2" data-path="../classes/AttributeBoolean.html">
|
|
|
|
<a href="../classes/AttributeBoolean.html">
|
|
|
|
|
|
AttributeBoolean
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.3" data-path="../classes/AttributeCollection.html">
|
|
|
|
<a href="../classes/AttributeCollection.html">
|
|
|
|
|
|
AttributeCollection
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.4" data-path="../classes/AttributeDateTime.html">
|
|
|
|
<a href="../classes/AttributeDateTime.html">
|
|
|
|
|
|
AttributeDateTime
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.5" data-path="../classes/AttributeJoinedData.html">
|
|
|
|
<a href="../classes/AttributeJoinedData.html">
|
|
|
|
|
|
AttributeJoinedData
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.6" data-path="../classes/AttributeNumber.html">
|
|
|
|
<a href="../classes/AttributeNumber.html">
|
|
|
|
|
|
AttributeNumber
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.7" data-path="../classes/AttributeObject.html">
|
|
|
|
<a href="../classes/AttributeObject.html">
|
|
|
|
|
|
AttributeObject
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.8" data-path="../classes/AttributeServerId.html">
|
|
|
|
<a href="../classes/AttributeServerId.html">
|
|
|
|
|
|
AttributeServerId
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.9" data-path="../classes/AttributeString.html">
|
|
|
|
<a href="../classes/AttributeString.html">
|
|
|
|
|
|
AttributeString
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.10" data-path="../classes/DatabaseStore.html">
|
|
|
|
<a href="../classes/DatabaseStore.html">
|
|
|
|
|
|
DatabaseStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.11" data-path="../classes/Matcher.html">
|
|
|
|
<a href="../classes/Matcher.html">
|
|
|
|
|
|
Matcher
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.12" data-path="../classes/ModelQuery.html">
|
|
|
|
<a href="../classes/ModelQuery.html">
|
|
|
|
|
|
ModelQuery
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.13" data-path="../classes/SortOrder.html">
|
|
|
|
<a href="../classes/SortOrder.html">
|
|
|
|
|
|
SortOrder
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7" >
|
|
|
|
<span>
|
|
|
|
|
|
Drafts
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.7.1" data-path="../classes/DraftChangeSet.html">
|
|
|
|
<a href="../classes/DraftChangeSet.html">
|
|
|
|
|
|
DraftChangeSet
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7.2" data-path="../classes/DraftEditingSession.html">
|
|
|
|
<a href="../classes/DraftEditingSession.html">
|
|
|
|
|
|
DraftEditingSession
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7.3" data-path="../classes/DraftStore.html">
|
|
|
|
<a href="../classes/DraftStore.html">
|
|
|
|
|
|
DraftStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.8" >
|
|
|
|
<span>
|
|
|
|
|
|
NylasEnv
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.8.1" data-path="../classes/PackageManager.html">
|
|
|
|
<a href="../classes/PackageManager.html">
|
|
|
|
|
|
PackageManager
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.9" >
|
|
|
|
<span>
|
|
|
|
|
|
Atom
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >Integration Testing</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<h1 id="integration-testing"><a name="integration-testing" class="plugin-anchor" href="#integration-testing"><i class="fa fa-link" aria-hidden="true"></i></a>Integration Testing</h1>
|
|
<p>In addition to unit tests, we run integration tests using
|
|
<a href="https://code.google.com/p/selenium/wiki/ChromeDriver" target="_blank">ChromeDriver</a> and
|
|
<a href="http://webdriver.io/" target="_blank">WebdriverIO</a> through the
|
|
<a href="https://github.com/kevinsawicki/spectron" target="_blank">Spectron</a> library.</p>
|
|
<h2 id="running-tests"><a name="running-tests" class="plugin-anchor" href="#running-tests"><i class="fa fa-link" aria-hidden="true"></i></a>Running Tests</h2>
|
|
<pre><code>script/grunt run-integration-tests
|
|
</code></pre><p>This command will, in order:</p>
|
|
<ol>
|
|
<li>Run <code>npm test</code> in the <code>/spec_integration</code> directory and pass in the
|
|
<code>NYLAS_ROOT_PATH</code></li>
|
|
<li>Boot <code>jasmine</code> and load all files ending in <code>-spec</code></li>
|
|
<li>Most tests in <code>beforeAll</code> will boot N1 via the <code>N1Launcher</code>. See
|
|
<code>spec_integration/helpers/n1-launcher.es6</code></li>
|
|
<li>This instantiates a new <code>spectron</code> <code>Application</code> which will spawn a
|
|
<code>ChromeDriver</code> process with the appropriate N1 launch args.</li>
|
|
<li><code>ChromeDriver</code> will then boot a <a href="http://www.seleniumhq.org/" target="_blank">Selenium</a>
|
|
server at <code>http://localhost:9515</code></li>
|
|
<li>The ChromeDriver / Selenium server will boot N1 with testing hooks and
|
|
expose an controlling API.</li>
|
|
<li>The API is made easily available through the <a href="https://github.com/kevinsawicki/spectron/blob/master/README.md" target="_blank">Spectron API</a></li>
|
|
<li>The <code>N1Launcher</code>'s <code>mainWindowReady</code> or <code>popoutComposerWindowReady</code> or
|
|
<code>onboardingWindowReady</code> methods poll the app until the designated
|
|
window is available and loaded. Then will resolve a Promise once
|
|
everything has booted.</li>
|
|
</ol>
|
|
<h2 id="writing-tests"><a name="writing-tests" class="plugin-anchor" href="#writing-tests"><i class="fa fa-link" aria-hidden="true"></i></a>Writing Tests</h2>
|
|
<p>The <a href="https://github.com/kevinsawicki/spectron/blob/master/README.md" target="_blank">Spectron API</a> is a pure extension over the <a href="http://webdriver.io/api.html" target="_blank">Webdriver API</a>. Reference both to write tests.</p>
|
|
<p>Most of the methods on <code>app.client</code> object apply to the "currently
|
|
focused" window only. Since N1 has several windows (many of which are
|
|
hidden) the <code>N1Launcher</code> extension will cycle through windows
|
|
automatically until it finds the one you want, and then select it.</p>
|
|
<p>Furthermore, "loaded" in the pure Spectron sense is only once the window
|
|
is booted. N1 windows take much longer to full finish loading packages and
|
|
rendering the UI. The <code>N1Launcher::windowReady</code> method and its derivatives
|
|
take this into account.</p>
|
|
<p>You will almost always need the minimal boilerplate for each integration
|
|
test:</p>
|
|
<pre><code class="lang-javascript">describe(<span class="hljs-string">'My test'</span>, () => {
|
|
beforeAll((done)=>{
|
|
<span class="hljs-comment">// Boot in dev mode with no arguments</span>
|
|
<span class="hljs-keyword">this</span>.app = <span class="hljs-keyword">new</span> N1Launcher([<span class="hljs-string">"--dev"</span>]);
|
|
<span class="hljs-keyword">this</span>.app.mainWindowReady().finally(done);
|
|
});
|
|
|
|
afterAll((done)=> {
|
|
<span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.app && <span class="hljs-keyword">this</span>.app.isRunning()) {
|
|
<span class="hljs-keyword">this</span>.app.stop().finally(done);
|
|
} <span class="hljs-keyword">else</span> {
|
|
done()
|
|
}
|
|
});
|
|
|
|
it(<span class="hljs-string">"is a test you'll write"</span>, () => {
|
|
});
|
|
|
|
it(<span class="hljs-string">"is an async test you'll write"</span>, (done) => {
|
|
doSomething.finally(done)
|
|
});
|
|
});
|
|
</code></pre>
|
|
<h3 id="executing-code-in-n1s-environment"><a name="executing-code-in-n1s-environment" class="plugin-anchor" href="#executing-code-in-n1s-environment"><i class="fa fa-link" aria-hidden="true"></i></a>Executing Code in N1's environment</h3>
|
|
<p>The <code>app.client.execute</code> and <code>app.client.executeAsync</code> methods are
|
|
extremely helpful when running code in N1. Those are documented slightly
|
|
more on the <a href="http://webdriver.io/api/protocol/execute.html" target="_blank">WebdriveIO API docs page here</a></p>
|
|
<pre><code class="lang-javascript">it(<span class="hljs-string">"is a test you'll write"</span>, () => {
|
|
<span class="hljs-keyword">this</span>.app.client.execute((arg1)=>{
|
|
<span class="hljs-comment">// <span class="hljs-doctag">NOTE:</span> `arg1` just got passed in over a JSON api. It can only be a</span>
|
|
<span class="hljs-comment">// primitive data type</span>
|
|
|
|
<span class="hljs-comment">// I'M RUNNING IN N1</span>
|
|
<span class="hljs-keyword">return</span> someValue
|
|
|
|
}, arg1).then(({value})=>{
|
|
<span class="hljs-comment">// <span class="hljs-doctag">NOTE:</span> the return is stuffed in an attribute called `value`. Also it</span>
|
|
<span class="hljs-comment">// passed back of a JSON API and can only be a primitive value.</span>
|
|
})
|
|
});
|
|
</code></pre>
|
|
<h3 id="debugging-tests"><a name="debugging-tests" class="plugin-anchor" href="#debugging-tests"><i class="fa fa-link" aria-hidden="true"></i></a>Debugging tests.</h3>
|
|
<p>Debugging is through lots of <code>console.log</code>ing.</p>
|
|
<p>There is code is <code>spec_integration/jasmine/bootstrap.js</code> that attempts to
|
|
catch unhandled Promises and color them accordingly.</p>
|
|
<p>If you want to access logs from within N1 via the <code>app.client.execute</code>
|
|
blocks, you'll have to either package it up yourself and return it, or use
|
|
the new <code>app.client.getMainProcessLogs()</code> just added into Spectron.</p>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<a href="WritingSpecs.html" class="navigation navigation-prev " aria-label="Previous page: Writing Tests">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="Windows.html" class="navigation navigation-next " aria-label="Next page: Developing on Windows">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Integration Testing","level":"1.13","depth":1,"next":{"title":"Developing on Windows","level":"1.14","depth":1,"path":"guides/Windows.md","ref":"guides/Windows.md","articles":[]},"previous":{"title":"Writing Tests","level":"1.12","depth":1,"path":"guides/WritingSpecs.md","ref":"guides/WritingSpecs.md","articles":[]},"dir":"ltr"},"config":{"plugins":["search","lunr","-fontsettings","-sharing","anchors","github","editlink","favicon"],"root":"./docs_src","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/nylas/nylas-mail-docs/tree/master"},"github":{"url":"https://github.com/nylas/nylas-mail-docs"},"favicon":{"shortcut":"/img/favicon.png"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"anchors":{},"highlight":{},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Nylas Mail Plugin SDK","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"3.2.2"},"file":{"path":"guides/IntegrationTesting.md","mtime":"2017-01-30T09:55:21.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-01-30T10:28:53.038Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-editlink/plugin.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|