Add tests

Author: ayeowch

.circleci/config.yml

@@ -0,0 +1,54 @@
+defaults: &defaults
+  docker:
+    - image: circleci/python:2.7.15
+  working_directory: ~/bitnodes
+
+version: 2
+jobs:
+  build:
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - dependencies-{{ checksum "requirements.txt" }}
+      - run:
+          name: install dependencies
+          command: |
+            pip install virtualenv
+            virtualenv -p python2 venv
+            . venv/bin/activate
+            pip install -r requirements.txt
+      - save_cache:
+          paths:
+            - ./venv
+          key: dependencies-{{ checksum "requirements.txt" }}
+
+  test:
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - dependencies-{{ checksum "requirements.txt" }}
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+            pytest --junitxml=test-reports/pytest/junit.xml
+      - store_test_results:
+          path: test-reports
+      - store_artifacts:
+          path: test-reports
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - build
+      - test:
+          requires:
+            - build
+          filters:
+            branches:
+              only: master

.flake8

@@ -0,0 +1,10 @@
+[flake8]
+ignore = E402
+exclude =
+    .git
+    conf
+    data
+    geoip
+    internal-tests
+    log
+    venv

.gitignore

@@ -4,10 +4,10 @@
 *.pyc
 .DS_Store
 /.idea/
+/.pytest_cache/
 /data/
-/tests/
-clean.sh
-geoip/*.dat
+/internal-tests/
+/test-reports/
 geoip/*.mmdb
 geoip/*.txt
 rsync.sh

README.md

@@ -15,3 +15,5 @@ Bitnodes is currently being developed to estimate the size of the Bitcoin networ
 * [Leaderboard](https://bitnodes.earn.com/nodes/leaderboard/)
 
 See [Provisioning Bitcoin Network Crawler](https://github.com/ayeowch/bitnodes/wiki/Provisioning-Bitcoin-Network-Crawler) for steps on setting up a machine to run Bitnodes. The [Redis Data](https://github.com/ayeowch/bitnodes/wiki/Redis-Data) contains the list of keys and their associated values that are written by the scripts in this project. If you wish to access the data, e.g. network snapshots, collected using this project, see [Bitnodes API v1.0](https://bitnodes.earn.com/api/).
+
+[![CircleCI](https://circleci.com/gh/ayeowch/bitnodes.svg?style=svg)](https://circleci.com/gh/ayeowch/bitnodes)

requirements.txt

@@ -1,7 +1,9 @@
 dpkt==1.9.1
+flake8==3.5.0
 geoip2==2.9.0
 gevent==1.3.4
 ipaddress==1.0.22
 PySocks==1.6.8
+pytest==3.7.3
 redis==2.10.6
 requests==2.19.1

tests/data/bip144.pcap

@@ -0,0 +1 @@
+../pcap.py

tests/pcap.py

@@ -0,0 +1 @@
+../protocol.py

tests/protocol.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+from binascii import hexlify, unhexlify
+from collections import defaultdict
+from Queue import PriorityQueue
+
+from pcap import Stream, Cache
+from protocol import Serializer
+
+
+class Reader(Cache):
+    def __init__(self, filepath):
+        self.filepath = filepath
+        self.serializer = Serializer(magic_number=unhexlify('f9beb4d9'))
+        self.streams = defaultdict(PriorityQueue)
+        self.stream = Stream()
+
+
+def test_bip144():
+    filepath = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)), 'data', 'bip144.pcap')
+
+    reader = Reader(filepath=filepath)
+    reader.extract_streams()
+    msgs = []
+
+    for stream_id, reader.stream.segments in reader.streams.iteritems():
+        assert stream_id == ('1.1.1.1', 56691, '2.2.2.2', 8333)
+        msg, _ = reader.serializer.deserialize_msg(reader.stream.data().next())
+        msgs.append(msg)
+
+    assert len(msgs) == 1
+
+    keys = sorted(msgs[0].keys())
+    assert keys == [
+        'checksum',
+        'command',
+        'length',
+        'lock_time',
+        'magic_number',
+        'tx_hash',
+        'tx_in',
+        'tx_in_count',
+        'tx_out',
+        'tx_out_count',
+        'version',
+    ]
+
+    sig = hexlify(msgs[0]['tx_in'][0]['wits'][0]).decode()
+    pub = hexlify(msgs[0]['tx_in'][0]['wits'][1]).decode()
+
+    assert (
+        sig ==
+        '30440220643f9527d1d226bb25321e85fa4c2e13afcc2ccfb14bc069642ec51efd5c7'
+        'b430220752a1d43350d5014559eb8d57fb5d48f1e759d120fc5e0dd6f26769b1d7951'
+        'c701')
+
+    assert (
+        pub ==
+        '03bf91e659ba26545fe7b04b48ca3b77c624993caed10e6fdb177fba33b25230d2')

tests/test_bip144.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from subprocess import call
+
+
+def test_flake8():
+    return_code = call(['flake8'])
+    assert return_code == 0

tests/test_flake8.py

@@ -0,0 +1 @@
+../utils.py