add travis ci with regtest tests

Author: jcramer

.travis.yml

@@ -0,0 +1,5 @@
+services:
+  - docker
+sudo: false
+script:
+  - sh -c 'cd ./regtest && ./test.sh'

npm-shrinkwrap.json

@@ -1,5 +1,6 @@
 {
   "name": "slpdb",
+  "private": true,
   "version": "1.0.0",
   "description": "Indexer for the Simple Ledger Protocol with real-time validation notifications.",
   "main": "index.js",

package.json

@@ -3,3 +3,6 @@ node_modules
 .idea
 .DS_STORE
 log
+
+regtest
+test

regtest/.dockerignore

@@ -0,0 +1,14 @@
+# Start from a Debian image with the latest version of Go installed
+# and a workspace (GOPATH) configured at /go.
+FROM node:14.16.0-slim
+
+RUN apt-get update && apt-get install -y build-essential
+
+# Copy the local package files to the container's workspace.
+ADD . /usr/src/SLPDB
+
+# Switch to the correct working directory.
+WORKDIR /usr/src/SLPDB/regtest
+
+# Create the data volume.
+VOLUME ["/data"]

regtest/Dockerfile.nodejs

@@ -1,32 +1,7 @@
-## Regtest Network for End-to-End testing
+# Regtest tests
 
-To get started with unit tests you need to startup the sandboxed bitcoin regtest network described in `docker-compose.yml`.  This will creates a network of bitcoin nodes which will connect to a locally running SLPDB instance outside of the docker container.
+Tests are provided for SLPDB using a docker compose network that has two bitcoin node containers, one mongo db container, and one SLPDB container.  Tests are run using mocha and cover the expected data written to MongoDB for various scenarios that would be expected in a live network.  Continuous integration tests have been setup using Travis CI (see `../.travis.yml`).
 
-Start the regtest network and SLPDB:
-```
-$ git apply ./patches/*
-$ cp .env.regtest .env
-$ cd regtest
-$ docker-compose up -d
-$ npm start
+## Run the tests
 
-```
-
-Next, in a new terminal run the e2e tests using:
-
-```
-$ npm test
-```
-
-
-
-### Optional: Setting up mongoDB replica set for testing
-1. Uncomment mongo entrypoint/volume lines in `docker-compose.yml`
-2. Delete `regtest/mongo/db` and `regtest/mongo/configdb` directories
-3. Run `docker-compose up -d`
-4. Run `docker exec -it regtest_mongo_1 mongo`
-5. Run `rs.initiate()`
-6. Run `rs.status()` to make sure `ok: 1`
-7. Run `cfg = rs.config()`
-8. Run `cfg.members[0].host = "localhost:27017"`
-9. Run `cfg.reconfig(cfg, {force:true})`
+`$ cd ./regtest && ./test.sh`

regtest/README.md

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+git apply ./patches/*
+
+export RPC1_HOST="bitcoin1"
+export RPC1_PORT="18443"
+export RPC2_HOST="bitcoin2"
+export RPC2_PORT="18443"
+export MONGO_HOST="mongo"
+export MONGO_PORT="27017"
+
+npm test

regtest/_test.sh

@@ -7,9 +7,9 @@ RUN set -ex \
 	&& apt-get install -qq --no-install-recommends ca-certificates dirmngr gosu gpg wget \
 	&& rm -rf /var/lib/apt/lists/*
 
-ENV BITCOIN_VERSION 0.21.2
-ENV BITCOIN_URL https://github.com/bitcoin-cash-node/bitcoin-cash-node/releases/download/v0.21.2/bitcoin-cash-node-0.21.2-x86_64-linux-gnu.tar.gz
-ENV BITCOIN_SHA256 f22df3e37beff99651dd2a0902d9627642464502a6d017f5b4494a44a6159177
+ENV BITCOIN_VERSION 23.0.0
+ENV BITCOIN_URL https://github.com/bitcoin-cash-node/bitcoin-cash-node/releases/download/v23.0.0/bitcoin-cash-node-23.0.0-x86_64-linux-gnu.tar.gz
+ENV BITCOIN_SHA256 474d53ba3dc10cee20da4c1e8d77e31a6b3c54c805f72eab7d705c9211c879bd
 
 # install bitcoin binaries
 RUN set -ex \

regtest/bitcoin-abc/Dockerfile regtest/bitcoind/Dockerfile

@@ -1,44 +1,39 @@
 version: "3.5"
 services:
-  bitcoin1: # the node not connected to SLPDB
-    image: "bitcoin-abc"
+  bitcoin1: # the node connected to SLPDB via RPC and zmq
+    image: "bchn"
     restart: always
     build:
-      context: "./bitcoin-abc"
+      context: "./bitcoind"
     command: "bitcoind"
     healthcheck:
       test: ["CMD", "/entrypoint.sh", "bitcoin-cli", "getblockchaininfo"]
     expose:
       - "18333"
     ports:
-      - "18444:18443"
+      - "18443:18443"
+      - "28332:28332"
     volumes:
-      - ./bitcoin-abc/bitcoin.conf:/data/bitcoin.conf
-    networks:
-      - regnet
-  bitcoin2: # the node connected to SLPDB via RPC and zmq
-    image: "bitcoin-abc"
+      - ./bitcoind/bitcoin.conf:/data/bitcoin.conf
+  bitcoin2: # the node not connected to SLPDB
+    image: "bchn"
     restart: always
     build:
-      context: "./bitcoin-abc"
+      context: "./bitcoind"
     command: "bitcoind"
     healthcheck:
       test: ["CMD", "/entrypoint.sh", "bitcoin-cli", "getblockchaininfo"]
     expose:
       - "18333"
-      - "28332"
     ports:
-      - "18443:18443"
-      - "29332:28332"
+      - "18444:18443"
     volumes:
-      - ./bitcoin-abc/bitcoin.conf:/data/bitcoin.conf
-    networks:
-      - regnet
+      - ./bitcoind/bitcoin.conf:/data/bitcoin.conf
+    depends_on: 
+      - bitcoin1
   mongo:
-    image: mongo:4.2
+    image: mongo:4.4
     restart: always
-    networks:
-      - regnet
     # entrypoint: [ "/usr/bin/mongod", "--bind_ip_all", "--replSet", "devrs" ]
     healthcheck:
       test: echo 'db.runCommand("ping").ok' | mongo --quiet 1
@@ -48,21 +43,19 @@ services:
       start_period: 40s
     ports:
       - "26017:27017"
-    # volumes:
-    #    - ./mongo/db:/data/db
-    #    - ./mongo/configdb:/data/configdb
-  # slpdb:
-  #   build:
-  #     context: "./slpdb"
-  #   image: slpdb
-  #   restart: always
-  #   networks:
-  #     - regnet
-  #   depends_on:
-  #     - mongo
-  #     - bitcoin2
-  #   ports:
-  #     - "27339:28339"
-
-networks:
-  regnet:
+    depends_on: 
+      - bitcoin1
+      - bitcoin2
+  slpdb:
+    build:
+      context: ".."
+      dockerfile: "./regtest/slpdb/Dockerfile"
+    image: slpdb
+    restart: always
+    depends_on:
+      - mongo
+    ports:
+      - "27339:27339"
+    volumes:
+      - .:/usr/src/SLPDB/regtest
+      - ..:/usr/src/SLPDB/test

regtest/bitcoin-abc/bitcoin.conf regtest/bitcoind/bitcoin.conf

@@ -1,21 +1,21 @@
 rpc_protocol='http'
 rpc_user='bitcoin'
 rpc_pass='password'
-rpc_host='localhost'
+rpc_host='bitcoin1'
 rpc_port='18443'
 rpc_limit='150'
 db_name='slpdb'
-db_url='mongodb://localhost:26017' 
+db_url='mongodb://mongo:26017' 
 core_from='543375'
 core_from_testnet='0'
 core_slp_mempool_ignore_length='1000000'
-zmq_incoming_host='0.0.0.0'
-zmq_incoming_port='29332'
+zmq_incoming_host='bitcoin1'
+zmq_incoming_port='28332'
 zmq_outgoing_host='0.0.0.0'
 zmq_outgoing_port='27339'
 zmq_outgoing_enable=1
 telemetry_host='status.slpdb.io'
 telemetry_advertised_host="James' MBP"
 telemetry_advertised_graph_search_host=''
 telemetry_advertised_slp_socket_host=''
-telemetry_secret='7da8a6ac0a1f03f24ae852d6769ac27e9c411ff3ba7d8ec1feae81f81924e0ac'
+telemetry_secret='7da8a6ac0a1f03f24ae852d6769ac27e9c411ff3ba7d8ec1feae81f81924e0ac'

regtest/bitcoin-abc/docker-entrypoint.sh regtest/bitcoind/docker-entrypoint.sh

@@ -5,22 +5,19 @@ RUN apk update && apk upgrade && \
 
 RUN apk add --no-cache --virtual build-dependencies python --update py-pip \
     build-base python-dev make automake autoconf libtool \
-    && pip install --upgrade pip \
-    && rm -rf /var/cache/apk/*
+    && pip install --upgrade pip
 
 RUN mkdir -p /usr/src/SLPDB
 
 WORKDIR /usr/src
 
-RUN git clone https://github.com/simpleledger/SLPDB.git && cd SLPDB
+ADD . /usr/src/SLPDB
 WORKDIR /usr/src/SLPDB
-RUN npm install
-RUN git fetch --all && git checkout c2f6763ab9c1a80d68b1c8bd37fee0180e143758
-RUN npm install
+RUN npm i
 
-COPY regtest.env .env
-COPY filters.regtest.yml filters.yml
-COPY ./docker-entrypoint.sh ./entrypoint.sh
+COPY ./regtest/slpdb/.env.regtest .env
+COPY ./regtest/slpdb/filters.regtest.yml filters.yml
+COPY ./regtest/slpdb/docker-entrypoint.sh ./entrypoint.sh
 
 ENTRYPOINT [ "./entrypoint.sh" ]
 CMD [ "run" ]

regtest/docker-compose.yml

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+echo "INFO: Cleaning up from previous runs..."
+docker-compose down
+
+echo "INFO: Creating regtest network from source"
+docker-compose up -d
+
+echo "INFO: Running mocha tests in docker"
+docker-compose exec slpdb ./regtest/_test.sh
+exit_code=$?
+
+if [ $exit_code -eq 0 ]; then
+  echo "INFO: All regtest network tests pass (code: $exit_code)"
+else
+  echo "ERROR: One or more regtest network tests failed (code: $exit_code)"
+fi
+
+echo "INFO: Cleaning up."
+docker-compose down
+
+exit $exit_code