-
Notifications
You must be signed in to change notification settings - Fork 56
/
test_dockerfile_based_harness.py
195 lines (175 loc) · 9.52 KB
/
test_dockerfile_based_harness.py
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
import os
import subprocess
from typing import List
import docker
import pytest
from docker.errors import BuildError
from semver import Version
from config import _image_generator_configs
from utils import get_dir_for_version, get_match_specs, get_semver
_docker_client = docker.from_env()
@pytest.mark.cpu
@pytest.mark.parametrize(
"dockerfile_path, required_packages",
[
("keras.test.Dockerfile", ["keras"]),
("autogluon.test.Dockerfile", ["autogluon"]),
("matplotlib.test.Dockerfile", ["matplotlib"]),
("matplotlib.test.Dockerfile", ["matplotlib-base"]),
("sagemaker-headless-execution-driver.test.Dockerfile", ["sagemaker-headless-execution-driver"]),
("scipy.test.Dockerfile", ["scipy"]),
("numpy.test.Dockerfile", ["numpy"]),
("boto3.test.Dockerfile", ["boto3"]),
("pandas.test.Dockerfile", ["pandas"]),
("sm-python-sdk.test.Dockerfile", ["sagemaker-python-sdk"]),
("pytorch.examples.Dockerfile", ["pytorch"]),
("tensorflow.examples.Dockerfile", ["tensorflow"]),
("jupyter-ai.test.Dockerfile", ["jupyter-ai"]),
("jupyter-collaboration.test.Dockerfile", ["jupyter-collaboration"]),
("jupyter-dash.test.Dockerfile", ["jupyter-dash"]),
("jupyterlab-lsp.test.Dockerfile", ["jupyterlab-lsp"]),
("python-lsp-server.test.Dockerfile", ["jupyter-lsp-server"]),
("sagemaker-code-editor.test.Dockerfile", ["sagemaker-code-editor"]),
("notebook.test.Dockerfile", ["notebook"]),
("glue-sessions.test.Dockerfile", ["aws-glue-sessions"]),
("altair.test.Dockerfile", ["altair"]),
("sagemaker-studio-analytics-extension.test.Dockerfile", ["sagemaker-studio-analytics-extension"]),
("amazon-codewhisperer-jupyterlab-ext.test.Dockerfile", ["amazon-codewhisperer-jupyterlab-ext"]),
("jupyterlab-git.test.Dockerfile", ["jupyterlab-git"]),
("amazon-sagemaker-sql-magic.test.Dockerfile", ["amazon-sagemaker-sql-magic"]),
("amazon_sagemaker_sql_editor.test.Dockerfile", ["amazon_sagemaker_sql_editor"]),
("serve.test.Dockerfile", ["langchain"]),
("langchain-aws.test.Dockerfile", ["langchain-aws"]),
("mlflow.test.Dockerfile", ["mlflow"]),
("jupyter-activity-monitor-extension.test.Dockerfile", ["jupyter-activity-monitor-extension"]),
("docker-cli.test.Dockerfile", ["docker-cli"]),
],
)
def test_dockerfiles_for_cpu(
dockerfile_path: str, required_packages: List[str], local_image_version: str, use_gpu: bool
):
_validate_docker_images(dockerfile_path, required_packages, local_image_version, use_gpu, "cpu")
@pytest.mark.gpu
@pytest.mark.parametrize(
"dockerfile_path, required_packages",
[
("keras.test.Dockerfile", ["keras"]),
("autogluon.test.Dockerfile", ["autogluon"]),
("matplotlib.test.Dockerfile", ["matplotlib"]),
("matplotlib.test.Dockerfile", ["matplotlib-base"]),
("sagemaker-headless-execution-driver.test.Dockerfile", ["sagemaker-headless-execution-driver"]),
("scipy.test.Dockerfile", ["scipy"]),
("numpy.test.Dockerfile", ["numpy"]),
("boto3.test.Dockerfile", ["boto3"]),
("pandas.test.Dockerfile", ["pandas"]),
("sm-python-sdk.test.Dockerfile", ["sagemaker-python-sdk"]),
("pytorch.examples.Dockerfile", ["pytorch"]),
("tensorflow.examples.Dockerfile", ["tensorflow"]),
("glue-sessions.test.Dockerfile", ["aws-glue-sessions"]),
("jupyter-ai.test.Dockerfile", ["jupyter-ai"]),
("jupyter-dash.test.Dockerfile", ["jupyter-dash"]),
("jupyterlab-lsp.test.Dockerfile", ["jupyterlab-lsp"]),
("python-lsp-server.test.Dockerfile", ["jupyter-lsp-server"]),
("sagemaker-code-editor.test.Dockerfile", ["sagemaker-code-editor"]),
("notebook.test.Dockerfile", ["notebook"]),
("glue-sessions.test.Dockerfile", ["aws-glue-sessions"]),
("altair.test.Dockerfile", ["altair"]),
("sagemaker-studio-analytics-extension.test.Dockerfile", ["sagemaker-studio-analytics-extension"]),
("amazon-codewhisperer-jupyterlab-ext.test.Dockerfile", ["amazon-codewhisperer-jupyterlab-ext"]),
("jupyterlab-git.test.Dockerfile", ["jupyterlab-git"]),
("amazon-sagemaker-sql-magic.test.Dockerfile", ["amazon-sagemaker-sql-magic"]),
("amazon_sagemaker_sql_editor.test.Dockerfile", ["amazon_sagemaker_sql_editor"]),
("serve.test.Dockerfile", ["langchain"]),
("langchain-aws.test.Dockerfile", ["langchain-aws"]),
("mlflow.test.Dockerfile", ["mlflow"]),
("sagemaker-mlflow.test.Dockerfile", ["sagemaker-mlflow"]),
("jupyter-activity-monitor-extension.test.Dockerfile", ["jupyter-activity-monitor-extension"]),
("gpu-dependencies.test.Dockerfile", ["pytorch", "tensorflow"]),
("docker-cli.test.Dockerfile", ["docker-cli"]),
],
)
def test_dockerfiles_for_gpu(
dockerfile_path: str, required_packages: List[str], local_image_version: str, use_gpu: bool
):
_validate_docker_images(dockerfile_path, required_packages, local_image_version, use_gpu, "gpu")
# The following is a simple function to check whether the local machine has at least 1 GPU and some Nvidia driver
# version.
def _is_nvidia_drivers_available() -> bool:
exitcode, output = subprocess.getstatusoutput("nvidia-smi --query-gpu=driver_version --format=csv,noheader --id=0")
if exitcode == 0:
print(f"Found Nvidia driver version: {output}")
else:
print(f"No Nvidia drivers found on the machine. Error output: {output}")
return exitcode == 0
def _check_docker_file_existence(dockerfile_name: str, test_artifacts_path: str):
if not os.path.exists(f"{test_artifacts_path}/{dockerfile_name}"):
pytest.skip(f"Skipping test because {dockerfile_name} does not exist.")
def _check_required_package_constraints(target_version: Version, required_packages: List[str], image_type: str):
target_version_dir = get_dir_for_version(target_version)
if not os.path.exists(target_version_dir):
pytest.skip(f"Skipping test because {target_version_dir} does not exist.")
# fetch the env.out file for this image_type
env_out_file_name = next(
config["env_out_filename"]
for config in _image_generator_configs[target_version.major]
if config["image_type"] == image_type
)
env_out_path = f"{target_version_dir}/{env_out_file_name}"
if not os.path.exists(env_out_path):
pytest.skip(f"Skipping test because {env_out_path} does not exist.")
target_match_spec_out = get_match_specs(env_out_path)
for required_package in required_packages:
if required_package not in target_match_spec_out:
pytest.skip(f"Skipping test because {required_package} is not present in {env_out_file_name}")
def _validate_docker_images(
dockerfile_path: str, required_packages: List[str], local_image_version: str, use_gpu: bool, image_type: str
):
target_version = get_semver(local_image_version)
test_artifacts_path = f"test/test_artifacts/v{str(target_version.major)}"
_check_docker_file_existence(dockerfile_path, test_artifacts_path)
_check_required_package_constraints(target_version, required_packages, image_type)
image_tag_generator_from_config = next(
config["image_tag_generator"]
for config in _image_generator_configs[target_version.major]
if config["image_type"] == image_type
)
docker_image_tag = image_tag_generator_from_config.format(image_version=local_image_version)
docker_image_identifier = f"localhost/sagemaker-distribution:{docker_image_tag}"
print(f"Will start running test for: {dockerfile_path} against: {docker_image_identifier}")
try:
image, _ = _docker_client.images.build(
path=test_artifacts_path,
dockerfile=dockerfile_path,
shmsize="512000000",
tag=dockerfile_path.lower().replace(".", "-"),
rm=True,
buildargs={"SAGEMAKER_DISTRIBUTION_IMAGE": docker_image_identifier},
)
except BuildError as e:
for line in e.build_log:
if "stream" in line:
print(line["stream"].strip())
# After printing the logs raise the exception (which is the old behavior)
raise
print(f"Built a test image: {image.id}, will now execute its default CMD.")
# Execute the new image once. Mark the current test successful/failed based on container's exit code. (We assume
# that the image would have supplied the right entrypoint.
device_requests = []
if use_gpu and _is_nvidia_drivers_available():
# Pass all available GPUs, if available.
device_requests.append(docker.types.DeviceRequest(count=-1, capabilities=[["gpu"]]))
# We assume that the image above would have supplied the right entrypoint, so we just run it as is. If the container
# didn't execute successfully, the Docker client below will throw an error and fail the test.
# A consequence of this design decision is that any test assertions should go inside the container's entry-point.
container = _docker_client.containers.run(image=image.id, detach=True, stderr=True, device_requests=device_requests)
# Wait till container completes execution
result = container.wait()
exit_code = result["StatusCode"]
if exit_code != 0:
# Print STD out only during test failure
print(container.logs().decode("utf-8"))
# Remove the container.
container.remove(force=True)
_docker_client.images.remove(image=image.id, force=True)
# Fail the test if docker exit code is not zero
assert exit_code == 0