forked from aptos-labs/aptos-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdev_setup.sh
executable file
·1121 lines (1021 loc) · 33 KB
/
dev_setup.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/bash
# Copyright © Aptos Foundation
# Parts of the project are originally copyright © Meta Platforms, Inc.
# SPDX-License-Identifier: Apache-2.0
# This script sets up the environment for the build by installing necessary dependencies.
#
# Usage ./dev_setup.sh <options>
# v - verbose, print all statements
# Assumptions for nix systems:
# 1 The running user is the user who will execute the builds.
# 2 .profile will be used to configure the shell
# 3 ${HOME}/bin/, or ${INSTALL_DIR} is expected to be on the path - hashicorp tools/etc. will be installed there on linux systems.
# fast fail.
set -eo pipefail
SHELLCHECK_VERSION=0.7.1
GRCOV_VERSION=0.8.2
KUBECTL_VERSION=1.18.6
TERRAFORM_VERSION=0.12.26
HELM_VERSION=3.2.4
VAULT_VERSION=1.5.0
Z3_VERSION=4.11.2
CVC5_VERSION=0.0.3
DOTNET_VERSION=6.0
BOOGIE_VERSION=3.0.9
ALLURE_VERSION=2.15.pr1135
# this is 3.21.4; the "3" is silent
PROTOC_VERSION=21.4
SOLC_VERSION="v0.8.11+commit.d7f03943"
SCRIPT_PATH="$(cd "$(dirname "$0")" >/dev/null 2>&1 && pwd)"
cd "$SCRIPT_PATH/.." || exit
function usage {
echo "Usage:"
echo "Installs or updates necessary dev tools for aptoslabs/aptos-core."
echo "-b batch mode, no user interactions and minimal output"
echo "-p update ${HOME}/.profile"
echo "-r install protoc and related tools"
echo "-t install build tools"
echo "-o install operations tooling as well: helm, terraform, yamllint, vault, docker, kubectl, python3"
echo "-y install or update Move Prover tools: z3, cvc5, dotnet, boogie"
echo "-d install tools for the Move documentation generator: graphviz"
echo "-a install tools for build and test api"
echo "-P install PostgreSQL"
echo "-J install js/ts tools"
echo "-v verbose mode"
echo "-i installs an individual tool by name"
echo "-n will target the /opt/ dir rather than the $HOME dir. /opt/bin/, /opt/rustup/, and /opt/dotnet/ rather than $HOME/bin/, $HOME/.rustup/, and $HOME/.dotnet/"
echo "-k skip pre-commit"
echo "If no toolchain component is selected with -t, -o, -y, -d, or -p, the behavior is as if -t had been provided."
echo "This command must be called from the root folder of the Aptos-core project."
}
function add_to_profile {
eval "$1"
FOUND=$(grep -c "$1" <"${HOME}/.profile" || true) # grep error return would kill the script.
if [ "$FOUND" == "0" ]; then
echo "$1" >>"${HOME}"/.profile
fi
}
# It is important to keep all path updates together to allow this script to work well when run in github actions
# inside of a docker image created using this script. GHA wipes the home directory via docker mount options, so
# this profile needs built and sourced on every execution of a job using the docker image. See the .github/actions/build-setup
# action in this repo, as well as docker/ci/github/Dockerfile.
function update_path_and_profile {
touch "${HOME}"/.profile
DOTNET_ROOT="$HOME/.dotnet"
BIN_DIR="$HOME/bin"
C_HOME="${HOME}/.cargo"
if [[ "$OPT_DIR" == "true" ]]; then
DOTNET_ROOT="/opt/dotnet"
BIN_DIR="/opt/bin"
C_HOME="/opt/cargo"
fi
mkdir -p "${BIN_DIR}"
if [ -n "$CARGO_HOME" ]; then
add_to_profile "export CARGO_HOME=\"${CARGO_HOME}\""
add_to_profile "export PATH=\"${BIN_DIR}:${CARGO_HOME}/bin:\$PATH\""
else
add_to_profile "export PATH=\"${BIN_DIR}:${C_HOME}/bin:\$PATH\""
fi
if [[ "$INSTALL_PROTOC" == "true" ]]; then
add_to_profile "export PATH=\$PATH:/usr/local/include"
fi
if [[ "$INSTALL_PROVER" == "true" ]]; then
add_to_profile "export DOTNET_ROOT=\"${DOTNET_ROOT}\""
add_to_profile "export PATH=\"${DOTNET_ROOT}/tools:\$PATH\""
add_to_profile "export Z3_EXE=\"${BIN_DIR}/z3\""
add_to_profile "export CVC5_EXE=\"${BIN_DIR}/cvc5\""
add_to_profile "export BOOGIE_EXE=\"${DOTNET_ROOT}/tools/boogie\""
fi
add_to_profile "export SOLC_EXE=\"${BIN_DIR}/solc\""
}
function install_build_essentials {
PACKAGE_MANAGER=$1
#Differently named packages for pkg-config
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
install_pkg build-essential "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "pacman" ]]; then
install_pkg base-devel "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "apk" ]]; then
install_pkg alpine-sdk "$PACKAGE_MANAGER"
install_pkg coreutils "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "yum" ]] || [[ "$PACKAGE_MANAGER" == "dnf" ]]; then
install_pkg gcc "$PACKAGE_MANAGER"
install_pkg gcc-c++ "$PACKAGE_MANAGER"
install_pkg make "$PACKAGE_MANAGER"
fi
#if [[ "$PACKAGE_MANAGER" == "brew" ]]; then
# install_pkg pkgconfig "$PACKAGE_MANAGER"
#fi
}
function install_protoc {
INSTALL_PROTOC="true"
echo "Installing protoc and plugins"
if command -v "${INSTALL_DIR}protoc" &>/dev/null && [[ "$("${INSTALL_DIR}protoc" --version || true)" =~ .*${PROTOC_VERSION}.* ]]; then
echo "protoc 3.${PROTOC_VERSION} already installed"
return
fi
if [[ "$(uname)" == "Linux" ]]; then
PROTOC_PKG="protoc-$PROTOC_VERSION-linux-x86_64"
elif [[ "$(uname)" == "Darwin" ]]; then
PROTOC_PKG="protoc-$PROTOC_VERSION-osx-universal_binary"
else
echo "protoc support not configured for this platform (uname=$(uname))"
return
fi
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/
(
cd "$TMPFILE" || exit
curl -LOs "https://github.com/protocolbuffers/protobuf/releases/download/v$PROTOC_VERSION/$PROTOC_PKG.zip" --retry 3
"${PRE_COMMAND[@]}" unzip -o "$PROTOC_PKG.zip" -d /usr/local bin/protoc
"${PRE_COMMAND[@]}" unzip -o "$PROTOC_PKG.zip" -d /usr/local 'include/*'
"${PRE_COMMAND[@]}" chmod +x "/usr/local/bin/protoc"
)
rm -rf "$TMPFILE"
# Install the cargo plugins
if ! command -v protoc-gen-prost &>/dev/null; then
cargo install protoc-gen-prost --locked
fi
if ! command -v protoc-gen-prost-serde &>/dev/null; then
cargo install protoc-gen-prost-serde --locked
fi
if ! command -v protoc-gen-prost-crate &>/dev/null; then
cargo install protoc-gen-prost-crate --locked
fi
}
function install_rustup {
echo installing rust.
BATCH_MODE=$1
if [[ "$OPT_DIR" == "true" ]]; then
export RUSTUP_HOME=/opt/rustup/
mkdir -p "$RUSTUP_HOME" || true
export CARGO_HOME=/opt/cargo/
mkdir -p "$CARGO_HOME" || true
fi
# Install Rust
if [[ "${BATCH_MODE}" == "false" ]]; then
echo "Installing Rust......"
fi
VERSION="$(rustup --version || true)"
if [ -n "$VERSION" ]; then
if [[ "${BATCH_MODE}" == "false" ]]; then
echo "Rustup is already installed, version: $VERSION"
fi
else
curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain stable
if [[ -n "${CARGO_HOME}" ]]; then
PATH="${CARGO_HOME}/bin:${PATH}"
else
PATH="${HOME}/.cargo/bin:${PATH}"
fi
fi
}
function install_vault {
VERSION=$("${INSTALL_DIR}"/vault --version || true)
if [[ "$VERSION" != "Vault v${VAULT_VERSION}" ]]; then
MACHINE=$(uname -m)
if [[ $MACHINE == "x86_64" ]]; then
MACHINE="amd64"
fi
TMPFILE=$(mktemp)
curl -sL -o "$TMPFILE" "https://releases.hashicorp.com/vault/${VAULT_VERSION}/vault_${VAULT_VERSION}_$(uname -s | tr '[:upper:]' '[:lower:]')_${MACHINE}.zip"
unzip -qq -d "$INSTALL_DIR" "$TMPFILE"
rm "$TMPFILE"
chmod +x "${INSTALL_DIR}"/vault
fi
"${INSTALL_DIR}"/vault --version
}
function install_helm {
if ! command -v helm &>/dev/null; then
if [[ $(uname -s) == "Darwin" ]]; then
install_pkg helm brew
else
MACHINE=$(uname -m)
if [[ $MACHINE == "x86_64" ]]; then
MACHINE="amd64"
fi
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/
curl -sL -o "$TMPFILE"/out.tar.gz "https://get.helm.sh/helm-v${HELM_VERSION}-$(uname -s | tr '[:upper:]' '[:lower:]')-${MACHINE}.tar.gz"
tar -zxvf "$TMPFILE"/out.tar.gz -C "$TMPFILE"/
cp "${TMPFILE}/$(uname -s | tr '[:upper:]' '[:lower:]')-${MACHINE}/helm" "${INSTALL_DIR}/helm"
rm -rf "$TMPFILE"
chmod +x "${INSTALL_DIR}"/helm
fi
fi
}
function install_terraform {
VERSION=$(terraform --version | head -1 || true)
if [[ "$VERSION" != "Terraform v${TERRAFORM_VERSION}" ]]; then
if [[ $(uname -s) == "Darwin" ]]; then
install_pkg tfenv brew
tfenv install ${TERRAFORM_VERSION}
tfenv use ${TERRAFORM_VERSION}
else
MACHINE=$(uname -m)
if [[ $MACHINE == "x86_64" ]]; then
MACHINE="amd64"
fi
TMPFILE=$(mktemp)
curl -sL -o "$TMPFILE" "https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_$(uname -s | tr '[:upper:]' '[:lower:]')_${MACHINE}.zip"
unzip -qq -d "${INSTALL_DIR}" "$TMPFILE"
rm "$TMPFILE"
chmod +x "${INSTALL_DIR}"/terraform
terraform --version
fi
fi
}
function install_kubectl {
VERSION=$(kubectl version client --short=true | head -1 || true)
if [[ "$VERSION" != "Client Version: v${KUBECTL_VERSION}" ]]; then
if [[ $(uname -s) == "Darwin" ]]; then
install_pkg kubectl brew
else
MACHINE=$(uname -m)
if [[ $MACHINE == "x86_64" ]]; then
MACHINE="amd64"
fi
curl -sL -o "${INSTALL_DIR}"/kubectl "https://storage.googleapis.com/kubernetes-release/release/v${KUBECTL_VERSION}/bin/$(uname -s | tr '[:upper:]' '[:lower:]')/${MACHINE}/kubectl"
chmod +x "${INSTALL_DIR}"/kubectl
fi
fi
kubectl version client --short=true | head -1 || true
}
function install_awscli {
PACKAGE_MANAGER=$1
if ! command -v aws &>/dev/null; then
if [[ $(uname -s) == "Darwin" ]]; then
install_pkg awscli brew
elif [[ "$PACKAGE_MANAGER" == "apk" ]]; then
apk add --no-cache python3 py3-pip &&
pip3 install --upgrade pip &&
pip3 install awscli
else
MACHINE=$(uname -m)
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/work/
curl -sL -o "$TMPFILE"/aws.zip "https://awscli.amazonaws.com/awscli-exe-$(uname -s | tr '[:upper:]' '[:lower:]')-${MACHINE}.zip"
unzip -qq -d "$TMPFILE"/work/ "$TMPFILE"/aws.zip
TARGET_DIR="${HOME}"/.local/
if [[ "$OPT_DIR" == "true" ]]; then
TARGET_DIR="/opt/aws/"
fi
mkdir -p "${TARGET_DIR}"
"$TMPFILE"/work/aws/install -i "${TARGET_DIR}" -b "${INSTALL_DIR}"
"${INSTALL_DIR}"aws --version
fi
fi
}
function install_s5cmd {
if command -v s5cmd &>/dev/null; then
echo "s5cmd exists, remove before reinstalling."
return
fi
if [[ $(uname -s) == "Darwin" ]]; then
install_pkg peak/tap/s5cmd brew
return
fi
if [[ $(uname -s) == "Linux" ]]; then
MACHINE=$(uname -m | tr '[:upper:]' '[:lower]')
SUFFIX=""
if [[ "$MACHINE" == "x86_64" ]]; then
SUFFIX="64bit"
elif [[ "$MACHINE" == "i386" ]] || [[ "$MACHINE" == "i686" ]]; then
SUFFIX="32bit"
elif
[[ "$MACHINE" == "aarch64_be" ]] ||
[[ "$MACHINE" == "aarch64" ]] ||
[[ "$MACHINE" == "armv8b" ]] ||
[[ "$MACHINE" == "armv8l" ]] \
;
then
SUFFIX="arm64"
elif [[ "$MACHINE" == "arm" ]]; then
SUFFIX="armv6"
fi
if [[ $SUFFIX != "" ]]; then
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/work/
curl -sL -o "$TMPFILE"/s5cmd.tar.gz https://github.com/peak/s5cmd/releases/download/v2.2.2/s5cmd_2.2.2_Linux-$SUFFIX.tar.gz
tar -C "$TMPFILE"/work -xzvf "$TMPFILE"/s5cmd.tar.gz
mv "$TMPFILE"/work/s5cmd "${INSTALL_DIR}"/
"${INSTALL_DIR}"s5cmd version
return
fi
fi
echo No good way to install s5cmd 'install_s5cmd '"$PACKAGE_MANAGER"
}
function install_pkg {
package=$1
PACKAGE_MANAGER=$2
PRE_COMMAND=()
if [ "$(whoami)" != 'root' ]; then
PRE_COMMAND=(sudo)
fi
if command -v "$package" &>/dev/null; then
echo "$package is already installed"
else
echo "Installing ${package}."
if [[ "$PACKAGE_MANAGER" == "yum" ]]; then
"${PRE_COMMAND[@]}" yum install "${package}" -y
elif [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
"${PRE_COMMAND[@]}" apt-get install "${package}" --no-install-recommends -y
echo apt-get install result code: $?
elif [[ "$PACKAGE_MANAGER" == "pacman" ]]; then
"${PRE_COMMAND[@]}" pacman -Syu "$package" --noconfirm
elif [[ "$PACKAGE_MANAGER" == "apk" ]]; then
apk --update add --no-cache "${package}"
elif [[ "$PACKAGE_MANAGER" == "dnf" ]]; then
dnf install "$package"
elif [[ "$PACKAGE_MANAGER" == "brew" ]]; then
brew install "$package"
fi
fi
}
function install_pkg_config {
PACKAGE_MANAGER=$1
#Differently named packages for pkg-config
if [[ "$PACKAGE_MANAGER" == "apt-get" ]] || [[ "$PACKAGE_MANAGER" == "dnf" ]]; then
install_pkg pkg-config "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "pacman" ]]; then
install_pkg pkgconf "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "brew" ]] || [[ "$PACKAGE_MANAGER" == "apk" ]] || [[ "$PACKAGE_MANAGER" == "yum" ]]; then
install_pkg pkgconfig "$PACKAGE_MANAGER"
fi
}
function install_shellcheck {
if ! command -v shellcheck &>/dev/null; then
if [[ $(uname -s) == "Darwin" ]]; then
install_pkg shellcheck brew
else
install_pkg xz "$PACKAGE_MANAGER"
MACHINE=$(uname -m)
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/
curl -sL -o "$TMPFILE"/out.xz "https://github.com/koalaman/shellcheck/releases/download/v${SHELLCHECK_VERSION}/shellcheck-v${SHELLCHECK_VERSION}.$(uname -s | tr '[:upper:]' '[:lower:]').${MACHINE}.tar.xz"
tar -xf "$TMPFILE"/out.xz -C "$TMPFILE"/
cp "${TMPFILE}/shellcheck-v${SHELLCHECK_VERSION}/shellcheck" "${INSTALL_DIR}/shellcheck"
rm -rf "$TMPFILE"
chmod +x "${INSTALL_DIR}"/shellcheck
fi
fi
}
function install_openssl_dev {
PACKAGE_MANAGER=$1
#Differently named packages for openssl dev
if [[ "$PACKAGE_MANAGER" == "apk" ]]; then
install_pkg openssl-dev "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
install_pkg libssl-dev "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "yum" ]] || [[ "$PACKAGE_MANAGER" == "dnf" ]]; then
install_pkg openssl-devel "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "pacman" ]] || [[ "$PACKAGE_MANAGER" == "brew" ]]; then
install_pkg openssl "$PACKAGE_MANAGER"
fi
}
function install_lcov {
PACKAGE_MANAGER=$1
#Differently named packages for lcov with different sources.
if [[ "$PACKAGE_MANAGER" == "apk" ]]; then
apk --update add --no-cache -X http://dl-cdn.alpinelinux.org/alpine/edge/testing lcov
fi
if [[ "$PACKAGE_MANAGER" == "apt-get" ]] || [[ "$PACKAGE_MANAGER" == "yum" ]] || [[ "$PACKAGE_MANAGER" == "dnf" ]] || [[ "$PACKAGE_MANAGER" == "brew" ]]; then
install_pkg lcov "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "pacman" ]]; then
echo nope no lcov for you.
echo You can try installing yourself with:
echo install_pkg git "$PACKAGE_MANAGER"
echo cd lcov
echo git clone https://aur.archlinux.org/lcov.git
echo makepkg -si --noconfirm
fi
}
function install_tidy {
PACKAGE_MANAGER=$1
#Differently named packages for tidy
if [[ "$PACKAGE_MANAGER" == "apk" ]]; then
apk --update add --no-cache -X http://dl-cdn.alpinelinux.org/alpine/edge/testing tidyhtml
else
install_pkg tidy "$PACKAGE_MANAGER"
fi
}
function install_toolchain {
version=$1
FOUND=$(rustup show | grep -c "$version" || true)
if [[ "$FOUND" == "0" ]]; then
echo "Installing ${version} of rust toolchain"
rustup install "$version"
else
echo "${version} rust toolchain already installed"
fi
}
function install_rustup_components_and_nightly {
echo "Printing the rustup version and toolchain list"
rustup --version
rustup show
rustup toolchain list -v
echo "Updating rustup and installing rustfmt & clippy"
rustup update
rustup component add rustfmt
rustup component add clippy
# We require nightly for strict rust formatting
echo "Installing the nightly toolchain and rustfmt nightly"
if ! rustup toolchain install nightly; then
if [[ "$(uname)" == "Linux" ]]; then
# TODO: remove this once we have an answer: https://github.com/rust-lang/rustup/issues/3390
echo "Failed to install the nightly toolchain using rustup! Falling back to an older linux build at 2023-06-01."
rustup toolchain install nightly-2023-06-01 # Fix the date to avoid flakiness
# Rename the toolchain to nightly (crazy... see: https://github.com/rust-lang/rustup/issues/1299).
# Note: this only works for linux. The primary purpose is to unblock CI/CD on flakes.
mv ~/.rustup/toolchains/nightly-2023-06-01-x86_64-unknown-linux-gnu ~/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu
else
echo "Failed to install the nightly toolchain using rustup! Manual installation is required!"
fi
fi
if ! rustup component add rustfmt --toolchain nightly; then
echo "Failed to install rustfmt nightly using rustup."
fi
}
function install_cargo_sort {
if ! command -v cargo-sort &>/dev/null; then
cargo install cargo-sort --locked
fi
}
function install_cargo_nextest {
if ! command -v cargo-nextest &>/dev/null; then
cargo install cargo-nextest --locked
fi
}
function install_grcov {
if ! command -v grcov &>/dev/null; then
cargo install grcov --version="${GRCOV_VERSION}" --locked
fi
}
function install_dotnet {
echo "Installing .Net"
mkdir -p "${DOTNET_INSTALL_DIR}" || true
if [[ $("${DOTNET_INSTALL_DIR}/dotnet" --list-sdks | grep -c "^${DOTNET_VERSION}" || true) == "0" ]]; then
if [[ "$(uname)" == "Linux" ]]; then
# Install various prerequisites for .dotnet. There are known bugs
# in the dotnet installer to warn even if they are present. We try
# to install anyway based on the warnings the dotnet installer creates.
if [ "$PACKAGE_MANAGER" == "apk" ]; then
install_pkg icu "$PACKAGE_MANAGER"
install_pkg zlib "$PACKAGE_MANAGER"
install_pkg libintl "$PACKAGE_MANAGER"
install_pkg libcurl "$PACKAGE_MANAGER"
elif [ "$PACKAGE_MANAGER" == "apt-get" ]; then
install_pkg gettext "$PACKAGE_MANAGER"
install_pkg zlib1g "$PACKAGE_MANAGER"
elif [ "$PACKAGE_MANAGER" == "yum" ] || [ "$PACKAGE_MANAGER" == "dnf" ]; then
install_pkg icu "$PACKAGE_MANAGER"
install_pkg zlib "$PACKAGE_MANAGER"
elif [ "$PACKAGE_MANAGER" == "pacman" ]; then
install_pkg icu "$PACKAGE_MANAGER"
install_pkg zlib "$PACKAGE_MANAGER"
fi
fi
# Below we need to (a) set TERM variable because the .net installer expects it and it is not set
# in some environments (b) use bash not sh because the installer uses bash features.
# NOTE: use wget to better follow the redirect
wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
chmod +x dotnet-install.sh
./dotnet-install.sh --channel $DOTNET_VERSION --install-dir "${DOTNET_INSTALL_DIR}" --version latest
rm dotnet-install.sh
else
echo Dotnet already installed.
fi
}
function install_boogie {
echo "Installing boogie"
mkdir -p "${DOTNET_INSTALL_DIR}tools/" || true
if [[ "$("${DOTNET_INSTALL_DIR}dotnet" tool list --tool-path "${DOTNET_INSTALL_DIR}tools/")" =~ .*boogie.*${BOOGIE_VERSION}.* ]]; then
echo "Boogie $BOOGIE_VERSION already installed"
else
"${DOTNET_INSTALL_DIR}dotnet" tool update --tool-path "${DOTNET_INSTALL_DIR}tools/" Boogie --version $BOOGIE_VERSION
fi
}
function install_z3 {
echo "Installing Z3"
if command -v /usr/local/bin/z3 &>/dev/null; then
echo "z3 already exists at /usr/local/bin/z3"
echo "but this install will go to ${INSTALL_DIR}/z3."
echo "you may want to remove the shared instance to avoid version confusion"
fi
if command -v "${INSTALL_DIR}z3" &>/dev/null && [[ "$("${INSTALL_DIR}z3" --version || true)" =~ .*${Z3_VERSION}.* ]]; then
echo "Z3 ${Z3_VERSION} already installed"
return
fi
if [[ "$(uname)" == "Linux" ]]; then
Z3_PKG="z3-$Z3_VERSION-x64-glibc-2.31"
elif [[ "$(uname)" == "Darwin" ]]; then
if [[ "$(uname -m)" == "arm64" ]]; then
Z3_PKG="z3-$Z3_VERSION-arm64-osx-11.0"
else
Z3_PKG="z3-$Z3_VERSION-x64-osx-10.16"
fi
else
echo "Z3 support not configured for this platform (uname=$(uname))"
return
fi
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/
(
cd "$TMPFILE" || exit
curl -LOs "https://github.com/Z3Prover/z3/releases/download/z3-$Z3_VERSION/$Z3_PKG.zip"
unzip -q "$Z3_PKG.zip"
cp "$Z3_PKG/bin/z3" "${INSTALL_DIR}"
chmod +x "${INSTALL_DIR}z3"
)
rm -rf "$TMPFILE"
}
function install_cvc5 {
echo "Installing cvc5"
if command -v /usr/local/bin/cvc5 &>/dev/null; then
echo "cvc5 already exists at /usr/local/bin/cvc5"
echo "but this install will go to $${INSTALL_DIR}cvc5."
echo "you may want to remove the shared instance to avoid version confusion"
fi
if command -v "${INSTALL_DIR}cvc5" &>/dev/null && [[ "$("${INSTALL_DIR}cvc5" --version || true)" =~ .*${CVC5_VERSION}.* ]]; then
echo "cvc5 ${CVC5_VERSION} already installed"
return
fi
if [[ "$(uname)" == "Linux" ]]; then
CVC5_PKG="cvc5-Linux"
elif [[ "$(uname)" == "Darwin" ]]; then
CVC5_PKG="cvc5-macOS"
else
echo "cvc5 support not configured for this platform (uname=$(uname))"
return
fi
TMPFILE=$(mktemp)
rm "$TMPFILE"
mkdir -p "$TMPFILE"/
(
cd "$TMPFILE" || exit
curl -LOs "https://github.com/cvc5/cvc5/releases/download/cvc5-$CVC5_VERSION/$CVC5_PKG" || true
cp "$CVC5_PKG" "${INSTALL_DIR}cvc5" || true
chmod +x "${INSTALL_DIR}cvc5" || true
)
rm -rf "$TMPFILE"
}
function install_allure {
VERSION="$(allure --version || true)"
if [[ "$VERSION" != "${ALLURE_VERSION}" ]]; then
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
"${PRE_COMMAND[@]}" apt-get install default-jre -y --no-install-recommends
export ALLURE=${HOME}/allure_"${ALLURE_VERSION}"-1_all.deb
curl -sL -o "$ALLURE" "https://github.com/diem/allure2/releases/download/${ALLURE_VERSION}/allure_${ALLURE_VERSION}-1_all.deb"
"${PRE_COMMAND[@]}" dpkg -i "$ALLURE"
rm "$ALLURE"
elif [[ "$PACKAGE_MANAGER" == "apk" ]]; then
apk --update add --no-cache -X http://dl-cdn.alpinelinux.org/alpine/edge/community openjdk11
else
echo No good way to install allure 'install_pkg allure '"$PACKAGE_MANAGER"
fi
fi
}
function install_xsltproc {
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
install_pkg xsltproc "$PACKAGE_MANAGER"
else
install_pkg libxslt "$PACKAGE_MANAGER"
fi
}
function install_nodejs {
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
# install via nodesource: https://github.com/nodesource/distributions/issues/1709#issuecomment-1788473588
NODE_MAJOR=18
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | "${PRE_COMMAND[@]}" tee /etc/apt/sources.list.d/nodesource.list
fi
install_pkg nodejs "$PACKAGE_MANAGER"
install_pkg npm "$PACKAGE_MANAGER"
}
function install_solidity {
echo "Installing Solidity compiler"
if [ -f "${INSTALL_DIR}solc" ]; then
echo "Solidity already installed at ${INSTALL_DIR}solc"
return
fi
# We fetch the binary from https://binaries.soliditylang.org
if [[ "$(uname)" == "Linux" ]]; then
SOLC_BIN="linux-amd64/solc-linux-amd64-${SOLC_VERSION}"
elif [[ "$(uname)" == "Darwin" ]]; then
SOLC_BIN="macosx-amd64/solc-macosx-amd64-${SOLC_VERSION}"
else
echo "Solidity support not configured for this platform (uname=$(uname))"
return
fi
curl -o "${INSTALL_DIR}solc" "https://binaries.soliditylang.org/${SOLC_BIN}"
chmod +x "${INSTALL_DIR}solc"
}
function install_pnpm {
curl -fsSL https://get.pnpm.io/install.sh | "${PRE_COMMAND[@]}" env PNPM_VERSION=8.2.0 SHELL="$(which bash)" bash -
}
function install_python3 {
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
install_pkg python3-all-dev "$PACKAGE_MANAGER"
install_pkg python3-setuptools "$PACKAGE_MANAGER"
install_pkg python3-pip "$PACKAGE_MANAGER"
elif [[ "$PACKAGE_MANAGER" == "apk" ]]; then
install_pkg python3-dev "$PACKAGE_MANAGER"
else
install_pkg python3 "$PACKAGE_MANAGER"
fi
}
function install_postgres {
if [[ "$PACKAGE_MANAGER" == "apt-get" ]] || [[ "$PACKAGE_MANAGER" == "apk" ]]; then
install_pkg libpq-dev "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "pacman" ]] || [[ "$PACKAGE_MANAGER" == "yum" ]]; then
install_pkg postgresql-libs "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "dnf" ]]; then
install_pkg libpq-devel "$PACKAGE_MANAGER"
fi
if [[ "$PACKAGE_MANAGER" == "brew" ]]; then
install_pkg postgresql "$PACKAGE_MANAGER"
fi
}
function install_lld {
# Right now, only install lld for linux
if [[ "$(uname)" == "Linux" ]]; then
install_pkg lld "$PACKAGE_MANAGER"
fi
}
function install_libdw {
# Right now, only install libdw for linux
if [[ "$(uname)" == "Linux" ]]; then
install_pkg libdw-dev "$PACKAGE_MANAGER"
fi
}
# this is needed for hdpi crate from aptos-ledger
function install_libudev-dev {
# Need to install libudev-dev for linux
if [[ "$(uname)" == "Linux" && "$PACKAGE_MANAGER" != "pacman" ]]; then
install_pkg libudev-dev "$PACKAGE_MANAGER"
fi
}
function welcome_message {
cat <<EOF
Welcome to Aptos!
This script will download and install the necessary dependencies needed to
build, test and inspect Aptos Core.
Based on your selection, these tools will be included:
EOF
if [[ "$INSTALL_BUILD_TOOLS" == "true" ]]; then
cat <<EOF
Build tools (since -t or no option was provided):
* Rust (and the necessary components, e.g. rust-fmt, clippy)
* CMake
* Clang
* grcov
* lcov
* pkg-config
* libssl-dev
* protoc (and related tools)
* lld (only for Linux)
EOF
fi
if [[ "$OPERATIONS" == "true" ]]; then
cat <<EOF
Operation tools (since -o was provided):
* yamllint
* python3
* docker
* vault
* terraform
* kubectl
* helm
* aws cli
* s5cmd
* allure
EOF
fi
if [[ "$INSTALL_PROVER" == "true" ]]; then
cat <<EOF
Move prover tools (since -y was provided):
* z3
* cvc5
* dotnet
* boogie
EOF
fi
if [[ "$INSTALL_DOC" == "true" ]]; then
cat <<EOF
tools for the Move documentation generator (since -d was provided):
* graphviz
EOF
fi
if [[ "$INSTALL_PROTOC" == "true" ]]; then
cat <<EOF
protoc and related plugins (since -r was provided):
* protoc
EOF
fi
if [[ "$INSTALL_API_BUILD_TOOLS" == "true" ]]; then
cat <<EOF
API build and testing tools (since -a was provided):
* Python3 (schemathesis)
EOF
fi
if [[ "$INSTALL_POSTGRES" == "true" ]]; then
cat <<EOF
PostgreSQL database (since -P was provided):
EOF
fi
if [[ "$INSTALL_JSTS" == "true" ]]; then
cat <<EOF
Javascript/TypeScript tools (since -J was provided):
* node.js
* pnpm
* solidity
EOF
fi
if [[ "$INSTALL_PROFILE" == "true" ]]; then
cat <<EOF
Moreover, ~/.profile will be updated (since -p was provided).
EOF
fi
cat <<EOF
If you'd prefer to install these dependencies yourself, please exit this script
now with Ctrl-C.
EOF
}
BATCH_MODE=false
# set verbose if not interactive.
if [[ ! (-t 2) ]]; then
VERBOSE=true
else
VERBOSE=false
fi
INSTALL_BUILD_TOOLS=false
OPERATIONS=false
INSTALL_PROFILE=false
INSTALL_PROVER=false
INSTALL_DOC=false
INSTALL_PROTOC=false
INSTALL_API_BUILD_TOOLS=false
INSTALL_POSTGRES=false
INSTALL_JSTS=false
INSTALL_INDIVIDUAL=false
INSTALL_PACKAGES=()
INSTALL_DIR="${HOME}/bin/"
OPT_DIR="false"
SKIP_PRE_COMMIT=false
#parse args
while getopts "btoprvydaPJh:i:nk" arg; do
case "$arg" in
b)
BATCH_MODE="true"
;;
t)
INSTALL_BUILD_TOOLS="true"
;;
o)
OPERATIONS="true"
;;
p)
INSTALL_PROFILE="true"
;;
r)
INSTALL_PROTOC="true"
;;
v)
VERBOSE=true
;;
y)
INSTALL_PROVER="true"
;;
d)
INSTALL_DOC="true"
;;
a)
INSTALL_API_BUILD_TOOLS="true"
;;
P)
INSTALL_POSTGRES="true"
;;
J)
INSTALL_JSTS="true"
;;
i)
INSTALL_INDIVIDUAL="true"
echo "$OPTARG"
INSTALL_PACKAGES+=("$OPTARG")
;;
n)
OPT_DIR="true"
;;
k)
SKIP_PRE_COMMIT="true"
;;
*)
usage
exit 0
;;
esac
done
if [[ "$VERBOSE" == "true" ]]; then
set -x
fi
if [[ "$INSTALL_BUILD_TOOLS" == "false" ]] &&
[[ "$OPERATIONS" == "false" ]] &&
[[ "$INSTALL_PROFILE" == "false" ]] &&
[[ "$INSTALL_PROVER" == "false" ]] &&
[[ "$INSTALL_DOC" == "false" ]] &&
[[ "$INSTALL_API_BUILD_TOOLS" == "false" ]] &&
[[ "$INSTALL_POSTGRES" == "false" ]] &&
[[ "$INSTALL_JSTS" == "false" ]] &&
[[ "$INSTALL_INDIVIDUAL" == "false" ]]; then
INSTALL_BUILD_TOOLS="true"
fi
if [ ! -f rust-toolchain.toml ]; then
echo "Unknown location. Please run this from the aptos-core repository. Abort."
exit 1
fi
if [[ "${OPT_DIR}" == "true" ]]; then
INSTALL_DIR="/opt/bin/"
fi
mkdir -p "$INSTALL_DIR" || true
PRE_COMMAND=()
if [ "$(whoami)" != 'root' ]; then
PRE_COMMAND=(sudo)
fi
PACKAGE_MANAGER=
if [[ "$(uname)" == "Linux" ]]; then
if command -v yum &>/dev/null; then
PACKAGE_MANAGER="yum"
elif command -v apt-get &>/dev/null; then
PACKAGE_MANAGER="apt-get"
elif command -v pacman &>/dev/null; then
PACKAGE_MANAGER="pacman"
elif command -v apk &>/dev/null; then
PACKAGE_MANAGER="apk"
elif command -v dnf &>/dev/null; then
echo "WARNING: dnf package manager support is experimental"
PACKAGE_MANAGER="dnf"
else
echo "Unable to find supported package manager (yum, apt-get, dnf, or pacman). Abort"
exit 1
fi
elif [[ "$(uname)" == "Darwin" ]]; then
if command -v brew &>/dev/null; then
PACKAGE_MANAGER="brew"
else
echo "Missing package manager Homebrew (https://brew.sh/). Abort"
exit 1
fi
else
echo "Unknown OS. Abort."
exit 1
fi
if [[ "$BATCH_MODE" == "false" ]]; then
welcome_message
printf "Proceed with installing necessary dependencies? (y/N) > "
read -e -r input
if [[ "$input" != "y"* ]]; then
echo "Exiting..."
exit 0
fi
fi
if [[ "$PACKAGE_MANAGER" == "apt-get" ]]; then
if [[ "$BATCH_MODE" == "false" ]]; then
echo "Updating apt-get......"
fi
"${PRE_COMMAND[@]}" apt-get update
if [[ "$BATCH_MODE" == "false" ]]; then
echo "Installing ca-certificates......"
fi
install_pkg ca-certificates "$PACKAGE_MANAGER"
fi
if [[ "$INSTALL_PROFILE" == "true" ]]; then
update_path_and_profile
fi
install_pkg curl "$PACKAGE_MANAGER"
install_pkg unzip "$PACKAGE_MANAGER"
install_pkg wget "$PACKAGE_MANAGER"
if [[ "$INSTALL_BUILD_TOOLS" == "true" ]]; then
install_build_essentials "$PACKAGE_MANAGER"
install_pkg cmake "$PACKAGE_MANAGER"
install_pkg clang "$PACKAGE_MANAGER"
install_pkg llvm "$PACKAGE_MANAGER"