Skip to content
Browse files

Updated readme to be inline with other projects

  • Loading branch information...
1 parent 4857f22 commit cd0cd114874f91326d5f18f37ae4b61d4f1d2bd9 @AutomatedTester AutomatedTester committed Jul 5, 2011
Showing with 96 additions and 13 deletions.
  1. +96 −13 README
  2. 0 requirements.txt → requirements/mozwebqa.txt
View
109 README
@@ -1,23 +1,106 @@
-Selenium tests to be run on FlightDeck.
+Firefox Addons-Builder Tests
+====================
-Installation
-############
+Automated tests for the Firefox Addons Builder web application.
-All requirements in requirements.txt
+Running Tests
+-------------
-Please add settings_local.py with content from settings.py which should be
-overwritten - especially AMO_USERNAME and AMO_PASSWORD
+### Java
+You will need a version of the [Java Runtime Environment][JRE] installed
-If you'd like to test localhost change the HOME_PAGE_URL to your localhost
+[JRE]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
+### Python
+Before you will be able to run these tests you will need to have Python 2.6 installed.
-Usage
-#####
+Run
-``./run.py test_module1 test_module2``
+ easy_install pip
-Where ``test_module`` is the name of the module from ./tests/ directory
+followed by
-in example:
+ sudo pip install -r requirements/mozwebqa.txt
+
+__note__
+
+If you are running on Ubuntu/Debian you will need to do following first
+
+ sudo apt-get install python-setuptools
+
+to install the required Python libraries.
+
+### Selenium
+Once this is all set up you will need to download and start a Selenium server. You can download the latest Selenium server from [here][Selenium Downloads]. The filename will be something like 'selenium-server-standalone-2.0.jar'
+
+To start the Selenium server run the following command:
+
+ java -jar ~/Downloads/selenium-server-standalone-2.0.jar
+
+Change the path/name to the downloaded Selenium server file.
+
+[Selenium Downloads]: http://code.google.com/p/selenium/downloads/list
+
+### Running tests locally
+
+To run tests locally its a simple case of calling the command below from this directory
+
+ py.test .
+
+
+Writing Tests
+-------------
+
+If you want to get involved and add more tests then there's just a few things
+we'd like to ask you to do:
+
+1. Use the [template files][GitHub Templates] for all new tests and page objects
+2. Follow our simple [style guide][Style Guide]
+3. Fork this project with your own GitHub account
+4. Make sure all tests are passing, and submit a pull request with your changes
+
+[GitHub Templates]: https://github.com/AutomatedTester/mozwebqa-test-templates
+[Style Guide]: https://wiki.mozilla.org/QA/Execution/Web_Testing/Docs/Automation/StyleGuide
+
+License
+-------
+This software is licensed under the [Mozilla Tri-License][MPL]:
+
+ ***** BEGIN LICENSE BLOCK *****
+ Version: MPL 1.1/GPL 2.0/LGPL 2.1
+
+ The contents of this file are subject to the Mozilla Public License Version
+ 1.1 (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.mozilla.org/MPL/
+
+ Software distributed under the License is distributed on an "AS IS" basis,
+ WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ for the specific language governing rights and limitations under the
+ License.
+
+ The Original Code is Mozilla WebQA Selenium Tests.
+
+ The Initial Developer of the Original Code is Mozilla.
+ Portions created by the Initial Developer are Copyright (C) 2011
+ the Initial Developer. All Rights Reserved.
+
+ Contributor(s):
+ Dave Hunt <dhunt@mozilla.com>
+
+ Alternatively, the contents of this file may be used under the terms of
+ either the GNU General Public License Version 2 or later (the "GPL"), or
+ the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ in which case the provisions of the GPL or the LGPL are applicable instead
+ of those above. If you wish to allow use of your version of this file only
+ under the terms of either the GPL or the LGPL, and not to allow others to
+ use your version of this file under the terms of the MPL, indicate your
+ decision by deleting the provisions above and replace them with the notice
+ and other provisions required by the GPL or the LGPL. If you do not delete
+ the provisions above, a recipient may use your version of this file under
+ the terms of any one of the MPL, the GPL or the LGPL.
+
+ ***** END LICENSE BLOCK *****
+
+[MPL]: http://www.mozilla.org/MPL/
-``./run.py check_addon_label check_lib_label``
View
0 requirements.txt → requirements/mozwebqa.txt
File renamed without changes.

0 comments on commit cd0cd11

Please sign in to comment.
Something went wrong with that request. Please try again.