Repository navigation
Expand file tree
/
Copy pathcodegen.py
More file actions
327 lines (274 loc) · 11.7 KB
/
Copy pathcodegen.py
File metadata and controls
327 lines (274 loc) · 11.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
import logging
import os
import shutil
import zipfile
from pathlib import PurePosixPath
from subprocess import PIPE, CalledProcessError, run as subprocess_run # nosec
from tempfile import TemporaryFile
from typing import Dict
import docker
from docker.errors import APIError, ContainerError, ImageLoadError
from requests.exceptions import ConnectionError as RequestsConnectionError
from rpdk.core.data_loaders import resource_stream
from rpdk.core.exceptions import DownstreamError, SysExitRecommendedError
from rpdk.core.init import input_with_validation
from rpdk.core.jsonutils.resolver import ContainerType, resolve_models
from rpdk.core.plugin_base import LanguagePlugin
from rpdk.core.project import ARTIFACT_TYPE_HOOK
from . import __version__
from .resolver import contains_model, translate_type
LOG = logging.getLogger(__name__)
EXECUTABLE = "cfn"
SUPPORT_LIB_NAME = "cloudformation-cli-python-lib"
SUPPORT_LIB_PKG = SUPPORT_LIB_NAME.replace("-", "_")
class StandardDistNotFoundError(SysExitRecommendedError):
pass
def validate_no(value):
return value.lower() not in ("n", "no")
class Python36LanguagePlugin(LanguagePlugin):
MODULE_NAME = __name__
NAME = "python36"
RUNTIME = "python3.6"
HOOK_ENTRY_POINT = "{}.handlers.hook"
RESOURCE_ENTRY_POINT = "{}.handlers.resource"
TEST_ENTRY_POINT = "{}.handlers.test_entrypoint"
CODE_URI = "build/"
def __init__(self):
self.env = self._setup_jinja_env(
trim_blocks=True, lstrip_blocks=True, keep_trailing_newline=True
)
self.env.filters["translate_type"] = translate_type
self.env.filters["contains_model"] = contains_model
self.env.globals["ContainerType"] = ContainerType
self.namespace = None
self.package_name = None
self.package_root = None
self._use_docker = None
self._protocol_version = "2.0.0"
def _init_from_project(self, project):
self.namespace = tuple(s.lower() for s in project.type_info)
self.package_name = "_".join(self.namespace)
self._use_docker = project.settings.get("use_docker")
self.package_root = project.root / "src"
def _init_settings(self, project):
LOG.debug("Writing settings")
project.runtime = self.RUNTIME
if project.artifact_type == ARTIFACT_TYPE_HOOK:
project.entrypoint = self.HOOK_ENTRY_POINT.format(self.package_name)
project.test_entrypoint = project.entrypoint.replace(
".hook", ".test_entrypoint"
)
else:
project.entrypoint = self.RESOURCE_ENTRY_POINT.format(self.package_name)
project.test_entrypoint = project.entrypoint.replace(
".resource", ".test_entrypoint"
)
self._use_docker = self._use_docker or input_with_validation(
"Use docker for platform-independent packaging (Y/n)?\n",
validate_no,
"This is highly recommended unless you are experienced \n"
"with cross-platform Python packaging.",
)
project.settings["use_docker"] = self._use_docker
project.settings["protocolVersion"] = self._protocol_version
def init(self, project):
LOG.debug("Init started")
self._init_from_project(project)
self._init_settings(project)
def _render_template(path, **kwargs):
LOG.debug("Writing '%s'", path)
template = self.env.get_template(path.name)
contents = template.render(**kwargs)
project.safewrite(path, contents)
def _copy_resource(path, resource_name=None):
LOG.debug("Writing '%s'", path)
if not resource_name:
resource_name = path.name
contents = resource_stream(__name__, f"data/{resource_name}").read()
project.safewrite(path, contents)
# handler Python package
handler_package_path = self.package_root / self.package_name
LOG.debug("Making folder '%s'", handler_package_path)
handler_package_path.mkdir(parents=True, exist_ok=True)
_copy_resource(handler_package_path / "__init__.py")
self.init_handlers(project, handler_package_path)
# models.py produced by generate
# project support files
_copy_resource(project.root / ".gitignore", "Python.gitignore")
_render_template(
project.root / "requirements.txt", support_lib_name=SUPPORT_LIB_NAME
)
_render_template(
project.root / "README.md",
type_name=project.type_name,
schema_path=project.schema_path,
project_path=self.package_name,
executable=EXECUTABLE,
support_lib_pkg=SUPPORT_LIB_PKG,
)
# CloudFormation/SAM template for handler lambda
handler_params = {
"Handler": project.entrypoint,
"Runtime": project.runtime,
"CodeUri": self.CODE_URI,
}
_render_template(
project.root / "template.yml",
resource_type=project.type_name,
functions={
"TypeFunction": handler_params,
"TestEntrypoint": {
**handler_params,
"Handler": project.test_entrypoint,
},
},
)
LOG.debug("Init complete")
def init_handlers(self, project, handler_package_path):
path = handler_package_path / "handlers.py"
if project.artifact_type == ARTIFACT_TYPE_HOOK:
template = self.env.get_template("hook_handlers.py")
else:
template = self.env.get_template("handlers.py")
contents = template.render(
support_lib_pkg=SUPPORT_LIB_PKG, type_name=project.type_name
)
project.safewrite(path, contents)
def generate(self, project):
LOG.debug("Generate started")
self._init_from_project(project)
if project.artifact_type == ARTIFACT_TYPE_HOOK:
models = resolve_models(project.schema, "HookInputModel")
else:
models = resolve_models(project.schema)
if project.configuration_schema:
configuration_schema_path = (
project.root / project.configuration_schema_filename
)
project.write_configuration_schema(configuration_schema_path)
configuration_models = resolve_models(
project.configuration_schema, "TypeConfigurationModel"
)
else:
configuration_models = {"TypeConfigurationModel": {}}
models.update(configuration_models)
path = self.package_root / self.package_name / "models.py"
LOG.debug("Writing file: %s", path)
if project.artifact_type == ARTIFACT_TYPE_HOOK:
template = self.env.get_template("hook_models.py")
else:
template = self.env.get_template("models.py")
contents = template.render(support_lib_pkg=SUPPORT_LIB_PKG, models=models)
project.overwrite(path, contents)
LOG.debug("Generate complete")
# pylint: disable=unused-argument
# the argument "project" is not used here but is used in codegen.py of other plugins
# this method is called in cloudformation-cli/src/rpdk/core/project.py
def get_plugin_information(self, project) -> Dict:
return self._get_plugin_information()
def _pre_package(self, build_path):
f = TemporaryFile("w+b") # pylint: disable=R1732
with zipfile.ZipFile(f, mode="w") as zip_file:
self._recursive_relative_write(build_path, build_path, zip_file)
f.seek(0)
return f
@staticmethod
def _recursive_relative_write(src_path, base_path, zip_file):
for path in src_path.rglob("*"):
if path.is_file() and path.suffix != ".pyc":
relative = path.relative_to(base_path)
zip_file.write(path.resolve(), str(relative))
def package(self, project, zip_file):
LOG.debug("Package started")
self._init_from_project(project)
handler_package_path = self.package_root / self.package_name
build_path = project.root / "build"
self._remove_build_artifacts(build_path)
self._build(project.root)
shutil.copytree(str(handler_package_path), str(build_path / self.package_name))
inner_zip = self._pre_package(build_path)
zip_file.writestr("ResourceProvider.zip", inner_zip.read())
self._recursive_relative_write(handler_package_path, project.root, zip_file)
LOG.debug("Package complete")
@staticmethod
def _remove_build_artifacts(deps_path):
try:
shutil.rmtree(deps_path)
except FileNotFoundError:
LOG.debug("'%s' not found, skipping removal", deps_path, exc_info=True)
def _build(self, base_path):
LOG.debug("Dependencies build started from '%s'", base_path)
if self._use_docker:
self._docker_build(base_path)
else:
self._pip_build(base_path)
LOG.debug("Dependencies build finished")
@staticmethod
def _make_pip_command(base_path):
return [
"pip",
"install",
"--no-cache-dir",
"--no-color",
"--disable-pip-version-check",
"--upgrade",
"--requirement",
str(base_path / "requirements.txt"),
"--target",
str(base_path / "build"),
]
@staticmethod
def _get_plugin_information() -> Dict:
return {"plugin-tool-version": __version__, "plugin-name": "python"}
@classmethod
def _docker_build(cls, external_path):
internal_path = PurePosixPath("/project")
command = " ".join(cls._make_pip_command(internal_path))
LOG.debug("command is '%s'", command)
volumes = {str(external_path): {"bind": str(internal_path), "mode": "rw"}}
image = f"lambci/lambda:build-{cls.RUNTIME}"
LOG.warning(
"Starting Docker build. This may take several minutes if the "
"image '%s' needs to be pulled first.",
image,
)
docker_client = docker.from_env()
try:
logs = docker_client.containers.run(
image=image,
command=command,
auto_remove=True,
volumes=volumes,
stream=True,
user=f"{os.geteuid()}:{os.getgid()}",
)
except RequestsConnectionError as e:
# it seems quite hard to reliably extract the cause from
# ConnectionError. we replace it with a friendlier error message
# and preserve the cause for debug traceback
cause = RequestsConnectionError(
"Could not connect to docker - is it running?"
)
cause.__cause__ = e
raise DownstreamError("Error running docker build") from cause
except (ContainerError, ImageLoadError, APIError) as e:
raise DownstreamError("Error running docker build") from e
LOG.debug("Build running. Output:")
for line in logs:
LOG.debug(line.rstrip(b"\n").decode("utf-8"))
@classmethod
def _pip_build(cls, base_path):
command = cls._make_pip_command(base_path)
LOG.debug("command is '%s'", command)
LOG.warning("Starting pip build.")
try:
completed_proc = subprocess_run( # nosec
command, stdout=PIPE, stderr=PIPE, cwd=base_path, check=True
)
except (FileNotFoundError, CalledProcessError) as e:
raise DownstreamError("pip build failed") from e
LOG.debug("--- pip stdout:\n%s", completed_proc.stdout)
LOG.debug("--- pip stderr:\n%s", completed_proc.stderr)
class Python37LanguagePlugin(Python36LanguagePlugin):
NAME = "python37"
RUNTIME = "python3.7"