Merge lp:~cprov/core-result-checker/flake8 into lp:core-result-checker

[Celso Providelo]

Installing flake8 for tests and benefiting of its integration with setuptools for processing all installed files.

Installing flake8 for tests and benefiting of its integration with setuptools for processing all installed files.

Also fixing current issues and requiring flake8 clearness in tarmac, plus extra heavy-lifting on boilerplate files (README and requirements.txt)

[Thomi Richards (thomir-deactivatedaccount)]

review: Approve

=== modified file 'README.rst'
--- README.rst	2015-03-24 22:57:22 +0000
+++ README.rst	2015-04-01 01:35:59 +0000
@@ -1,4 +1,75 @@
 Core Result Checker
 ###################
 
-A micro-service that checks results from the core-image-tester and makes them public.
+A micro-service that checks results from the core-image-tester and makes
+them public.
+
+
+Get the Source
+==============
+
+Branch the code::
+
+  $ bzr branch lp:core-result-checker
+
+
+Install the Service
+===================
+
+Build and activate a virtualenv with python3::
+
+  $ virtualenv -p python3 --system-site-packages ve
+  $ . ve/bin/activate
+
+Install dependencies from pypi::
+
+  $ pip install -r requirements.txt
+
+Install the service itself::
+
+  $ python setup.py install
+
+...you may want to install it in 'development mode', which symlinks files, 
+so you can edit/re-run without having to re-install the service. In that 
+case, run::
+
+  $ python setup.py develop
+
+
+Run the tests!
+==============
+
+Install dependencies::
+
+  $ pip install -r test_requirements.txt
+
+Run those tests - with vigour!::
+
+  $ python setup.py test
+
+Also with elegance in mind::
+
+  $ python setup.py flake8
+
+
+The config file
+===============
+
+The sample configuration file in 'core-service.conf'::
+
+  [amqp]
+  uris = amqp://guest:guest@localhost:5672//
+
+  [nova]
+  os_username = foo
+  os_password = <redacted>
+  os_tenant_name = foo_project
+  os_auth_url = http://172.20.161.138:5000/v2.0/
+
+...optionally, add a logstash section, which will turn on the logstash
+handler::
+
+  [logstash]
+  host = 127.0.0.1
+  port = 1234
+  version = 1

=== modified file 'called-by-tarmac.py'
--- called-by-tarmac.py	2015-03-27 04:37:20 +0000
+++ called-by-tarmac.py	2015-04-01 01:35:59 +0000
@@ -89,6 +89,11 @@
                 'setup.py',
                 'test',
             ],
+            [
+                os.path.join(ve_dir, 'bin', 'python3'),
+                'setup.py',
+                'flake8',
+            ],
         )
         for cmd in all_cmds:
             ret = _run_command(cmd)

=== modified file 'core_result_checker/__init__.py'
--- core_result_checker/__init__.py	2015-03-27 04:35:19 +0000
+++ core_result_checker/__init__.py	2015-04-01 01:35:59 +0000
@@ -19,6 +19,7 @@
 import configparser
 import logging
 import logging.handlers
+import logstash
 import os
 import select
 

=== modified file 'requirements.txt'
--- requirements.txt	2015-03-25 02:54:49 +0000
+++ requirements.txt	2015-04-01 01:35:59 +0000
@@ -0,0 +1,2 @@
+kombu==3.0.24
+python-logstash==0.4.2

=== modified file 'setup.py'
--- setup.py	2015-03-25 04:59:12 +0000
+++ setup.py	2015-04-01 01:35:59 +0000
@@ -20,7 +20,10 @@
 import sys
 assert sys.version_info >= (3,), 'Python 3 is required'
 
-from setuptools import find_packages, setup, Extension
+from setuptools import (
+    find_packages,
+    setup,
+)
 
 
 VERSION = '1.0.0'

=== modified file 'test_requirements.txt'
--- test_requirements.txt	2015-03-25 02:54:49 +0000
+++ test_requirements.txt	2015-04-01 01:35:59 +0000
@@ -0,0 +1,2 @@
+testtools==1.7.1
+flake8==2.4.0