Merge pull request #137 from Grokzen/unstable

Release 1.2.0

Author: Grokzen

.gitignore

@@ -10,3 +10,6 @@ htmlcov
 dist
 build
 *.egg-info
+.cache
+docs/_build
+docs/_build_html

.travis.yml

@@ -2,21 +2,27 @@ sudo: false
 language: python
 python:
   - "2.7"
-  - "3.2"
   - "3.3"
   - "3.4"
   - "3.5"
   - "nightly"
 services:
   - redis-server
 install:
-  - make redis-install
+  - "if [[ $REDIS_VERSION == '3.0' ]]; then REDIS_VERSION=3.0.7 make redis-install; fi"
+  - "if [[ $REDIS_VERSION == '3.2' ]]; then REDIS_VERSION=3.2.0-rc3 make redis-install; fi"
   - pip install -r dev-requirements.txt
   - pip install -e .
-  - "if [[ $TEST_HIREDIS == '1' ]]; then pip install hiredis; fi"
+  - "if [[ $HIREDIS == '1' ]]; then pip install hiredis; fi"
 env:
-  - TEST_HIREDIS=0
-  - TEST_HIREDIS=1
+  # Redis 3.0.6
+  - HIREDIS=0 REDIS_VERSION=3.0
+  # Redis 3.0.6 and HIREDIS
+  - HIREDIS=1 REDIS_VERSION=3.0
+  # Redis 3.2.0-rc3
+  - HIREDIS=0 REDIS_VERSION=3.2
+  # Redis 3.2.0-rc3 and HIREDIS
+  - HIREDIS=1 REDIS_VERSION=3.2
 script: 
   - make start
   - coverage erase

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+
+# Pull Request
+
+For bug fixes you should provide some information about how to reproduce the problem so it can be verified if the new code solves the bug.
+
+All CI tests must pass (Travis-CI)
+
+Follow the code quality standards described in this file.
+
+You are responsible for ensuring the code is mergable and fix any issues that can occur if other code was merged before your code.
+
+Allways ensure docs is up to date based on your changes. If docs is missing and you think it should exists you are responsible to write it.
+
+For all PR you should do/include the following
+ - A line about the change in the `CHANGES` file Add it in the section `Next release`, create it if needed.
+ - If you change something already implemented, for example add/remove argument you should add a line in `docs/Upgrading.md` describing how to migrate existing code from the old to the new code. Add it in the section `Next release`, create it if needed.
+ - Add yourself to `docs/Authors` file (This is optional if you want)
+
+
+
+# Code standard
+
+In general, you should follow the established pep8 coding standard, but with the following exceptions/changes. https://www.python.org/dev/peps/pep-0008/
+
+ - The default max line length (80) should not be followed religiously. Instead try to not exceed ~140 characters.
+   Use the `flake8` tool to ensure you have good code quality.
+ - Try to document as much as possible in the method docstring and avoid doc inside the code. Code should describe itself as much as possible.
+ - Follow the `KISS` rule and `Make it work first, optimize later`
+ - When indenting, try to indent with json style. For example:
+```
+# Do not use this style
+from foo import (bar, qwe, rty,
+                 foobar, barfoo)
+
+print("foobar {barfoo} {qwert}".format(barfoo=foo,
+                                       qwerty=bar))
+```
+
+```
+# Use this style instead
+from foo import (
+    bar, qwe, rty,
+    foobar, barfoo,
+)
+
+print("foobar {barfoo} {qwert}".format(
+    barfoo=foo, qwerty=bar))
+```
+
+
+
+# Tests
+
+I (Johan/Grokzen) have been allowed (by andymccurdy) explicitly to use all test code that already exists inside `redis-py` lib. If possible you should reuse code that exists in there.
+
+All code should aim to have 100% test coverage. This is just a target and not a requirements.
+
+All new features must implement tests to show that it works as intended.
+
+All implemented tests must pass on all supported python versions. List of supported versions can be found in the `README.md`.
+
+All tests should be assumed to work against the test environment that is implemented when running in `travis-ci`. Currently that means 6 nodes in the cluster, 3 masters, 3 slaves, using port `7000-7005` and the node on port `7000` must be accessible on `127.0.0.1`

MANIFEST.in

@@ -1,6 +1,7 @@
 exclude *.py
+include docs/authors.rst
 include docs/License.txt
+include docs/release-notes.rst
 include CHANGES
 include setup.py
 include README.md
-include docs/Authors

Makefile

@@ -97,8 +97,126 @@ cluster-enabled yes
 cluster-config-file /tmp/redis_cluster_node8.conf
 endef
 
+
+# CLUSTER REDIS PASSWORD PROTECTED NODES
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE1_CONF
+daemonize yes
+port 7100
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node1.pid
+logfile /tmp/redis_cluster_password_protected_node1.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node1.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE2_CONF
+daemonize yes
+port 7101
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node2.pid
+logfile /tmp/redis_cluster_password_protected_node2.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node2.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE3_CONF
+daemonize yes
+port 7102
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node3.pid
+logfile /tmp/redis_cluster_password_protected_node3.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node3.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE4_CONF
+daemonize yes
+port 7103
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node4.pid
+logfile /tmp/redis_cluster_password_protected_node4.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node4.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE5_CONF
+daemonize yes
+port 7104
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node5.pid
+logfile /tmp/redis_cluster_password_protected_node5.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node5.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE6_CONF
+daemonize yes
+port 7105
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node6.pid
+logfile /tmp/redis_cluster_password_protected_node6.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node6.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE7_CONF
+daemonize yes
+port 7106
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node7.pid
+logfile /tmp/redis_cluster_password_protected_node7.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node7.conf
+endef
+
+define REDIS_CLUSTER_PASSWORD_PROTECTED_NODE8_CONF
+daemonize yes
+port 7107
+cluster-node-timeout 5000
+pidfile /tmp/redis_cluster_password_protected_node8.pid
+logfile /tmp/redis_cluster_password_protected_node8.log
+save ""
+masterauth password_is_protected
+requirepass password_is_protected
+appendonly no
+cluster-enabled yes
+cluster-config-file /tmp/redis_cluster_password_protected_node8.conf
+endef
+
 ifndef REDIS_TRIB_RB
-	REDIS_TRIB_RB=redis-git/src/redis-trib.rb
+	REDIS_TRIB_RB=tests/redis-trib.rb
+endif
+
+ifndef REDIS_VERSION
+	REDIS_VERSION=3.0.7
 endif
 
 export REDIS_CLUSTER_NODE1_CONF
@@ -110,10 +228,19 @@ export REDIS_CLUSTER_NODE6_CONF
 export REDIS_CLUSTER_NODE7_CONF
 export REDIS_CLUSTER_NODE8_CONF
 
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE1_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE2_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE3_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE4_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE5_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE6_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE7_CONF
+export REDIS_CLUSTER_PASSWORD_PROTECTED_NODE8_CONF
+
 help:
 	@echo "Please use 'make <target>' where <target> is one of"
 	@echo "  clean           remove temporary files created by build tools"
-	@echo "  cleanmeta       removes all META-* and egg-info/ files created by build tools"	
+	@echo "  cleanmeta       removes all META-* and egg-info/ files created by build tools"
 	@echo "  cleancov        remove all files related to coverage reports"
 	@echo "  cleanall        all the above + tmp files from development tools"
 	@echo "  test            run test suite"
@@ -167,12 +294,27 @@ start: cleanup
 	echo "$$REDIS_CLUSTER_NODE6_CONF" | redis-server -
 	echo "$$REDIS_CLUSTER_NODE7_CONF" | redis-server -
 	echo "$$REDIS_CLUSTER_NODE8_CONF" | redis-server -
+
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE1_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE2_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE3_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE4_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE5_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE6_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE7_CONF" | redis-server -
+	echo "$$REDIS_CLUSTER_PASSWORD_PROTECTED_NODE8_CONF" | redis-server -
+
 	sleep 5
 	echo "yes" | ruby $(REDIS_TRIB_RB) create --replicas 1 127.0.0.1:7000 127.0.0.1:7001 127.0.0.1:7002 127.0.0.1:7003 127.0.0.1:7004 127.0.0.1:7005
+
+	sleep 5
+	echo "yes" | ruby $(REDIS_TRIB_RB) create --replicas 1 --password password_is_protected 127.0.0.1:7100 127.0.0.1:7101 127.0.0.1:7102 127.0.0.1:7103 127.0.0.1:7104 127.0.0.1:7105
+
 	sleep 5
 
 cleanup:
 	- rm -vf /tmp/redis_cluster_node*.conf 2>/dev/null
+	- rm -vf /tmp/redis_cluster_password_protected_node*.conf 2>/dev/null
 	- rm dump.rdb appendonly.aof - 2>/dev/null
 
 stop:
@@ -184,6 +326,16 @@ stop:
 	kill `cat /tmp/redis_cluster_node6.pid` || true
 	kill `cat /tmp/redis_cluster_node7.pid` || true
 	kill `cat /tmp/redis_cluster_node8.pid` || true
+
+	kill `cat /tmp/redis_cluster_password_protected_node1.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node2.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node3.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node4.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node5.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node6.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node7.pid` || true
+	kill `cat /tmp/redis_cluster_password_protected_node8.pid` || true
+
 	rm -f /tmp/redis_cluster_node1.conf
 	rm -f /tmp/redis_cluster_node2.conf
 	rm -f /tmp/redis_cluster_node3.conf
@@ -193,6 +345,15 @@ stop:
 	rm -f /tmp/redis_cluster_node7.conf
 	rm -f /tmp/redis_cluster_node8.conf
 
+	rm -f /tmp/redis_cluster_password_protected_node1.conf
+	rm -f /tmp/redis_cluster_password_protected_node2.conf
+	rm -f /tmp/redis_cluster_password_protected_node3.conf
+	rm -f /tmp/redis_cluster_password_protected_node4.conf
+	rm -f /tmp/redis_cluster_password_protected_node5.conf
+	rm -f /tmp/redis_cluster_password_protected_node6.conf
+	rm -f /tmp/redis_cluster_password_protected_node7.conf
+	rm -f /tmp/redis_cluster_password_protected_node8.conf
+
 test:
 	make start
 	make tox
@@ -201,11 +362,16 @@ test:
 tox:
 	coverage erase
 	tox
+	TEST_PASSWORD_PROTECTED=1 tox
 	coverage combine
 	coverage report
 
+clone-redis:
+	[ ! -e redis-git ] && git clone https://github.com/antirez/redis.git redis-git || true
+	cd redis-git && git checkout $(REDIS_VERSION)
+
 redis-install:
-	[ ! -e redis-git ] && git clone --depth 1 https://github.com/antirez/redis.git redis-git || true
+	make clone-redis
 	make -C redis-git -j4
 	gem install redis
 	sleep 3
@@ -224,4 +390,7 @@ benchmark:
 	@echo " -- Running Simple benchmark with StrictRedisCluster lib and cluster server"
 	python benchmarks/simple.py --port 7001 --timeit --pipeline
 
+ptp:
+	python ptp-debug.py
+
 .PHONY: test