|
|
| Line 1: |
Line 1: |
| [[Category:Developer Manual]] | | #REDIRECT [[Running_ProB_from_source]] |
| __NOTOC__
| |
| | |
| | |
| === The Prolog Sources ===
| |
| If you want to contribute to the Prolog part of ProB, if you want to extend the ProB API, or need them as reference, you need the Prolog sources which can be downloaded from [https://www3.hhu.de/stups/downloads/prob/source/ https://www3.hhu.de/stups/downloads/prob/source/]. To compile the sources you need a [http://www.sics.se/isl/sicstuswww/site/index.html SICStus Prolog] licence.
| |
| | |
| === Running ProB from Prolog ===
| |
| | |
| You first need to download and install [http://www.sics.se/isl/sicstuswww/site/index.html SICStus Prolog]. Evaluation licenses (30-days) are available. You need SICStus 4.2 or newer (we will switch to SICStus 4.3 in summer or autumn of 2014).
| |
| | |
| You need the password to download SICStus then run <tt>sudo ./InstallSICStus</tt> and provide the site name, license code and expiration date. Be sure to add the SICStus binaries to your PATH.
| |
| | |
| Probably you should also install a recent Active Tcl distribution.
| |
| | |
| Now, you need the ProB Prolog sources.
| |
| | |
| Now, add the following to your <tt>.bash_login</tt> file (at least on Mac OS; supposing you cloned the Git repository into ~/git_root):
| |
|
| |
| export PROBDIR=~/git_root/prob_prolog
| |
| export PROB_SOURCE_DIR=$PROBDIR/src
| |
| alias prob='cd $PROB_SOURCE_DIR; sicstus -Dprob_profile=true -l $PROB_SOURCE_DIR/prob_tcltk.pl --goal "go."'
| |
| | |
| Now, you can simply start ProB from the command-line and from source with <tt>prob</tt>.
| |
| | |
| To start the Unit Test REPL, add the following to your <tt>.bash_login</tt> file (at least on Mac OS):
| |
| | |
| alias test='cd $PROBDIR; rlwrap sicstus -Dprob_safe_mode=true -l $PROB_SOURCE_DIR/test_runner.pl --goal "test_repl."'
| |
| | |
| (It is recommended to install rlwrap so that you get a history of your commands. If you don't want to install rlwrap just remove it from the line above.)
| |
| | |
| Before using ProB for the first time from source you should build the extensions. The minimal extensions are counter and user_signal. You can build them using
| |
| cd extensions/counter
| |
| make
| |
| cd ../user_signal
| |
| make
| |
| | |
| You could also build all extensions at once by going to the top of the prob_prolog tree (i.e., the directory containing src and lib as sub-directories) and then type
| |
| make
| |
| | |
| On Mac you may have to add a symbolic link to gawk in order to build the ProZ fuzz extension:
| |
| sudo ln -s /usr/bin/awk /usr/bin/gawk
| |
| | |
| Now you can start the testing console using <tt>test</tt>. You can e.g. type the number of a unit test to run it, or a test category such as <tt>tickets</tt> to run all tests in that category.
| |
| | |
| === Running the Prolog Tests ===
| |
| | |
| All Prolog tests are stored as facts in the file <tt>test cases.pl</tt>.
| |
| Every test has
| |
| * an identifier (a number); the last test added has the highest number
| |
| * a non-empty list of categories (such as unit, tickets,...)
| |
| * the test itself: the parameters to <tt>probcli</tt> needed to run the test
| |
| * a textual description of the test
| |
| | |
| There is a specific <tt>test_runner.pl</tt> file for running all Prolog unit and integration tests. The test_runner also provides a REPL (read-eval-print-loop) for running tests and collection of tests.
| |
| | |
| Supposing you have set the variable <tt> PROBDIR</tt> (see above) and have the <tt>rlwrap</tt> tool, you can define the following alias (e.g., in your <tt>.bash_login</tt> file on Mac OS X):
| |
| alias test='cd $PROBDIR; rlwrap sicstus -Dprob_safe_mode=true -l $PROBDIR/src/test_runner.pl --goal "test_repl."'
| |
| | |
| Now you can start the test runner:
| |
| <pre>
| |
| $ test
| |
| ...
| |
| SICStus 4.2.3 (x86_64-darwin-11.4.2): Fri Oct 5 15:58:35 CEST 2012
| |
| Licensed to SP4phil-fak.uni-duesseldorf.de
| |
| TEST ==> last.
| |
| ...
| |
| All tests successful.
| |
| Walltime: 100 ms
| |
| </pre>
| |
| | |
| Some useful commands are:
| |
| * last to run the last test added to <tt>testcases.pl</tt>
| |
| * all to run all tests
| |
| * cat to list all categories of tests (e.g., cbc, cbc_deadlock,...)
| |
| * cbc, cbc_deadlock, tickets, ... : to run all tests in that category
| |
| * type in a number to run the specific test with that number (see <tt>testcases.pl</tt>)
| |
| * type in a range m-n to run all tests in that range
| |
| * v or vv to switch to verbose or very verbose mode
| |
| * q to quit the test runner (and stay in Prolog)
| |
| * x to quit the test runner and Prolog
| |
| * debug to switch on Prolog debug mode
| |
| * trace to force Prolog to start tracing as soon as an error occurs (if you have switched to debug above then you will be able to inspect the Prolog goal stack)
| |