[tor-bugs] #19755 [Metrics/CollecTor]: improve code quality of bridgedescs module

Tor Bug Tracker & Wiki blackhole at torproject.org
Wed Jul 27 09:42:31 UTC 2016


#19755: improve code quality of bridgedescs module
-------------------------------+---------------------------------
 Reporter:  iwakeh             |          Owner:  iwakeh
     Type:  enhancement        |         Status:  needs_review
 Priority:  Medium             |      Milestone:  CollecTor 1.1.0
Component:  Metrics/CollecTor  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:                     |  Actual Points:
Parent ID:                     |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+---------------------------------

Old description:

> The code quality of bridgedescs module should be improved using the
> reports generated by Findbugs and PMD.
>
> Intended results:
> * add ant tasks for both
> * define the set of rules that will be used for all java projects
> * improve code quality of the bridgedescs module based on the reports

New description:

 The code quality of bridgedescs module should be improved using the
 reports generated by Findbugs and PMD.

 Intended results:
 * increase test coverage of `org.torproject.collector.bridgedescs` to
 something reasonably close to 100%
 * add ant tasks for both
 * define the set of rules that will be used for all java projects
 * improve code quality of the bridgedescs module based on the reports

--

Comment (by iwakeh):

 Very good point!
 I changed the ticket description to include the new tests as additional
 result.

 I ran the `coverage` task, it's already up to 70% line and 56% branch
 coverage in the bridgedescs module.

 I'll take a closer look at the code next.

 Just from skimming through: could you create separate helper classes for
 the descriptor builders?
 And, it should be avoided that a `recent` folder is left after the test.
 One way to prevent that is to change the Configuration as in
 MainTest.changeFilePathsAndSetActivation.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/19755#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list