Test release builds using Firefly (#407)

* Jenkinsfile: correct directory for arch dockerfile

* Jenkinsfile: RELEASE_ID => KEVM_RELEASE_ID variable name

* Jenkinsfile, deps/k_release, package/Dockerfile: retrieve K_RELEASE to use from file

* Jenkinsfile: set K_RELEASE after checkout

* Jenkinsfile: escape literal $

* Jenkinsfile: capture stdout for getting K_RELEASE

* package/Dockerfile: echo the K_RELEASE being used, avoid setting default

* Makefile: add test-interactive-firefly target

* Jenkinsfile, package/Dockerfile: run firefly tests on releases

* Jenkinsfile, Dockerfile, package/Dockerfile.ubuntu-bionic: apt => apt-get

* package/Dockerfile.ubuntu-bionic: remove npm direct dependency

* package/Dockerfile.ubuntu-bionic: add sudo, create user manually

* Jenkinsfile: correction to installing kevm

* package/Dockerfile.ubuntu-bionic: get node 10 directly

* package/Dockerfile.ubuntu-bionic: install nodejs after setting up repos

* Makefile: run npm install after npx kevm-ganache-cli

* Jenkinsfile, package/Dockerfile: install npx in Dockerfiles

* Makefile: correctly run in openzeppelin subdirectory

* Makefile: keep background process from confusing shell &&

* Makefile: change into correct subdir

* Jenkinsfile: correct variable name for sh script

* Jenkinsfile: correct path to kevm-git package

* package/Dockerfile.arch: install base and base-devel

* Jenkinsfile: make sure K_RELEASE is set on Deploy phase

* Makefile: blow away openzeppelin-solidity directory if it exists

* Jenkinsfile: use git_commit variable directly

* Jenkinsfile: run upload block in repo subdir

* INSTALL: avoid you in install text

* Jenkinsfile: tag commit before pushing to avoid race

* Jenkinsfile: skip tag creation

* Makefile, Jenkinsfile: build release file as make target

* Jenkinsfile: use HEAD for commitish

* deps/k_release: update release dependency

* deps/k: update submodule dependency

* Jenkinsfile, package/Dockerfile: install K release after updating containers

* Jenkinsfile: release dockerfiles dont need K_RELEASE anymore

* Jenkinsfile: rename stage

* Jenkinsfile: get k_release from file directly instead of extra env setup

* Jenkinsfile: update failure message

* Jenkinsfile: add --yes to apt-get instructions

* package/Dockerfile.ubuntu-bionic: no need for `jq`

* deps/k_release: correct URL

* Jenkinsfile: --noconfirm option to pacman

* Makefile: peg specific commit of open zeppelin, run all tests

* Jenkinsfile, deps/k_release: get release from submodule peg

* Jenkinsfile: change to deps/k in subshell

* Makefile: only run ERC20 test on firefly

* Makefile: formatting

* Jenkinsfile: use current HEAD for release commit

* Jenkinsfile: fix typo

* Jenkinsfile: correct RELEASE_ID => KEVM_RELEASE_ID

* .ci: remove old file

* Jenkinsfile: build source tarball first

* Jenkinsfile: no committish flag

Author: ehildenb

.ci

@@ -4,12 +4,12 @@ ENV TZ=America/Chicago
 RUN    ln --symbolic --no-dereference --force /usr/share/zoneinfo/$TZ /etc/localtime \
     && echo $TZ > /etc/timezone
 
-RUN    apt update                                                               \
-    && apt upgrade --yes                                                        \
-    && apt install --yes                                                        \
-        autoconf bison clang-8 cmake curl flex gcc libboost-test-dev          \
+RUN    apt-get update                                                           \
+    && apt-get upgrade --yes                                                    \
+    && apt-get install --yes                                                    \
+        autoconf bison clang-8 cmake curl flex gcc libboost-test-dev            \
         libcrypto++-dev libffi-dev libjemalloc-dev libmpfr-dev libprocps-dev    \
-        libsecp256k1-dev libssl-dev libtool libyaml-dev lld-8 llvm-8-tools  \
+        libsecp256k1-dev libssl-dev libtool libyaml-dev lld-8 llvm-8-tools      \
         make maven opam openjdk-8-jdk pandoc pkg-config python3 python-pygments \
         python-recommonmark python-sphinx time zlib1g-dev protobuf-compiler     \
         libprotobuf-dev

Dockerfile

@@ -52,7 +52,7 @@ cp -r package/debian ./
 dpkg-buildpackage --no-sign
 ```
 
-This will throw an error for any build dependencies you're missing, install them with `sudo apt install ...`.
+This will throw an error for any missing build dependencies, install them with `sudo apt install ...`.
 The `kevm_X.Y.Z_amd64_ID.deb` package will be placed one directory up from the repository root.
 
 ### Arch

INSTALL.md

@@ -6,7 +6,7 @@ pipeline {
   stages {
     stage("Init title") {
       when {
-        changeRequest() 
+        changeRequest()
         beforeAgent true
       }
       steps {
@@ -148,7 +148,7 @@ pipeline {
         }
       }
     }
-    stage('Deploy') {
+    stage('Release') {
       when {
         not { changeRequest() }
         branch 'master'
@@ -157,89 +157,161 @@ pipeline {
       agent { label 'docker' }
       options { skipDefaultCheckout() }
       environment {
-        GITHUB_TOKEN = credentials('rv-jenkins')
-        RELEASE_ID   = '1.0.0'
+        GITHUB_TOKEN    = credentials('rv-jenkins')
+        KEVM_RELEASE_ID = '1.0.0'
       }
       stages {
-        stage('Checkout SCM') {
-          steps { dir("kevm-${env.RELEASE_ID}") { checkout scm } }
+        stage('Checkout SCM - Download K Release') {
+          steps {
+            dir("kevm-${env.KEVM_RELEASE_ID}") {
+              checkout scm
+              sh '''
+                commit_short=$(cd deps/k && git rev-parse --short HEAD)
+                K_RELEASE="https://github.com/kframework/k/releases/download/nightly-$commit_short"
+                curl --fail --location "${K_RELEASE}/kframework_5.0.0_amd64_bionic.deb"    --output kframework.deb
+                curl --fail --location "${K_RELEASE}/kframework-5.0.0-1-x86_64.pkg.tar.xz" --output kframework-git.pkg.tar.xz
+              '''
+              stash name: 'bionic-kframework', includes: 'kframework.deb'
+              stash name: 'arch-kframework',   includes: 'kframework-git.pkg.tar.xz'
+            }
+          }
         }
-        stage('Build Ubuntu Package') {
+        stage('Build Source Tarball') {
           agent {
             dockerfile {
-              dir "kevm-${env.RELEASE_ID}/package"
+              dir "kevm-${env.KEVM_RELEASE_ID}/package"
+              filename 'Dockerfile.arch'
+              additionalBuildArgs '--build-arg USER_ID=$(id -u) --build-arg GROUP_ID=$(id -g)'
+              reuseNode true
+            }
+          }
+          steps {
+            dir("kevm-${KEVM_RELEASE_ID}-src") {
+              checkout scm
+              sh '''
+                find . -name .git | xargs rm -r
+                rm -r deps/k tests/ethereum-tests deps/metropolis
+                cd ..
+                tar czvf kevm-${KEVM_RELEASE_ID}-src.tar.gz kevm-${KEVM_RELEASE_ID}-src
+              '''
+            }
+            stash name: 'src-kevm', includes: "kevm-${env.KEVM_RELEASE_ID}-src.tar.gz"
+          }
+        }
+        stage('Build Ubuntu Bionic Package') {
+          agent {
+            dockerfile {
+              dir "kevm-${env.KEVM_RELEASE_ID}/package"
               filename 'Dockerfile.ubuntu-bionic'
+              additionalBuildArgs '--build-arg USER_ID=$(id -u) --build-arg GROUP_ID=$(id -g)'
               reuseNode true
             }
           }
           steps {
-            dir("kevm-${env.RELEASE_ID}") {
+            dir("kevm-${env.KEVM_RELEASE_ID}") {
+              unstash 'bionic-kframework'
               sh '''
-                sudo apt update && sudo apt upgrade --yes
+                sudo apt-get update && sudo apt-get upgrade --yes
+                sudo apt-get install --yes ./kframework.deb
                 cp -r package/debian ./
                 dpkg-buildpackage --no-sign
               '''
             }
-            stash name: 'bionic', includes: "kevm_${env.RELEASE_ID}_amd64.deb"
+            stash name: 'bionic-kevm', includes: "kevm_${env.KEVM_RELEASE_ID}_amd64.deb"
+          }
+        }
+        stage('Test Ubuntu Bionic Package') {
+          agent {
+            dockerfile {
+              dir "kevm-${env.KEVM_RELEASE_ID}/package"
+              filename 'Dockerfile.ubuntu-bionic'
+              additionalBuildArgs '--build-arg USER_ID=$(id -u) --build-arg GROUP_ID=$(id -g)'
+              reuseNode true
+            }
+          }
+          steps {
+            dir("kevm-${env.KEVM_RELEASE_ID}") {
+              unstash 'bionic-kevm'
+              sh '''
+                sudo apt-get update && sudo apt-get upgrade --yes
+                sudo apt-get install --yes ./kevm_${KEVM_RELEASE_ID}_amd64.deb
+                make test-interactive-firefly
+              '''
+            }
           }
         }
         stage('Build Arch Package') {
           agent {
             dockerfile {
-              dir "kevm-${env.RELEASE_ID}/package"
+              dir "kevm-${env.KEVM_RELEASE_ID}/package"
               filename 'Dockerfile.arch'
               additionalBuildArgs '--build-arg USER_ID=$(id -u) --build-arg GROUP_ID=$(id -g)'
               reuseNode true
             }
           }
           steps {
-            dir("kevm-${env.RELEASE_ID}") {
+            dir("kevm-${env.KEVM_RELEASE_ID}") {
+              unstash 'arch-kframework'
               sh '''
                 sudo pacman -Syu --noconfirm
+                sudo pacman --noconfirm -U kframework-git.pkg.tar.xz
                 cd package
                 makepkg --noconfirm --syncdeps
               '''
             }
-            stash name: 'arch', includes: "kevm-${env.RELEASE_ID}/package/kevm-git-${env.RELEASE_ID}-1-x86_64.pkg.tar.xz"
+            stash name: 'arch-kevm', includes: "kevm-${env.KEVM_RELEASE_ID}/package/kevm-git-${env.KEVM_RELEASE_ID}-1-x86_64.pkg.tar.xz"
           }
         }
-        stage('Upload Packages') {
+        stage('Test Arch Package') {
           agent {
             dockerfile {
-              dir 'package'
+              dir "kevm-${env.KEVM_RELEASE_ID}/package"
               filename 'Dockerfile.arch'
+              additionalBuildArgs '--build-arg USER_ID=$(id -u) --build-arg GROUP_ID=$(id -g)'
               reuseNode true
             }
           }
           steps {
-            unstash 'bionic'
-            unstash 'arch'
-            dir("kevm-${env.RELEASE_ID}") {
-              checkout scm
+            dir("kevm-${env.KEVM_RELEASE_ID}") {
+              unstash 'arch-kevm'
               sh '''
-                find . -name .git | xargs rm -r
-                rm -r deps/k tests/ethereum-tests deps/metropolis
-                cd ..
-                tar czvf kevm-${RELEASE_ID}.tar.gz kevm-${RELEASE_ID}
+                sudo pacman -Syu --noconfirm
+                sudo pacman --noconfirm -U package/kevm-git-${KEVM_RELEASE_ID}-1-x86_64.pkg.tar.xz
+                make test-interactive-firefly
               '''
             }
+          }
+        }
+        stage('Upload Release') {
+          agent {
+            dockerfile {
+              dir "kevm-${env.KEVM_RELEASE_ID}/package"
+              filename 'Dockerfile.arch'
+              additionalBuildArgs '--build-arg USER_ID=$(id -u) --build-arg GROUP_ID=$(id -g)'
+              reuseNode true
+            }
+          }
+          steps {
+            unstash 'src-kevm'
+            unstash 'bionic-kevm'
+            unstash 'arch-kevm'
             sh '''
-              git_commit=$(cd kevm-$RELEASE_ID && git rev-parse --short HEAD)
-              hub release create                                                                                            \
-                  --attach "kevm_${RELEASE_ID}_amd64.deb#Ubuntu Bionic (18.04) Package"                                     \
-                  --attach "kevm-${RELEASE_ID}/package/kevm-git-${RELEASE_ID}-1-x86_64.pkg.tar.xz#Arch Package"             \
-                  --attach "kevm-${RELEASE_ID}.tar.gz#Source tar.gz"                                                        \
-                  --message "$(echo -e "KEVM Release $RELEASE_ID - $git_commit\n\n" ; cat kevm-${RELEASE_ID}/INSTALL.md ;)" \
-                  --commitish $(git rev-parse HEAD) "v$RELEASE_ID-$git_commit"
+              release_tag="v${KEVM_RELEASE_ID}-$(git rev-parse --short HEAD)"
+              make release.md KEVM_RELEASE_TAG=${release_tag}
+              hub release create                                                                                          \
+                  --attach "kevm-${KEVM_RELEASE_ID}-src.tar.gz#Source tar.gz"                                             \
+                  --attach "kevm_${KEVM_RELEASE_ID}_amd64.deb#Ubuntu Bionic (18.04) Package"                              \
+                  --attach "kevm-${KEVM_RELEASE_ID}/package/kevm-git-${KEVM_RELEASE_ID}-1-x86_64.pkg.tar.xz#Arch Package" \
+                  --file "release.md" "${release_tag}"
             '''
           }
         }
       }
       post {
         failure {
-          slackSend color: '#cb2431'                                   \
-                  , channel: '#kevm'                                   \
-                  , message: "KEVM Packaging Failed: ${env.BUILD_URL}"
+          slackSend color: '#cb2431'                                 \
+                  , channel: '#kevm'                                 \
+                  , message: "KEVM Release Failed: ${env.BUILD_URL}"
         }
       }
     }

Jenkinsfile

@@ -41,7 +41,7 @@ export LUA_PATH
         test test-all test-conformance test-slow-conformance test-all-conformance \
         test-vm test-slow-vm test-all-vm test-bchain test-slow-bchain test-all-bchain \
         test-proof test-klab-prove test-parse test-failure \
-        test-interactive test-interactive-help test-interactive-run test-interactive-prove test-interactive-search \
+        test-interactive test-interactive-help test-interactive-run test-interactive-prove test-interactive-search test-interactive-firefly \
         media media-pdf sphinx metropolis-theme
 .SECONDARY:
 
@@ -306,11 +306,11 @@ $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/plugin/proto/msg.pb.cc: $(PLUGIN_SUB
 $(node_kompiled): $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/interpreter $(libff_out)
 	mkdir -p $(DEFN_DIR)/vm
 	$(K_BIN)/llvm-kompile $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/definition.kore $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/dt library $(PLUGIN_SUBMODULE)/vm-c/main.cpp $(PLUGIN_SUBMODULE)/vm-c/vm.cpp \
-                          $(PLUGIN_SUBMODULE)/plugin-c/*.cpp $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/plugin/proto/msg.pb.cc $(PLUGIN_SUBMODULE)/vm-c/kevm/semantics.cpp -o $@ -g -O2 \
-                          -I $(PLUGIN_SUBMODULE)/plugin-c/ -I $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/plugin -I $(PLUGIN_SUBMODULE)/vm-c/ -I $(PLUGIN_SUBMODULE)/vm-c/kevm/ -I node/ \
-                          $(LLVM_KOMPILE_OPTS) \
-                          -L$(LIBRARY_PATH) \
-                          -lff -lprotobuf -lgmp $(LINK_PROCPS) -lcryptopp -lsecp256k1
+	                      $(PLUGIN_SUBMODULE)/plugin-c/*.cpp $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/plugin/proto/msg.pb.cc $(PLUGIN_SUBMODULE)/vm-c/kevm/semantics.cpp -o $@ -g -O2 \
+	                      -I $(PLUGIN_SUBMODULE)/plugin-c/ -I $(DEFN_DIR)/node/$(MAIN_DEFN_FILE)-kompiled/plugin -I $(PLUGIN_SUBMODULE)/vm-c/ -I $(PLUGIN_SUBMODULE)/vm-c/kevm/ -I node/ \
+	                      $(LLVM_KOMPILE_OPTS) \
+	                      -L$(LIBRARY_PATH) \
+	                      -lff -lprotobuf -lgmp $(LINK_PROCPS) -lcryptopp -lsecp256k1
 
 # LLVM Backend
 
@@ -329,10 +329,17 @@ $(llvm_kompiled): $(llvm_files) $(libff_out)
 # Installing
 # ----------
 
+KEVM_RELEASE_TAG?=
+
 install: $(node_kompiled)
 	mkdir -p $(INSTALL_DIR)
 	cp $(node_kompiled) $(INSTALL_DIR)/
 
+release.md: INSTALL.md
+	echo "KEVM Release $(KEVM_RELEASE_TAG)"  > $@
+	echo                                    >> $@
+	cat INSTALL.md                          >> $@
+
 # Tests
 # -----
 
@@ -467,6 +474,18 @@ test-interactive-search: $(search_tests:=.search)
 test-interactive-help:
 	$(TEST) help
 
+# Notice that `npm install` comes after `npx kevm-ganache-cli` to allow time for it to start up.
+test-interactive-firefly:
+	mkdir -p $(BUILD_DIR)/firefly
+	cd $(BUILD_DIR)/firefly                                                  \
+	    && rm -rf openzeppelin-solidity                                      \
+	    && git clone 'https://github.com/openzeppelin/openzeppelin-solidity' \
+	    && cd openzeppelin-solidity                                          \
+	    && git checkout b8c8308                                              \
+	    && { npx kevm-ganache-cli & }                                        \
+	    && npm install                                                       \
+	    && npx truffle test test/token/ERC20/ERC20.test.js
+
 # Media
 # -----
 

Makefile

@@ -1,10 +1,9 @@
 FROM archlinux/base
 
 RUN    pacman -Syu --noconfirm \
-    && pacman -S   --noconfirm git hub sudo
+    && pacman -S   --noconfirm base base-devel curl gcc git hub make nodejs npm python2 sudo
 
-ADD https://github.com/kframework/k/releases/download/nightly-89361d7c8/kframework-5.0.0-1-x86_64.pkg.tar.xz kframework_5.0.0-1_x86_64.pkg.tar.xz
-RUN pacman --noconfirm -U ./kframework_5.0.0-1_x86_64.pkg.tar.xz
+RUN npm install -g npx
 
 ARG USER_ID=1000
 ARG GROUP_ID=1000

deps/k

@@ -4,11 +4,18 @@ ENV TZ=America/Chicago
 RUN    ln --symbolic --no-dereference --force /usr/share/zoneinfo/$TZ /etc/localtime \
     && echo $TZ > /etc/timezone
 
-RUN    apt update                                                                        \
-    && apt upgrade --yes                                                                 \
-    && apt install --yes clang-8 cmake curl dh-make jq libcrypto++-dev libjemalloc-dev \
-                         libprocps-dev libprotobuf-dev libsecp256k1-dev libssl-dev       \
-                         pandoc pkg-config protobuf-compiler
-
-ADD https://github.com/kframework/k/releases/download/nightly-89361d7c8/kframework_5.0.0_amd64_bionic.deb kframework_5.0.0_amd64_bionic.deb
-RUN apt install --yes ./kframework_5.0.0_amd64_bionic.deb
+RUN    apt-get update                                                                   \
+    && apt-get upgrade --yes                                                            \
+    && apt-get install --yes clang-8 cmake curl dh-make git libcrypto++-dev             \
+                         libjemalloc-dev libprocps-dev libprotobuf-dev libsecp256k1-dev \
+                         libssl-dev pandoc pkg-config protobuf-compiler sudo
+
+RUN curl -sL https://deb.nodesource.com/setup_10.x | bash -
+RUN apt-get install --yes nodejs
+RUN npm install -g npx
+
+ARG USER_ID=1000
+ARG GROUP_ID=1000
+RUN    groupadd -g $GROUP_ID user                                                \
+    && useradd --create-home --uid $USER_ID --shell /bin/sh --gid $GROUP_ID user \
+    && echo "user ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers