provide executable jar

metrics-db currently has (at least) six classes providing a main method, which are invoked using six corresponding ant tasks.

One solution for providing an executable jar:

Add a new class org.torproject.ernie.db.Main as the jar's main class adding the following functionality:

• calling java -jar metrics-db.jar will show a usage message and exit.
• calling java -jar metrics-db.jar <taskname> will run the main method of the class called in the current ant task of the same name, i.e., taskname is one of
  • bridgedescs
  • bridgepools
  • exitlists
  • relaydescs
  • torperf
  • updateindex

Finally, remove the then obsolete ant tasks from build.xml.

What is missing? Should a task be added or removed? Other thoughts?

changed milestone to %CollecTor 1.0.0

added component::metrics/collector ctip milestone::CollecTor 1.0.0 owner::iwakeh priority::medium resolution::implemented severity::normal status::closed type::enhancement labels

Trac:
Status: new to needs_information

Sounds like a fine plan. Two suggestions:

• I'd like to move over to a package hierarchy org.torproject.collector* and get rid of org.torproject.ernie* packages and classes. How about we use that new package structure for new classes like the new Main class you're thinking of? That could be org.torproject.collector.Main.

• Can you also update the scripts in bin/* and call the new Main method with appropriate task name and ideally parameters like -Xmx2048m as in the current build.xml?

Other than that, nothing comes to mind that would be missing.

Replying to karsten:

• I'd like to move over to a package hierarchy org.torproject.collector* and get rid of org.torproject.ernie* packages and classes. How about we use that new package structure for new classes like the new Main class you're thinking of? That could be org.torproject.collector.Main.

org.torproject.collector.Main is fine. (also see #18727 (moved))

• Can you also update the scripts in bin/* and call the new Main method with appropriate task name and ideally parameters like -Xmx2048m as in the current build.xml?

Sure. Good point.

depends on #18727 (moved) and on #18792 (moved) and now #18794 (moved)

Discuss the following question from #18792 (moved) comment 3, by karsten:

• Should the produced .jar file contain the required .jar files from lib/, except for example junit.jar? I don't remember the reasons for/against doing that in Onionoo and it might be that the answer is no for good reasons. And should we remove the compiled test classes? See Onionoo's build.xml where we're doing that.

Onionoo includes the classes from the required jars (cf. jar task) (It is not possible to add jars inside a jar to the classpath. That's why we used zipgroupfileset in Onionoo.)

For CollecTor the jar collector.jar will also include the necessary classes.

Trac:
Status: needs_information to assigned

Please find attached a patch implementing this task.

This could have also be achieved by using annotations, but as there will probably only one additional class with a main method, I decided to use a simpler approach. Only one added class (as outlined above) is necessary that way.

The shell scripts are changed accordingly and the jar ant task is extended to include all dependencies and the Main-Class property.

Main.java is free of checkstyle complaints.

Trac:
Status: assigned to needs_review

Looks good! Just one thing: Can you change <zipgroupfileset> to just include the libraries that are necessary for running CollecTor? Two reasons: the .jar file will be smaller and it won't contain classes from packages that are not in Debian stable. Other than that, ready to merge. Thanks!

Trac:
Status: needs_review to needs_revision

Trac:
0001-Provide-executable-jar-containing-all-dependencies-r.patch

implements this task

Oops, thanks for noticing the oversized runtime jar!

The patch is replaced and the resulting runtime jar is reduced by a factor of ten.

Trac:
Status: needs_revision to needs_review

Thanks for making that change. For some reason I'm unable to apply your patch using git am. Would you mind pushing your branch to your shiny new git.torproject.org repository?

Trac:
Status: needs_review to merge_ready

Here's the patch: https://gitweb.torproject.org/user/iwakeh/collector.git/patch/?id=2be9f6890af28bcb78d29fb00eb66b8cd8edf9c2

Finally :-)

Great, merged to master!

In the future, consider pushing your changes to a separate task branch, like task-18719 (or whatever naming scheme you prefer). The downsides of using your master branch is that it may derive from the official master and that you can only have one change under review.

Closing this ticket as implemented. Thanks!

Trac:
Status: merge_ready to closed
Resolution: N/A to implemented

Added to milestone for first release.

Trac:
Milestone: N/A to CollecTor 1.0.0

closed

mentioned in issue #18792 (moved)