Merge pull request #831 from CosmWasm/dev-scripts-to-files

Move development scripts to files; Add shell formatter

Author: webmaster128

README.md

@@ -322,30 +322,13 @@ nightly toolchain installed as well.
 **Workspace**
 
 ```sh
-cargo fmt \
-  && (cd packages/crypto && cargo build && cargo test && cargo clippy -- -D warnings) \
-  && (cd packages/std && cargo wasm-debug --features iterator && cargo test --features iterator && cargo clippy --features iterator -- -D warnings && cargo schema) \
-  && (cd packages/storage && cargo build && cargo test --features iterator && cargo clippy --features iterator -- -D warnings) \
-  && (cd packages/schema && cargo build && cargo test && cargo clippy -- -D warnings) \
-  && (cd packages/vm && cargo build --features iterator,stargate && cargo test --features iterator,stargate && cargo clippy --features iterator,stargate -- -D warnings)
+./devtools/check_workspace.sh
 ```
 
 **Contracts**
 
-Step 1 (fast checks, rebuilds lock files)
-
-```sh
-for contract_dir in contracts/*/; do (cd "$contract_dir" && cargo check --tests) || break; done
-```
-
-Step 2 (medium fast checks)
-
-```sh
-for contract_dir in contracts/*/; do (cd "$contract_dir" && cargo fmt && cargo check --tests && cargo wasm-debug && cargo unit-test && cargo clippy --tests -- -D warnings && cargo schema) || break; done
-```
-
-Step 3 (slower checks)
-
-```sh
-for contract_dir in contracts/*/; do (cd "$contract_dir" && cargo wasm && cargo integration-test) || break; done
-```
+| Step | Description                      | Command                                |
+| ---- | -------------------------------- | -------------------------------------- |
+| 1    | fast checks, rebuilds lock files | `./devtools/check_contracts_fast.sh`   |
+| 2    | medium fast checks               | `./devtools/check_contracts_medium.sh` |
+| 3    | slower checks                    | `./devtools/check_contracts_full.sh`   |

devtools/check_contracts_fast.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -o errexit -o nounset -o pipefail
+command -v shellcheck >/dev/null && shellcheck "$0"
+
+for contract_dir in contracts/*/; do
+  (
+    cd "$contract_dir"
+    cargo fmt
+    cargo check --tests
+  )
+done

devtools/check_contracts_full.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -o errexit -o nounset -o pipefail
+command -v shellcheck >/dev/null && shellcheck "$0"
+
+for contract_dir in contracts/*/; do
+  (
+    cd "$contract_dir"
+    cargo fmt
+    cargo check --tests
+    cargo unit-test
+    cargo clippy --tests -- -D warnings
+    cargo schema
+    cargo wasm
+    cargo integration-test
+  )
+done

devtools/check_contracts_medium.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -o errexit -o nounset -o pipefail
+command -v shellcheck >/dev/null && shellcheck "$0"
+
+for contract_dir in contracts/*/; do
+  (
+    cd "$contract_dir"
+    cargo fmt
+    cargo check --tests
+    cargo unit-test
+    cargo clippy --tests -- -D warnings
+    cargo schema
+    cargo wasm-debug
+  )
+done

devtools/check_workspace.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -o errexit -o nounset -o pipefail
+command -v shellcheck >/dev/null && shellcheck "$0"
+
+cargo fmt
+(cd packages/crypto && cargo build && cargo test && cargo clippy -- -D warnings)
+(cd packages/std && cargo wasm-debug --features iterator && cargo test --features iterator && cargo clippy --features iterator -- -D warnings && cargo schema)
+(cd packages/storage && cargo build && cargo test --features iterator && cargo clippy --features iterator -- -D warnings)
+(cd packages/schema && cargo build && cargo test && cargo clippy -- -D warnings)
+(cd packages/vm && cargo build --features iterator,stargate && cargo test --features iterator,stargate && cargo clippy --features iterator,stargate -- -D warnings)

devtools/format_md.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 set -o errexit -o nounset -o pipefail
-command -v shellcheck > /dev/null && shellcheck "$0"
+command -v shellcheck >/dev/null && shellcheck "$0"
 
 npx [email protected] --write --prose-wrap always "./**/*.md"

devtools/format_sh.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -o errexit -o nounset -o pipefail
+command -v shellcheck >/dev/null && shellcheck "$0"
+
+shfmt -w devtools packages

devtools/format_yml.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 set -o errexit -o nounset -o pipefail
-command -v shellcheck > /dev/null && shellcheck "$0"
+command -v shellcheck >/dev/null && shellcheck "$0"
 
 npx [email protected] --write "./**/*.yml"

devtools/set_version.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -o errexit -o nounset -o pipefail
-command -v shellcheck > /dev/null && shellcheck "$0"
+command -v shellcheck >/dev/null && shellcheck "$0"
 
 gnused="$(command -v gsed || echo sed)"
 
@@ -11,8 +11,8 @@ function print_usage() {
 }
 
 if [ "$#" -ne 1 ]; then
-    print_usage
-    exit 1
+  print_usage
+  exit 1
 fi
 
 # Check repo
@@ -25,9 +25,9 @@ fi
 # Ensure repo is not dirty
 CHANGES_IN_REPO=$(git status --porcelain)
 if [[ -n "$CHANGES_IN_REPO" ]]; then
-    echo "Repository is dirty. Showing 'git status' and 'git --no-pager diff' for debugging now:"
-    git status && git --no-pager diff
-    exit 3
+  echo "Repository is dirty. Showing 'git status' and 'git --no-pager diff' for debugging now:"
+  git status && git --no-pager diff
+  exit 3
 fi
 
 NEW="$1"

packages/vm/examples/module_size.sh

@@ -11,8 +11,8 @@ PROFILE="release"
 MEM_UTIL="valgrind --tool=massif --max-snapshots=$MAX_SNAPSHOTS"
 SUM_UTIL="ms_print"
 
-PROG=`basename $0 .sh`
-BASE_DIR=`dirname $0`/..
+PROG=$(basename $0 .sh)
+BASE_DIR=$(dirname $0)/..
 
 # Look for the useful info
 FNS="module_compile module_deserialize"
@@ -22,8 +22,7 @@ BIN="$BASE_DIR/../../target/$PROFILE/examples/$PROG"
 RESULTS="$BASE_DIR/$PROG.log"
 SUMMARY="$BASE_DIR/ms_print.log"
 
-if [ "$PROFILE" = "release" ]
-then
+if [ "$PROFILE" = "release" ]; then
   RUSTFLAGS="-g" cargo build --release --example module_size
 else
   cargo build --example module_size
@@ -32,18 +31,16 @@ fi
 $MEM_UTIL --massif-out-file=$RESULTS $BIN $WASM
 $SUM_UTIL $RESULTS >$SUMMARY
 
-for FN in $FNS
-do
+for FN in $FNS; do
   # Try to compute $FN() total (heap) bytes
-  LAST_LINE=`grep -n "::$FN " $SUMMARY| tail -1 | cut -f1 -d:`
-  if [ -z "$LAST_LINE" ]
-  then
+  LAST_LINE=$(grep -n "::$FN " $SUMMARY | tail -1 | cut -f1 -d:)
+  if [ -z "$LAST_LINE" ]; then
     echo -n "'$FN' not found. "
     [ $MAX_SNAPSHOTS -lt 1000 ] && echo "Try increasing MAX_SNAPSHOTS (current: $MAX_SNAPSHOTS, max: 1000). " || echo "Try again."
     continue
   fi
-  TOTAL_LINES=`wc -l $SUMMARY | cut -f1 -d\ `
-  START_LINE=$[TOTAL_LINES - $LAST_LINE + 1]
+  TOTAL_LINES=$(wc -l $SUMMARY | cut -f1 -d\ )
+  START_LINE=$((TOTAL_LINES - $LAST_LINE + 1))
   echo -n "module size ($FN): "
   tac $SUMMARY | sed -n "$START_LINE,/^  n /p" | grep "::$FN " | cut -f2 -d\( | cut -f1 -d\) | sort -u | sed 's/,//g;s/B//' | sed ':a;N;s/\n/+/;ta' | bc -l | sed 's/$/ bytes/'
 done