Merge pull request #85 from ankur325/build-fix-osx

Make fails on OS X due to sed differences.

Author: ashcherbakov

.gitignore

@@ -3,3 +3,5 @@ settings.json
 build
 localnet
 rest-server.out
+.DS_Store
+.vscode

Dockerfile

@@ -17,6 +17,9 @@
 ############################
 FROM golang:alpine AS builder
 
+# Build Delve - This is helpful if you want to do remote debugging by attaching to one of the docker containers remotely
+RUN go get github.com/go-delve/delve/cmd/dlv
+
 # Git is required for fetching the dependencies,
 # make is required for building.
 RUN apk update && apk add --no-cache git make
@@ -33,6 +36,7 @@ FROM alpine:latest
 
 COPY --from=builder /go/bin/dcld /usr/bin/dcld
 COPY --from=builder /go/bin/dclcli /usr/bin/dclcli
+COPY --from=builder /go/bin/dlv /usr/bin/dlv
 
 VOLUME /root/.dcld
 VOLUME /root/.dclcli

README-DEV.md

@@ -73,6 +73,23 @@ dclcli
 ```
 Have a look at [How To](docs/how-to.md) and [CLI Help](docs/cli-help.md) for instructions how to configure and use the CLI.
 
+## Remote Debugging local pool 
+If you want to remotely debug the node running in docker in order to inspect and step thru the code, modify the following lines in the `docker-compose.yml`. Comment out the default `dcld start` command with the `dlv` as shown below (delve is the go remote debugger) 
+```
+    # uncomment following line if starting in debug mode 
+    - "2345:2345"
+
+    # command: dcld start    
+    # Please use the following as the entry point if you want to start this node in debug mode for easy debugging
+    command: dlv --listen=:2345 --headless=true --log=true --log-output=debugger,debuglineerr,gdbwire,lldbout,rpc --accept-multiclient --api-version=2 exec /usr/bin/dcld start
+```
+After making the changes re-initialize and start the localnet
+  - `make localnet_stop` -If your localnet is still up
+  - `make localnet_init` 
+  - `make localnet_start`
+
+Once all the four nodes are running, the last node i.e. node03 will be listing on port `2345` to which you can attach a debug process from any IDE (e.g. Visual Studio) and step thru the code. (p.s. node03 will only start working as validator node once the debugger is attached.). More details about IDE configuration can be found at https://github.com/go-delve/delve/blob/master/Documentation/EditorIntegration.md
+
 ## Contributing
 Please take into account the following when sending a PR:
 1) Make sure there is a license header added:

docker-compose.yml

@@ -60,12 +60,16 @@ services:
     container_name: node3
     ports:
       - "26662-26663:26656-26657"
+      # uncomment following line if starting in debug mode 
+      # - "2345:2345"
     volumes:
       - ./localnet/node3:/root/.dcld:Z
     networks:
       localnet:
         ipv4_address: 192.167.10.5
-    command: dcld start
+    command: dcld start    
+    # Please use the following as the entry point if you want to start this node in debug mode for easy debugging
+    # command: dlv --listen=:2345 --headless=true --log=true --log-output=debugger,debuglineerr,gdbwire,lldbout,rpc --accept-multiclient --api-version=2 exec /usr/bin/dcld start
 
 networks:
   localnet:

genlocalnetconfig.sh

@@ -15,6 +15,12 @@
 
 set -euo pipefail
 
+SED_EXT=
+if [ "$(uname)" == "Darwin" ]; then
+    # Mac OS X sed needs the file extension when -i flag is used. Keeping it empty as we don't need backupfile
+    SED_EXT="''"
+fi
+
 rm -rf ~/.dclcli
 rm -rf ~/.dcld
 
@@ -127,11 +133,13 @@ id3=$(ls localnet/node3/config/gentx | sed 's/gentx-\(.*\).json/\1/')
 
 # Update address book of the first node
 peers="$id0@192.167.10.2:26656,$id1@192.167.10.3:26656,$id2@192.167.10.4:26656,$id3@192.167.10.5:26656"
-sed -i "s/persistent_peers = \"\"/persistent_peers = \"$peers\"/g" localnet/node0/config/config.toml
 
-# Make RPC enpoint available externally
+# Update address book of the first node 
+sed -i $SED_EXT "s/persistent_peers = \"\"/persistent_peers = \"$peers\"/g" localnet/node0/config/config.toml
 
-sed -i 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node0/config/config.toml
-sed -i 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node1/config/config.toml
-sed -i 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node2/config/config.toml
-sed -i 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node3/config/config.toml
+# Make RPC endpoint available externally
+sed -i $SED_EXT "s/persistent_peers = \"\"/persistent_peers = \"$peers\"/g" localnet/node0/config/config.toml
+sed -i $SED_EXT 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node0/config/config.toml
+sed -i $SED_EXT 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node1/config/config.toml
+sed -i $SED_EXT 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node2/config/config.toml
+sed -i $SED_EXT 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' localnet/node3/config/config.toml

integration_tests/ci/run-all.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/bash
+#!/bin/bash
 # Copyright 2020 DSR Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,6 +16,11 @@
 DETAILED_OUTPUT=true
 
 LOG_PREFIX="[run all] "
+SED_EXT=
+if [ "$(uname)" == "Darwin" ]; then
+    # Mac OS X sed needs the file extension when -i flag is used. Keeping it empty as we don't need backupfile
+    SED_EXT="''"
+fi
 
 if ${DETAILED_OUTPUT}; then
   DETAILED_OUTPUT_TARGET=/dev/stdout
@@ -59,10 +64,10 @@ patch_consensus_config() {
   local NODE_CONFIGS=$(find localnet -type f -name "config.toml" -wholename "*node*")
 
   for NODE_CONFIG in ${NODE_CONFIGS}; do
-    sed -i 's/timeout_propose = "3s"/timeout_propose = "500ms"/g' "${NODE_CONFIG}"
-    sed -i 's/timeout_prevote = "1s"/timeout_prevote = "500ms"/g' "${NODE_CONFIG}"
-    sed -i 's/timeout_precommit = "1s"/timeout_precommit = "500ms"/g' "${NODE_CONFIG}"
-    sed -i 's/timeout_commit = "5s"/timeout_commit = "500ms"/g' "${NODE_CONFIG}"
+    sed -i $SED_EXT 's/timeout_propose = "3s"/timeout_propose = "500ms"/g' "${NODE_CONFIG}"
+    sed -i $SED_EXT 's/timeout_prevote = "1s"/timeout_prevote = "500ms"/g' "${NODE_CONFIG}"
+    sed -i $SED_EXT 's/timeout_precommit = "1s"/timeout_precommit = "500ms"/g' "${NODE_CONFIG}"
+    sed -i $SED_EXT 's/timeout_commit = "5s"/timeout_commit = "500ms"/g' "${NODE_CONFIG}"
   done
 }
 
@@ -94,7 +99,7 @@ cleanup_pool() {
 
 run_rest_server() {
   log "Running cli in rest-server mode"
-  dclcli rest-server --chain-id dclchain &>>rest-server.out &
+  dclcli rest-server --chain-id dclchain & >> rest-server.out &
 }
 
 stop_rest_server() {
@@ -119,8 +124,10 @@ CLI_SHELL_TESTS=$(find integration_tests/cli -type f -not -name "common.sh")
 for CLI_SHELL_TEST in ${CLI_SHELL_TESTS}; do
   init_pool
 
+  log "*****************************************************************************************"
   log "Running $CLI_SHELL_TEST"
-
+  log "*****************************************************************************************"
+  
   if bash "$CLI_SHELL_TEST" &>${DETAILED_OUTPUT_TARGET}; then
     log "$CLI_SHELL_TEST finished successfully"
   else
@@ -136,9 +143,11 @@ GO_REST_TESTS=$(find integration_tests/rest -type f)
 
 for GO_REST_TEST in ${GO_REST_TESTS}; do
   init_pool
+  log "Starting the rest server"
   run_rest_server
 
   log "Running $GO_REST_TEST"
+  
 
   if go test "$GO_REST_TEST" &>${DETAILED_OUTPUT_TARGET}; then
     log "$GO_REST_TEST finished successfully"

integration_tests/cli/validator-demo.sh

@@ -80,7 +80,7 @@ check_response "$result" "\"validator_pubkey\": \"$vpubkey\""
 echo "$result"
 
 echo "Connect CLI to node \"$node\" and check status"
-dclcli config node "tcp://$ip:26657"
+dclcli config node "tcp://localhost:26665"
 result=$(dclcli status)
 check_response "$result" "\"moniker\": \"$node\""
 echo "$result"
@@ -100,7 +100,7 @@ echo "$result"
 sleep 5
 
 echo "Connect CLI to node \"node0\""
-dclcli config node $node0
+dclcli config node "tcp://localhost:26657"
 result=$(dclcli status)
 check_response "$result" "\"moniker\": \"node0\""
 echo "$result"