Triq (Term Reductive Invariant Questant) is an Apache licensed QuickCheck library for Erlang.

Nick Vatamaniuc 59fd5177f9 Merge branch 'update-authors' into 'master' 4 months ago
doc 5fbc692468 Updated authors edoc field 4 months ago
include 51dd82d059 Remove superfluous comment lines 7 months ago
pages 52ee1be40b pages: back to grey bg, now lighter than before 11 months ago
src e68b47fe7b Prepare 1.3.0 4 months ago
test 51dd82d059 Remove superfluous comment lines 7 months ago
util 38dbbca18d Remove obsolete releaser script 11 months ago
.gitignore 67868ad690 Implement GitLab Pages 1 year ago
.gitlab-ci.yml 7ba9ca9872 gitlab-ci: test with 21 5 months ago
CONTRIBUTING.org 00a2d175ad Add contributing guide to gitlab pages 11 months ago
LICENSE 8245650127 Add LICENSE and NOTICE files. 8 years ago
Makefile e0d25a213c Add copyright line mentioning Triq authors 8 months ago
NOTICE e0d25a213c Add copyright line mentioning Triq authors 8 months ago
README.org 9977fd93cd README: add missing punctuation 4 months ago
THANKS d0b10eba50 Add missing license header to reporter 8 months ago
rebar.config 194cd71179 rebar.config: macros require EDoc epp option 8 months ago
rebar.config.script 544d875277 Make rand/random mod selection at compile time 7 months ago

README.org

Triq QuickCheck for Erlang

Introduction

:PROPERTIES: :CUSTOM_ID: introduction :END:

Triq (Term Reductive Invariant Questant) is an Apache licensed QuickCheck library for Erlang. It is a continuation and community fork of Trifork QuickCheck. This fork is in no way affiliated with, or a product of, Trifork.

Homepage https://triq.gitlab.io
Hex.pm https://hex.pm/packages/triq

By and large, the Triq API is modeled closely after QuviQ eqc, except you want to replace any occurrence of eqc with triq. The main supporting module is called triq_dom, corresponding to eqc's =eqc_gen=.

<p>
<a href="https://gitlab.com/triq/triq/pipelines"><img src="https://gitlab.com/triq/triq/badges/master/pipeline.svg"></a>
</p>

Writing QuickCheck properties with Triq

:PROPERTIES: :CUSTOM_ID: writing-properties-with-triq :END:

To write properties with triq, include the triq.hrl header file:


-include_lib("triq/include/triq.hrl").

Modules compiled with the triq.hrl header auto-export all functions named prop_*, and have a function added called check/0 which runs =triq:check/1= on all the properties in the module. Further, adding the attribute -triq(eunit) will generate EUnit tests for all properties, turning the module into a regular EUnit test suite.

If you use erlang.mk, you will typically want to use the built-in Triq plugin to check properties. Otherwise we highly recommend letting Triq generate EUnit tests, thus arriving at a demo module like this:


-module(triq_demo).
-include_lib("triq/include/triq.hrl").
-triq(eunit).
prop_append() ->
    ?FORALL({Xs,Ys},{list(int()),list(int())},
            lists:reverse(Xs++Ys)
            ==
            lists:reverse(Ys) ++ lists:reverse(Xs)).

Now, all you have to do is run =rebar3 eunit=:


$ rebar3 eunit -v
===> Verifying dependencies...
===> Compiling triq_demo
===> Performing EUnit tests...
======================== EUnit ========================
file "triq_demo.app"
  application 'triq_demo'
    triq_demo:5: append_test_ (module 'triq_demo')...[0.262 s] ok
    [done in 0.269 s]
  [done in 0.274 s]
=======================================================
  Test passed.

If you use -triq({eunit, [{runs, N}]}), then Triq will do N runs for each property in the module, which is equivalent to calling triq:check(Module, N). This can be useful to make Triq try more (or less) cases than the default.

For advanced features, please consult the API docs.

Obtaining Triq

:PROPERTIES: :CUSTOM_ID: obtaining-triq :END:

Installation via package manager

:PROPERTIES: :CUSTOM_ID: installation-via-package-manager :END:

To use triq, you can add it as a project dependency and let your package manager of choice handle it:

rebar.config {deps, [triq]}
erlang.mk DEPS triq=
mix.exs {:triq, "~> 1.*"}

Installation from source into $ERL_LIBS

:PROPERTIES: :CUSTOM_ID: installation-from-source-into-erl_libs :END:

If you want to make triq available globally, you can install it from source into your Erlang installation by adding it in one of your =$ERL_LIBS= paths. So, it's either somewhere like =/usr/lib/erlang/lib= or $HOME/.erl.

You can either download a tagged release and extract that or clone the git repo in the target directory. Once that's done, cd into the directory and run make.

Now, if you start erl, you should be able to call functions from the =triq= module.


    $ erl
    1> code:which(triq).
    "/usr/lib/erlang/lib/triq/ebin/triq.beam"
    2>