Changeset 40:f4140b9f7311 in pyenvjasmine

Timestamp:

Apr 3, 2018, 1:41:17 PM (6 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Message:

Bumped version to 0.3.0
Added CHANGES.rst with release info
Updated README.rst with new install/deps/use information for the new release

Files:

• CHANGELOG.rst (added)
• CHANGES.rst (added)
• README.rst (modified) (3 diffs)
• setup.py (modified) (1 diff)

README.rst

@@ -31 +31 @@
    https://packaging.python.org/en/latest/distributing.html#working-in-development-mode
 
+.. warning::
+
+   Starting with version **0.3.0**, pyenvjasmine has support to run tests with
+   different browsers/engines. The headless browser rhino is included with
+   pyenvjasmine, but in order to use the other engines, you have to install the
+   needed browser(s).
+
+   Right now, only phantomjs_ is supported, so ensure you have it installed if
+   you want to use that browser/engine to run tests on. **Required if you want
+   to run tests on jasmine 3.x** (also required to run pyenvjasmine's own
+   tests).
+
 
 Running pyenvjasmine tests
@@ -36 +48 @@
 
 To run the tests on this code here (as opposed to *your* JavaScript code you
-want to test), install pyenvjasmine and then run::
+want to test), install pyenvjasmine (and phantomjs) and then run::
 
   py.test
@@ -58 +70 @@
             runner = Runner(
                 testdir='/path/to/my/testdir',
-                configfile='relative/path/to/configfile')
+                configfile='relative/path/to/configfile',
+                testing_environment='phantomjs')
             success, stdout = runner.run()
             # assert on success, will be true if tests passed, False if any
             # test failed
-            assert success
+            assert success, "One or more javascript tests have failed"
             # you can inspect stdout if you want to get more info, but it
             # will be printed to the console stdout anyway
             assert b'Total: 120' in stdout
 
+In this example, the *phantomjs* browse/engine is used, replace that with
+*rhino* to run tests on rhino + jasmine 1.x.
+
+.. note::
+
+   *phantomjs* is the preferred browser/engine, so it is what pyenvjasmine
+   will use as a default if you don't set *testing_environment* when creating
+   a new *Runner* instance.
 
 .. _envjasmine : https://github.com/trevmex/EnvJasmine
 .. _pip: http://www.pip-installer.org/en/latest/index.html
 .. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
+.. _phantomjs: http://phantomjs.org

setup.py

@@ -2 +2 @@
 from distutils.core import setup
 
-version = '0.2.1'
+version = '0.3.0'
 
 requires = [