Reconhecer os status de serviços de validação de um pacote #810

Author: jfunez

scielomanager/articletrack/models.py

@@ -2,6 +2,7 @@
 import caching.base
 import datetime
 import logging
+from collections import deque
 
 from django.db import models
 from django.db.models.signals import post_save
@@ -13,9 +14,12 @@
 
 from articletrack import modelmanagers
 from journalmanager.models import Journal
+from scielomanager.utils import misc
 
 logger = logging.getLogger(__name__)
 
+SERVICE_STATUS_MAX_STAGES = 2  # The count of pairs (SERV_BEGIN, SERV_END) in notice.status at the end of processing
+
 MSG_WORKFLOW_ACCEPTED = 'Checkin Accepted'
 MSG_WORKFLOW_REJECTED = 'Checkin Rejected'
 MSG_WORKFLOW_REVIEWED = 'Checkin Reviewed'
@@ -100,14 +104,46 @@ class Meta:
         ordering = ['-created_at']
         permissions = (("list_checkin", "Can list Checkin"),)
 
+    @property
+    def is_serv_status_completed(self):
+        """
+        If:
+            the count of SERV_END < SERVICE_STATUS_MAX_STAGES, or
+            the count of SERV_BEGIN < SERVICE_STATUS_MAX_STAGES
+        then:
+            the checkin's notices sequence is UNCOMPLETED (possible more notices will arrive)
+            -> Return False
+        Else:
+            if the count of SERV_* is equal to 2 * SERVICE_STATUS_MAX_STAGES, then
+                call the ``misc.validate_sequence`` function
+                to check if the checkin's notices sequence is COMPLETED
+                -> Return True
+            else:
+                -> Return False
+        """
+        count_serv_end_notices = self.notices.filter(status__iexact="SERV_END").count()
+        count_serv_begin_notices = self.notices.filter(status__iexact="SERV_BEGIN").count()
+        if (count_serv_end_notices < SERVICE_STATUS_MAX_STAGES) or (count_serv_begin_notices < SERVICE_STATUS_MAX_STAGES):
+            return False
+        else:
+            serv_ocurrs = self.notices.filter(status__istartswith="serv_").order_by('created_at')
+            if serv_ocurrs.count() == (2 * SERVICE_STATUS_MAX_STAGES):
+                sequence = [sym.status for sym in serv_ocurrs]
+                return misc.validate_sequence(sequence)
+            else:
+                return False
+
     @property
     def get_error_level(self):
-        if self.notices.filter(status__iexact="error").count() > 0:
-            return "error"
-        elif self.notices.filter(status__iexact="warning").count() > 0:
-            return "warning"
+        if self.is_serv_status_completed:
+            if self.notices.filter(status__iexact="error").count() > 0:
+                return "error"
+            elif self.notices.filter(status__iexact="warning").count() > 0:
+                return "warning"
+            else:
+                return "ok"
         else:
-            return "ok"
+            return "in progress"
 
     @property
     def get_newest_checkin(self):

scielomanager/articletrack/templates/articletrack/includes/checkin_list_and_filterform.html

@@ -49,7 +49,11 @@ <h3><i class="{{ icon_class|default:''}}"></i> {% trans list_title %}:</h3>
         <td>{{ checkin.article.issue_label }}</td>
         <td>{{ checkin.created_at|date:"d/m/Y - H:i" }}</td>
         <td>
-          <span class="label label-{% trans_status checkin.get_error_level to_label='True' %}">
+          {% if checkin.get_error_level == 'in progress' %}
+            <span class="label label-info">
+          {% else %}
+            <span class="label label-{% trans_status checkin.get_error_level to_label='True' %}">
+          {% endif %}
             {{ checkin.get_error_level }}
           </span>
         </td>

scielomanager/articletrack/templates/articletrack/notice_detail.html

@@ -170,30 +170,30 @@ <h3>{% trans 'Notices' %}:</h3>
             </thead>
             <tbody>
               {% for notice in notices %}
-              <tr class="{% trans_status notice.status %}">
-                <td>
-                  {{ notice.stage }}
-                </td>
-                <td>
-                  <span class="label label-{% trans_status notice.status to_label='True' %}">
-                    {{ notice.status }}
-                  </span>
-                </td>
-                <td>
-                  {{ notice.message }}
-                </td>
-                <td>
-                  {{ notice.created_at|date:"d/m/Y - H:i" }}
-                </td>
-              </tr>
+                <tr class="{% trans_status notice.status %}">
+                  <td>
+                    {{ notice.stage }}
+                  </td>
+                  <td>
+                    <span class="label label-{% trans_status notice.status to_label='True' %}">
+                      {{ notice.status }}
+                    </span>
+                  </td>
+                  <td>
+                    {{ notice.message }}
+                  </td>
+                  <td>
+                    {{ notice.created_at|date:"d/m/Y - H:i" }}
+                  </td>
+                </tr>
               {% empty %}
-              <tr>
-                <td colspan="5">
-                  <div class="alert alert-info">
-                    <i class="icon-info-sign"></i> {% trans "There are no notices." %}
-                  </div>
-                </td>
-              </tr>
+                <tr>
+                  <td colspan="5">
+                    <div class="alert alert-info">
+                      <i class="icon-info-sign"></i> {% trans "There are no notices." %}
+                    </div>
+                  </td>
+                </tr>
               {% endfor %}
             <tbody>
           </table>

scielomanager/articletrack/tests/tests_models.py

@@ -5,6 +5,7 @@
 from django.conf import settings
 from articletrack import models
 from . import modelfactories
+from scielomanager.utils import misc
 
 
 class CommentTests(TestCase):
@@ -203,6 +204,20 @@ def test_if_expiration_date_is_today_then_checkin_is_expirable(self):
         self.assertEqual(checkin.expiration_at.date(), now.date())
         self.assertTrue(checkin.is_expirable)
 
+    def test_validate_sequence_function(self):
+        sequences = (
+            (True, ["SERV_BEGIN", "SERV_END", "SERV_BEGIN", "SERV_END"]),
+            (True, ["SERV_BEGIN", "SERV_BEGIN", "SERV_END", "SERV_END"]),
+            (False, ["SERV_BEGIN", "SERV_BEGIN", "SERV_END", "ANOTHER_SYMBOL"]),
+            (False, ["SERV_BEGIN", "SERV_BEGIN", "SERV_END"]),
+            (False, ["SERV_BEGIN", "SERV_END", "SERV_END"]),
+            (False, ["SERV_BEGIN", "SERV_BEGIN", "SERV_BEGIN", "SERV_BEGIN", ]),
+            (False, ["SERV_END", "SERV_END", "SERV_END", "SERV_END", ]),
+        )
+        for expected_result, sequence in sequences:
+            validation_result = misc.validate_sequence(sequence)
+            self.assertEqual(expected_result, validation_result)
+
 
 class ArticleTests(TestCase):
 
@@ -360,3 +375,68 @@ def test_do_expires_generate_log_entry(self):
         self.assertIsNone(logs[0].user)
         self.assertEqual(logs[0].status, 'expired')
         self.assertEqual(logs[0].description, models.MSG_WORKFLOW_EXPIRED)
+
+    def test_checkin_with_notices_incomplete_service_status_must_be_in_progress(self):
+        """
+        For one checkin, generate various notices like incomplete processing, such as only one SERV_BEGIN
+        """
+        checkin = modelfactories.CheckinFactory()
+        modelfactories.NoticeFactory(
+            checkin=checkin,
+            stage=" ", message=" ", status="SERV_BEGIN",
+            created_at=datetime.datetime.now())
+
+        self.assertFalse(checkin.is_serv_status_completed)
+        self.assertEqual('in progress', checkin.get_error_level)
+
+    def test_checkin_notices_with_less_serv_status_than_SERVICE_STATUS_MAX_STAGES_is_incompleted(self):
+        """
+        If a checkin's notices, are less than SERVICE_STATUS_MAX_STAGES service status (SERV_END), is incomplete
+        """
+        checkin = modelfactories.CheckinFactory()
+        serv_status_count = models.SERVICE_STATUS_MAX_STAGES - 1
+        for step in xrange(0, serv_status_count):
+            modelfactories.NoticeFactory(
+                checkin=checkin,
+                stage=" ", message=" ", status="SERV_END",
+                created_at=datetime.datetime.now())
+
+        self.assertFalse(checkin.is_serv_status_completed)
+        self.assertEqual('in progress', checkin.get_error_level)
+
+    def test_checkin_notices_with_equal_serv_status_than_SERVICE_STATUS_MAX_STAGES_is_incompleted(self):
+        """
+        If a checkin's notices, are equal to SERVICE_STATUS_MAX_STAGES service status (SERV_END), still incomplete
+        because only have: "SERV_END" as service status.
+        """
+        checkin = modelfactories.CheckinFactory()
+        serv_status_count = models.SERVICE_STATUS_MAX_STAGES
+        for step in xrange(0, serv_status_count):
+            modelfactories.NoticeFactory(
+                checkin=checkin,
+                stage=" ", message=" ", status="SERV_END",
+                created_at=datetime.datetime.now())
+
+        self.assertFalse(checkin.is_serv_status_completed)
+        self.assertEqual('in progress', checkin.get_error_level)
+
+    def test_checkin_notices_with_correct_pair_of_service_status_is_completed(self):
+        """
+        If checkin's notices, are equal to SERVICE_STATUS_MAX_STAGES service status (SERV_END), is complete
+        because each service status  has a pair: "SERV_BEGIN"/"SERV_END" as service status, and checkin.error_level
+        is 'ok' because has no "error"/"warning" notices
+        """
+        checkin = modelfactories.CheckinFactory()
+        serv_status_count = models.SERVICE_STATUS_MAX_STAGES
+        for step in xrange(0, serv_status_count):
+            notice_serv_begin = modelfactories.NoticeFactory(
+                checkin=checkin,
+                stage=" ", message=" ", status="SERV_BEGIN",
+                created_at=datetime.datetime.now())
+            notice_serv_end = modelfactories.NoticeFactory(
+                checkin=checkin,
+                stage=" ", message=" ", status="SERV_END",
+                created_at=datetime.datetime.now())
+        self.assertTrue(checkin.is_serv_status_completed)
+        self.assertEqual('ok', checkin.get_error_level)
+

scielomanager/articletrack/views.py

@@ -257,7 +257,7 @@ def checkin_history(request, checkin_id):
 def notice_detail(request, checkin_id):
 
     checkin = get_object_or_404(models.Checkin.userobjects.active(), pk=checkin_id)
-    notices = checkin.notices.all()
+    notices = checkin.notices.exclude(status__istartswith="serv_")
     tickets = checkin.article.tickets.all()
     opened_tickets = tickets.filter(finished_at__isnull=True)
     closed_tickets = tickets.filter(finished_at__isnull=False)

scielomanager/scielomanager/utils/misc.py

@@ -0,0 +1,13 @@
+# coding: utf-8
+def validate_sequence(sequence, open_symbol='SERV_BEGIN', close_symbol='SERV_END'):
+    opened = 0
+    for item in sequence:
+        if item == open_symbol:
+            opened += 1
+        elif item == close_symbol:
+            opened -= 1
+
+        if opened < 0:  # quebra a invariante
+            return False
+
+    return opened == 0