Debugging and Testing Hets

sternk edited this page Jun 10, 2014 · 1 revision

Debugging and testing Hets

If Hets does not compile: try make distclean

Important: Hets is quite a large system. It is useful to first understand the central data structures of Hets by following the sample ghci session below.

Hets may be tested and debugged

  • in a top-down manner, by calling hets on some libraries and inserting some trace output, or by simulating the hets command line with ghci, see below,
  • or in a bottom-up manner, by testing and debugging individual modules.

Which way is better depends on the nature of your specific task, and on your personal preferences. Generally, bottom up should be prefered if this is possible, because this reduces complexity.

There are several tools for debugging and testing Hets:

  1. Interactive evaluation with ghci
  2. Tracing
  3. Regression tests
  4. Standalone versions of Hets
  5. Profiling
  6. Quick Check
  7. Debugger
  8. Interactive Tests

Interactive evaluation with ghci

With make ghci, you can call the interactive Haskell interpreter ghci. Use :l filename.hs to load your specific module (use :r to reload the module if you have changed the sources). Then you can interactively test individual functions of your module.

You also can simulate the hets command line. Type in:

:l Scratch.hs
Just (ln,libenv) <- process "test/Sorting1.casl"

and your file gets analysed and you can inspect the resulting data structures. Therefore, you probably need to load modules like Common/Id.hs as well:

:m +Common.Id

A sample session is stored in the file sample-ghci-script that can be pointed to by a .ghci file. Look into Static/DevGraph.hs (and also into Logic/Grothendieck.hs and CASL/Sign.hs) to understand the data structures involved. It is advisable not to look into the (rather large) data structures directly, but instead inspect their types by:

:browse Main
:browse Common.Id
:t showId

and then further decompose them, as shown in the sample file.

If you have written a parser, you can test it by adding two lines to your source file:

import Common.AnnoState
parse p inp = runParser p (emptyAnnos ()) "" inp

Then call at the ghci command prompt:

parse myParser myInputString

Tracing

With the Debug.Trace.trace function, you can output trace information. Use show or Common.DocUtils.showDoc for converting a value to a string. For example:

import Debug.Trace
import Common.DocUtils
f :: Show a => [a] -> [a]
f x = trace ("x=" ++ show x) $ reverse x
g :: Pretty a => [a] -> [a]
g x = trace ("x=" ++ showDoc x "") $ reverse x

Regression tests

make check runs various regression tests partly using the following standalone programs.

Standalone versions of Hets

There are various standalone versions covering specific aspects of Hets:

  • Parser: make test_parser
  • CASL parser: make capa
  • HasCASL parser: make hacapa
  • Haskell analysis: make hana
  • HasCASL to Haskell translation: make h2h
  • HetCASL parser: make hetpa
  • HetCASL analysis: make hetana
  • ATC test system: make atctest
  • ATerm.Lib test system: make atermlibtest, make hatermdiff

Profiling

In order to translate hets with profiling, move away the uni and programatica directories. In the Makefile uncomment HC_PROFILE and translate all packages with profiling by adding -p following configure of cabal's Setup. Unregister the packages manually or make package_clean before make. (When switching off profiling later on, the packages don't need to be recompiled again.)

Also comment out HAXML_PACKAGE and -DCASLEXTENSIONS if it's not needed. (Translated uni with profiling has not been tested yet.) The resulting hets binary now creates a file hets.prof for inspection if executed with additional final arguments +RTS -p.

hets -v2 -o prf Basic/Numbers.casl +RTS -p

Quick Check

We have a single file Common/Lib/RelCheck.hs with quick check properties. We have not yet worked on writing HUnit tests.

Debugger

The GHCi debugger does not seem to be working. Other tools are usually restricted to Haskell98 sources.

Interactive Tests

See Interactive Tests

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.