Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 65 lines (34 sloc) 3.351 kb
9428ec8 @snej Updated to Couchbase Lite.
snej authored
1 ## Couchbase Lite Workflow Test App
881b1c6 @snej Added README, and some comments.
snej authored
2
9428ec8 @snej Updated to Couchbase Lite.
snej authored
3 This iOS app is a shell for long-running workflow tests of the [Couchbase Lite][1] framework.
881b1c6 @snej Added README, and some comments.
snej authored
4
5 ## Getting Started
6
e5b1e32 @snej Cloned, and renamed Worker Bee
snej authored
7 These instructions assume you are familiar with how to make an iOS app. Please follow them fully and in order the first time you build.
881b1c6 @snej Added README, and some comments.
snej authored
8
9 If you have questions or get stuck or just want to say hi, please visit the [Mobile Couchbase group][4] on Google Groups.
10
9428ec8 @snej Updated to Couchbase Lite.
snej authored
11 Prerequisite: Xcode 4.3 or later with the SDK for iOS 6 or later.
881b1c6 @snej Added README, and some comments.
snej authored
12
e5b1e32 @snej Cloned, and renamed Worker Bee
snej authored
13 ## Building The App
881b1c6 @snej Added README, and some comments.
snej authored
14
15 ### Download or clone the repository
16
9428ec8 @snej Updated to Couchbase Lite.
snej authored
17 Clone the repo with git:
881b1c6 @snej Added README, and some comments.
snej authored
18
e5b1e32 @snej Cloned, and renamed Worker Bee
snej authored
19 git clone git://github.com/couchbaselabs/WorkerBee.git
881b1c6 @snej Added README, and some comments.
snej authored
20
9428ec8 @snej Updated to Couchbase Lite.
snej authored
21 ### Get the framework
881b1c6 @snej Added README, and some comments.
snej authored
22
9428ec8 @snej Updated to Couchbase Lite.
snej authored
23 This project isn't quite standalone; it links against the [Couchbase Lite][1] framework, which it expects to find in the `Frameworks` subfolder. Build that framework, or download a precompiled build, and copy or symlink the iOS version of `CouchbaseLite.framework` into `Frameworks`.
881b1c6 @snej Added README, and some comments.
snej authored
24
25 ### Open the Xcode project
26
e5b1e32 @snej Cloned, and renamed Worker Bee
snej authored
27 open 'Worker Bee.xcodeproj'
881b1c6 @snej Added README, and some comments.
snej authored
28
e5b1e32 @snej Cloned, and renamed Worker Bee
snej authored
29 ### Build and run the app
881b1c6 @snej Added README, and some comments.
snej authored
30
31 1. Select the appropriate destination (an iOS device or simulator) from the pop-up menu in the Xcode toolbar.
8f7d1db @snej Updated the README.
snej authored
32 2. Click the Run button.
33
34 Once in the app, you'll see a list of available tests. Tap the on/off switch next to a test to start or stop it. (Some tests stop automatically, some run forever till you stop them.)
35
36 To see more info about a test, tap its name to navigate to its page. This will show the test's log output. You can also start and stop the test from this page. The test will keep running whether you're on its page or not.
37
9adf3c8 @snej Updated README.md for TouchDB.
snej authored
38 Test output is saved to the app's Documents directory. If you're running on a real device, you can access this directory by tethering the device, selecting it in iTunes, going to the Apps tab, scrolling down to the File Sharing list, then selecting "Worker Bee" in the list. In the simulator, you can look in the Xcode console output for lines starting with `** OPENING` to see the paths to the log files.
8f7d1db @snej Updated the README.
snej authored
39
40 ## Adding Your Own Tests
41
42 Just create a new subclass of BeeCouchTest. Read API docs for that class and its parent BeeTest to see what you can do, and look at the existing tests for inspiration.
43
44 Generally you'll override -setUp, set a heartbeatInterval, and override -heartbeat to perform periodic activity. The framework takes care of creating a fresh database for you to work with.
881b1c6 @snej Added README, and some comments.
snej authored
45
9adf3c8 @snej Updated README.md for TouchDB.
snej authored
46 ## Uploading Test Results
47
9428ec8 @snej Updated to Couchbase Lite.
snej authored
48 Test results are saved into a local Couchbase Lite database and can be replicated to a remote database server. This is very useful for collecting and analyzing data from multiple devices.
881b1c6 @snej Added README, and some comments.
snej authored
49
9428ec8 @snej Updated to Couchbase Lite.
snej authored
50 To enable replication, open TestListController.m, uncomment the definition of `kUpstreamSavedTestDatabaseURL`, and set its value to the URL of the database to upload to. This can be the Couchbase Sync Gateway, or any CouchDB-compatible database. (It does need to allow anonymous push replication, unless you want to extend SavedTestRun.m to support authentication.)
9adf3c8 @snej Updated README.md for TouchDB.
snej authored
51
52 ## License
881b1c6 @snej Added README, and some comments.
snej authored
53
9adf3c8 @snej Updated README.md for TouchDB.
snej authored
54 Released under the Apache license, 2.0.
8f7d1db @snej Updated the README.
snej authored
55
9adf3c8 @snej Updated README.md for TouchDB.
snej authored
56 Background pattern images are from [subtlepatterns.com][9], released under a Creative Commons Attribution 3.0 Unported License.
57 Bee icon is 19th-century clip art, public domain.
881b1c6 @snej Added README, and some comments.
snej authored
58
9428ec8 @snej Updated to Couchbase Lite.
snej authored
59 Copyright 2011-2013, Couchbase, Inc.
881b1c6 @snej Added README, and some comments.
snej authored
60
61
9428ec8 @snej Updated to Couchbase Lite.
snej authored
62 [1]: https://github.com/couchbase/Couchbase-Lite-iOS
881b1c6 @snej Added README, and some comments.
snej authored
63 [4]: https://groups.google.com/group/mobile-couchbase
8f7d1db @snej Updated the README.
snej authored
64 [9]: http://subtlepatterns.com/
Something went wrong with that request. Please try again.