Running Java applications with jgo

This example shows how to run an arbitrary package available from a Maven repository using jgo.

import cjdk
import jgo
import os
from contextlib import contextmanager

jgo requires Apache Maven, so we’ll install that first:

# From https://maven.apache.org/download.html
maven_url = "tgz+https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.tar.gz"
maven_sha512 = "706f01b20dec0305a822ab614d51f32b07ee11d0218175e55450242e49d2156386483b506b3a4e8a03ac8611bae96395fd5eec15f50d3013d5deed6d1ee18224"

maven_dir = cjdk.cache_package("Maven", maven_url, sha512=maven_sha512)

cjdk: Installing Maven to /home/runner/.cache/cjdk

The Maven .tar.gz file has been extracted into maven_dir; find the bin directory within it:

maven_bin = list(maven_dir.glob("apache-maven-*"))[0] / "bin"
assert (maven_bin / "mvn").is_file()

Let’s write a context manager that we can use to temporarily put the Maven bin directory on PATH.

@contextmanager
def path_prepended(path):
    """
    Context manager to temporarily prepend the given path to PATH.
    """
    save_path = os.environ.get("PATH", "")
    new_path = str(path) + os.pathsep + save_path
    os.environ["PATH"] = new_path
    try:
        yield
    finally:
        os.environ["PATH"] = save_path

Now for the magic: run a program by specifying its Maven coordinates.

The JRE and all required Jars are downloaded (and cached) automatically.

with cjdk.java_env(vendor="zulu-jre", version="8"):
    with path_prepended(maven_bin):
        jgo.main_from_endpoint(
            "com.puppycrawl.tools:checkstyle:9.3",
            primary_endpoint_main_class="com.puppycrawl.tools.checkstyle.Main",
            argv=["--version"],
        )

cjdk: Installing JDK zulu-jre:8.0.422 to /home/runner/.cache/cjdk

INFO 2024-08-09 22:05:04,310: First time start-up may be slow. Downloaded dependencies will be cached for shorter start-up times in subsequent executions.

Checkstyle version: 9.3