local-test-libxml2-delta-02/fuzz-tooling/infra/experimental/chronos/chronos.sh

# 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.
#
################################################################################

# This script records the ENV and commands needed for fuzz target recompilation.
# It intercepts bash commands to save: 1) the ENV variable values before
# building the fuzz target (`recompile_env.sh`) and 2) all subsequent bash
# commands from that point (`recompile`). Combined with Docker, this setup
# allows for recompiling the fuzz target without rebuilding the entire project.
# Usage:
# 1. Set FUZZ_TARGET (e.g., in project's Dockerfile)
# 2. Source this file before compiling the fuzz target (e.g., source chronos.sh
# at the beginning of project's build.sh).

export START_RECORDING="false"
RECOMPILE_ENV="/usr/local/bin/recompile_env.sh"


# Initialize the recompile script as compile in case Chronos did not trap any
# command containing the fuzz target.
initialize_recompile_script() {
    export RECOMPILE_SCRIPT="/usr/local/bin/recompile"
    cp "/usr/local/bin/compile" "$RECOMPILE_SCRIPT"
}

reset_recompile_script() {
    rm "$RECOMPILE_SCRIPT"
    echo "#!/bin/bash" > "$RECOMPILE_SCRIPT"
    echo "source $RECOMPILE_ENV" >> "$RECOMPILE_SCRIPT" 
    chmod +x "$RECOMPILE_SCRIPT" 
}


# Execute or record command for recompilation.
execute_or_record_command() {
    record_command() {
        echo "cd \"$(pwd)\"" >> "$RECOMPILE_SCRIPT"
        echo "$@" >> "$RECOMPILE_SCRIPT"
    }

    # Check if any element in the command array contains the FUZZ_TARGET.
    if [[ "$BASH_COMMAND" == *"$FUZZ_TARGET"* ]]; then
        export START_RECORDING="true"
        # Save all environment variables, excluding read-only ones
        reset_recompile_script
        declare -p | grep -Ev 'declare -[^ ]*r[^ ]*' > "$RECOMPILE_ENV"
    fi

    if [[ "$START_RECORDING" == "true" ]]; then
        record_command "$BASH_COMMAND"
        echo "Recorded execution of: $BASH_COMMAND"
    fi
}


main() {
    # Initialize.
    initialize_recompile_script
    
    # Set up trap for DEBUG to intercept commands.
    trap 'execute_or_record_command' DEBUG

    # Enable extended debugging mode
    shopt -s extdebug  
    # Ensure trap works in subshells and functions.
    set -T  
}

main