KartikMistry has uploaded a new change for review. https://gerrit.wikimedia.org/r/116069
Change subject: Wrapped README.md to 80 chars for readability ...................................................................... Wrapped README.md to 80 chars for readability Change-Id: I87aa98e56e72dee658960f5387eea573899a199d --- M README.md 1 file changed, 33 insertions(+), 13 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/selenium refs/changes/69/116069/1 diff --git a/README.md b/README.md index 5aabc3c..beb9778 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ # Mediawiki::Selenium -Several MediaWiki extensions share code that makes it easy to run Selenium tests. This gem -makes it easy to update the shared code. +Several MediaWiki extensions share code that makes it easy to run Selenium +tests. This gem makes it easy to update the shared code. ## Installation -To run the Selenium tests you will have to install Ruby. Look at the `Gemfile` file for the exact required version. You also have to install the latest versions of RubyGems and Firefox (the default browser in which the tests run). The easiest way to install Ruby on Linux/Unix/Mac is [RVM](https://rvm.io/) and on Windows [RubyInstaller](http://rubyinstaller.org/). -ALERT: On Windows you must use Ruby 1.9.3 for now because cucumber/gherkin library currently doesn't work with Ruby 2.x.x. +To run the Selenium tests you will have to install Ruby. Look at the `Gemfile` +file for the exact required version. You also have to install the latest +versions of RubyGems and Firefox (the default browser in which the tests run). +The easiest way to install Ruby on Linux/Unix/Mac is [RVM](https://rvm.io/) and +on Windows [RubyInstaller](http://rubyinstaller.org/). + +ALERT: On Windows you must use Ruby 1.9.3 for now because cucumber/gherkin +library currently doesn't work with Ruby 2.x.x. cd /tests/browser gem update --system gem install bundler bundle install -If you're not using RVM to manage your Ruby versions, you will need to run the commands as root (using `sudo`). +If you're not using RVM to manage your Ruby versions, you will need to run the +commands as root (using `sudo`). -Environment variables MEDIAWIKI_USER and MEDIAWIKI_PASSWORD are required for tests tagged `@login`. For local testing, create a test user on your local wiki and export the user and password as the values for those variables. +Environment variables MEDIAWIKI_USER and MEDIAWIKI_PASSWORD are required for +tests tagged `@login`. For local testing, create a test user on your local wiki +and export the user and password as the values for those variables. For example: export MEDIAWIKI_USER=<username here> # Linux/Unix/Mac @@ -28,38 +37,49 @@ Run the tests with `bundle exec cucumber`, this should start Firefox. -By default the tests run at en.wikipedia.beta.wmflabs.org. If you want to run the tests elsewhere, set the `MEDIAWIKI_URL` environment variable. For example: +By default the tests run at en.wikipedia.beta.wmflabs.org. If you want to run +the tests elsewhere, set the `MEDIAWIKI_URL` environment variable. For example: export MEDIAWIKI_URL=http://commons.wikimedia.beta.wmflabs.org/wiki/ # Linux/Unix/Mac set MEDIAWIKI_URL=http://commons.wikimedia.beta.wmflabs.org/wiki/ # Windows To run a single test file enter `bundle exec cucumber features/FEATURE_NAME.feature`. -To run a single test scenario, put a colon and the line number (NN) on which the scenario begins after the file name: `bundle exec cucumber features/FEATURE_NAME.feature:NN`. +To run a single test scenario, put a colon and the line number (NN) on which +the scenario begins after the file name: `bundle exec cucumber features/FEATURE_NAME.feature:NN`. -You can use a different browser with the `BROWSER` env variable, the fastest is probably PhantomJS, a headless browser: +You can use a different browser with the `BROWSER` env variable, the fastest is +probably PhantomJS, a headless browser: export BROWSER=phantomjs # Linux/Unix/Mac set BROWSER=phantomjs # Windows -By default, the browser will close itself at the end of every scenario. If you want the browser to stay open, set the environment variable `KEEP_BROWSER_OPEN` to `true`: +By default, the browser will close itself at the end of every scenario. If you +want the browser to stay open, set the environment variable `KEEP_BROWSER_OPEN` +to `true`: export KEEP_BROWSER_OPEN=true # Linux/Unix/Mac set KEEP_BROWSER_OPEN=true # Windows ## Screenshots -You can get screenshots on failures (since 0.2.1) by setting the environment variable SCREENSHOT_FAILURES to "true", screenshots will be written under the `screenshots` directory relatively to working directory. The SCREENSHOT_FAILURES_PATH environment variable (since 0.2.2) let you override the destination path for screenshots. Example: +You can get screenshots on failures (since 0.2.1) by setting the environment +variable SCREENSHOT_FAILURES to "true", screenshots will be written under the +`screenshots` directory relatively to working directory. The +SCREENSHOT_FAILURES_PATH environment variable (since 0.2.2) let you override +the destination path for screenshots. Example: SCREENSHOT_FAILURES=true SCREENSHOT_FAILURES_PATH="/tmp/screenshots" bundle exec cucumber ## Update your Gemfile -In your repository, the Gemfile specify dependencies and Gemfile.lock defines the whole dependency tree. To update it simply run: +In your repository, the Gemfile specify dependencies and Gemfile.lock defines +the whole dependency tree. To update it simply run: bundle update -It will fetch all dependencies and updates the Gemfile.lock file, you can then commit back both files. +It will fetch all dependencies and updates the Gemfile.lock file, you can then +commit back both files. ## Links -- To view, visit https://gerrit.wikimedia.org/r/116069 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I87aa98e56e72dee658960f5387eea573899a199d Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/selenium Gerrit-Branch: master Gerrit-Owner: KartikMistry <kartik.mis...@gmail.com> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
