Merge pull request #1096 from scieloorg/beta

Incorporação de códigos estáveis

Author: gustavofonseca

.travis.yml

@@ -1,10 +1,8 @@
 language: python
 python:
   - 2.7
-services: 
-  - mongodb
 env:
-  - DJANGO_VERSION=1.4
+  - DJANGO_VERSION=1.4 SCIELOMANAGER_SETTINGS_FILE=`pwd`/scielomanager/scielomanager/settings_local.include
 install:
   - pip install -r requirements.txt --use-mirrors
   - pip install -r requirements-test.txt --use-mirrors

Makefile

@@ -6,36 +6,37 @@ FIXTURES_DIR = $(APP_PATH)/scielomanager/fixtures
 
 deps:
 	@pip install -r requirements.txt
-	@pip install -r requirements-test.txt
 
 clean:
+	@echo "Removing all .pyc files..."
 	@find . -name "*.pyc" -delete
 
-test: clean
+test: 
 	@python $(MANAGE) test --settings=$(SETTINGS_TEST)
 
-testfast: clean
+testfast:
 	@python $(MANAGE) test --settings=$(SETTINGS_TEST) --failfast
 
 dbsetup:
 	@python $(MANAGE) syncdb --settings=$(SETTINGS)
-	@python $(MANAGE) loaddata $(FIXTURES_DIR)/groups.json --settings=$(SETTINGS)
 
 loaddata:
+	@python $(MANAGE) loaddata $(FIXTURES_DIR)/groups.json --settings=$(SETTINGS)
 	@python $(MANAGE) loaddata $(APP_PATH)/journalmanager/fixtures/use_licenses.json --settings=$(SETTINGS)
 	@python $(MANAGE) loaddata $(FIXTURES_DIR)/subject_categories.json --settings=$(SETTINGS)
 	@python $(MANAGE) loaddata $(FIXTURES_DIR)/study_area.json --settings=$(SETTINGS)
+	@python $(MANAGE) sync_perms --settings=$(SETTINGS)
 
 dbmigrate:
 	@python $(MANAGE) migrate --settings=$(SETTINGS)
 
 compilemessages:
-	@cd $(APP_PATH) && python manage.py compilemessages --settings=$(SETTINGS)
+	@python $(MANAGE) compilemessages --settings=$(SETTINGS)
 
-setup: deps dbsetup dbmigrate loaddata compilemessages test refreshsecretkey
+compile: 
+	@echo "Compiling all source files..."
+	@cd $(APP_PATH) && python -m compileall .
 
-upgrade: deps dbmigrate compilemessages test
-	@python $(MANAGE) sync_perms --settings=$(SETTINGS)
+setup: clean compile deps dbsetup dbmigrate loaddata compilemessages test 
 
-refreshsecretkey:
-	@sed -e 's:^\(SECRET_KEY\).*$$:\1 = '" '`openssl rand -base64 32`' "':g' -i $(APP_PATH)/settings.py
+upgrade: clean compile deps dbmigrate compilemessages

requirements.txt

@@ -23,3 +23,4 @@ django-celery
 django-kombu
 defusedxml==0.4.1
 django-countries
+zerorpc>=0.4.4   

scielomanager/api/resources_v2.py

@@ -120,7 +120,6 @@ def build_filters(self, filters=None):
             param_filters['journal__eletronic_issn'] = filters['journal_eissn']
 
         if 'journal_pissn' in filters:
-            import pdb; pdb.set_trace()
             param_filters['journal__print_issn'] = filters['journal_pissn']
 
         sections = models.Section.objects.filter(**param_filters)

scielomanager/health/__init__.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+import datetime
+import threading
+import logging
+
+import zerorpc
+from django.conf import settings
+
+
+logger = logging.getLogger(__name__)
+BIND_ADDR = getattr(settings, 'IPC_HEALTHD_BIND_ADDR', 'tcp://0.0.0.0:11711')
+
+
+def Server(health_endpoint):
+    server = zerorpc.Server(health_endpoint)
+    server.bind(BIND_ADDR)
+    logger.info('healthd is bound to %s', BIND_ADDR)
+
+    return server
+
+
+def Client(**kwargs):
+    """ Cria um cliente, já conectado ao serviço de monitoramento de
+    saúde do sistema.
+
+    Argumentos nomeados serão passados diretamente na inicialização
+    do objeto `zerorpc.Client`.
+    """
+    client = zerorpc.Client(**kwargs)
+    client.connect(BIND_ADDR)
+    logger.info('healthd client is connected to %s', BIND_ADDR)
+
+    return client
+
+
+class CheckItem(object):
+    """
+    Represents an item that needs to be checked.
+    """
+    def __call__(self):
+        """
+        Performs the check step for a specific app aspect.
+        """
+        raise NotImplementedError()
+
+    def structured(self):
+        return {'description': self.__class__.__doc__.strip(),
+                'status': self()}
+
+
+class CheckList(object):
+    """
+    Performs a sequence of checks related to the application health.
+    """
+    def __init__(self, refresh=0.25):
+        """
+        :param refresh: (optional) refresh rate in minutes.
+        """
+        self.latest_report = {}
+
+        self._check_list = []
+        self._refresh_rate = datetime.timedelta(minutes=refresh)
+        self._refreshed_at = None
+
+        self._lock = threading.Lock()
+
+    def add_check(self, check):
+        """
+        Add a check to the registry.
+
+        :param check: a callable that receives nothing as argument.
+        """
+        assert isinstance(check, CheckItem)
+        self._check_list.append(check)
+
+    def run(self):
+        """
+        Run all checks sequentially and updates the object state.
+        """
+        self.latest_report = {check.__class__.__name__: check.structured()
+                              for check in self._check_list}
+        self._refreshed_at = datetime.datetime.now()
+
+    def update(self):
+        """
+        Run all checks respecting the refresh rate.
+        """
+        with self._lock:
+            if self._refreshed_at is None or (
+                self._refreshed_at + self._refresh_rate <= datetime.datetime.now()):
+
+                self.run()
+
+    def since(self):
+        """
+        Total seconds since the last refresh.
+        """
+        try:
+            return str(datetime.datetime.now() - self._refreshed_at)
+        except TypeError:
+            # called before run any check
+            return None
+

scielomanager/health/checks.py

@@ -0,0 +1,122 @@
+#coding: utf-8
+import logging
+import uuid
+
+import psycopg2
+from django.db import connections, DatabaseError
+from django.core.cache import cache
+from celery import current_app
+from kombu import Connection
+
+from . import CheckItem
+
+
+logger = logging.getLogger(__name__)
+
+
+class PGConnection(CheckItem):
+    """
+    Connection with the data backend
+    """
+    working_status = (
+            psycopg2.extensions.STATUS_READY,
+            psycopg2.extensions.STATUS_BEGIN,
+            psycopg2.extensions.STATUS_IN_TRANSACTION,
+            psycopg2.extensions.STATUS_PREPARED,
+    )
+    def __init__(self):
+        self.must_fail = False
+
+        for conn in connections.all():
+            try:
+                # Executa uma query, mesmo que inválida, apenas para
+                # forçar a comunicação com o backend
+                conn.cursor().execute('SELECT')
+            except DatabaseError:
+                # Erro esperado por conta da query inválida
+                pass
+            except psycopg2.OperationalError as e:
+                self.must_fail = True
+
+    def __call__(self):
+        """
+        Try to list table names just to reach the db.
+        """
+        if self.must_fail:
+            return False
+
+        for conn in connections.all():
+            try:
+                if conn.connection.status not in self.working_status:
+                    return False
+            except AttributeError as e:
+                return None
+        else:
+            return True
+
+
+class CachingBackend(CheckItem):
+    """
+    Connection with the caching backend
+    """
+    def __call__(self):
+        key = uuid.uuid4().hex
+
+        try:
+            ret_code = cache.add(key, '\x01', timeout=1)
+            return bool(ret_code)
+        finally:
+            cache.delete(key)
+
+
+class CeleryConnection(CheckItem):
+    """
+    Connection with celery backend.
+    """
+    def __init__(self):
+        self.broker_url = current_app.conf.BROKER_URL
+
+    def __call__(self):
+        """
+        If backend is "django://" will return None
+        Else: return if is connected or not
+        """
+        if self.broker_url == 'django://':
+            return None
+        else:
+            try:
+                ping_response = current_app.control.ping(timeout=1)[0]
+                ping_key = ping_response.keys()[0]
+                status = ping_response[ping_key]['ok'] == u'pong'
+            except Exception as exc:
+                logger.exception(exc)
+                status = False
+            return status
+
+
+class RabbitConnection(CheckItem):
+    """
+    Connection with RabbitMQ server.
+    """
+    def __init__(self):
+        self.broker_url = current_app.conf.BROKER_URL
+
+    def __call__(self):
+        """
+        Broker URL must start with "amqp://" else return None
+        Return True if can establish connection or not.
+        """
+        if self.broker_url.startswith("amqp://"):
+            try:
+                connection = Connection(self.broker_url, connection_timeout=1)
+                try:
+                    connection.connect()
+                    status = connection.connected
+                finally:
+                    connection.release()
+            except Exception as exc:
+                logger.exception(exc)
+                status = False
+            return status
+        else:
+            return None

scielomanager/health/domain.py

@@ -0,0 +1,44 @@
+#coding: utf-8
+import logging
+
+import zerorpc
+
+import health
+
+
+logger = logging.getLogger(__name__)
+
+
+class BackendUnavailable(Exception):
+    """ Backend de verificação de saúde está indisponível.
+    """
+
+
+class StatusChecker(object):
+    """ Realiza e agrupa as verificações de saúde do sistema.
+    """
+    def __init__(self, client=health.Client):
+        self.client = client(timeout=5)
+
+    @property
+    def is_fully_operational(self):
+        return all([st['status'] for st in self.overall_status().values()])
+
+    def overall_status(self):
+        if not hasattr(self, '_overall_status'):
+            try:
+                setattr(self, '_overall_status', self.client.overall_status())
+            except (zerorpc.LostRemote, zerorpc.TimeoutExpired) as e:
+                logger.exception(e)
+                raise BackendUnavailable(e.message)
+
+        return self._overall_status
+
+    @property
+    def elapsed_time(self):
+        try:
+            return self.client.elapsed_time()
+        except (zerorpc.LostRemote, zerorpc.TimeoutExpired) as e:
+            logger.exception(e)
+            raise BackendUnavailable(e.message)
+