E2E Testing

.dockerignore

@@ -0,0 +1,2 @@
+test/**
+.git/**

.gitignore

@@ -5,4 +5,8 @@ remiro
 config.toml
 
 # Ignore test coverage reports
-coverage.txt
+coverage.txt
+
+# Ignore E2E Testing stuff
+test/e2e/remiro-e2e-env
+test/e2e/__pycache__

.travis.yml

@@ -1,15 +1,29 @@
-language: go
+services:
+  - docker
 
-go:
-  - 1.12.x
+matrix:
+  include:
+    - language: go
 
-env:
-  - GO111MODULE=on
+      go:
+        - 1.12.x
 
-script:
-  - make lint-prepare
-  - make lint
-  - make test
+      env:
+        - GO111MODULE=on
 
-after_success:
-  - bash <(curl -s https://codecov.io/bash)
+      script:
+        - make lint-prepare
+        - make lint
+        - make test
+
+      after_success:
+        - bash <(curl -s https://codecov.io/bash)
+
+    - language: python
+
+      python:
+        - "3.6"
+
+      script:
+        - cd test/e2e
+        - make e2e-test

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "python.pythonPath": "${workspaceFolder}/test/e2e/remiro-e2e-env/bin/python",
+    "python.formatting.provider": "black"
+}

Dockerfile

@@ -0,0 +1,11 @@
+FROM golang:1.12
+
+ENV GO111MODULE=on
+
+WORKDIR /app
+
+COPY . .
+
+RUN go build -o remiro 
+
+ENTRYPOINT ["/app/remiro"]

test/e2e/Makefile

@@ -0,0 +1,13 @@
+.PHONY: setup-virtual-env 
+setup-virtual-env:
+	python3 -m venv remiro-e2e-env
+	source remiro-e2e-env/bin/activate; \
+	python --version; \
+	pip install -r requirements.txt;
+
+.PHONY: e2e-test
+e2e-test: setup-virtual-env
+	source remiro-e2e-env/bin/activate; \
+	python e2e.py;
+
+.DEFAULT_GOAL := e2e-test

test/e2e/README.md

@@ -0,0 +1,40 @@
+# Remiro End-to-End Testing
+
+## Test Methodology
+
+`e2e.py` builds and spins up new 6 Docker containers for each test cases:
+
+- `remiro` : testing subject
+- `redis-src`: source Redis server
+- `redis-dst`: destination Redis server
+- `redis-src-expected`: expected source Redis server
+- `redis-dst-expected`: expected destination Redis server
+- `redis-rdb-tools`: a tool to compare two dump files of Redis data (.rdb) (<https://github.com/sripathikrishnan/redis-rdb-tools>)
+
+then, `e2e.py` does following tasks while running a test case :
+
+- populate setup data to `redis-src` and `redis-dst`
+- populate expected data to `redis-src-expected` and `redis-dst-expected`
+- run a test to `remiro` by using Redis Python client [redis-py](https://github.com/andymccurdy/redis-py)
+- run `SAVE` command for each Redis server containers to get Redis data dump files: `dump-redis-src.rdb`, `dump-redis-dst.rdb`, `dump-redis-src-expected.rdb`, `dump-redis-dst-expected.rdb`
+- by using `redis-rdb-tools`, compare:
+  1. `dump-redis-src.rdb` & `dump-redis-src-expected.rdb`
+  2. `dump-redis-dst.rdb` & `dump-redis-dst-expected.rdb`
+
+## Test Case Scenario
+
+Each test case is defined in `scenario.py` with the following format:
+
+- `id`: (required) id of the test case
+- `name`: (required) name / description of the test case
+- `test`
+  - `given_data`: (required)
+    - `src`: list of Redis commands to populate initial data in `redis-src` server
+    - `dst`: list of Redis commands to populate initial data in `redis-dst` server
+  - `when_req_then_data`: list of Redis request commands and its expected responses
+    - `req`: a Redis command with its arguments. It consists of `"<redis_cmd>": ("<arg1>", "<arg2>", "<etc>")`
+    - `resp`: (optional) expected response
+    - `respError`: (optional) `True`: if an exception is expected
+  - `then_data`: (required)
+    - `src`: list of Redis commands to populate expected data in `redis-src-expected` server
+    - `dst`: list of Redis commands to populate expected data in `redis-dst-expected` server

test/e2e/clean-docker.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+docker container prune -f
+docker rm $(docker container ls -f name="redis" -q) --force
+docker rm $(docker container ls -f name="remiro" -q) --force
+docker network rm $(docker network ls -f name="e2e" -q)
+docker volume rm $(docker volume ls -f name="e2e" -q)
+docker image prune -f
+# docker rmi $(docker images "remiro*" -q) --force
+# docker rmi $(docker images "redis-rdb-tools*" -q) --force             
+docker rmi hello-world -f
+

test/e2e/docker-redis-rdb-tools/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.5-alpine
+
+RUN apk add gcc musl-dev
+
+RUN pip install  --no-cache-dir rdbtools python-lzf
+
+CMD [ "/bin/sh" ]