-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add discogapic generator * Create Artman class
- Loading branch information
1 parent
89ba266
commit c89c309
Showing
4 changed files
with
240 additions
and
100 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| # Copyright 2018 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import os | ||
| import tempfile | ||
| import platform | ||
| import venv | ||
|
|
||
| from synthtool import cache | ||
| from synthtool import log | ||
| from synthtool import shell | ||
|
|
||
| ARTMAN_VERSION = os.environ.get("SYNTHTOOL_ARTMAN_VERSION", "latest") | ||
| ARTMAN_VENV = cache.get_cache_dir() / "artman_venv" | ||
|
|
||
|
|
||
| class Artman: | ||
| def __init__(self): | ||
| # Docker on mac by default cannot use the default temp file location | ||
| # # instead use the more standard *nix /tmp location\ | ||
| if platform.system() == "Darwin": | ||
| tempfile.tempdir = "/tmp" | ||
| self._ensure_dependencies_installed() | ||
| self._install_artman() | ||
|
|
||
| def run(self, image, root_dir, config, *args): | ||
| """Executes artman command in the artman container. | ||
| Args: | ||
| root_dir: The input directory that will be mounted to artman docker | ||
| container as local googleapis directory. | ||
| Returns: | ||
| The output directory with artman-generated files. | ||
| """ | ||
| container_name = "artman-docker" | ||
| output_dir = root_dir / "artman-genfiles" | ||
|
|
||
| docker_cmd = [ | ||
| "docker", | ||
| "run", | ||
| "--name", | ||
| container_name, | ||
| "--rm", | ||
| "-i", | ||
| "-e", | ||
| f"HOST_USER_ID={os.getuid()}", | ||
| "-e", | ||
| f"HOST_GROUP_ID={os.getgid()}", | ||
| "-e", | ||
| "RUNNING_IN_ARTMAN_DOCKER=True", | ||
| "-v", | ||
| f"{root_dir}:{root_dir}", | ||
| "-v", | ||
| f"{output_dir}:{output_dir}", | ||
| "-w", | ||
| root_dir, | ||
| image, | ||
| "/bin/bash", | ||
| "-c", | ||
| ] | ||
|
|
||
| artman_command = " ".join( | ||
| map(str, ["artman", "--local", "--config", config, "generate"] + list(args)) | ||
| ) | ||
|
|
||
| cmd = docker_cmd + [artman_command] | ||
|
|
||
| shell.run(cmd, cwd=root_dir) | ||
|
|
||
| return output_dir | ||
|
|
||
| def _ensure_dependencies_installed(self): | ||
| log.debug("Ensuring dependencies.") | ||
|
|
||
| dependencies = ["docker", "git"] | ||
| failed_dependencies = [] | ||
| for dependency in dependencies: | ||
| return_code = shell.run(["which", dependency], check=False).returncode | ||
| if return_code: | ||
| failed_dependencies.append(dependency) | ||
|
|
||
| if failed_dependencies: | ||
| raise EnvironmentError( | ||
| f"Dependencies missing: {', '.join(failed_dependencies)}" | ||
| ) | ||
|
|
||
| def _install_artman(self): | ||
| if not ARTMAN_VENV.exists(): | ||
| venv.main([str(ARTMAN_VENV)]) | ||
|
|
||
| if ARTMAN_VERSION != "latest": | ||
| version_specifier = f"=={ARTMAN_VERSION}" | ||
| else: | ||
| version_specifier = "" | ||
|
|
||
| shell.run( | ||
| [ | ||
| ARTMAN_VENV / "bin" / "pip", | ||
| "install", | ||
| "--upgrade", | ||
| f"googleapis-artman{version_specifier}", | ||
| ] | ||
| ) | ||
| log.debug("Pulling artman image.") | ||
| shell.run(["docker", "pull", f"googleapis/artman:{ARTMAN_VERSION}"]) |
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,119 @@ | ||
| # Copyright 2018 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from pathlib import Path | ||
|
|
||
| from synthtool import _tracked_paths | ||
| from synthtool import log | ||
| from synthtool.gcp import artman | ||
| from synthtool.sources import git | ||
|
|
||
| DISCOVERY_ARTIFACT_MANAGER_URL: str = "git@github.com:googleapis/discovery-artifact-manager.git" | ||
|
|
||
|
|
||
| class DiscoGAPICGenerator: | ||
| def __init__(self): | ||
| self._clone_discovery_artifact_manager() | ||
|
|
||
| def py_library(self, service: str, version: str, **kwargs) -> Path: | ||
| """ | ||
| Generates the Python Library files using artman/GAPIC | ||
| returns a `Path` object | ||
| library: path to library. 'google/cloud/speech' | ||
| version: version of lib. 'v1' | ||
| """ | ||
| return self._generate_code(service, version, "python", **kwargs) | ||
|
|
||
| def node_library(self, service: str, version: str, **kwargs) -> Path: | ||
| return self._generate_code(service, version, "nodejs", **kwargs) | ||
|
|
||
| nodejs_library = node_library | ||
|
|
||
| def ruby_library(self, service: str, version: str, **kwargs) -> Path: | ||
| return self._generate_code(service, version, "ruby", **kwargs) | ||
|
|
||
| def php_library(self, service: str, version: str, **kwargs) -> Path: | ||
| return self._generate_code(service, version, "php", **kwargs) | ||
|
|
||
| def java_library(self, service: str, version: str, **kwargs) -> Path: | ||
| return self._generate_code(service, version, "java", **kwargs) | ||
|
|
||
| def _generate_code( | ||
| self, service, version, language, config_path=None, artman_output_name=None | ||
| ): | ||
| # map the language to the artman argument and subdir of genfiles | ||
| GENERATE_FLAG_LANGUAGE = { | ||
| "python": ("python_gapic", "python"), | ||
| "nodejs": ("nodejs_gapic", "js"), | ||
| "ruby": ("ruby_gapic", "ruby"), | ||
| "php": ("php_gapic", "php"), | ||
| "java": ("java_discogapic", "java"), | ||
| } | ||
|
|
||
| if language not in GENERATE_FLAG_LANGUAGE: | ||
| raise ValueError("provided language unsupported") | ||
|
|
||
| gapic_language_arg, gen_language = GENERATE_FLAG_LANGUAGE[language] | ||
|
|
||
| if self.discovery_artifact_manager is None: | ||
| raise RuntimeError( | ||
| f"Unable to generate {config_path}, the googleapis repository" | ||
| "is unavailable." | ||
| ) | ||
|
|
||
| # Run the code generator. | ||
| # $ artman --config path/to/artman_api.yaml generate python_gapic | ||
| if config_path is None: | ||
| config_path = ( | ||
| Path("gapic/google") / service / f"artman_{service}_{version}.yaml" | ||
| ) | ||
| elif Path(config_path).is_absolute(): | ||
| config_path = Path(config_path).relative_to("/") | ||
| else: | ||
| config_path = Path("gapic/google") / service / Path(config_path) | ||
|
|
||
| if not (self.discovery_artifact_manager / config_path).exists(): | ||
| raise FileNotFoundError( | ||
| f"Unable to find configuration yaml file: {config_path}." | ||
| ) | ||
|
|
||
| log.debug(f"Running generator for {config_path}.") | ||
| output_root = artman.Artman().run( | ||
| f"googleapis/artman:{artman.ARTMAN_VERSION}", | ||
| self.discovery_artifact_manager, | ||
| config_path, | ||
| gapic_language_arg, | ||
| ) | ||
|
|
||
| # Expect the output to be in the artman-genfiles directory. | ||
| # example: /artman-genfiles/python/speech-v1 | ||
| if artman_output_name is None: | ||
| artman_output_name = f"{service}-{version}" | ||
| genfiles = output_root / gen_language / artman_output_name | ||
|
|
||
| if not genfiles.exists(): | ||
| raise FileNotFoundError( | ||
| f"Unable to find generated output of artman: {genfiles}." | ||
| ) | ||
|
|
||
| log.success(f"Generated code into {genfiles}.") | ||
|
|
||
| _tracked_paths.add(genfiles) | ||
| return genfiles | ||
|
|
||
| def _clone_discovery_artifact_manager(self): | ||
| log.debug("Cloning discovery-artifact-manager.") | ||
| self.discovery_artifact_manager = git.clone( | ||
| DISCOVERY_ARTIFACT_MANAGER_URL, depth=1 | ||
| ) |
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