[tor-bugs] #20596 [Metrics]: streamline build.xml and metrics_checkstyle.xml throughout all java projects

[Tor Bug Tracker & Wiki]

#20596: streamline build.xml and metrics_checkstyle.xml throughout all java
projects
-------------------------+--------------------------
 Reporter:  iwakeh       |          Owner:  iwakeh
     Type:  enhancement  |         Status:  assigned
 Priority:  Medium       |      Milestone:
Component:  Metrics      |        Version:
 Severity:  Normal       |     Resolution:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
 Reviewer:               |        Sponsor:
-------------------------+--------------------------

Comment (by karsten):

 Replying to [comment:19 iwakeh]:
 > Replying to [comment:17 karsten]:
 > > Replying to [comment:16 iwakeh]:
 > > > I'd propose having another git repository `metrics-base` or
 `metrics-java-base` for providing the standard build elements, which
 currently would be a base-build.xml and metrics' checkstyle rules.
 > > > This can be referenced as a sub-module and thus avoid code
 duplication.
 > >
 > > Plausible!
 >
 > Which name?
 > `metrics-base` or `metrics-java-base` or something else?

 Hmm, how about `metrics-base` and we add any shared resources regardless
 of language?  In the beginning there'd be only Java files, but would it
 hurt if we'd add files that are only relevant for other languages?

 > > > Thoughts?
 > >
 > > First thought is that we should try to avoid confusing new
 contributors.  Basically, we're adding yet another hurdle for them to get
 up to speed.  Though I admit that this hurdle is worth considering to
 avoid duplicating code.
 > >
 > > What we'd have to do is fail with a useful error message in case this
 submodule has not yet been initialized.  That message should contain the
 exact command that is necessary to initialize the missing submodule.
 Wording is important here, I think.
 >
 > Yes, the error message should be clear.
 > Actually the submodule update could be perfomed by `ant`.

 Sounds good!

 > > Another thought is that we should make sure that this won't break any
 future Jenkins tasks.
 >
 > The submodule setup only needs `ant` and `git`, which are available in a
 Jenkins build.

 Including the network access to fetch the dependent repository from Tor's
 Git server?  If so, great!

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