Merge branch 'thurau/nns-tools-support-swap-upgrade-testing' into 'master'

Allow for upgrading Swap type canisters when testing sns upgrade permutations

permutations 

See merge request dfinity-lab/public/ic!12597

Author: Daniel Thurau

testnet/tools/nns-tools/lib/canister_wasms.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-get_sns_canister_wasm_gz_for_type() {
+download_sns_canister_wasm_gz_for_type() {
     local CANISTER_TYPE=$1
     local VERSION=$2
 

testnet/tools/nns-tools/lib/functions.sh

@@ -21,7 +21,7 @@ propose_upgrade_canister_to_version_pem() {
 
     WASM_FILE=$(get_nns_canister_wasm_gz_for_type "$CANISTER_NAME" "$VERSION")
 
-    propose_upgrade_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_NAME" "$WASM_FILE" "$ENCODED_ARGS_FILE"
+    propose_upgrade_nns_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_NAME" "$WASM_FILE" "$ENCODED_ARGS_FILE"
 }
 
 build_canister_and_propose_upgrade_pem() {
@@ -36,7 +36,7 @@ build_canister_and_propose_upgrade_pem() {
 
     WASM_FILE="$(repo_root)/$(canister_bazel_artifact_path "${CANISTER_NAME}")"
 
-    propose_upgrade_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_NAME" "$WASM_FILE" "$ENCODED_ARGS_FILE"
+    propose_upgrade_nns_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_NAME" "$WASM_FILE" "$ENCODED_ARGS_FILE"
 }
 
 canister_bazel_label() {
@@ -74,7 +74,7 @@ canister_bazel_artifact_path() {
     bazel cquery --output=files $(canister_bazel_label "$CANISTER_NAME") 2>/dev/null
 }
 
-propose_upgrade_canister_wasm_file_pem() {
+propose_upgrade_nns_canister_wasm_file_pem() {
     ensure_variable_set IC_ADMIN
 
     local NNS_URL=$1
@@ -86,6 +86,19 @@ propose_upgrade_canister_wasm_file_pem() {
 
     CANISTER_ID=$(nns_canister_id "$CANISTER_NAME")
 
+    propose_upgrade_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_ID" "$WASM_FILE" "$ENCODED_ARGS_FILE"
+}
+
+propose_upgrade_canister_wasm_file_pem() {
+    ensure_variable_set IC_ADMIN
+
+    local NNS_URL=$1
+    local NEURON_ID=$2
+    local PEM=$3
+    local CANISTER_ID=$4
+    local WASM_FILE=$5
+    local ENCODED_ARGS_FILE=${6:-}
+
     # See note at variable declaration
     PROPOSAL="$MY_DOWNLOAD_DIR"/testnet_upgrade_proposal.txt
     echo "Testnet $CANISTER_NAME upgrade" >$PROPOSAL

testnet/tools/nns-tools/lib/proposals.sh

@@ -8,7 +8,7 @@ generate_sale_canister_upgrade_proposal_text() {
     local CANISTER_ID=$3
     local OUTPUT_FILE=${4:-}
 
-    WASM_GZ=$(get_sns_canister_wasm_gz_for_type "swap" "$NEXT_COMMIT")
+    WASM_GZ=$(download_sns_canister_wasm_gz_for_type "swap" "$NEXT_COMMIT")
     WASM_SHA=$(sha_256 "$WASM_GZ")
     CAPITALIZED_CANISTER_NAME="Swap"
     LAST_WASM_HASH=$(canister_hash ic $CANISTER_ID)
@@ -135,7 +135,7 @@ generate_sns_bless_wasm_proposal_text() {
     local CANISTER_TYPE=$3
     local OUTPUT_FILE=${4:-}
 
-    WASM_GZ=$(get_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$NEXT_COMMIT")
+    WASM_GZ=$(download_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$NEXT_COMMIT")
     WASM_SHA=$(sha_256 "$WASM_GZ")
     CAPITALIZED_CANISTER_TYPE="$(tr '[:lower:]' '[:upper:]' <<<${CANISTER_TYPE:0:1})${CANISTER_TYPE:1}"
 
@@ -421,7 +421,7 @@ validate_sns_version_wasm_sha() {
     local EXPECTED_SHA=$3
 
     _base_validate_version_wasm_sha \
-        $(get_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$VERSION") \
+        $(download_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$VERSION") \
         "$EXPECTED_SHA"
 }
 

testnet/tools/nns-tools/lib/sns_upgrades.sh

@@ -69,7 +69,7 @@ upload_canister_git_version_to_sns_wasm() {
     local CANISTER_TYPE=$4
     local VERSION=$5
 
-    WASM_GZ=$(get_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$VERSION")
+    WASM_GZ=$(download_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$VERSION")
 
     upload_wasm_to_sns_wasm "$NNS_URL" "$NEURON_ID" \
         "$PEM" "$CANISTER_TYPE" "$WASM_GZ"
@@ -167,7 +167,7 @@ wait_for_sns_canister_has_version() {
     local SNS_CANISTER_TYPE=$3
     local VERSION=$4
 
-    WASM=$(get_sns_canister_wasm_gz_for_type $SNS_CANISTER_TYPE $VERSION)
+    WASM=$(download_sns_canister_wasm_gz_for_type $SNS_CANISTER_TYPE $VERSION)
     wait_for_canister_has_file_contents "$NETWORK" "$CANISTER_ID" "$WASM"
 }
 

testnet/tools/nns-tools/submit-mainnet-publish-sns-wasm-proposal.sh

@@ -46,7 +46,7 @@ submit_nns_publish_sns_wasm_proposal_mainnet() {
     validate_sns_version_wasm_sha "$CANISTER_TYPE" "$VERSION" "$PROPOSAL_SHA"
     validate_no_todos "$PROPOSAL_FILE"
 
-    WASM_GZ=$(get_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$VERSION")
+    WASM_GZ=$(download_sns_canister_wasm_gz_for_type "$CANISTER_TYPE" "$VERSION")
     WASM_SHA=$(sha_256 $WASM_GZ)
 
     echo

testnet/tools/nns-tools/submit-mainnet-sale-canister-upgrade-proposal.sh

@@ -37,7 +37,7 @@ submit_sale_upgrade_proposal_mainnet() {
     validate_sns_version_wasm_sha "swap" "$VERSION" "$PROPOSAL_SHA"
     validate_no_todos "$PROPOSAL_FILE"
 
-    WASM_GZ=$(get_sns_canister_wasm_gz_for_type swap "$VERSION")
+    WASM_GZ=$(download_sns_canister_wasm_gz_for_type swap "$VERSION")
     WASM_SHA=$(sha_256 "$WASM_GZ")
 
     echo

testnet/tools/nns-tools/test-canister-upgrade.sh

@@ -61,7 +61,7 @@ if [ "$CANISTER_NAME" == "cycles-minting" ]; then
     # Get ungzipped version to make it easy to detect upgrade status
     CURRENT_VERSION_UNZIPPED=$(get_nns_canister_wasm_gz_for_type "$CANISTER_NAME" "$CURRENT_VERSION")
 
-    SKIP_STOPPING=yes propose_upgrade_canister_wasm_file_pem "$NNS_URL" \
+    SKIP_STOPPING=yes propose_upgrade_nns_canister_wasm_file_pem "$NNS_URL" \
         "$NEURON_ID" "$PEM" "$CANISTER_NAME" \
         "$CURRENT_VERSION_UNZIPPED" "$(encode_candid_args_in_file \
             "(record {
@@ -97,7 +97,7 @@ if [ "$NEW_HASH" == "$ORIGINAL_HASH" ]; then
 fi
 
 # We upgrade to same version but with a different hash so that we can verify that second upgrade worked.
-propose_upgrade_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_NAME" "$UNZIPPED" "$ENCODED_ARGS_FILE"
+propose_upgrade_nns_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_NAME" "$UNZIPPED" "$ENCODED_ARGS_FILE"
 
 if wait_for_nns_canister_has_file_contents "$NNS_URL" "$CANISTER_NAME" "$UNZIPPED"; then
     echo "Second upgrade successful..."

testnet/tools/nns-tools/test-sns-canister-upgrades.sh

@@ -32,6 +32,7 @@ CANISTERS="${@}"
 
 ensure_variable_set IDL2JSON
 ensure_variable_set SNS_QUILL
+ensure_variable_set IC_ADMIN
 
 ensure_variable_set NNS_URL
 ensure_variable_set SUBNET_URL
@@ -53,6 +54,39 @@ sns_canister_id_for_sns_canister_type() {
     cat $PWD/sns_canister_ids.json | jq -r ".${SNS_CANISTER_TYPE}_canister_id"
 }
 
+upgrade_swap() {
+    NNS_URL=$1
+    NEURON_ID=$2
+    PEM=$3
+    CANISTER_ID=$4
+    VERSION=$5
+
+    WASM_FILE=$(download_sns_canister_wasm_gz_for_type swap "$VERSION")
+
+    propose_upgrade_canister_wasm_file_pem "$NNS_URL" "$NEURON_ID" "$PEM" "$CANISTER_ID" "$WASM_FILE"
+}
+
+upgrade_sns() {
+    NNS_URL=$1
+    SUBNET_URL=$2
+    NEURON_ID=$3
+    PEM=$4
+    CANISTER_NAME=$5
+    VERSION=$6
+    LOG_FILE=$7
+    SWAP_CANISTER_ID=$8
+    GOV_CANISTER_ID=$9
+
+    # SNS upgrade proposal
+    if [[ $CANISTER_NAME = "swap" ]]; then
+        echo "Submitting upgrade proposal to NNS Governance for Swap" | tee -a "$LOG_FILE"
+        upgrade_swap "$NNS_URL" "$NEURON_ID" "$PEM" "$SWAP_CANISTER_ID" "$VERSION"
+    else
+        echo "Submitting upgrade proposal to $GOV_CANISTER_ID" | tee -a "$LOG_FILE"
+        sns_upgrade_to_next_version "$SUBNET_URL" "$PEM" "$GOV_CANISTER_ID" 0
+    fi
+}
+
 echo "$PERMUTATIONS" \
     | while read -r ORDERING; do
 
@@ -67,7 +101,8 @@ echo "$PERMUTATIONS" \
         echo "Deployed SNS" | tee -a $LOG_FILE
         cat $PWD/sns_canister_ids.json | tee -a $LOG_FILE
 
-        GOV_CANISTER=$(sns_canister_id_for_sns_canister_type governance)
+        GOV_CANISTER_ID=$(sns_canister_id_for_sns_canister_type governance)
+        SWAP_CANISTER_ID=$(sns_canister_id_for_sns_canister_type swap)
 
         # Assert that all canisters have the mainnet hashes so our test is legitimate
         canister_has_hash_installed $SUBNET_URL \
@@ -89,9 +124,8 @@ echo "$PERMUTATIONS" \
             upload_canister_git_version_to_sns_wasm "$NNS_URL" "$NEURON_ID" \
                 "$PEM" "$CANISTER" "$VERSION"
 
-            # SNS upgrade proposal
-            echo "Submitting upgrade proposal to $GOV_CANISTER" | tee -a $LOG_FILE
-            sns_upgrade_to_next_version "$SUBNET_URL" "$PEM" "$GOV_CANISTER" 0
+            upgrade_sns "$NNS_URL" "$SUBNET_URL" "$NEURON_ID" "$PEM" \
+                "$CANISTER" "$VERSION" "$LOG_FILE" "$SWAP_CANISTER_ID" "$GOV_CANISTER_ID"
 
             echo "Waiting for upgrade..." | tee -a $LOG_FILE
             if ! wait_for_sns_canister_has_version "$SUBNET_URL" \
@@ -100,7 +134,7 @@ echo "$PERMUTATIONS" \
                 break
             fi
 
-            WASM_GZ_FILE=$(get_sns_canister_wasm_gz_for_type "$CANISTER" "$VERSION")
+            WASM_GZ_FILE=$(download_sns_canister_wasm_gz_for_type "$CANISTER" "$VERSION")
 
             ORIGINAL_HASH=$(sha_256 $WASM_GZ_FILE)
             UNZIPPED=$(ungzip $WASM_GZ_FILE)
@@ -111,9 +145,9 @@ echo "$PERMUTATIONS" \
             fi
             upload_wasm_to_sns_wasm "$NNS_URL" "$NEURON_ID" \
                 "$PEM" "$CANISTER" "$UNZIPPED"
-            # SNS upgrade proposal
-            echo "Submitting unzipped proposal to $GOV_CANISTER" | tee -a $LOG_FILE
-            sns_upgrade_to_next_version "$SUBNET_URL" "$PEM" "$GOV_CANISTER" 0
+
+            upgrade_sns "$NNS_URL" "$SUBNET_URL" "$NEURON_ID" "$PEM" \
+                "$CANISTER" "$VERSION" "$LOG_FILE" "$SWAP_CANISTER_ID" "$GOV_CANISTER_ID"
 
             if ! wait_for_canister_has_file_contents "$SUBNET_URL" \
                 $(sns_canister_id_for_sns_canister_type $CANISTER) "$UNZIPPED"; then