April 2018 - tor-commits - lists.torproject.org

[tor/master] Add wrappers for event_base_loopexit and event_base_loopbreak.
by nickm＠torproject.org 06 Apr '18

06 Apr '18

commit 39cb04335f9fd5c3268c808bac549f531fe389a3 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 3 11:09:44 2017 -0400 Add wrappers for event_base_loopexit and event_base_loopbreak. --- src/common/compat_libevent.c | 32 ++++++++++++++++++++++++++++++++ src/common/compat_libevent.h | 7 ++++--- src/or/main.c | 7 ++++--- src/or/ntmain.c | 5 ++--- src/test/test-timers.c | 2 +- src/test/test_channelpadding.c | 12 ++++++------ src/test/test_workqueue.c | 6 +++--- 7 files changed, 52 insertions(+), 19 deletions(-) diff --git a/src/common/compat_libevent.c b/src/common/compat_libevent.c index f453a8e87..cb311ea46 100644 --- a/src/common/compat_libevent.c +++ b/src/common/compat_libevent.c @@ -363,6 +363,38 @@ tor_libevent_free_all(void) the_event_base = NULL; } +/** + * Run the event loop for the provided event_base, handling events until + * something stops it. If once is set, then just poll-and-run + * once, then exit. Return 0 on success, -1 if an error occurred, or 1 + * if we exited because no events were pending or active. + * + * This isn't reentrant or multithreaded. + */ +int +tor_libevent_run_event_loop(struct event_base *base, int once) +{ + const int flags = once ? EVLOOP_ONCE : 0; + return event_base_loop(base, flags); +} + +/** Tell the event loop to exit after delay. If delay is NULL, + * instead exit after we're done running the currently active events. */ +void +tor_libevent_exit_loop_after_delay(struct event_base *base, + const struct timeval *delay) +{ + event_base_loopexit(base, delay); +} + +/** Tell the event loop to exit after running whichever callback is currently + * active. */ +void +tor_libevent_exit_loop_after_callback(struct event_base *base) +{ + event_base_loopbreak(base); +} + #if defined(LIBEVENT_VERSION_NUMBER) && \ LIBEVENT_VERSION_NUMBER >= V(2,1,1) && \ !defined(TOR_UNIT_TESTS) diff --git a/src/common/compat_libevent.h b/src/common/compat_libevent.h index 711c3a2eb..86bc77ba5 100644 --- a/src/common/compat_libevent.h +++ b/src/common/compat_libevent.h @@ -45,9 +45,6 @@ void mainloop_event_free_(mainloop_event_t *event); #define mainloop_event_free(event) \ FREE_AND_NULL(mainloop_event_t, mainloop_event_free_, (event)) -#define tor_event_base_loopexit event_base_loopexit -#define tor_event_base_loopbreak event_base_loopbreak - /** Defines a configuration for using libevent with Tor: passed as an argument * to tor_libevent_initialize() to describe how we want to set up. */ typedef struct tor_libevent_cfg { @@ -75,6 +72,10 @@ void tor_gettimeofday_cache_set(const struct timeval *tv); void tor_libevent_postfork(void); #endif +void tor_libevent_exit_loop_after_delay(struct event_base *base, + const struct timeval *delay); +void tor_libevent_exit_loop_after_callback(struct event_base *base); + #ifdef COMPAT_LIBEVENT_PRIVATE /** Macro: returns the number of a Libevent version as a 4-byte number, diff --git a/src/or/main.c b/src/or/main.c index 9f26732a2..9a8ac3088 100644 --- a/src/or/main.c +++ b/src/or/main.c @@ -719,7 +719,7 @@ tell_event_loop_to_run_external_code(void) { if (!called_loop_once) { struct timeval tv = { 0, 0 }; - tor_event_base_loopexit(tor_libevent_get_base(), &tv); + tor_libevent_exit_loop_after_delay(tor_libevent_get_base(), &tv); called_loop_once = 1; /* hack to avoid adding more exit events */ } } @@ -779,8 +779,9 @@ tor_shutdown_event_loop_and_exit(int exitcode) shutdown_did_not_work_callback, NULL); event_add(shutdown_did_not_work_event, &ten_seconds); - /* Unlike loopexit, loopbreak prevents other callbacks from running. */ - tor_event_base_loopbreak(tor_libevent_get_base()); + /* Unlike exit_loop_after_delay(), exit_loop_after_callback + * prevents other callbacks from running. */ + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); } /** Return true iff tor_shutdown_event_loop_and_exit() has been called. */ diff --git a/src/or/ntmain.c b/src/or/ntmain.c index ebbe0018b..e9a299807 100644 --- a/src/or/ntmain.c +++ b/src/or/ntmain.c @@ -24,8 +24,6 @@ #include "main.h" #include "ntmain.h" -#include <event2/event.h> - #include <windows.h> #define GENSRV_SERVICENAME "tor" #define GENSRV_DISPLAYNAME "Tor Win32 Service" @@ -245,7 +243,8 @@ nt_service_control(DWORD request) log_notice(LD_GENERAL, "Got stop/shutdown request; shutting down cleanly."); service_status.dwCurrentState = SERVICE_STOP_PENDING; - event_base_loopexit(tor_libevent_get_base(), &exit_now); + tor_libevent_exit_loop_after_delay(tor_libevent_get_base(), + &exit_now); return; } service_fns.SetServiceStatus_fn(hStatus, &service_status); diff --git a/src/test/test-timers.c b/src/test/test-timers.c index a0b5b535c..1b4466ecc 100644 --- a/src/test/test-timers.c +++ b/src/test/test-timers.c @@ -50,7 +50,7 @@ timer_cb(tor_timer_t *t, void *arg, const monotime_t *now_mono) // printf("%d / %d\n",n_fired, N_TIMERS); if (n_fired == n_active_timers) { - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); } } diff --git a/src/test/test_channelpadding.c b/src/test/test_channelpadding.c index 9e570b81a..072a347de 100644 --- a/src/test/test_channelpadding.c +++ b/src/test/test_channelpadding.c @@ -65,7 +65,7 @@ mock_channel_write_cell_relay2(channel_t *chan, cell_t *cell) (void)chan; tried_to_write_cell++; channel_tls_handle_cell(cell, ((channel_tls_t*)relay1_relay2)->conn); - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); return 0; } @@ -75,7 +75,7 @@ mock_channel_write_cell_relay1(channel_t *chan, cell_t *cell) (void)chan; tried_to_write_cell++; channel_tls_handle_cell(cell, ((channel_tls_t*)relay2_relay1)->conn); - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); return 0; } @@ -85,7 +85,7 @@ mock_channel_write_cell_relay3(channel_t *chan, cell_t *cell) (void)chan; tried_to_write_cell++; channel_tls_handle_cell(cell, ((channel_tls_t*)client_relay3)->conn); - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); return 0; } @@ -95,7 +95,7 @@ mock_channel_write_cell_client(channel_t *chan, cell_t *cell) (void)chan; tried_to_write_cell++; channel_tls_handle_cell(cell, ((channel_tls_t*)relay3_client)->conn); - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); return 0; } @@ -105,7 +105,7 @@ mock_channel_write_cell(channel_t *chan, cell_t *cell) tried_to_write_cell++; channel_tls_handle_cell(cell, ((channel_tls_t*)chan)->conn); if (!dont_stop_libevent) - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); return 0; } @@ -246,7 +246,7 @@ static void dummy_timer_cb(tor_timer_t *t, void *arg, const monotime_t *now_mono) { (void)t; (void)arg; (void)now_mono; - event_base_loopbreak(tor_libevent_get_base()); + tor_libevent_exit_loop_after_callback(tor_libevent_get_base()); return; } diff --git a/src/test/test_workqueue.c b/src/test/test_workqueue.c index 2b0317371..de7884ff9 100644 --- a/src/test/test_workqueue.c +++ b/src/test/test_workqueue.c @@ -230,7 +230,7 @@ add_n_work_items(threadpool_t *tp, int n) ent = add_work(tp); if (! ent) { puts("Z"); - tor_event_base_loopexit(tor_libevent_get_base(), NULL); + tor_libevent_exit_loop_after_delay(tor_libevent_get_base(), NULL); return -1; } if (n_try_cancel < opt_n_cancel && @@ -308,7 +308,7 @@ replysock_readable_cb(tor_socket_t sock, short what, void *arg) handle_reply_shutdown, NULL); { struct timeval limit = { 2, 0 }; - tor_event_base_loopexit(tor_libevent_get_base(), &limit); + tor_libevent_exit_loop_after_delay(tor_libevent_get_base(), &limit); } } } @@ -433,7 +433,7 @@ main(int argc, char **argv) { struct timeval limit = { 180, 0 }; - tor_event_base_loopexit(tor_libevent_get_base(), &limit); + tor_libevent_exit_loop_after_delay(tor_libevent_get_base(), &limit); } event_base_loop(tor_libevent_get_base(), 0);

1 0

[tor/master] Wrap the function we use to run the event loop.
by nickm＠torproject.org 06 Apr '18

06 Apr '18

commit b3586629c9ce41393898b381159ba331906f8fc3 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 3 11:20:59 2017 -0400 Wrap the function we use to run the event loop. Doing this lets us remove the event2/event.h header from a few more modules, particularly in the tests. Part of work on 23750. --- src/common/compat_libevent.h | 1 + src/or/main.c | 4 ++-- src/test/test-timers.c | 4 +--- src/test/test_channelpadding.c | 4 ++-- src/test/test_workqueue.c | 2 +- 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/src/common/compat_libevent.h b/src/common/compat_libevent.h index 86bc77ba5..c8b037156 100644 --- a/src/common/compat_libevent.h +++ b/src/common/compat_libevent.h @@ -72,6 +72,7 @@ void tor_gettimeofday_cache_set(const struct timeval *tv); void tor_libevent_postfork(void); #endif +int tor_libevent_run_event_loop(struct event_base *base, int once); void tor_libevent_exit_loop_after_delay(struct event_base *base, const struct timeval *delay); void tor_libevent_exit_loop_after_callback(struct event_base *base); diff --git a/src/or/main.c b/src/or/main.c index 9a8ac3088..d1df11af5 100644 --- a/src/or/main.c +++ b/src/or/main.c @@ -2832,8 +2832,8 @@ run_main_loop_once(void) * an event, or the second ends, or until we have some active linked * connections to trigger events for. Libevent will wait till one * of these happens, then run all the appropriate callbacks. */ - loop_result = event_base_loop(tor_libevent_get_base(), - called_loop_once ? EVLOOP_ONCE : 0); + loop_result = tor_libevent_run_event_loop(tor_libevent_get_base(), + called_loop_once); if (get_options()->MainloopStats) { /* Update our main loop counters. */ diff --git a/src/test/test-timers.c b/src/test/test-timers.c index 1b4466ecc..5efd99cac 100644 --- a/src/test/test-timers.c +++ b/src/test/test-timers.c @@ -7,8 +7,6 @@ #include <stdio.h> #include <string.h> -#include <event2/event.h> - #include "compat.h" #include "compat_libevent.h" #include "crypto.h" @@ -90,7 +88,7 @@ main(int argc, char **argv) --n_active_timers; } - event_base_loop(tor_libevent_get_base(), 0); + tor_libevent_run_event_loop(tor_libevent_get_base(), 0); int64_t total_difference = 0; uint64_t total_square_difference = 0; diff --git a/src/test/test_channelpadding.c b/src/test/test_channelpadding.c index 072a347de..2c803c344 100644 --- a/src/test/test_channelpadding.c +++ b/src/test/test_channelpadding.c @@ -15,7 +15,6 @@ #include "channelpadding.h" #include "compat_libevent.h" #include "config.h" -#include <event2/event.h> #include "compat_time.h" #include "main.h" #include "networkstatus.h" @@ -264,7 +263,8 @@ dummy_nop_timer(void) timer_schedule(dummy_timer, &timeout); - event_base_loop(tor_libevent_get_base(), 0); + tor_libevent_run_event_loop(tor_libevent_get_base(), 0); + timer_free(dummy_timer); } diff --git a/src/test/test_workqueue.c b/src/test/test_workqueue.c index de7884ff9..2a0261147 100644 --- a/src/test/test_workqueue.c +++ b/src/test/test_workqueue.c @@ -436,7 +436,7 @@ main(int argc, char **argv) tor_libevent_exit_loop_after_delay(tor_libevent_get_base(), &limit); } - event_base_loop(tor_libevent_get_base(), 0); + tor_libevent_run_event_loop(tor_libevent_get_base(), 0); if (n_sent != opt_n_items || n_received+n_successful_cancel != n_sent) { printf("%d vs %d\n", n_sent, opt_n_items);

1 0

[tor/master] Remove redundant event2/event.h usage from test_scheduler.c
by nickm＠torproject.org 06 Apr '18

06 Apr '18

commit 4225300648face7339b22c81ddcebef51b296a02 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 3 12:58:19 2017 -0400 Remove redundant event2/event.h usage from test_scheduler.c This module doesn't actually need to mock the libevent mainloop at all: it can just use the regular mainloop that the test environment sets up. Part of ticket 23750. --- src/test/test_scheduler.c | 75 ++--------------------------------------------- 1 file changed, 2 insertions(+), 73 deletions(-) diff --git a/src/test/test_scheduler.c b/src/test/test_scheduler.c index ebba71266..841fc6945 100644 --- a/src/test/test_scheduler.c +++ b/src/test/test_scheduler.c @@ -4,7 +4,6 @@ #include "orconfig.h" #include <math.h> -#include <event2/event.h> #define SCHEDULER_KIST_PRIVATE #define TOR_CHANNEL_INTERNAL_ @@ -101,62 +100,6 @@ mock_kist_networkstatus_get_param( return 12; } -/* Event base for scheduelr tests */ -static struct event_base *mock_event_base = NULL; -/* Setup for mock event stuff */ -static void mock_event_free_all(void); -static void mock_event_init(void); -static void -mock_event_free_all(void) -{ - tt_ptr_op(mock_event_base, OP_NE, NULL); - - if (mock_event_base) { - event_base_free(mock_event_base); - mock_event_base = NULL; - } - - tt_ptr_op(mock_event_base, OP_EQ, NULL); - - done: - return; -} - -static void -mock_event_init(void) -{ - struct event_config *cfg = NULL; - - tt_ptr_op(mock_event_base, OP_EQ, NULL); - - /* - * Really cut down from tor_libevent_initialize of - * src/common/compat_libevent.c to kill config dependencies - */ - - if (!mock_event_base) { - cfg = event_config_new(); -#if LIBEVENT_VERSION_NUMBER >= V(2,0,9) - /* We can enable changelist support with epoll, since we don't give - * Libevent any dup'd fds. This lets us avoid some syscalls. */ - event_config_set_flag(cfg, EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST); -#endif - mock_event_base = event_base_new_with_config(cfg); - event_config_free(cfg); - } - - tt_ptr_op(mock_event_base, OP_NE, NULL); - - done: - return; -} - -static struct event_base * -tor_libevent_get_base_mock(void) -{ - return mock_event_base; -} - static int scheduler_compare_channels_mock(const void *c1_v, const void *c2_v) @@ -417,9 +360,7 @@ perform_channel_state_tests(int KISTSchedRunInterval, int sched_type) mocked_options.KISTSchedRunInterval = KISTSchedRunInterval; set_scheduler_options(sched_type); - /* Set up libevent and scheduler */ - mock_event_init(); - MOCK(tor_libevent_get_base, tor_libevent_get_base_mock); + /* Set up scheduler */ scheduler_init(); /* * Install the compare channels mock so we can test @@ -523,14 +464,12 @@ perform_channel_state_tests(int KISTSchedRunInterval, int sched_type) channel_free_all(); scheduler_free_all(); - mock_event_free_all(); done: tor_free(ch1); tor_free(ch2); UNMOCK(scheduler_compare_channels); - UNMOCK(tor_libevent_get_base); UNMOCK(get_options); cleanup_scheduler_options(); @@ -635,10 +574,7 @@ test_scheduler_loop_vanilla(void *arg) set_scheduler_options(SCHEDULER_VANILLA); mocked_options.KISTSchedRunInterval = 0; - /* Set up libevent and scheduler */ - - mock_event_init(); - MOCK(tor_libevent_get_base, tor_libevent_get_base_mock); + /* Set up scheduler */ scheduler_init(); /* * Install the compare channels mock so we can test @@ -786,7 +722,6 @@ test_scheduler_loop_vanilla(void *arg) channel_flush_some_cells_mock_free_all(); channel_free_all(); scheduler_free_all(); - mock_event_free_all(); done: tor_free(ch1); @@ -795,7 +730,6 @@ test_scheduler_loop_vanilla(void *arg) UNMOCK(channel_flush_some_cells); UNMOCK(scheduler_compare_channels); - UNMOCK(tor_libevent_get_base); UNMOCK(get_options); } @@ -917,8 +851,6 @@ test_scheduler_initfree(void *arg) tt_ptr_op(channels_pending, ==, NULL); tt_ptr_op(run_sched_ev, ==, NULL); - mock_event_init(); - MOCK(tor_libevent_get_base, tor_libevent_get_base_mock); MOCK(get_options, mock_get_options); set_scheduler_options(SCHEDULER_KIST); set_scheduler_options(SCHEDULER_KIST_LITE); @@ -935,9 +867,6 @@ test_scheduler_initfree(void *arg) scheduler_free_all(); - UNMOCK(tor_libevent_get_base); - mock_event_free_all(); - tt_ptr_op(channels_pending, ==, NULL); tt_ptr_op(run_sched_ev, ==, NULL);

1 0

[tor/master] changes file for libevent isolation work
by nickm＠torproject.org 06 Apr '18

06 Apr '18

commit 421c2310a804cf4341a42d9a20f425e3d59ac013 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 3 13:02:59 2017 -0400 changes file for libevent isolation work --- changes/isolate_libevent | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/changes/isolate_libevent b/changes/isolate_libevent new file mode 100644 index 000000000..852e533fd --- /dev/null +++ b/changes/isolate_libevent @@ -0,0 +1,5 @@ + o Code simplification and refactoring: + - Initial work to isolate Libevent usage to a handful of modules in our + codebase, to simplify our call structure, and so that we can more + easily change event loops in the future if needed. Closes ticket + 23750.

1 0

[tor/master] Move responsibility for threadpool reply-handler events to workqueue
by nickm＠torproject.org 06 Apr '18

06 Apr '18

commit 6a5f62f68f2c73dbbbbddb4fa3759586f4c2b0dc Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 3 12:49:34 2017 -0400 Move responsibility for threadpool reply-handler events to workqueue This change makes cpuworker and test_workqueue no longer need to include event2/event.h. Now workqueue.c needs to include it, but that is at least somewhat logical here. --- src/common/workqueue.c | 47 ++++++++++++++++++++++++++++++++++++++++------- src/common/workqueue.h | 5 ++++- src/or/cpuworker.c | 25 +++++-------------------- src/test/test_workqueue.c | 27 ++++++++++----------------- 4 files changed, 59 insertions(+), 45 deletions(-) diff --git a/src/common/workqueue.c b/src/common/workqueue.c index ec96959b7..12e31414e 100644 --- a/src/common/workqueue.c +++ b/src/common/workqueue.c @@ -1,3 +1,4 @@ + /* copyright (c) 2013-2015, The Tor Project, Inc. */ /* See LICENSE for licensing information */ @@ -24,6 +25,7 @@ #include "orconfig.h" #include "compat.h" +#include "compat_libevent.h" #include "compat_threads.h" #include "crypto.h" #include "util.h" @@ -31,6 +33,8 @@ #include "tor_queue.h" #include "torlog.h" +#include <event2/event.h> + #define WORKQUEUE_PRIORITY_FIRST WQ_PRI_HIGH #define WORKQUEUE_PRIORITY_LAST WQ_PRI_LOW #define WORKQUEUE_N_PRIORITIES (((int) WORKQUEUE_PRIORITY_LAST)+1) @@ -63,6 +67,9 @@ struct threadpool_s { void (*free_update_arg_fn)(void *); /** Array of n_threads update arguments. */ void **update_args; + /** Event to notice when another thread has sent a reply. */ + struct event *reply_event; + void (*reply_cb)(threadpool_t *); /** Number of elements in threads. */ int n_threads; @@ -597,15 +604,41 @@ replyqueue_new(uint32_t alertsocks_flags) return rq; } -/** - * Return the "read socket" for a given reply queue. The main thread should - * listen for read events on this socket, and call replyqueue_process() every - * time it triggers. +/** Internal: Run from the libevent mainloop when there is work to handle in + * the reply queue handler. */ +static void +reply_event_cb(evutil_socket_t sock, short events, void *arg) +{ + threadpool_t *tp = arg; + (void) sock; + (void) events; + replyqueue_process(tp->reply_queue); + if (tp->reply_cb) + tp->reply_cb(tp); +} + +/** Register the threadpool tp's reply queue with the libevent + * mainloop of base. If tp is provided, it is run after + * each time there is work to process from the reply queue. Return 0 on + * success, -1 on failure. */ -tor_socket_t -replyqueue_get_socket(replyqueue_t *rq) +int +threadpool_register_reply_event(threadpool_t *tp, + void (*cb)(threadpool_t *tp)) { - return rq->alert.read_fd; + struct event_base *base = tor_libevent_get_base(); + + if (tp->reply_event) { + tor_event_free(tp->reply_event); + } + tp->reply_event = tor_event_new(base, + tp->reply_queue->alert.read_fd, + EV_READ|EV_PERSIST, + reply_event_cb, + tp); + tor_assert(tp->reply_event); + tp->reply_cb = cb; + return event_add(tp->reply_event, NULL); } /** diff --git a/src/common/workqueue.h b/src/common/workqueue.h index eb885e680..e1fe612e2 100644 --- a/src/common/workqueue.h +++ b/src/common/workqueue.h @@ -56,8 +56,11 @@ threadpool_t *threadpool_new(int n_threads, replyqueue_t *threadpool_get_replyqueue(threadpool_t *tp); replyqueue_t *replyqueue_new(uint32_t alertsocks_flags); -tor_socket_t replyqueue_get_socket(replyqueue_t *rq); void replyqueue_process(replyqueue_t *queue); +struct event_base; +int threadpool_register_reply_event(threadpool_t *tp, + void (*cb)(threadpool_t *tp)); + #endif /* !defined(TOR_WORKQUEUE_H) */ diff --git a/src/or/cpuworker.c b/src/or/cpuworker.c index 7da7dc5f8..083691c4f 100644 --- a/src/or/cpuworker.c +++ b/src/or/cpuworker.c @@ -30,8 +30,6 @@ #include "router.h" #include "workqueue.h" -#include <event2/event.h> - static void queue_pending_tasks(void); typedef struct worker_state_s { @@ -69,22 +67,12 @@ worker_state_free_void(void *arg) static replyqueue_t *replyqueue = NULL; static threadpool_t *threadpool = NULL; -static struct event *reply_event = NULL; static tor_weak_rng_t request_sample_rng = TOR_WEAK_RNG_INIT; static int total_pending_tasks = 0; static int max_pending_tasks = 128; -static void -replyqueue_process_cb(evutil_socket_t sock, short events, void *arg) -{ - replyqueue_t *rq = arg; - (void) sock; - (void) events; - replyqueue_process(rq); -} - /** Initialize the cpuworker subsystem. It is OK to call this more than once * during Tor's lifetime. */ @@ -94,14 +82,6 @@ cpu_init(void) if (!replyqueue) { replyqueue = replyqueue_new(0); } - if (!reply_event) { - reply_event = tor_event_new(tor_libevent_get_base(), - replyqueue_get_socket(replyqueue), - EV_READ|EV_PERSIST, - replyqueue_process_cb, - replyqueue); - event_add(reply_event, NULL); - } if (!threadpool) { /* In our threadpool implementation, half the threads are permissive and @@ -115,7 +95,12 @@ cpu_init(void) worker_state_new, worker_state_free_void, NULL); + + int r = threadpool_register_reply_event(threadpool, NULL); + + tor_assert(r == 0); } + /* Total voodoo. Can we make this more sensible? */ max_pending_tasks = get_num_cpus(get_options()) * 64; crypto_seed_weak_rng(&request_sample_rng); diff --git a/src/test/test_workqueue.c b/src/test/test_workqueue.c index 2a0261147..940973cda 100644 --- a/src/test/test_workqueue.c +++ b/src/test/test_workqueue.c @@ -12,7 +12,6 @@ #include "compat_libevent.h" #include <stdio.h> -#include <event2/event.h> #define MAX_INFLIGHT (1<<16) @@ -159,6 +158,7 @@ static tor_weak_rng_t weak_rng; static int n_sent = 0; static int rsa_sent = 0; static int ecdh_sent = 0; +static int n_received_previously = 0; static int n_received = 0; static int no_shutdown = 0; @@ -256,19 +256,13 @@ add_n_work_items(threadpool_t *tp, int n) static int shutting_down = 0; static void -replysock_readable_cb(tor_socket_t sock, short what, void *arg) +replysock_readable_cb(threadpool_t *tp) { - threadpool_t *tp = arg; - replyqueue_t *rq = threadpool_get_replyqueue(tp); - - int old_r = n_received; - (void) sock; - (void) what; - - replyqueue_process(rq); - if (old_r == n_received) + if (n_received_previously == n_received) return; + n_received_previously = n_received; + if (opt_verbose) { printf("%d / %d", n_received, n_sent); if (opt_n_cancel) @@ -337,7 +331,6 @@ main(int argc, char **argv) threadpool_t *tp; int i; tor_libevent_cfg evcfg; - struct event *ev; uint32_t as_flags = 0; for (i = 1; i < argc; ++i) { @@ -411,11 +404,11 @@ main(int argc, char **argv) memset(&evcfg, 0, sizeof(evcfg)); tor_libevent_initialize(&evcfg); - ev = tor_event_new(tor_libevent_get_base(), - replyqueue_get_socket(rq), EV_READ|EV_PERSIST, - replysock_readable_cb, tp); - - event_add(ev, NULL); + { + int r = threadpool_register_reply_event(tp, + replysock_readable_cb); + tor_assert(r == 0); + } #ifdef TRACK_RESPONSES handled = bitarray_init_zero(opt_n_items);

1 0

[tor/master] Merge branch 'isolate_libevent_2_squashed'
by nickm＠torproject.org 06 Apr '18

06 Apr '18

1 0

[tor/master] Remove needless event2/thread.h include from test_compat_libevent.c
by nickm＠torproject.org 06 Apr '18

06 Apr '18

commit 245fdf8ca05261dba0d944f6a02c3b4750aca1a2 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 3 13:01:31 2017 -0400 Remove needless event2/thread.h include from test_compat_libevent.c --- src/test/test_compat_libevent.c | 1 - 1 file changed, 1 deletion(-) diff --git a/src/test/test_compat_libevent.c b/src/test/test_compat_libevent.c index 7dd8e6519..376524c2d 100644 --- a/src/test/test_compat_libevent.c +++ b/src/test/test_compat_libevent.c @@ -10,7 +10,6 @@ #include "compat_libevent.h" #include <event2/event.h> -#include <event2/thread.h> #include "log_test_helpers.h"

1 0

[metrics-web/master] Document Onionoo's new protocol version 5.2.
by karsten＠torproject.org 06 Apr '18

06 Apr '18

commit c2e0babcf84bbf0a84bbb890d2e39a39da4582d2 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Fri Apr 6 11:02:02 2018 +0200 Document Onionoo's new protocol version 5.2. --- src/main/resources/web/jsps/onionoo.jsp | 49 +++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/src/main/resources/web/jsps/onionoo.jsp b/src/main/resources/web/jsps/onionoo.jsp index 28b16c6..540ca23 100644 --- a/src/main/resources/web/jsps/onionoo.jsp +++ b/src/main/resources/web/jsps/onionoo.jsp @@ -300,6 +300,9 @@ Always added a relay's own fingerprint to its "effective_family" and made nickname fields "n" in summary documents and "nickname" in details documents required fields on March 14, 2018. <a href="#versions_5_1" class="anchor">#</a></li> +<li><a id="versions_5_2"></a>5.2 +Added "version_status" field to details documents on April 6, 2018. +<a href="#versions_5_2" class="anchor">#</a></li> <li><a id="versions_6_0"></a>6.0 (scheduled, but not deployed yet!): Include all exit addresses in "exit_addresses", regardless of whether they're used as OR addresses or not, to @@ -1490,6 +1493,29 @@ the relay did not report which version it runs. </li> <li> +<a id="details_relay_version_status"></a> +version_status new +<code class="typeof">string</code> +optional +<a href="#details_relay_version_status" class="anchor">#</a> + +Status of the Tor software version of this relay based on the versions +recommended by the directory authorities. +Possible version statuses are: +"recommended" if a version is listed as recommended; +"experimental" if a version is newer than every recommended version; +"obsolete" if a version is older than every recommended version; +"new in series" if a version has other recommended versions with the same first +three components, and the version is newer than all such recommended versions, +but it is not newer than every recommended version; +"unrecommended" if none of the above conditions hold. +Omitted if either the directory authorities did not recommend versions, or the +relay did not report which version it runs. +Added on April 6, 2018. + +</li> + +<li> <a id="details_relay_effective_family"></a> effective_family updated <code class="typeof">array of strings</code> @@ -1829,6 +1855,29 @@ the bridge did not report which version it runs. </li> <li> +<a id="details_bridge_version_status"></a> +version_status new +<code class="typeof">string</code> +optional +<a href="#details_bridge_version_status" class="anchor">#</a> + +Status of the Tor software version of this bridge based on the versions +recommended by the directory authorities. +Possible version statuses are: +"recommended" if a version is listed as recommended; +"experimental" if a version is newer than every recommended version; +"obsolete" if a version is older than every recommended version; +"new in series" if a version has other recommended versions with the same first +three components, and the version is newer than all such recommended versions, +but it is not newer than every recommended version; +"unrecommended" if none of the above conditions hold. +Omitted if either the directory authorities did not recommend versions, or the +bridge did not report which version it runs. +Added on April 6, 2018. + +</li> + +<li> <a id="details_bridge_transports"></a> transports <code class="typeof">array of strings</code>

1 0

[onionoo/master] Bump version to 5.2-1.12.0-dev.
by karsten＠torproject.org 06 Apr '18

06 Apr '18

commit 1d874ba10dbc8ba82795e370941bed8eef71746d Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Fri Apr 6 11:53:34 2018 +0200 Bump version to 5.2-1.12.0-dev. --- build.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.xml b/build.xml index 15e85ac..f6b7e2f 100644 --- a/build.xml +++ b/build.xml @@ -10,7 +10,7 @@ <property name="implementation-title" value="Onionoo" /> <property name="onionoo.protocol.version" value="5.2"/> <property name="release.version" - value="${onionoo.protocol.version}-1.12.0"/> + value="${onionoo.protocol.version}-1.12.0-dev"/> <property name="metricslibversion" value="2.2.0"/> <property name="jetty.version" value="-9.2.21.v20170120" /> <property name="warfile"

1 0

[onionoo/release] Add version_status field to details documents.
by karsten＠torproject.org 06 Apr '18

06 Apr '18

commit 76dec0651148e99d069ab798693b22a33162b6b8 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Thu Feb 22 20:59:31 2018 +0100 Add version_status field to details documents. Implements #24256. --- CHANGELOG.md | 3 + .../torproject/onionoo/docs/DetailsDocument.java | 10 ++ .../org/torproject/onionoo/docs/DetailsStatus.java | 10 ++ .../org/torproject/onionoo/docs/NodeStatus.java | 17 +++ .../torproject/onionoo/server/ResponseBuilder.java | 2 + .../onionoo/updater/NodeDetailsStatusUpdater.java | 23 +++- .../org/torproject/onionoo/updater/TorVersion.java | 150 +++++++++++++++++++++ .../onionoo/updater/TorVersionStatus.java | 47 +++++++ .../onionoo/writer/DetailsDocumentWriter.java | 1 + .../torproject/onionoo/updater/TorVersionTest.java | 127 +++++++++++++++++ 10 files changed, 384 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a3c468..36d6471 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Changes in version 5.1-1.12.0 - 2018-??-?? + * Medium changes + - Add version_status field to details documents. + * Minor changes - Don't attempt to un-escape character sequences in contact lines (like "\uk") that only happen to start like escaped utf-8 characters diff --git a/src/main/java/org/torproject/onionoo/docs/DetailsDocument.java b/src/main/java/org/torproject/onionoo/docs/DetailsDocument.java index c749fba..e112efe 100644 --- a/src/main/java/org/torproject/onionoo/docs/DetailsDocument.java +++ b/src/main/java/org/torproject/onionoo/docs/DetailsDocument.java @@ -356,6 +356,16 @@ public class DetailsDocument extends Document { return this.version; } + private String version_status; + + public void setVersionStatus(String versionStatus) { + this.version_status = versionStatus; + } + + public String getVersionStatus() { + return this.version_status; + } + private SortedSet<String> alleged_family; public void setAllegedFamily(SortedSet<String> allegedFamily) { diff --git a/src/main/java/org/torproject/onionoo/docs/DetailsStatus.java b/src/main/java/org/torproject/onionoo/docs/DetailsStatus.java index c3cdc28..f838ec0 100644 --- a/src/main/java/org/torproject/onionoo/docs/DetailsStatus.java +++ b/src/main/java/org/torproject/onionoo/docs/DetailsStatus.java @@ -550,5 +550,15 @@ public class DetailsStatus extends Document { public String getVersion() { return this.version; } + + private String version_status; + + public void setVersionStatus(String versionStatus) { + this.version_status = versionStatus; + } + + public String getVersionStatus() { + return this.version_status; + } } diff --git a/src/main/java/org/torproject/onionoo/docs/NodeStatus.java b/src/main/java/org/torproject/onionoo/docs/NodeStatus.java index 94da8c8..1ea8b98 100644 --- a/src/main/java/org/torproject/onionoo/docs/NodeStatus.java +++ b/src/main/java/org/torproject/onionoo/docs/NodeStatus.java @@ -3,6 +3,8 @@ package org.torproject.onionoo.docs; +import org.torproject.onionoo.updater.TorVersionStatus; + import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -330,6 +332,16 @@ public class NodeStatus extends Document { return this.version; } + private TorVersionStatus versionStatus; + + public void setVersionStatus(TorVersionStatus versionStatus) { + this.versionStatus = versionStatus; + } + + public TorVersionStatus getVersionStatus() { + return this.versionStatus; + } + /* From exit lists: */ private SortedSet<String> exitAddresses; @@ -572,6 +584,9 @@ public class NodeStatus extends Document { if (parts.length >= 25 && !parts[24].isEmpty()) { nodeStatus.setHostName(parts[24]); } + if (parts.length >= 26) { + nodeStatus.setVersionStatus(TorVersionStatus.ofAbbreviation(parts[25])); + } return nodeStatus; } catch (NumberFormatException e) { log.error("Number format exception while parsing node " @@ -640,6 +655,8 @@ public class NodeStatus extends Document { .append((this.getVersion() != null ? this.getVersion() : "")); sb.append("\t") .append((this.getHostName() != null ? this.getHostName() : "")); + sb.append("\t").append(null != this.getVersionStatus() + ? this.getVersionStatus().getAbbreviation() : ""); return sb.toString(); } } diff --git a/src/main/java/org/torproject/onionoo/server/ResponseBuilder.java b/src/main/java/org/torproject/onionoo/server/ResponseBuilder.java index e2bdf82..fcf3c8f 100644 --- a/src/main/java/org/torproject/onionoo/server/ResponseBuilder.java +++ b/src/main/java/org/torproject/onionoo/server/ResponseBuilder.java @@ -339,6 +339,8 @@ public class ResponseBuilder { detailsDocument.getUnreachableOrAddresses()); } else if (field.equals("version")) { dd.setVersion(detailsDocument.getVersion()); + } else if (field.equals("version_status")) { + dd.setVersionStatus(detailsDocument.getVersionStatus()); } } /* Don't escape HTML characters, like < and >, contained in diff --git a/src/main/java/org/torproject/onionoo/updater/NodeDetailsStatusUpdater.java b/src/main/java/org/torproject/onionoo/updater/NodeDetailsStatusUpdater.java index 4fdf98b..b8bd4f6 100644 --- a/src/main/java/org/torproject/onionoo/updater/NodeDetailsStatusUpdater.java +++ b/src/main/java/org/torproject/onionoo/updater/NodeDetailsStatusUpdater.java @@ -22,10 +22,8 @@ import org.slf4j.LoggerFactory; import java.util.Arrays; import java.util.HashMap; -import java.util.HashSet; import java.util.List; import java.util.Map; -import java.util.Set; import java.util.SortedMap; import java.util.SortedSet; import java.util.TreeMap; @@ -89,7 +87,7 @@ public class NodeDetailsStatusUpdater implements DescriptorListener, private SortedMap<String, Integer> lastBandwidthWeights = null; - private Set<String> lastRecommendedServerVersions = null; + private SortedSet<TorVersion> lastRecommendedServerVersions = null; private int relayConsensusesProcessed = 0; @@ -306,8 +304,15 @@ public class NodeDetailsStatusUpdater implements DescriptorListener, this.relayConsensusesProcessed++; if (this.relaysLastValidAfterMillis == validAfterMillis) { this.lastBandwidthWeights = consensus.getBandwidthWeights(); - this.lastRecommendedServerVersions - = new HashSet<>(consensus.getRecommendedServerVersions()); + this.lastRecommendedServerVersions = new TreeSet<>(); + for (String recommendedServerVersion : + consensus.getRecommendedServerVersions()) { + TorVersion recommendedTorServerVersion + = TorVersion.of(recommendedServerVersion); + if (null != recommendedTorServerVersion) { + this.lastRecommendedServerVersions.add(recommendedTorServerVersion); + } + } } } @@ -798,8 +803,13 @@ public class NodeDetailsStatusUpdater implements DescriptorListener, * the recommended_version field accordingly. */ if (null != this.lastRecommendedServerVersions && null != nodeStatus.getVersion()) { + TorVersion torVersion = TorVersion.of(nodeStatus.getVersion()); nodeStatus.setRecommendedVersion(this.lastRecommendedServerVersions - .contains(nodeStatus.getVersion())); + .contains(torVersion)); + nodeStatus.setVersionStatus(null != torVersion + ? torVersion.determineVersionStatus( + this.lastRecommendedServerVersions) + : TorVersionStatus.UNRECOMMENDED); } Map<String, Long> exitAddresses = new HashMap<>(); @@ -909,6 +919,7 @@ public class NodeDetailsStatusUpdater implements DescriptorListener, detailsStatus.setLastChangedOrAddressOrPort( nodeStatus.getLastChangedOrAddressOrPort()); detailsStatus.setVersion(nodeStatus.getVersion()); + detailsStatus.setVersionStatus(nodeStatus.getVersionStatus().toString()); this.documentStore.store(detailsStatus, fingerprint); this.documentStore.store(nodeStatus, fingerprint); diff --git a/src/main/java/org/torproject/onionoo/updater/TorVersion.java b/src/main/java/org/torproject/onionoo/updater/TorVersion.java new file mode 100644 index 0000000..d8e1683 --- /dev/null +++ b/src/main/java/org/torproject/onionoo/updater/TorVersion.java @@ -0,0 +1,150 @@ +/* Copyright 2018 The Tor Project + * See LICENSE for licensing information */ + +package org.torproject.onionoo.updater; + +import java.util.HashMap; +import java.util.Map; +import java.util.SortedSet; + +/** + * Helper class to compare Tor versions. + * + * Based on "How Tor Version Numbers Work", available at + * https://gitweb.torproject.org/torspec.git/tree/version-spec.txt + */ +public class TorVersion implements Comparable<TorVersion> { + + private int majorVersion; + + private int minorVersion; + + private int microVersion; + + private String releaseSeries; + + private Integer patchLevel = null; + + private String statusTag = null; + + private static Map<String, TorVersion> knownVersions = new HashMap<>(); + + private TorVersion() { + } + + /** Return a TorVersion instance from the given tor version string that can be + * compared to other tor version strings, or null if the given string is not a + * valid tor version. */ + public static TorVersion of(String versionString) { + if (null == versionString) { + return null; + } + if (!knownVersions.containsKey(versionString)) { + TorVersion result = new TorVersion(); + String[] components = versionString.split("-")[0].split("\\."); + try { + result.majorVersion = Integer.parseInt(components[0]); + result.minorVersion = Integer.parseInt(components[1]); + result.microVersion = Integer.parseInt(components[2]); + result.releaseSeries = String.format("%d.%d.%d", + result.majorVersion, result.minorVersion, result.microVersion); + if (components.length == 4) { + result.patchLevel = Integer.parseInt(components[3]); + if (versionString.contains("-")) { + result.statusTag = versionString.split("-", 2)[1].split(" ")[0]; + } + } + } catch (ArrayIndexOutOfBoundsException + | NumberFormatException exception) { + result = null; + } + knownVersions.put(versionString, result); + } + return knownVersions.get(versionString); + } + + @Override + public int compareTo(TorVersion other) { + if (null == other) { + throw new NullPointerException(); + } + int result; + if ((result = Integer.compare(this.majorVersion, + other.majorVersion)) != 0) { + return result; + } + if ((result = Integer.compare(this.minorVersion, + other.minorVersion)) != 0) { + return result; + } + if ((result = Integer.compare(this.microVersion, + other.microVersion)) != 0) { + return result; + } + if (null == this.patchLevel && null == other.patchLevel) { + return 0; + } else if (null == patchLevel) { + return -1; + } else if (null == other.patchLevel) { + return 1; + } else if ((result = Integer.compare(this.patchLevel, + other.patchLevel)) != 0) { + return result; + } + if (null == this.statusTag && null == other.statusTag) { + return 0; + } else if (null == this.statusTag) { + return -1; + } else if (null == other.statusTag) { + return 1; + } else { + return this.statusTag.compareTo(other.statusTag); + } + } + + @Override + public boolean equals(Object other) { + return null != other && other instanceof TorVersion + && this.compareTo((TorVersion) other) == 0; + } + + @Override + public int hashCode() { + return 2 * Integer.hashCode(this.majorVersion) + + 3 * Integer.hashCode(this.minorVersion) + + 5 * Integer.hashCode(this.microVersion) + + 7 * (null == this.patchLevel ? 0 : this.patchLevel) + + 11 * (null == this.statusTag ? 0 : this.statusTag.hashCode()); + } + + /** Determine the version status of this tor version in the context of the + * given recommended tor versions. */ + public TorVersionStatus determineVersionStatus( + SortedSet<TorVersion> recommendedVersions) { + if (recommendedVersions.contains(this)) { + return TorVersionStatus.RECOMMENDED; + } else if (this.compareTo(recommendedVersions.last()) > 0) { + return TorVersionStatus.EXPERIMENTAL; + } else if (this.compareTo(recommendedVersions.first()) < 0) { + return TorVersionStatus.OBSOLETE; + } else { + boolean seriesHasRecommendedVersions = false; + boolean notNewInSeries = false; + for (TorVersion recommendedVersion : recommendedVersions) { + if (this.releaseSeries.equals( + recommendedVersion.releaseSeries)) { + seriesHasRecommendedVersions = true; + if (this.compareTo(recommendedVersion) < 0) { + notNewInSeries = true; + } + } + } + if (seriesHasRecommendedVersions && !notNewInSeries) { + return TorVersionStatus.NEW_IN_SERIES; + } else { + return TorVersionStatus.UNRECOMMENDED; + } + } + } +} + diff --git a/src/main/java/org/torproject/onionoo/updater/TorVersionStatus.java b/src/main/java/org/torproject/onionoo/updater/TorVersionStatus.java new file mode 100644 index 0000000..5825064 --- /dev/null +++ b/src/main/java/org/torproject/onionoo/updater/TorVersionStatus.java @@ -0,0 +1,47 @@ +/* Copyright 2018 The Tor Project + * See LICENSE for licensing information */ + +package org.torproject.onionoo.updater; + +import java.util.HashMap; +import java.util.Map; + +public enum TorVersionStatus { + + RECOMMENDED("recommended", "r"), + EXPERIMENTAL("experimental", "e"), + OBSOLETE("obsolete", "o"), + NEW_IN_SERIES("new in series", "n"), + UNRECOMMENDED("unrecommended", "u"); + + private final String statusString; + + private final String abbreviation; + + TorVersionStatus(String statusString, String abbreviation) { + this.statusString = statusString; + this.abbreviation = abbreviation; + } + + public String getAbbreviation() { + return this.abbreviation; + } + + private static Map<String, TorVersionStatus> byAbbreviation = new HashMap<>(); + + static { + for (TorVersionStatus status : TorVersionStatus.values()) { + byAbbreviation.put(status.abbreviation, status); + } + } + + public static TorVersionStatus ofAbbreviation(String abbrevation) { + return byAbbreviation.get(abbrevation); + } + + @Override + public String toString() { + return this.statusString; + } +} + diff --git a/src/main/java/org/torproject/onionoo/writer/DetailsDocumentWriter.java b/src/main/java/org/torproject/onionoo/writer/DetailsDocumentWriter.java index 8490f05..eca7874 100644 --- a/src/main/java/org/torproject/onionoo/writer/DetailsDocumentWriter.java +++ b/src/main/java/org/torproject/onionoo/writer/DetailsDocumentWriter.java @@ -162,6 +162,7 @@ public class DetailsDocumentWriter implements DocumentWriter { detailsDocument.setUnreachableOrAddresses(unreachableOrAddresses); } detailsDocument.setVersion(detailsStatus.getVersion()); + detailsDocument.setVersionStatus(detailsStatus.getVersionStatus()); this.documentStore.store(detailsDocument, fingerprint); } diff --git a/src/test/java/org/torproject/onionoo/updater/TorVersionTest.java b/src/test/java/org/torproject/onionoo/updater/TorVersionTest.java new file mode 100644 index 0000000..b6a9764 --- /dev/null +++ b/src/test/java/org/torproject/onionoo/updater/TorVersionTest.java @@ -0,0 +1,127 @@ +/* Copyright 2018 The Tor Project + * See LICENSE for licensing information */ + +package org.torproject.onionoo.updater; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; +import org.junit.experimental.runners.Enclosed; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameter; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Arrays; +import java.util.Collection; +import java.util.SortedSet; +import java.util.TreeSet; + +(a)RunWith(Enclosed.class) +public class TorVersionTest { + + @RunWith(Parameterized.class) + public static class TorVersionStatusTest { + + private static String[] recommendedVersionStrings = new String[] { + "0.2.5.16", "0.2.5.17", "0.2.9.14", "0.2.9.15", "0.3.1.9", "0.3.1.10", + "0.3.2.8-rc", "0.3.2.9", "0.3.3.1-alpha", "0.3.3.2-alpha" }; + + /** Provide test data. */ + @Parameters + public static Collection<Object[]> data() { + return Arrays.asList(new Object[][] { + { "Recommended version", "0.2.5.16", "recommended" }, + { "Recommended version", "0.3.2.8-rc", "recommended" }, + { "Recommended version", "0.3.3.2-alpha", "recommended" }, + { "Experimental version", "0.3.3.2-alpha-dev", "experimental" }, + { "Experimental version", "0.3.3.3-alpha", "experimental" }, + { "Experimental version", "0.3.4.0-alpha-dev", "experimental" }, + { "Obsolete version", "0.2.5.15", "obsolete" }, + { "Obsolete version", "0.1.0.1-rc", "obsolete" }, + { "New-in-series version", "0.2.5.18", "new in series" }, + { "New-in-series version", "0.3.2.9-dev", "new in series" }, + { "New-in-series version", "0.3.2.10", "new in series" }, + { "Unrecommended version", "0.2.9.13", "unrecommended" }, + { "Unrecommended version", "0.3.1.8-dev", "unrecommended" }, + { "Unrecommended version", "0.3.3.0-alpha-dev", "unrecommended" }, + { "Unrecognized (experimental) version", "1.0-final", + "unrecommended" }, + { "Unrecognized (obsolete) version", "0.0.2pre13", "unrecommended" } + }); + } + + @Parameter + public String testDescription; + + @Parameter(1) + public String versionString; + + @Parameter(2) + public String expectedVersionStatus; + + @Test + public void test() { + SortedSet<TorVersion> recommendedTorVersions = new TreeSet<>(); + for (String recommendedVersionString : recommendedVersionStrings) { + recommendedTorVersions.add(TorVersion.of(recommendedVersionString)); + } + TorVersion torVersion = TorVersion.of(this.versionString); + String determinedVersionStatus = "unrecommended"; + if (null != torVersion) { + determinedVersionStatus = torVersion + .determineVersionStatus(recommendedTorVersions).toString(); + } + assertEquals(this.testDescription, this.expectedVersionStatus, + determinedVersionStatus); + } + } + + @RunWith(Parameterized.class) + public static class TorVersionEqualsHashCodeCompareToTest { + + /** Provide test data. */ + @Parameters + public static Collection<Object[]> data() { + return Arrays.asList(new Object[][] { + { "0.2.5.16", "0.2.5.16", true, true, 0 }, + { "0.2.5.16", "0.2.5.17", false, false, -1 }, + { "0.3.3.1-alpha", "0.3.3.1-alpha", true, true, 0 }, + { "0.1.2.3", "00.01.02.03", true, true, 0 }, + { "0.1.2.3-alpha", "00.01.02.03-aallpphhaa", false, false, 1 } + }); + } + + @Parameter + public String firstVersionString; + + @Parameter(1) + public String secondVersionString; + + @Parameter(2) + public boolean expectedEqualsResult; + + @Parameter(3) + public boolean expectedSameHashCodes; + + @Parameter(4) + public int expectedCompareToResult; + + @Test + public void test() { + TorVersion firstVersion = TorVersion.of(this.firstVersionString); + TorVersion secondVersion = TorVersion.of(this.secondVersionString); + assertEquals(this.expectedEqualsResult, + firstVersion.equals(secondVersion)); + if (this.expectedSameHashCodes) { + assertEquals(firstVersion.hashCode(), secondVersion.hashCode()); + } + int actualCompareToResult = firstVersion.compareTo(secondVersion); + assertTrue(this.expectedCompareToResult < 0 && actualCompareToResult < 0 + || this.expectedCompareToResult == 0 && actualCompareToResult == 0 + || this.expectedCompareToResult > 0 && actualCompareToResult > 0); + } + } +} +

1 0