-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make batch capable of emulating cloud build #12833
Open
jonathanmetzman
wants to merge
1
commit into
master
Choose a base branch
from
batch
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
# Copyright 2024 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 | ||
# | ||
# http://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 base64 | ||
import os | ||
import time | ||
import uuid | ||
import json | ||
|
||
|
||
import six.moves.urllib.parse as urlparse | ||
|
||
from google.cloud import batch_v1 as batch | ||
from google.cloud import storage | ||
from oauth2client import service_account as service_account_lib | ||
import yaml | ||
|
||
MACHINE_TYPE = 'e2-standard-4' | ||
SERVICE_ACCOUNT = '[email protected]' | ||
|
||
BUILD_TIMEOUT= 20*60 | ||
|
||
|
||
DIRECTORY = os.path.dirname(__file__) | ||
STARTUP_SCRIPT = os.path.join(DIRECTORY, 'cloud_build_emulator.py') | ||
# Controls how many containers (ClusterFuzz tasks) can run on a single VM. | ||
# THIS SHOULD BE 1 OR THERE WILL BE SECURITY PROBLEMS. | ||
TASK_COUNT_PER_NODE = 1 | ||
|
||
def get_job_name(): | ||
return 'j-' + str(uuid.uuid4()).lower() | ||
|
||
|
||
BATCH_BUILD_INPUT_BUCKET = 'batch-build-input' | ||
|
||
|
||
def upload_build_config(job_name, build_config): | ||
gcs_client = storage.Client() | ||
bucket = gcs_client.bucket(BATCH_BUILD_INPUT_BUCKET) | ||
yaml_filename = job_name + '.json' | ||
blob = bucket.blob(yaml_filename) | ||
blob.upload_from_string(json.dumps(build_config)) | ||
return get_signed_url(f'/{BATCH_BUILD_INPUT_BUCKET}/{yaml_filename}', method='GET') | ||
|
||
|
||
def get_signed_url(path, method='PUT', content_type=''): | ||
"""Returns signed url.""" | ||
timestamp = int(time.time() + BUILD_TIMEOUT) | ||
blob = f'{method}\n\n{content_type}\n{timestamp}\n{path}' | ||
|
||
service_account_path = os.environ.get('GOOGLE_APPLICATION_CREDENTIALS') | ||
if service_account_path: | ||
creds = ( | ||
service_account_lib.ServiceAccountCredentials.from_json_keyfile_name( | ||
os.environ['GOOGLE_APPLICATION_CREDENTIALS'])) | ||
client_id = creds.service_account_email | ||
signature = base64.b64encode(creds.sign_blob(blob)[1]) | ||
else: | ||
credentials, project = google.auth.default() | ||
iam = googleapiclient.discovery.build('iamcredentials', | ||
'v1', | ||
credentials=credentials, | ||
cache_discovery=False) | ||
client_id = project + '@appspot.gserviceaccount.com' | ||
service_account = f'projects/-/serviceAccounts/{client_id}' | ||
response = iam.projects().serviceAccounts().signBlob( | ||
name=service_account, | ||
body={ | ||
'delegates': [], | ||
'payload': base64.b64encode(blob.encode('utf-8')).decode('utf-8'), | ||
}).execute() | ||
signature = response['signedBlob'] | ||
|
||
values = { | ||
'GoogleAccessId': client_id, | ||
'Expires': timestamp, | ||
'Signature': signature, | ||
} | ||
return f'https://storage.googleapis.com{path}?{urlparse.urlencode(values)}' | ||
|
||
|
||
def run_build( | ||
build_body, | ||
cloud_project, | ||
timeout, credentials): | ||
job_name = get_job_name() | ||
input_download_url = upload_build_config(job_name, build_body) | ||
runnable = batch.Runnable() | ||
with open(STARTUP_SCRIPT) as fp: | ||
script_text = fp.read() | ||
runnable.script = batch.Runnable.Script(path='/opt/cloud_build_emulator.py', text=script_text) | ||
task_spec = batch.TaskSpec() | ||
task_spec.runnables = [runnable] | ||
task_spec.max_run_duration = f'{20 * 60}s' | ||
task_spec.max_retry_count = 1 | ||
disk = batch.AllocationPolicy.Disk() | ||
disk.image = 'batch-debian' | ||
disk.size_gb = '60' | ||
disk.type = 'pd-standard' | ||
instance_policy = batch.AllocationPolicy.InstancePolicy() | ||
instance_policy.boot_disk = disk | ||
instance_policy.machine_type = MACHINE_TYPE | ||
instances = batch.AllocationPolicy.InstancePolicyOrTemplate() | ||
instances.policy = instance_policy | ||
network_interface = batch.AllocationPolicy.NetworkInterface() | ||
network_interfaces = [network_interface] | ||
network_policy = batch.AllocationPolicy.NetworkPolicy() | ||
network_policy.network_interfaces = network_interfaces | ||
allocation_policy = batch.AllocationPolicy() | ||
allocation_policy.instances = [instances] | ||
allocation_policy.network = network_policy | ||
task_group = batch.TaskGroup() | ||
task_group.task_count = 1 # !!! | ||
task_group.task_environments = [ | ||
batch.Environment(variables={'INPUT_DOWNLOAD_URL': input_download_url}) | ||
] | ||
task_group.task_spec = task_spec | ||
job = batch.Job() | ||
job.task_groups = [task_group] | ||
job.allocation_policy = allocation_policy | ||
job.logs_policy = batch.LogsPolicy() | ||
job.logs_policy.destination = batch.LogsPolicy.Destination.CLOUD_LOGGING | ||
create_request = batch.CreateJobRequest() | ||
create_request.job = job | ||
create_request.job_id = job_name | ||
# The job's parent is the region in which the job will run. | ||
create_request.parent = f'projects/oss-fuzz/locations/us-central1' | ||
del os.environ['GOOGLE_APPLICATION_CREDENTIALS'] | ||
return batch.BatchServiceClient().create_job(create_request) |
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,49 @@ | ||
#!/usr/bin/env python3 | ||
import json | ||
import os | ||
from pathlib import Path | ||
import sys | ||
import subprocess | ||
import tempfile | ||
import urllib.request | ||
|
||
|
||
def run_commands(steps, workspace): | ||
os.chdir(workspace) # Needed for compatibility. | ||
for command in json.loads(steps)['steps']: | ||
docker_command = [ | ||
'docker', 'run', '-v', f'{workspace}:/workspace:rw', '-v', | ||
'/var/run/docker.sock:/var/run/docker.sock:rw', | ||
] | ||
for env_var in command.get('env', []): | ||
docker_command.extend(['-e', env_var]) | ||
|
||
entrypoint = command.get('entrypoint') | ||
if entrypoint: | ||
docker_command += ['--entrypoint', f'{Path(entrypoint).resolve()}'] | ||
|
||
args = command.get('args', []) # Ignore this for now as it causes errors. | ||
# !!! It's hacky that I'm doing abspath this but it seems to be needed. | ||
args = [arg for arg in args if not arg.startswith('--network')] | ||
directory = os.path.abspath(command.get('dir', '/workspace')) | ||
docker_command += ['-w', directory, command['name']] + args | ||
|
||
print(f'Running command:', docker_command) | ||
docker_command = ['sudo'] + docker_command | ||
subprocess.run(docker_command, check=True) | ||
|
||
def main(): | ||
url = os.getenv('INPUT_DOWNLOAD_URL') | ||
with urllib.request.urlopen(url) as response: | ||
content = response.read().decode() | ||
os.system('sudo mkdir /workspace') | ||
run_commands(content, '/workspace') | ||
|
||
# def main(): | ||
# with open(sys.argv[1], 'r') as f: | ||
# commands = yaml.safe_load(f) | ||
# # !!! FIX | ||
# run_commands(commands, '/workspace') | ||
|
||
if __name__ == '__main__': | ||
main() |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we look at using https://github.com/GoogleCloudPlatform/cloud-build-local instead? It's unmaintained, but it should at least be closer to real cloud build than anything we write.
There's probably specifics here that we're missing (e.g. the "cloudbuild" network) which might subtly break things otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It completely failed on everything I tried it on. But I could be holding it wrong, maybe someone else should try it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with you that it's a better solution in theory. This was a last resort after realizing there was no other option that could give us builds with VM level isolation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What did we need the VM level isolation for btw? Is this for OSS-Fuzz-Gen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For OSS-Fuzz as well.