diff --git a/.gitignore b/.gitignore index 9077f90e..1aaef366 100644 --- a/.gitignore +++ b/.gitignore @@ -3,8 +3,13 @@ (.*/)?\#[^/]*\#$ *.swp +# Python *.pyc +# Ruby +.ruby-version +Gemfile.lock + # MacOS .DS_Store diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e222c712..add9b86a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,52 @@ -# calabash-xcuitest-server +## Contributing -## Adding New Routes +***All pull requests should be based off the `develop` branch.*** + +The Calabash iOS Toolchain uses git-flow. + +See these links for information about git-flow and git best practices. + +Please see this [post](http://chris.beams.io/posts/git-commit/) for tips +on how to make a good commit messages. + +##### Git Flow Step-by-Step guide + +* https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow + +##### Git Best Practices + +* http://justinhileman.info/article/changing-history/ + +##### git-flow command line tool + +We don't use the git-flow tools, but this is useful anyway. + +* http://danielkummer.github.io/git-flow-cheatsheet/ + +## Start a Feature + +Start your work on a feature branch based off develop. -To add a new route, simply create a new object that implements the -`` protocol defined in `CBProtocols.h`. Implement the following -method: -```Objective-C -+ (NSArray *)getRoutes; ``` +# If you don't already have the develop branch +$ git fetch origin +$ git co -t origin/develop + +# If you already have the develop branch +$ git co develop +$ git pull origin develop +$ git co -b feature/my-new-feature -Generally the method definition should be something like: -```Objective-C -+ (NSArray *)getRoutes { - return @[ - - [CBRoute get:@"/foo/bar/calabash" withBlock:^(RouteRequest *request, RouteResponse *response) { - [response respondWithString:@"qux"]; - }], - - [CBRoute post:@"/baz/bar/calabash" withBlock:^(RouteRequest *request, RouteResponse *response) { - NSDictionary *requestData = DATA_TO_JSON(request.body); - NSString *param = requestData[@"key"]; - [Foo theBarBaz:param]; - - [response respondWithJSON:@{ @"status" : @"success!" }]; - }], - ... - ]; -} +# Publish your branch and make a pull-request on `develop` +$ git push -u origin feature/my-new-feature ``` -The route will automatically be picked up via objc runtime reflection. You can confirm -by reading the console logs. +**Contributors should not change the version.** + +## Testing + +TBD + +## Releasing + +TBD diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..ccb4bb30 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source "https://rubygems.org" + +gem "xcpretty", "~> 0.2" + diff --git a/LICENSE b/LICENSE new file mode 120000 index 00000000..51232064 --- /dev/null +++ b/LICENSE @@ -0,0 +1 @@ +epl-v10.html \ No newline at end of file diff --git a/README.md b/README.md index e5d483fd..556a16db 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,89 @@ -# calabash-xcuitest-server +| master | develop | [versioning](VERSIONING.md) | [license](LICENSE) | [contributing](CONTRIBUTING.md)| +|---------|---------|-----------------------------|--------------------|--------------------------------| +|[![Build Status](https://travis-ci.org/calabash/calabash-xcuitest-server.svg?branch=master)](https://travis-ci.org/calabash/calabash-xcuitest-server)| [![Build Status](https://travis-ci.org/calabash/calabash-xcuitest-server.svg?branch=develop)](https://travis-ci.org/calabash/calabash-xcuitest-server)| [![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](https://img.shields.io/badge/version-1.0.0-green.svg) |[![License](https://img.shields.io/badge/licence-Eclipse-blue.svg)](http://opensource.org/licenses/EPL-1.0) | [![Contributing](https://img.shields.io/badge/contrib-gitflow-orange.svg)](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow/)| -Open xcuitest_serverUITests.m in Xcode. -Start the `testRunner` test +## The Calabus Driver -The device IP:Portp will be output in the device log. -```shell -curl /health +### Building + +Requires Xcode 7 and iOS 9 or higher. + +Requires ruby >= 2.0. The latest ruby release is preferred. + +``` +$ git clone git@github.com:calabash/calabash-xcuitest-server.git +$ cd calabash-xcuitest-server +$ bundle update +$ make app +$ make ipa +``` + +To build with an alternative Xcode: + +``` +$ DEVELOPER_DIR=/Xcode/7.2b2/Xcode-beta.app make < rule > +``` + +If you have build errors, see the xcpretty section below. + +Maintainers must install the calabash/calabash-resign private repo. Details are below. + +### Code Signing + +If you are a maintainer, you _must_ install the codesign tool. + +* https://github.com/calabash/calabash-codesign + +If see messages like this: + +``` +iPhone Developer: ambiguous matches +``` + +then you must either: + +1. `$ CODE_SIGN_IDENTITY="< cert name >" make ipa-cal` (preferred) +2. Update the Xcode project with a specific Code Signing entity. **DO + NOT CHECK THESE CHANGES INTO GIT.** + +Maintainers should be using the Calabash.keychain (calabash/calabash-codesign). + +### Testing + +TBD + +### Contributing + +* The Calabash iOS Toolchain uses git-flow. +* Contributors should not bump the version. +* See the [CONTRIBUTING.md](CONTRIBUTING.md) guide. +* There is a style guide: [STYLE\_GUIDE.md](STYLE\_GUIDE.md). +* Pull-requests with unit tests will be merged faster. +* Pull-requests with Cucumber integration tests will be merged even faster. + +### Releasing + +See the [CONTRIBUTING.md](CONTRIBUTING.md) document for instructions. + +### xcpretty + +https://github.com/supermarin/xcpretty + +We use xcpretty to make builds faster and to reduce the amount of +logging. Travis CI, for example, has a limit on the number of lines of +logging that can be generated; xcodebuild breaks this limit. + +The only problem with xcpretty is that it does not report build errors +very well. If you encounter an issue with any of the make rules, run +without xcpretty: + ``` +$ XCPRETTY=0 make ipa +``` + +### Licenses + +Calabash iOS Server uses several third-party sources. You can find the +licenses for these sources in the third-party-licenses directory. + diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md new file mode 100644 index 00000000..1c0475e7 --- /dev/null +++ b/STYLE_GUIDE.md @@ -0,0 +1,14 @@ +### Objective-C + +1. Use spaces, not tabs. +2. Indents should be 4 spaces. +3. As much as possible, limit each line to no more than 80 characters. +4. Use Unicode UTF-8 and Unix newlines. + +When in doubt, refer to this guide: + +* https://github.com/raywenderlich/objective-c-style-guide + +If you are making a change to file, limit the number of style changes to as close to zero as possible so the diff can be easily read. + +One strategy is to make your changes, submit the PR, have it accepted, then make a style commit onto develop. diff --git a/VERSIONING.md b/VERSIONING.md new file mode 100644 index 00000000..21d93405 --- /dev/null +++ b/VERSIONING.md @@ -0,0 +1,17 @@ +## Versioning + +Calabash tries very hard to comply with Semantic Versioning [1] rules. + +However, the semantic versioning spec is incompatible with RubyGem's patterns for pre-release gems. + +> "But returning to the practical: No release version of SemVer is compatible with Rubygems." - _David Kellum_ [2] + +Calabash version numbers will be in this form: + +``` +..[.pre] +``` + +- [1] http://semver.org/ +- [2] http://gravitext.com/2012/07/22/versioning.html + diff --git a/epl-v10.html b/epl-v10.html new file mode 100644 index 00000000..813c07d8 --- /dev/null +++ b/epl-v10.html @@ -0,0 +1,261 @@ + + + + + + +Eclipse Public License - Version 1.0 + + + + + + +

Eclipse Public License - v 1.0

+ +

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE +PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR +DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS +AGREEMENT.

+ +

1. DEFINITIONS

+ +

"Contribution" means:

+ +

a) in the case of the initial Contributor, the initial +code and documentation distributed under this Agreement, and

+

b) in the case of each subsequent Contributor:

+

i) changes to the Program, and

+

ii) additions to the Program;

+

where such changes and/or additions to the Program +originate from and are distributed by that particular Contributor. A +Contribution 'originates' from a Contributor if it was added to the +Program by such Contributor itself or anyone acting on such +Contributor's behalf. Contributions do not include additions to the +Program which: (i) are separate modules of software distributed in +conjunction with the Program under their own license agreement, and (ii) +are not derivative works of the Program.

+ +

"Contributor" means any person or entity that distributes +the Program.

+ +

"Licensed Patents" mean patent claims licensable by a +Contributor which are necessarily infringed by the use or sale of its +Contribution alone or when combined with the Program.

+ +

"Program" means the Contributions distributed in accordance +with this Agreement.

+ +

"Recipient" means anyone who receives the Program under +this Agreement, including all Contributors.

+ +

2. GRANT OF RIGHTS

+ +

a) Subject to the terms of this Agreement, each +Contributor hereby grants Recipient a non-exclusive, worldwide, +royalty-free copyright license to reproduce, prepare derivative works +of, publicly display, publicly perform, distribute and sublicense the +Contribution of such Contributor, if any, and such derivative works, in +source code and object code form.

+ +

b) Subject to the terms of this Agreement, each +Contributor hereby grants Recipient a non-exclusive, worldwide, +royalty-free patent license under Licensed Patents to make, use, sell, +offer to sell, import and otherwise transfer the Contribution of such +Contributor, if any, in source code and object code form. This patent +license shall apply to the combination of the Contribution and the +Program if, at the time the Contribution is added by the Contributor, +such addition of the Contribution causes such combination to be covered +by the Licensed Patents. The patent license shall not apply to any other +combinations which include the Contribution. No hardware per se is +licensed hereunder.

+ +

c) Recipient understands that although each Contributor +grants the licenses to its Contributions set forth herein, no assurances +are provided by any Contributor that the Program does not infringe the +patent or other intellectual property rights of any other entity. Each +Contributor disclaims any liability to Recipient for claims brought by +any other entity based on infringement of intellectual property rights +or otherwise. As a condition to exercising the rights and licenses +granted hereunder, each Recipient hereby assumes sole responsibility to +secure any other intellectual property rights needed, if any. For +example, if a third party patent license is required to allow Recipient +to distribute the Program, it is Recipient's responsibility to acquire +that license before distributing the Program.

+ +

d) Each Contributor represents that to its knowledge it +has sufficient copyright rights in its Contribution, if any, to grant +the copyright license set forth in this Agreement.

+ +

3. REQUIREMENTS

+ +

A Contributor may choose to distribute the Program in object code +form under its own license agreement, provided that:

+ +

a) it complies with the terms and conditions of this +Agreement; and

+ +

b) its license agreement:

+ +

i) effectively disclaims on behalf of all Contributors +all warranties and conditions, express and implied, including warranties +or conditions of title and non-infringement, and implied warranties or +conditions of merchantability and fitness for a particular purpose;

+ +

ii) effectively excludes on behalf of all Contributors +all liability for damages, including direct, indirect, special, +incidental and consequential damages, such as lost profits;

+ +

iii) states that any provisions which differ from this +Agreement are offered by that Contributor alone and not by any other +party; and

+ +

iv) states that source code for the Program is available +from such Contributor, and informs licensees how to obtain it in a +reasonable manner on or through a medium customarily used for software +exchange.

+ +

When the Program is made available in source code form:

+ +

a) it must be made available under this Agreement; and

+ +

b) a copy of this Agreement must be included with each +copy of the Program.

+ +

Contributors may not remove or alter any copyright notices contained +within the Program.

+ +

Each Contributor must identify itself as the originator of its +Contribution, if any, in a manner that reasonably allows subsequent +Recipients to identify the originator of the Contribution.

+ +

4. COMMERCIAL DISTRIBUTION

+ +

Commercial distributors of software may accept certain +responsibilities with respect to end users, business partners and the +like. While this license is intended to facilitate the commercial use of +the Program, the Contributor who includes the Program in a commercial +product offering should do so in a manner which does not create +potential liability for other Contributors. Therefore, if a Contributor +includes the Program in a commercial product offering, such Contributor +("Commercial Contributor") hereby agrees to defend and +indemnify every other Contributor ("Indemnified Contributor") +against any losses, damages and costs (collectively "Losses") +arising from claims, lawsuits and other legal actions brought by a third +party against the Indemnified Contributor to the extent caused by the +acts or omissions of such Commercial Contributor in connection with its +distribution of the Program in a commercial product offering. The +obligations in this section do not apply to any claims or Losses +relating to any actual or alleged intellectual property infringement. In +order to qualify, an Indemnified Contributor must: a) promptly notify +the Commercial Contributor in writing of such claim, and b) allow the +Commercial Contributor to control, and cooperate with the Commercial +Contributor in, the defense and any related settlement negotiations. The +Indemnified Contributor may participate in any such claim at its own +expense.

+ +

For example, a Contributor might include the Program in a commercial +product offering, Product X. That Contributor is then a Commercial +Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance +claims and warranties are such Commercial Contributor's responsibility +alone. Under this section, the Commercial Contributor would have to +defend claims against the other Contributors related to those +performance claims and warranties, and if a court requires any other +Contributor to pay any damages as a result, the Commercial Contributor +must pay those damages.

+ +

5. NO WARRANTY

+ +

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS +PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS +OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, +ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY +OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely +responsible for determining the appropriateness of using and +distributing the Program and assumes all risks associated with its +exercise of rights under this Agreement , including but not limited to +the risks and costs of program errors, compliance with applicable laws, +damage to or loss of data, programs or equipment, and unavailability or +interruption of operations.

+ +

6. DISCLAIMER OF LIABILITY

+ +

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT +NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING +WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR +DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED +HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

+ +

7. GENERAL

+ +

If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further action +by the parties hereto, such provision shall be reformed to the minimum +extent necessary to make such provision valid and enforceable.

+ +

If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging that the +Program itself (excluding combinations of the Program with other +software or hardware) infringes such Recipient's patent(s), then such +Recipient's rights granted under Section 2(b) shall terminate as of the +date such litigation is filed.

+ +

All Recipient's rights under this Agreement shall terminate if it +fails to comply with any of the material terms or conditions of this +Agreement and does not cure such failure in a reasonable period of time +after becoming aware of such noncompliance. If all Recipient's rights +under this Agreement terminate, Recipient agrees to cease use and +distribution of the Program as soon as reasonably practicable. However, +Recipient's obligations under this Agreement and any licenses granted by +Recipient relating to the Program shall continue and survive.

+ +

Everyone is permitted to copy and distribute copies of this +Agreement, but in order to avoid inconsistency the Agreement is +copyrighted and may only be modified in the following manner. The +Agreement Steward reserves the right to publish new versions (including +revisions) of this Agreement from time to time. No one other than the +Agreement Steward has the right to modify this Agreement. The Eclipse +Foundation is the initial Agreement Steward. The Eclipse Foundation may +assign the responsibility to serve as the Agreement Steward to a +suitable separate entity. Each new version of the Agreement will be +given a distinguishing version number. The Program (including +Contributions) may always be distributed subject to the version of the +Agreement under which it was received. In addition, after a new version +of the Agreement is published, Contributor may elect to distribute the +Program (including its Contributions) under the new version. Except as +expressly stated in Sections 2(a) and 2(b) above, Recipient receives no +rights or licenses to the intellectual property of any Contributor under +this Agreement, whether expressly, by implication, estoppel or +otherwise. All rights in the Program not expressly granted under this +Agreement are reserved.

+ +

This Agreement is governed by the laws of the State of New York and +the intellectual property laws of the United States of America. No party +to this Agreement will bring a legal action under this Agreement more +than one year after the cause of action arose. Each party waives its +rights to a jury trial in any resulting litigation.

+ + + + diff --git a/third-party-licences/CocoaAsyncSocket b/third-party-licences/CocoaAsyncSocket new file mode 120000 index 00000000..3a05d3b6 --- /dev/null +++ b/third-party-licences/CocoaAsyncSocket @@ -0,0 +1 @@ +../Vendor/CocoaAsyncSocket/About.txt \ No newline at end of file diff --git a/third-party-licences/CocoaHTTPServer b/third-party-licences/CocoaHTTPServer new file mode 120000 index 00000000..98d4f845 --- /dev/null +++ b/third-party-licences/CocoaHTTPServer @@ -0,0 +1 @@ +../Vendor/CocoaHTTPServer/LICENSE.txt \ No newline at end of file diff --git a/third-party-licences/CocoaLumberjack b/third-party-licences/CocoaLumberjack new file mode 120000 index 00000000..71dc9207 --- /dev/null +++ b/third-party-licences/CocoaLumberjack @@ -0,0 +1 @@ +../Vendor/CocoaLumberjack/About.txt \ No newline at end of file diff --git a/third-party-licences/Facebook-WebDriverAgent b/third-party-licences/Facebook-WebDriverAgent new file mode 100644 index 00000000..b3db8e6e --- /dev/null +++ b/third-party-licences/Facebook-WebDriverAgent @@ -0,0 +1,30 @@ +BSD License + +For WebDriverAgent software + +Copyright (c) 2015-present, Facebook, Inc. All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + + * Neither the name Facebook nor the names of its contributors may be used to + endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/third-party-licences/RoutingHTTPServer b/third-party-licences/RoutingHTTPServer new file mode 120000 index 00000000..7d385f26 --- /dev/null +++ b/third-party-licences/RoutingHTTPServer @@ -0,0 +1 @@ +../Vendor/RoutingHTTPServer/LICENSE.txt \ No newline at end of file