combine-ymls.sh

#!/bin/bash

COMBINATIONS_FOLDER="combinations"
MATRIX_VERSION_FILE="matrix.yml"
MATRIX_VERSION_README="../../CDK_VERSION_MATRIX.MD"

# Extracts the base file name from a full path, removing the directory path and the .yml extension.
# e.g. get_file_name "forks/fork10.yml" should return "fork10".
extract_base_name() {
    echo "$1" | sed 's|.*/||; s|\.yml$||'
}

# Convert a YML array into a Markdown table.
yml2md() {
    echo "Fork ID|CDK Erigon|ZkEVM Prover|ZkEVM Contracts|Data Availability|Bridge"
    echo "---|---|---|---|---|---"
    yq -r '
        to_entries | 
        sort_by(.key | tonumber) | reverse |
        map(
            "\(.key)|[\(.value.cdk_erigon.version)](\(.value.cdk_erigon.source))|[\(.value.zkevm_prover.version)](\(.value.zkevm_prover.source))|[\(.value.zkevm_contracts.version)](\(.value.zkevm_contracts.source))|[\(.value.data_availability.version)](\(.value.data_availability.source))|[\(.value.bridge_service.version)](\(.value.bridge_service.source))"
        ) |
        join("\n")
    ' "$1"
}

true > "$MATRIX_VERSION_FILE"
echo -e "# Polygon CDK Version Matrix\n\nWhich versions of the CDK stack are meant to work together?\n" > "$MATRIX_VERSION_README"

# File combinations.
forks=(forks/*.yml)
data_availability=(da-modes/*.yml)
components=(components/*.yml)

default_erigon_version="$(grep -P "cdk_erigon_node_image.*hermeznetwork/cdk-erigon" ../../input_parser.star | sed 's#.*hermeznetwork/cdk-erigon:\([^"]*\).*#\1#')"
default_bridge_version="$(grep -P "zkevm_bridge_service_image.*hermeznetwork" ../../input_parser.star | sed 's#.*hermeznetwork/zkevm-bridge-service:\([^"]*\).*#\1#')"
default_da_version="$(grep -P "zkevm_da_image.*0xpolygon" ../../input_parser.star | sed 's#.*0xpolygon/cdk-data-availability:\([^"]*\).*#\1#')"

# Nested loops to create all combinations.
echo "Creating combinations..."
mkdir -p "$COMBINATIONS_FOLDER"
for fork in "${forks[@]}"; do
    for da in "${data_availability[@]}"; do
        for comp in "${components[@]}"; do
            base_fork="$(extract_base_name "$fork")"
            base_da="$(extract_base_name "$da")"
            base_comp="$(extract_base_name "$comp")"


            # The legacy stack doesn't work with fork 12
            if [[ "$base_fork" == "fork12" && "$base_comp" == "legacy-zkevm-stack" ]]; then
                continue
            fi

            # The legacy stack also doesn't work with fork 13
            if [[ "$base_fork" == "fork13" && "$base_comp" == "legacy-zkevm-stack" ]]; then
                continue
            fi

            # The combination of fork 11 with the zkevm stack with validium mode does not work
            if [[ "$base_fork" == "fork11" && "$base_comp" == "legacy-zkevm-stack" && "$base_da" == "cdk-validium" ]]; then
                continue
            fi

            output_file="$COMBINATIONS_FOLDER/$base_fork-$base_comp-$base_da.yml"
            yq --slurp ".[0] * .[1] * .[2]" "$fork" "$da" "$comp" --yaml-output > "$output_file"
            echo "- $output_file"

            # Save version matrix for each fork.
            if [[ "$base_da" == "cdk-validium" && "$base_comp" == "new-cdk-stack" ]]; then
                fork_id=${base_fork#fork}
                # shellcheck disable=SC2016
                yq --raw-output \
                   --arg fork_id "$fork_id" \
                   --arg bridge_version "$default_bridge_version" \
                   --arg da_version "$default_da_version" \
                   --arg erigon_version "$default_erigon_version" \
                   --yaml-output '{
                    ($fork_id): {
                        cdk_erigon: {
                            version: $erigon_version,
                            source: "https://github.com/0xPolygonHermez/cdk-erigon/releases/tag/\($erigon_version)",
                        },
                        zkevm_prover: {
                            version: .args.zkevm_prover_image | split(":")[1],
                            source: "https://github.com/0xPolygonHermez/zkevm-prover/releases/tag/\(.args.zkevm_prover_image | split(":")[1] | split("-fork")[0])",
                        },
                        zkevm_contracts: {
                            version: .args.zkevm_contracts_image | split(":")[1] | split("-patch.")[0],
                            source: "https://github.com/0xPolygonHermez/zkevm-contracts/releases/tag/\(.args.zkevm_contracts_image | split(":")[1] | split("-patch.")[0])",
                        },
                        data_availability: {
                            version: $da_version,
                            source: "https://github.com/0xPolygon/cdk-data-availability/releases/tag/v\($da_version)",
                        },
                        bridge_service: {
                            version: $bridge_version,
                            source: "https://github.com/0xPolygonHermez/zkevm-bridge-service/releases/tag/\($bridge_version)",
                        },
                }}
                ' "$output_file" >> "$MATRIX_VERSION_FILE"
            fi
        done
    done
done
yml2md "$MATRIX_VERSION_FILE" >> "$MATRIX_VERSION_README"
echo "All combinations created!"