[tor-bugs] #18964 [Metrics/CollecTor]: jenkins builds for and file structure in Metrics Team (java) projects

[Tor Bug Tracker & Wiki]

#18964: jenkins builds for and file structure in Metrics Team (java) projects
-------------------------------+------------------------
 Reporter:  iwakeh             |          Owner:  iwakeh
     Type:  enhancement        |         Status:  new
 Priority:  Medium             |      Milestone:
Component:  Metrics/CollecTor  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:                     |  Actual Points:
Parent ID:                     |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+------------------------

Comment (by karsten):

 Replying to [ticket:18964 iwakeh]:
 > I couldn't find a cross-concern Metrics Component for the following,
 That's why this is placed in CollecTor.

 True, there is no component for that.  But how about we start with
 CollecTor tickets for these issues, list things like "Jenkins integration"
 and "file structure" in the
 [https://trac.torproject.org/projects/tor/wiki/org/teams/MetricsTeam/Documentation#GuideDocuments
 guides], and later create tickets for other components when we change
 focus to them?

 > For implementation child-tickets should be opened with the appropriate
 component.
 > ----
 > Wouldn't it be nice to have a group of tasks in
 https://jenkins.torproject.org
 > for all the Metrics projects (no matter which language) or at least all
 the java ones?
 >
 > **1)** The Jenkins builds could just run in this clean environment
 whenever a check-in takes place.
 > Thus, not generating too much strain on the server(s) Jenkins uses. The
 builds are much smaller than the Tor ones anyway.
 > In addition, the last build's javadoc and reports as well as test
 results would be immediately available for viewing.

 That would be nice, but maybe on a lower priority than making sure that
 we're not missing descriptors, for example.  A ticket wouldn't hurt
 though.

 > **2)** Another cross-Metrics concern for java projects is the file
 structure.
 > It might be useful to unify the structure to the following (sort of
 similar to the typical maven layout):
 > "src" and "generated" as top level. "generated" should be used as in
 collector.
 > "src" should have the substructure "main" and "test" (as already started
 in Onionoo).
 > "main" contains "java", "resources", "web", ...
 > Same with "test" where appropriate.

 Sure.  How about we simply pick
 [https://maven.apache.org/guides/introduction/introduction-to-the-
 standard-directory-layout.html Maven's Standard Directory Layout] (without
 switching to Maven, of course)?  I don't mind much what directory
 structure we use, and using an existing layout would make documentation a
 bit easier.  Happy to discuss more on a separate ticket.

 Thanks!

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