Changeset 12005 for main/waeup.ikoba/trunk/src/waeup/ikoba

Timestamp:

20 Nov 2014, 05:40:52 (10 years ago)

Author:

Henrik Bettermann

Message:

Implement document_id generator. Ensure that document_ids remain unique during import.

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba

Files:

• app.py (modified) (2 diffs)
• customers/batching.py (modified) (2 diffs)
• customers/customer.py (modified) (1 diff)
• customers/tests/sample_document_data.csv (modified) (1 diff)
• customers/tests/test_batching.py (modified) (4 diffs)
• documents/container.py (modified) (1 diff)
• documents/document.py (modified) (2 diffs)
• documents/interfaces.py (modified) (1 diff)
• documents/tests.py (modified) (1 diff)
• documents/utils.py (added)

main/waeup.ikoba/trunk/src/waeup/ikoba/app.py

@@ -39 +39 @@
     grok.implements(ICompany)
 
+    _curr_doc_id = 101
+
     # Setup authentication for this app. Note: this is only
     # initialized, when a new instance of this app is created.
@@ -49 +51 @@
         self.setup()
         return
+
+    @property
+    def unique_document_id(self):
+        """A unique document id for all documents in company.
+
+        The document id returned is guaranteed to be unique. It
+        consists of some prefix (normally a single letter) followed by
+        a number with at least 7 digits.
+
+        Once a document id was issued, it won't be issued again.
+
+        Obtaining a document id is currently not thread-safe but can be
+        made easily by enabling commented lines.
+        """
+        # lock.acquire() # lock data
+        new_id = u'd%s' % (self._curr_doc_id)
+        self._curr_doc_id += 1
+        # self._p_changed = True
+        # commit()
+        # lock.release() # end of lock
+        return new_id
 
     def setup(self):

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/batching.py

@@ -40 +40 @@
 from waeup.ikoba.interfaces import IIkobaUtils
 from waeup.ikoba.interfaces import MessageFactory as _
+from waeup.ikoba.documents.utils import generate_document_id
 from waeup.ikoba.customers.interfaces import (
     ICustomer, ICustomerUpdateByRegNo,
@@ -440 +441 @@
         document_id = row.get('document_id', None)
         if not document_id:
-            timestamp = ("%d" % int(time()*10000))[1:]
-            document_id = "d%s" % timestamp
+            document_id = generate_document_id()
             conv_dict['document_id'] = document_id
             return errs, inv_errs, conv_dict
-        if not document_id.startswith('d') or len(document_id) != 14:
+        # document_id must not exist.
+        if mode == 'create':
+            cat = queryUtility(ICatalog, name='documents_catalog')
+            results = list(
+                cat.searchResults(document_id=(document_id, document_id)))
+            if results:
+                errs.append(('document_id','id exists'))
+        if not document_id.startswith('d'):
             errs.append(('document_id','invalid format'))
         return errs, inv_errs, conv_dict

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/customer.py

@@ -1 @@
-## $Id: customer.py 11604 2014-04-29 07:31:54Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/sample_document_data.csv

@@ -1 +1 @@
 document_id,reg_number,title
-d1266236341953,1,My first doc
-d1266236341954,2,My second doc
-d1266236341955,3,My third doc
+d3,1,My first doc
+d4,2,My second doc
+d5,3,My third doc
 ,1,My 4th doc
+d5,2,My stolen doc

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/test_batching.py

@@ -328 +328 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, DOCUMENT_HEADER_FIELDS,'create')
-        self.assertEqual(num_warns,0)
+        self.assertEqual(num_warns,1)
+        # document_id must be unique
+        fail_file = open(fail_file).read()
+        self.assertEqual(fail_file,
+            'reg_number,document_id,title,--ERRORS--\r\n'
+            '2,d5,My stolen doc,document_id: id exists\r\n')
         document = self.processor.getEntry(dict(reg_number='1',
-            document_id='d1266236341953'), self.app)
+            document_id='d3'), self.app)
         self.assertEqual(
-            self.app['customers']['X666666']['documents']['d1266236341953'],
+            self.app['customers']['X666666']['documents']['d3'],
             document)
-        self.assertEqual(document.document_id, 'd1266236341953')
+        self.assertEqual(document.document_id, 'd3')
         document = self.processor.getEntry(dict(reg_number='3',
-            document_id='d1266236341955'), self.app)
+            document_id='d5'), self.app)
         shutil.rmtree(os.path.dirname(fin_file))
         logcontent = open(self.logfile).read()
@@ -343 +348 @@
             'INFO - system - CustomerDocument Processor - '
             'sample_document_data - X666666 - updated: '
-            'document_id=d1266236341953, title=My first doc'
+            'document_id=d3, title=My first doc'
             in logcontent)
 
@@ -355 +360 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, DOCUMENT_HEADER_FIELDS,'update')
-        self.assertEqual(num_warns,1)  # There is one record without document_id
+        # There is one record without document_id and one duplicate
+        self.assertEqual(num_warns,2)
         shutil.rmtree(os.path.dirname(fin_file))
 
@@ -367 +373 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, DOCUMENT_HEADER_FIELDS,'remove')
-        self.assertEqual(num_warns,1)  # There is one record without document_id
+        # There is one record without document_id and one duplicate
+        self.assertEqual(num_warns,2)
         shutil.rmtree(os.path.dirname(fin_file))
         logcontent = open(self.logfile).read()
         self.assertTrue(
-            'INFO - system - K1000001 - Document removed: d1266236341955'
+            'INFO - system - K1000001 - Document removed: d5'
             in logcontent)

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/container.py

@@ -30 +30 @@
     grok.provides(IDocumentsContainer)
 
-    def __init__(self):
-        super(DocumentsContainer, self).__init__()
-        return
 
     def addDocument(self, document):

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/document.py

@@ -30 +30 @@
 from waeup.ikoba.interfaces import IIkobaUtils, IObjectHistory
 from waeup.ikoba.interfaces import MessageFactory as _
-from waeup.ikoba.documents.interfaces import IDocument, IDocument
 from waeup.ikoba.utils.helpers import attrs_to_fields, get_current_principal
 from waeup.ikoba.utils.logger import Logger
+from waeup.ikoba.documents.interfaces import IDocument, IDocument
+from waeup.ikoba.documents.utils import generate_document_id
 
 class Document(grok.Container, Logger):
@@ -51 +52 @@
         return
 
+    #def __init__(self):
+    #    super(Document, self).__init__()
+    #    timestamp = ("%d" % int(time()*10000))[1:]
+    #    self.document_id = "d%s" % timestamp
+     #   return
+
     def __init__(self):
         super(Document, self).__init__()
-        timestamp = ("%d" % int(time()*10000))[1:]
-        self.document_id = "d%s" % timestamp
+        # The site doesn't exist in unit tests
+        try:
+            self.document_id = generate_document_id()
+        except AttributeError:
+            self.document_id = u'd123'
         return
 

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/interfaces.py

@@ -35 +35 @@
     """
 
+    def addDocument(document):
+        """Add a document.
+        """
+
 class IDocument(IIkobaObject):
     """A base representation of documents.

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/tests.py

@@ -61 +61 @@
         self.assertEqual(container[document_id], document)
         self.assertRaises(TypeError, container.addDocument, object())
+        self.assertEqual(document_id, 'd123')
         return