/* ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio. This file is part of ChibiOS/RT. ChibiOS/RT is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. ChibiOS/RT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #ifndef _TEST_H_ #define _TEST_H_ #ifndef DELAY_BETWEEN_TESTS #define DELAY_BETWEEN_TESTS 200 #endif #ifndef TEST_NO_BENCHMARKS #define TEST_NO_BENCHMARKS FALSE #endif #define MAX_THREADS 5 #define MAX_TOKENS 16 #if defined(CH_ARCHITECTURE_AVR) || defined(CH_ARCHITECTURE_MSP430) #define THREADS_STACK_SIZE 48 #elif defined(CH_ARCHITECTURE_WIN32SIM) #define THREADS_STACK_SIZE 512 #else #define THREADS_STACK_SIZE 128 #endif #define WA_SIZE THD_WA_SIZE(THREADS_STACK_SIZE) struct testcase { char *(*gettest)(void); void (*setup)(void); void (*teardown)(void); void (*execute)(void); }; #ifdef __cplusplus extern "C" { #endif msg_t TestThread(void *p); void test_printn(uint32_t n); void test_print(char *msgp); void test_println(char *msgp); void test_emit_token(char token); bool_t _test_fail(char * msg); bool_t _test_assert(bool_t condition, char * msg); bool_t _test_assert_sequence(char *expected); bool_t _test_assert_time_window(systime_t start, systime_t end); void test_terminate_threads(void); void test_wait_threads(void); systime_t test_wait_tick(void); void test_cpu_pulse(unsigned ms); void test_start_timer(unsigned ms); #if defined(WIN32) void ChkIntSources(void); #endif #ifdef __cplusplus } #endif #define test_fail(msg) { \ test_fail(msg); \ return; \ } #define test_assert(condition, msg) { \ if (_test_assert(condition, msg)) \ return; \ } #define test_assert_sequence(expected) { \ if (_test_assert_sequence(expected)) \ return; \ } #define test_assert_time_window(start, end) { \ if (_test_assert_time_window(start, end)) \ return; \ } extern Thread *threads[MAX_THREADS]; extern void *wa[MAX_THREADS]; extern bool_t test_timer_done; #endif /* _TEST_H_ */ >)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
All the mitmproxy projects strive to maintain 100% code coverage. In general,
patches and pull requests will be declined unless they're accompanied by a
suitable extension to the test suite. 

Our tests are written for the [nose](https://nose.readthedocs.org/en/latest/).
At the point where you send your pull request, a command like this:

<pre class="terminal">
> nosetests --with-cov --cov-report term-missing ./test
</pre>

Should give output something like this:

<pre class="terminal">
> ---------- coverage: platform darwin, python 2.7.2-final-0 --
> Name                   Stmts   Miss  Cover   Missing
> ----------------------------------------------------
> libmproxy/__init__         0      0   100%
> libmproxy/app              4      0   100%
> libmproxy/cmdline        100      0   100%
> libmproxy/controller      69      0   100%
> libmproxy/dump           150      0   100%
> libmproxy/encoding        39      0   100%
> libmproxy/filt           201      0   100%
> libmproxy/flow           891      0   100%
> libmproxy/proxy          427      0   100%
> libmproxy/script          27      0   100%
> libmproxy/utils          133      0   100%
> libmproxy/version          4      0   100%
> ----------------------------------------------------
> TOTAL                   2045      0   100%
> ----------------------------------------------------
> Ran 251 tests in 11.864s
</pre>


There are exceptions to the coverage requirement - for instance, much of the
console interface code can't sensibly be unit tested. These portions are
excluded from coverage analysis either in the **.coveragerc** file, or using
**#pragma no-cover** directives. To keep our coverage analysis relevant, we use
these measures as sparingly as possible.