This directory contains scripts for running ClusterFuzz docker images locally.

This project uses a .tool-versions file. Follow these steps to install the correct Python version.

1. Install asdf Follow the official asdf guide.

2. Add Plugins

   asdf plugin add python
   asdf plugin add gcloud https://github.com/jthegedus/asdf-gcloud

3. Install tools Run this command inside the project directory. It will read the version from the .tool-versions file.

   asdf install
   python3.11 -m pip install pipenv

4. Install Deps Run this command inside the project directory. This script will use pipenv to set up a virtual environment and install all the required packages specified in the Pipfile, ensuring your local setup is consistent with the project's requirements.

   ./local/install_deps.bash

Provide credentials to connect to your project using one of the following ways:

• To use your own account credentials, run:

  $ gcloud auth application-default login

• To use a service account credentials file, run:

  $ export GOOGLE_APPLICATION_CREDENTIALS=<path-to-your-credentials.json>`

To run a local GCE metadata server emulating the credentials provided above:

$ ./run_metadata.bash \
  -project-id=<your-project-name> \
  -project-num=<your-project-number> \
  -deployment-bucket=<deployment.bucket attribute in your config-dir/project.yaml>

You can skip specifying the deployment-bucket if you plan to use local checkout.

To run a bot image locally, run:

$ ./run_docker.bash gcr.io/clusterfuzz-images/base

NOTE: You must run this command as a non-root user. Make sure that to add your user to the docker group using sudo adduser $USER docker.

By default this uses the latest deployed source, but you can also use your local checkout by doing:

$ LOCAL_SRC=1 CONFIG_DIR_OVERRIDE=<your-config-dir> ./run_docker.bash gcr.io/clusterfuzz-images/base

To run the CI environment locally, run

$ ./run_ci.bash
# (inside container)
$ setup