-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: bake gapic-generator-java into the hermetic build docker image (#…
…3067) Makes the gapic-generator-java jar a prepared binary in the Docker image whose location is now assumed by the scripts. Developers need now to prepare this well-know location (specified in `library_generation/DEVELOPMENT.md`. --------- Co-authored-by: Blake Li <blakeli@google.com> Co-authored-by: Joe Wang <106995533+JoeWang1127@users.noreply.github.com>
- Loading branch information
3 people
committed
Sep 3, 2024
1 parent
67342ea
commit a372e82
Showing
16 changed files
with
336 additions
and
199 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,3 +24,5 @@ target/ | |
| **/*egg-info/ | ||
| **/build/ | ||
| **/dist/ | ||
| library_generation/**/*.jar | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
| wrapper_dir=$(dirname "$(realpath "${BASH_SOURCE[0]}")") | ||
| source "${wrapper_dir}/utils/utilities.sh" | ||
|
|
||
| # Wrap gapic-generator-java.jar because protoc requires the plugin to be executable. | ||
| exec java -classpath "gapic-generator-java-${gapic_generator_version}.jar" com.google.api.generator.Main | ||
| exec java -classpath "$(get_gapic_generator_location)" com.google.api.generator.Main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| import subprocess | ||
| import unittest | ||
| import os | ||
| from library_generation.utils.utilities import ( | ||
| run_process_and_print_output as bash_call, | ||
| run_process_and_get_output_string as get_bash_call_output, | ||
| ) | ||
|
|
||
| script_dir = os.path.dirname(os.path.realpath(__file__)) | ||
|
|
||
|
|
||
| class GenerateLibraryUnitTests(unittest.TestCase): | ||
| """ | ||
| Confirms the correct behavior of `library_generation/utils/utilities.sh`. | ||
| Note that there is an already existing, shell-based, test suite for | ||
| generate_library.sh, but these tests will soon be transferred to this one as | ||
| an effort to unify the implementation of the Hermetic Build scripts as | ||
| python-only. New tests for `utilities.sh` should be added in this file. | ||
| """ | ||
|
|
||
| TEST_ARCHITECTURE = "linux-x86_64" | ||
|
|
||
| def setUp(self): | ||
| # we create a simulated home folder that has a fake generator jar | ||
| # in its well-known location | ||
| self.simulated_home = get_bash_call_output("mktemp -d") | ||
| bash_call(f"mkdir {self.simulated_home}/.library_generation") | ||
| bash_call( | ||
| f"touch {self.simulated_home}/.library_generation/gapic-generator-java.jar" | ||
| ) | ||
|
|
||
| # We create a per-test directory where all output files will be created into. | ||
| # Each folder will be deleted after its corresponding test finishes. | ||
| test_dir = get_bash_call_output("mktemp -d") | ||
| self.output_folder = self._run_command_and_get_sdout( | ||
| "get_output_folder", | ||
| cwd=test_dir, | ||
| ) | ||
| bash_call(f"mkdir {self.output_folder}") | ||
|
|
||
| def tearDown(self): | ||
| bash_call(f"rm -rdf {self.simulated_home}") | ||
|
|
||
| def _run_command(self, command, **kwargs): | ||
| env = os.environ.copy() | ||
| env["HOME"] = self.simulated_home | ||
| if "cwd" not in kwargs: | ||
| kwargs["cwd"] = self.output_folder | ||
| return bash_call( | ||
| [ | ||
| "bash", | ||
| "-exc", | ||
| f"source {script_dir}/../utils/utilities.sh " + f"&& {command}", | ||
| ], | ||
| exit_on_fail=False, | ||
| env=env, | ||
| **kwargs, | ||
| ) | ||
|
|
||
| def _run_command_and_get_sdout(self, command, **kwargs): | ||
| return self._run_command( | ||
| command, stderr=subprocess.PIPE, **kwargs | ||
| ).stdout.decode()[:-1] | ||
|
|
||
| def test_get_grpc_version_with_no_env_var_fails(self): | ||
| # the absence of DOCKER_GRPC_VERSION will make this function to fail | ||
| result = self._run_command("get_grpc_version") | ||
| self.assertEquals(1, result.returncode) | ||
| self.assertRegex(result.stdout.decode(), "DOCKER_GRPC_VERSION is not set") | ||
|
|
||
| def test_get_protoc_version_with_no_env_var_fails(self): | ||
| # the absence of DOCKER_PROTOC_VERSION will make this function to fail | ||
| result = self._run_command("get_protoc_version") | ||
| self.assertEquals(1, result.returncode) | ||
| self.assertRegex(result.stdout.decode(), "DOCKER_PROTOC_VERSION is not set") | ||
|
|
||
| def test_download_tools_without_baked_generator_fails(self): | ||
| # This test has the same structure as | ||
| # download_tools_succeed_with_baked_protoc, but meant for | ||
| # gapic-generator-java. | ||
|
|
||
| test_protoc_version = "1.64.0" | ||
| test_grpc_version = "1.64.0" | ||
| jar_location = ( | ||
| f"{self.simulated_home}/.library_generation/gapic-generator-java.jar" | ||
| ) | ||
| # we expect the function to fail because the generator jar is not found in | ||
| # its well-known location. To achieve this, we temporarily remove the fake | ||
| # generator jar | ||
| bash_call(f"rm {jar_location}") | ||
| result = self._run_command( | ||
| f"download_tools {test_protoc_version} {test_grpc_version} {self.TEST_ARCHITECTURE}" | ||
| ) | ||
| self.assertEquals(1, result.returncode) | ||
| self.assertRegex(result.stdout.decode(), "Please configure your environment") |
Oops, something went wrong.