Skip to content

Commit

Permalink
CONTRIBUTING: Explain how to execute code after changes
Browse files Browse the repository at this point in the history
  • Loading branch information
pekkaklarck committed Jan 23, 2017
1 parent 94028e2 commit b14871f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 6 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,21 @@ environments and interpreters (Windows, Linux, OS X, Python, Jython,
IronPython, Python 3, etc). Pull requests are also automatically tested on
continuous integration.

Executing changed code
''''''''''''''''''''''

If you want to manually verify the changes, an easy approach is directly
running the `<src/robot/run.py>`_ script that is part of Robot Framework
itself. Alternatively you can use the `<rundevel.py>`_ script that sets
some command line options and environment variables to ease executing tests
under the `<atest/testdata>`_ directory. It also automatically creates a
``tmp`` directory in the project root and writes all outputs there.

If you want to install the current code locally, you can do it like
``python setup.py install`` as explained in `<INSTALL.rst>`_. For
instructions how to create a distribution that allows installing elsewhere
see `<BUILD.rst>`_.

Acceptance tests
''''''''''''''''

Expand Down
17 changes: 11 additions & 6 deletions rundevel.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
#!/usr/bin/env python

"""rundevel.py -- script to run current code
"""rundevel.py -- script to run the current Robot Framework code
Usage: [interpreter] rundevel.py [run|rebot] [options] [arguments]
Options and arguments are same as Robot Framework itself accepts. Sets some
command line options and environment variables to ease executing tests under
the `atest/testdata` directory. Writes all outputs into `tmp` directory in
the project root.
Examples:
./rundevel.py --name Example tests.txt # run with python
./rundevel.py run --name Example tests.txt # same as above
jython rundevel.py --name Example tests.txt # run with jython
./rundevel.py rebot --name Example out.xml # rebot with python
ipy rundevel.py rebot --name Example out.xml # rebot with ipy
./rundevel.py --name Example tests.robot # Run with default Python
./rundevel.py run --name Example tests.robot # Same as the above
jython rundevel.py --name Example tests.robot # Run with Jython
./rundevel.py rebot --name Example out.robot # Rebot with Jython
ipy rundevel.py rebot --name Example out.robot # Rebot with IronPython
"""

from os.path import abspath, dirname, exists, join
Expand Down

0 comments on commit b14871f

Please sign in to comment.