6eb2aab0-9781-40f0-8cc1-9e7c437858cb

Committed 22 Apr 2025 04:28PM UTC coverage: 86.272% (+0.007%) from 86.265%

Build # 6eb2aab0-9781-40f0-8cc1-9e7c437858cb

Build Type

push

circleci

Committed by

web-flow

Commit Message

APIGW: validate REST API custom id tag (#12539)

Coverage Stats

7 of 7 new or added lines in 1 file covered. (100.0%)

82 existing lines in 10 files now uncovered.

63897 of 74065 relevant lines covered (86.27%)

0.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.22

/localstack-core/localstack/packages/java.py

import logging
import os
from typing import List

import requests

from localstack.constants import USER_AGENT_STRING
from localstack.packages import InstallTarget, Package
from localstack.packages.core import ArchiveDownloadAndExtractInstaller
from localstack.utils.files import rm_rf
from localstack.utils.platform import Arch, get_arch, is_linux, is_mac_os
from localstack.utils.run import run

LOG = logging.getLogger(__name__)

# Default version if not specified
DEFAULT_JAVA_VERSION = "11"

# Supported Java LTS versions mapped with Eclipse Temurin build semvers
JAVA_VERSIONS = {
    "8": "8u432-b06",
    "11": "11.0.25+9",
    "17": "17.0.13+11",
    "21": "21.0.5+11",
}


class JavaInstallerMixin:
    """
    Mixin class for packages that depend on Java. It introduces methods that install Java and help build environment.
    """

    def _prepare_installation(self, target: InstallTarget) -> None:
        java_package.install(target=target)

    def get_java_home(self) -> str | None:
        """
        Returns path to JRE installation.
        """
        return java_package.get_installer().get_java_home()

    def get_java_lib_path(self) -> str | None:
        """
        Returns the path to the Java shared library.
        """
        if java_home := self.get_java_home():
            if is_mac_os():
                return os.path.join(java_home, "lib", "jli", "libjli.dylib")
            return os.path.join(java_home, "lib", "server", "libjvm.so")
        return None

    def get_java_env_vars(
        self, path: str | None = None, ld_library_path: str | None = None
    ) -> dict[str, str]:
        """
        Returns environment variables pointing to the Java installation. This is useful to build the environment where
        the application will run.

        :param path: If not specified, the value of PATH will be obtained from the environment
        :param ld_library_path: If not specified, the value of LD_LIBRARY_PATH will be obtained from the environment
        :return: dict consisting of two items:
            - JAVA_HOME: path to JRE installation
            - PATH: the env path variable updated with JRE bin path
        """
        java_home = self.get_java_home()
        java_bin = f"{java_home}/bin"

        path = path or os.environ["PATH"]

        library_path = ld_library_path or os.environ.get("LD_LIBRARY_PATH")
        # null paths (e.g. `:/foo`) have a special meaning according to the manpages
        if library_path is None:
            full_library_path = f"{java_home}/lib:{java_home}/lib/server"
        else:
            full_library_path = f"{java_home}/lib:{java_home}/lib/server:{library_path}"

        return {
            "JAVA_HOME": java_home,  # type: ignore[dict-item]
            "LD_LIBRARY_PATH": full_library_path,
            "PATH": f"{java_bin}:{path}",
        }


class JavaPackageInstaller(ArchiveDownloadAndExtractInstaller):
    def __init__(self, version: str):
        super().__init__("java", version, extract_single_directory=True)

    def _get_install_marker_path(self, install_dir: str) -> str:
        if is_mac_os():
            return os.path.join(install_dir, "Contents", "Home", "bin", "java")
        return os.path.join(install_dir, "bin", "java")

    def _get_download_url(self) -> str:
        # Note: Eclipse Temurin does not provide Mac aarch64 Java 8 builds.
        # See https://adoptium.net/en-GB/supported-platforms/
        try:
            LOG.debug("Determining the latest Java build version")
            return self._download_url_latest_release()
        except Exception as exc:  # noqa
            LOG.debug(
                "Unable to determine the latest Java build version. Using pinned versions: %s", exc
            )
            return self._download_url_fallback()

    def _post_process(self, target: InstallTarget) -> None:
        target_directory = self._get_install_dir(target)
        minimal_jre_path = os.path.join(target.value, self.name, f"{self.version}.minimal")
        rm_rf(minimal_jre_path)

        # If jlink is not available, use the environment as is
        if not os.path.exists(os.path.join(target_directory, "bin", "jlink")):
            LOG.warning("Skipping JRE optimisation because jlink is not available")
            return

        # Build a custom JRE with only the necessary bits to minimise disk footprint
        LOG.debug("Optimising JRE installation")
        cmd = (
            "bin/jlink --add-modules "
            # Required modules
            "java.base,java.desktop,java.instrument,java.management,"
            "java.naming,java.scripting,java.sql,java.xml,jdk.compiler,"
            # jdk.unsupported contains sun.misc.Unsafe which is required by some dependencies
            "jdk.unsupported,"
            # Additional cipher suites
            "jdk.crypto.cryptoki,"
            # Archive support
            "jdk.zipfs,"
            # Required by MQ broker
            "jdk.httpserver,jdk.management,jdk.management.agent,"
            # Required by Spark and Hadoop
            "java.security.jgss,jdk.security.auth,"
            # Include required locales
            "jdk.localedata --include-locales en "
            # Supplementary args
            "--compress 2 --strip-debug --no-header-files --no-man-pages "
            # Output directory
            "--output " + minimal_jre_path
        )
        run(cmd, cwd=target_directory)

        rm_rf(target_directory)
        os.rename(minimal_jre_path, target_directory)

    def get_java_home(self) -> str | None:
        """
        Get JAVA_HOME for this installation of Java.
        """
        installed_dir = self.get_installed_dir()
        if is_mac_os():
            return os.path.join(installed_dir, "Contents", "Home")  # type: ignore[arg-type]
        return installed_dir

    @property
    def arch(self) -> str | None:
        return (
            "x64" if get_arch() == Arch.amd64 else "aarch64" if get_arch() == Arch.arm64 else None
        )

    @property
    def os_name(self) -> str | None:
        return "linux" if is_linux() else "mac" if is_mac_os() else None

    def _download_url_latest_release(self) -> str:
        """
        Return the download URL for latest stable JDK build.
        """
        endpoint = (
            f"https://api.adoptium.net/v3/assets/latest/{self.version}/hotspot?"
            f"os={self.os_name}&architecture={self.arch}&image_type=jdk"
        )
        # Override user-agent because Adoptium API denies service to `requests` library
        response = requests.get(endpoint, headers={"user-agent": USER_AGENT_STRING}).json()
        return response[0]["binary"]["package"]["link"]

    def _download_url_fallback(self) -> str:
        """
        Return the download URL for pinned JDK build.
        """
        semver = JAVA_VERSIONS[self.version]
        tag_slug = f"jdk-{semver}"
        semver_safe = semver.replace("+", "_")

        # v8 uses a different tag and version scheme
        if self.version == "8":
            semver_safe = semver_safe.replace("-", "")
            tag_slug = f"jdk{semver}"

        return (
            f"https://github.com/adoptium/temurin{self.version}-binaries/releases/download/{tag_slug}/"
            f"OpenJDK{self.version}U-jdk_{self.arch}_{self.os_name}_hotspot_{semver_safe}.tar.gz"
        )


class JavaPackage(Package[JavaPackageInstaller]):
    def __init__(self, default_version: str = DEFAULT_JAVA_VERSION):
        super().__init__(name="Java", default_version=default_version)

    def get_versions(self) -> List[str]:
        return list(JAVA_VERSIONS.keys())

    def _get_installer(self, version: str) -> JavaPackageInstaller:
        return JavaPackageInstaller(version)


java_package = JavaPackage()

1	import logging	1✔
2	import os	1✔
3	from typing import List	1✔
4
5	import requests	1✔
6
7	from localstack.constants import USER_AGENT_STRING	1✔
8	from localstack.packages import InstallTarget, Package	1✔
9	from localstack.packages.core import ArchiveDownloadAndExtractInstaller	1✔
10	from localstack.utils.files import rm_rf	1✔
11	from localstack.utils.platform import Arch, get_arch, is_linux, is_mac_os	1✔
12	from localstack.utils.run import run	1✔
13
14	LOG = logging.getLogger(__name__)	1✔
15
16	# Default version if not specified
17	DEFAULT_JAVA_VERSION = "11"	1✔
18
19	# Supported Java LTS versions mapped with Eclipse Temurin build semvers
20	JAVA_VERSIONS = {	1✔
21	"8": "8u432-b06",
22	"11": "11.0.25+9",
23	"17": "17.0.13+11",
24	"21": "21.0.5+11",
25	}
26
27
28	class JavaInstallerMixin:	1✔
29	"""
30	Mixin class for packages that depend on Java. It introduces methods that install Java and help build environment.
31	"""
32
33	def _prepare_installation(self, target: InstallTarget) -> None:	1✔
34	java_package.install(target=target)	×
35
36	def get_java_home(self) -> str \| None:	1✔
37	"""
38	Returns path to JRE installation.
39	"""
40	return java_package.get_installer().get_java_home()	1✔
41
42	def get_java_lib_path(self) -> str \| None:	1✔
43	"""
44	Returns the path to the Java shared library.
45	"""
46	if java_home := self.get_java_home():	1✔
47	if is_mac_os():	1✔
48	return os.path.join(java_home, "lib", "jli", "libjli.dylib")	×
49	return os.path.join(java_home, "lib", "server", "libjvm.so")	1✔
UNCOV 50	return None	×
51
52	def get_java_env_vars(	1✔
53	self, path: str \| None = None, ld_library_path: str \| None = None
54	) -> dict[str, str]:
55	"""
56	Returns environment variables pointing to the Java installation. This is useful to build the environment where
57	the application will run.
58
59	:param path: If not specified, the value of PATH will be obtained from the environment
60	:param ld_library_path: If not specified, the value of LD_LIBRARY_PATH will be obtained from the environment
61	:return: dict consisting of two items:
62	- JAVA_HOME: path to JRE installation
63	- PATH: the env path variable updated with JRE bin path
64	"""
65	java_home = self.get_java_home()	×
UNCOV 66	java_bin = f"{java_home}/bin"	×
67
UNCOV 68	path = path or os.environ["PATH"]	×
69
70	library_path = ld_library_path or os.environ.get("LD_LIBRARY_PATH")	×
71	# null paths (e.g. `:/foo`) have a special meaning according to the manpages
72	if library_path is None:	×
UNCOV 73	full_library_path = f"{java_home}/lib:{java_home}/lib/server"	×
74	else:
UNCOV 75	full_library_path = f"{java_home}/lib:{java_home}/lib/server:{library_path}"	×
76
UNCOV 77	return {	×
78	"JAVA_HOME": java_home, # type: ignore[dict-item]
79	"LD_LIBRARY_PATH": full_library_path,
80	"PATH": f"{java_bin}:{path}",
81	}
82
83
84	class JavaPackageInstaller(ArchiveDownloadAndExtractInstaller):	1✔
85	def __init__(self, version: str):	1✔
86	super().__init__("java", version, extract_single_directory=True)	1✔
87
88	def _get_install_marker_path(self, install_dir: str) -> str:	1✔
89	if is_mac_os():	1✔
UNCOV 90	return os.path.join(install_dir, "Contents", "Home", "bin", "java")	×
91	return os.path.join(install_dir, "bin", "java")	1✔
92
93	def _get_download_url(self) -> str:	1✔
94	# Note: Eclipse Temurin does not provide Mac aarch64 Java 8 builds.
95	# See https://adoptium.net/en-GB/supported-platforms/
96	try:	1✔
97	LOG.debug("Determining the latest Java build version")	1✔
98	return self._download_url_latest_release()	1✔
UNCOV 99	except Exception as exc: # noqa	×
100	LOG.debug(	×
101	"Unable to determine the latest Java build version. Using pinned versions: %s", exc
102	)
UNCOV 103	return self._download_url_fallback()	×
104
105	def _post_process(self, target: InstallTarget) -> None:	1✔
106	target_directory = self._get_install_dir(target)	1✔
107	minimal_jre_path = os.path.join(target.value, self.name, f"{self.version}.minimal")	1✔
108	rm_rf(minimal_jre_path)	1✔
109
110	# If jlink is not available, use the environment as is
111	if not os.path.exists(os.path.join(target_directory, "bin", "jlink")):	1✔
UNCOV 112	LOG.warning("Skipping JRE optimisation because jlink is not available")	×
UNCOV 113	return	×
114
115	# Build a custom JRE with only the necessary bits to minimise disk footprint
116	LOG.debug("Optimising JRE installation")	1✔
117	cmd = (	1✔
118	"bin/jlink --add-modules "
119	# Required modules
120	"java.base,java.desktop,java.instrument,java.management,"
121	"java.naming,java.scripting,java.sql,java.xml,jdk.compiler,"
122	# jdk.unsupported contains sun.misc.Unsafe which is required by some dependencies
123	"jdk.unsupported,"
124	# Additional cipher suites
125	"jdk.crypto.cryptoki,"
126	# Archive support
127	"jdk.zipfs,"
128	# Required by MQ broker
129	"jdk.httpserver,jdk.management,jdk.management.agent,"
130	# Required by Spark and Hadoop
131	"java.security.jgss,jdk.security.auth,"
132	# Include required locales
133	"jdk.localedata --include-locales en "
134	# Supplementary args
135	"--compress 2 --strip-debug --no-header-files --no-man-pages "
136	# Output directory
137	"--output " + minimal_jre_path
138	)
139	run(cmd, cwd=target_directory)	1✔
140
141	rm_rf(target_directory)	1✔
142	os.rename(minimal_jre_path, target_directory)	1✔
143
144	def get_java_home(self) -> str \| None:	1✔
145	"""
146	Get JAVA_HOME for this installation of Java.
147	"""
148	installed_dir = self.get_installed_dir()	1✔
149	if is_mac_os():	1✔
UNCOV 150	return os.path.join(installed_dir, "Contents", "Home") # type: ignore[arg-type]	×
151	return installed_dir	1✔
152
153	@property	1✔
154	def arch(self) -> str \| None:	1✔
155	return (	1✔
156	"x64" if get_arch() == Arch.amd64 else "aarch64" if get_arch() == Arch.arm64 else None
157	)
158
159	@property	1✔
160	def os_name(self) -> str \| None:	1✔
161	return "linux" if is_linux() else "mac" if is_mac_os() else None	1✔
162
163	def _download_url_latest_release(self) -> str:	1✔
164	"""
165	Return the download URL for latest stable JDK build.
166	"""
167	endpoint = (	1✔
168	f"https://api.adoptium.net/v3/assets/latest/{self.version}/hotspot?"
169	f"os={self.os_name}&architecture={self.arch}&image_type=jdk"
170	)
171	# Override user-agent because Adoptium API denies service to `requests` library
172	response = requests.get(endpoint, headers={"user-agent": USER_AGENT_STRING}).json()	1✔
173	return response[0]["binary"]["package"]["link"]	1✔
174
175	def _download_url_fallback(self) -> str:	1✔
176	"""
177	Return the download URL for pinned JDK build.
178	"""
UNCOV 179	semver = JAVA_VERSIONS[self.version]	×
UNCOV 180	tag_slug = f"jdk-{semver}"	×
181	semver_safe = semver.replace("+", "_")	×
182
183	# v8 uses a different tag and version scheme
UNCOV 184	if self.version == "8":	×
185	semver_safe = semver_safe.replace("-", "")	×
UNCOV 186	tag_slug = f"jdk{semver}"	×
187
UNCOV 188	return (	×
189	f"https://github.com/adoptium/temurin{self.version}-binaries/releases/download/{tag_slug}/"
190	f"OpenJDK{self.version}U-jdk_{self.arch}_{self.os_name}_hotspot_{semver_safe}.tar.gz"
191	)
192
193
194	class JavaPackage(Package[JavaPackageInstaller]):	1✔
195	def __init__(self, default_version: str = DEFAULT_JAVA_VERSION):	1✔
196	super().__init__(name="Java", default_version=default_version)	1✔
197
198	def get_versions(self) -> List[str]:	1✔
199	return list(JAVA_VERSIONS.keys())	1✔
200
201	def _get_installer(self, version: str) -> JavaPackageInstaller:	1✔
202	return JavaPackageInstaller(version)	1✔
203
204
205	java_package = JavaPackage()	1✔

localstack / localstack / 6eb2aab0-9781-40f0-8cc1-9e7c437858cb

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous