Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexCuadron committed Oct 20, 2024
2 parents 12798fd + 2637985 commit ef3646f
Show file tree
Hide file tree
Showing 11 changed files with 34 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ evaluation/toolqa/data
# frontend

# dependencies
frontend/node_modules
frontend/.pnp
frontend/bun.lockb
frontend/yarn.lock
Expand Down Expand Up @@ -228,3 +227,4 @@ runtime_*.tar
containers/runtime/Dockerfile
containers/runtime/project.tar.gz
containers/runtime/code
**/node_modules/
2 changes: 2 additions & 0 deletions evaluation/swe_bench/run_infer.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ def get_config(
use_host_network=False,
# large enough timeout, since some testcases take very long to run
timeout=300,
# Add platform to the sandbox config to solve issue 4401
platform='linux/amd64',
api_key=os.environ.get('ALLHANDS_API_KEY', None),
remote_runtime_api_url=os.environ.get('SANDBOX_REMOTE_RUNTIME_API_URL'),
keep_remote_runtime_alive=False,
Expand Down
2 changes: 2 additions & 0 deletions openhands/core/config/sandbox_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ class SandboxConfig:
For example, for specifying the base url of website for browsergym evaluation.
browsergym_eval_env: The BrowserGym environment to use for evaluation.
Default is None for general purpose browsing. Check evaluation/miniwob and evaluation/webarena for examples.
platform: The platform on which the image should be built. Default is None.
"""

remote_runtime_api_url: str = 'http://localhost:8000'
Expand All @@ -49,6 +50,7 @@ class SandboxConfig:
runtime_extra_deps: str | None = None
runtime_startup_env_vars: dict[str, str] = field(default_factory=dict)
browsergym_eval_env: str | None = None
platform: str | None = None

def defaults_to_dict(self) -> dict:
"""Serialize fields to a dict for the frontend, including type hints, defaults, and whether it's optional."""
Expand Down
3 changes: 2 additions & 1 deletion openhands/runtime/builder/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ def build(
self,
path: str,
tags: list[str],
platform: str | None = None,
) -> str:
"""
Build the runtime image.
Args:
path (str): The path to the runtime image's build directory.
tags (list[str]): The tags to apply to the runtime image (e.g., ["repo:my-repo", "sha:my-sha"]).
platform (str, optional): The target platform for the build. Defaults to None.
Returns:
str: The name:tag of the runtime image after build (e.g., "repo:sha").
This can be different from the tags input if the builder chooses to mutate the tags (e.g., adding a
Expand Down
6 changes: 6 additions & 0 deletions openhands/runtime/builder/docker.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ def build(
self,
path: str,
tags: list[str],
platform: str | None = None,
use_local_cache: bool = False,
extra_build_args: list[str] | None = None,
) -> str:
Expand All @@ -35,6 +36,7 @@ def build(
Args:
path (str): The path to the Docker build context.
tags (list[str]): A list of image tags to apply to the built image.
platform (str, optional): The target platform for the build. Defaults to None.
use_local_cache (bool, optional): Whether to use and update the local build cache. Defaults to True.
extra_build_args (list[str], optional): Additional arguments to pass to the Docker build command. Defaults to None.
Expand Down Expand Up @@ -70,6 +72,10 @@ def build(
'--load',
]

# Include the platform argument only if platform is specified
if platform:
buildx_cmd.append(f'--platform={platform}')

cache_dir = '/tmp/.buildx-cache'
if use_local_cache and self._is_cache_usable(cache_dir):
buildx_cmd.extend(
Expand Down
2 changes: 1 addition & 1 deletion openhands/runtime/builder/remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def __init__(self, api_url: str, api_key: str):
self.session = requests.Session()
self.session.headers.update({'X-API-Key': self.api_key})

def build(self, path: str, tags: list[str]) -> str:
def build(self, path: str, tags: list[str], platform: str | None = None) -> str:
"""Builds a Docker image using the Runtime API's /build endpoint."""
# Create a tar archive of the build context
tar_buffer = io.BytesIO()
Expand Down
1 change: 1 addition & 0 deletions openhands/runtime/client/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ def _init_bash_shell(self, work_dir: str, username: str) -> None:
self.shell = pexpect.spawn(
f'su {username}',
encoding='utf-8',
codec_errors='replace',
echo=False,
)
self.__bash_PS1 = (
Expand Down
1 change: 1 addition & 0 deletions openhands/runtime/client/runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ def __init__(
self.runtime_container_image = build_runtime_image(
self.base_container_image,
self.runtime_builder,
platform=self.config.sandbox.platform,
extra_deps=self.config.sandbox.runtime_extra_deps,
force_rebuild=self.config.sandbox.force_rebuild_runtime,
)
Expand Down
1 change: 1 addition & 0 deletions openhands/runtime/remote/runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ def _build_runtime(self):
self.container_image = build_runtime_image(
self.config.sandbox.base_container_image,
self.runtime_builder,
platform=self.config.sandbox.platform,
extra_deps=self.config.sandbox.runtime_extra_deps,
force_rebuild=self.config.sandbox.force_rebuild_runtime,
)
Expand Down
18 changes: 16 additions & 2 deletions openhands/runtime/utils/runtime_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ def get_runtime_image_repo_and_tag(base_image: str) -> tuple[str, str]:
def build_runtime_image(
base_image: str,
runtime_builder: RuntimeBuilder,
platform: str | None = None,
extra_deps: str | None = None,
build_folder: str | None = None,
dry_run: bool = False,
Expand All @@ -109,6 +110,7 @@ def build_runtime_image(
Parameters:
- base_image (str): The name of the base Docker image to use
- runtime_builder (RuntimeBuilder): The runtime builder to use
- platform (str): The target platform for the build (e.g. linux/amd64, linux/arm64)
- extra_deps (str):
- build_folder (str): The directory to use for the build. If not provided a temporary directory will be used
- dry_run (bool): if True, it will only ready the build folder. It will not actually build the Docker image
Expand All @@ -128,6 +130,7 @@ def build_runtime_image(
extra_deps=extra_deps,
dry_run=dry_run,
force_rebuild=force_rebuild,
platform=platform,
)
return result

Expand All @@ -138,6 +141,7 @@ def build_runtime_image(
extra_deps=extra_deps,
dry_run=dry_run,
force_rebuild=force_rebuild,
platform=platform,
)
return result

Expand All @@ -149,6 +153,7 @@ def build_runtime_image_in_folder(
extra_deps: str | None,
dry_run: bool,
force_rebuild: bool,
platform: str | None = None,
) -> str:
runtime_image_repo, _ = get_runtime_image_repo_and_tag(base_image)
lock_tag = f'oh_v{oh_version}_{get_hash_for_lock_files(base_image)}'
Expand All @@ -165,6 +170,7 @@ def build_runtime_image_in_folder(
runtime_image_repo,
hash_tag,
lock_tag,
platform,
)
return hash_image_name

Expand Down Expand Up @@ -194,6 +200,7 @@ def build_runtime_image_in_folder(
runtime_image_repo,
hash_tag,
lock_tag,
platform,
)

return hash_image_name
Expand Down Expand Up @@ -293,6 +300,7 @@ def _build_sandbox_image(
runtime_image_repo: str,
hash_tag: str,
lock_tag: str,
platform: str | None = None,
):
"""Build and tag the sandbox image. The image will be tagged with all tags that do not yet exist"""

Expand All @@ -305,7 +313,9 @@ def _build_sandbox_image(
if not runtime_builder.image_exists(name, False)
]

image_name = runtime_builder.build(path=str(build_folder), tags=names)
image_name = runtime_builder.build(
path=str(build_folder), tags=names, platform=platform
)
if not image_name:
raise RuntimeError(f'Build failed for image {names}')

Expand All @@ -319,6 +329,7 @@ def _build_sandbox_image(
)
parser.add_argument('--build_folder', type=str, default=None)
parser.add_argument('--force_rebuild', action='store_true', default=False)
parser.add_argument('--platform', type=str, default=None)
args = parser.parse_args()

if args.build_folder is not None:
Expand Down Expand Up @@ -349,6 +360,7 @@ def _build_sandbox_image(
build_folder=temp_dir,
dry_run=True,
force_rebuild=args.force_rebuild,
platform=args.platform,
)

_runtime_image_repo, runtime_image_hash_tag = runtime_image_hash_name.split(
Expand Down Expand Up @@ -382,5 +394,7 @@ def _build_sandbox_image(
# Dockerfile, we actually build the Docker image
logger.info('Building image in a temporary folder')
docker_builder = DockerRuntimeBuilder(docker.from_env())
image_name = build_runtime_image(args.base_image, docker_builder)
image_name = build_runtime_image(
args.base_image, docker_builder, platform=args.platform
)
print(f'\nBUILT Image: {image_name}\n')
1 change: 1 addition & 0 deletions tests/unit/test_runtime_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ def test_build_runtime_image_from_scratch():
f'{get_runtime_image_repo()}:{OH_VERSION}_mock-lock-hash_mock-source-hash',
f'{get_runtime_image_repo()}:{OH_VERSION}_mock-lock-hash',
],
platform=None,
)
assert (
image_name
Expand Down

0 comments on commit ef3646f

Please sign in to comment.