🚧 Add long time job

.travis.yml

@@ -56,7 +56,7 @@ script:
   - docker-compose -f docker-compose.${DATABASE}.yml ps "erpnext_app" | grep "Up"
   - docker-compose -f docker-compose.${DATABASE}.yml logs "erpnext_web"
   - docker-compose -f docker-compose.${DATABASE}.yml ps "erpnext_web" | grep "Up"
-  - echo 'Wait until test finished (3 minutes)' && sleep 180
+  - echo 'Wait until test finished (5 minutes)' && sleep 300
   - docker-compose -f docker-compose.${DATABASE}.yml logs "sut"
   - docker-compose -f docker-compose.${DATABASE}.yml ps "sut" | grep "Exit 0"
 

.travis/docker_test.sh

@@ -62,6 +62,10 @@ FRAPPE_APP_UNIT_TEST_PROFILE="$(pwd)/sites/.${FRAPPE_APP_TO_TEST}_unit_tests.pro
 
 #bench run-tests --help
 
+bench doctor
+bench enable-scheduler
+bench doctor
+
 echo "Executing Unit Tests of '${FRAPPE_APP_TO_TEST}' app..."
 if [ "${TEST_VERSION}" = "10" ]; then
     bench run-tests \

erpnext_ocr/erpnext_ocr/doctype/ocr_language/test_ocr_language.py

@@ -27,7 +27,7 @@ def delete_test_data():
         #test_user.remove_roles("System Manager")
         #test_user.delete()
         frappe.db.sql("""delete from `tabUser` where email='test_user@example.com'""") # ValidationError without SQL
-
+        frappe.db.sql("""delete from `tabEmail Queue`""")
 
 class TestOCRLanguage(unittest.TestCase):
     def setUp(self):

erpnext_ocr/erpnext_ocr/doctype/ocr_read/ocr_read.py

@@ -18,6 +18,7 @@
 
 from spellchecker import SpellChecker
 
+
 def get_words_from_text(message):
     """
     This function return only list of words from text. Example: Cat in gloves,
@@ -50,14 +51,30 @@ def __init__(self, *args, **kwargs):
         super(OCRRead, self).__init__(*args, **kwargs)
 
     def read_image(self):
-        start_time = time.time()
-        text = read_document(self.file_to_read, self.language or 'eng',
-                             self.spell_checker)
-        delta_time = time.time() - start_time
-        self.read_time = str(delta_time)
-        self.read_result = text
-        self.save()
-        return text
+        return read_ocr(self)
+
+    def read_image_bg(self, is_async=True, now=False):
+        return frappe.enqueue("erpnext_ocr.erpnext_ocr.doctype.ocr_read.ocr_read.read_ocr", queue="long",
+                              timeout=1500, is_async=is_async, now=now, **{'obj': self})
+
+
+@frappe.whitelist()
+def read_ocr(obj):
+    """Call Tesseract OCR to extract the text from a OCR Read object."""
+
+    if obj is None:
+        frappe.msgprint(frappe._("An expected error occurred."),
+                        raise_exception=True)
+
+    start_time = time.time()
+    text = read_document(obj.file_to_read, obj.language or 'eng', obj.spell_checker)
+    delta_time = time.time() - start_time
+
+    obj.read_time = str(delta_time)
+    obj.read_result = text
+    obj.save()
+
+    return text
 
 
 @frappe.whitelist()
@@ -71,9 +88,9 @@ def read_document(path, lang='eng', spellcheck=False, event="ocr_progress_bar"):
         return None
 
     if not lang_available(lang):
-        frappe.msgprint(
-            frappe._("The selected language is not available. Please contact your administrator."),
-            raise_exception=True)
+        frappe.msgprint(frappe._
+                        ("The selected language is not available. Please contact your administrator."),
+                        raise_exception=True)
 
     frappe.publish_realtime(event, {"progress": "0"}, user=frappe.session.user)
 

erpnext_ocr/erpnext_ocr/doctype/ocr_read/test_ocr_read.py

@@ -5,14 +5,16 @@
 
 from __future__ import unicode_literals
 
+
 import frappe
 import unittest
 import os
 
-from erpnext_ocr.erpnext_ocr.doctype.ocr_read.ocr_read import force_attach_file_doc
+from erpnext_ocr.erpnext_ocr.doctype.ocr_read.ocr_read import force_attach_file_doc, read_ocr
+
 
 # TODO Frappe default test records creation
-#def _make_test_records(verbose):
+# def _make_test_records(verbose):
 #    from frappe.test_runner import make_test_objects
 #
 #    docs = [
@@ -78,7 +80,7 @@ def delete_ocr_reads():
             doc.delete()
 
         # Delete directly in DB to avoid validation errors
-        #frappe.db.sql("""delete from `tabOCR Read`""")
+        # frappe.db.sql("""delete from `tabOCR Read`""")
 
         frappe.flags.test_ocr_reads_created = False
 
@@ -90,14 +92,66 @@ def setUp(self):
     def tearDown(self):
         delete_ocr_reads()
 
+    def test_ocr_read_image_bg(self):
+        frappe.set_user("Administrator")
+        doc = frappe.get_doc({
+            "doctype": "OCR Read",
+            "file_to_read": os.path.join(os.path.dirname(__file__),
+                                         os.path.pardir, os.path.pardir, os.path.pardir,
+                                         "tests", "test_data", "sample1.jpg"),
+            "language": "eng"
+        })
+
+        self.assertEqual(None, doc.read_result)
+
+        doc.read_image_bg(is_async=False, now=True)
+
+        # Wait worker completion before moving on in the tests
+
+        # Check worker completion and get "new" document after update by bg job
+        new_doc = frappe.get_doc("OCR Read",
+                                 {"file_to_read": os.path.join(os.path.dirname(__file__),
+                                                               os.path.pardir, os.path.pardir, os.path.pardir,
+                                                               "tests", "test_data", "sample1.jpg"),
+                                  "language": "eng"})
+
+        self.assertEqual(new_doc.read_result, doc.read_result)
+        self.assertIn("The quick brown fox", new_doc.read_result)
+        self.assertIn("jumped over the 5", new_doc.read_result)
+        self.assertIn("lazy dogs!", new_doc.read_result)
+        self.assertNotIn("And an elephant!", new_doc.read_result)
+
+    def test_ocr_read_image_bg_pdf(self):
+        frappe.set_user("Administrator")
+        doc = frappe.get_doc({
+            "doctype": "OCR Read",
+            "file_to_read": os.path.join(os.path.dirname(__file__),
+                                         os.path.pardir, os.path.pardir, os.path.pardir,
+                                         "tests", "test_data", "sample2.pdf"),
+            "language": "eng"
+        })
+
+        self.assertEqual(None, doc.read_result)
+
+        doc.read_image_bg(is_async=False, now=True)
+
+        new_doc = frappe.get_doc("OCR Read", {
+            "file_to_read": os.path.join(os.path.dirname(__file__),
+                                         os.path.pardir, os.path.pardir, os.path.pardir,
+                                         "tests", "test_data", "sample2.pdf"),
+            "language": "eng"})
+
+        self.assertEqual(new_doc.read_result, doc.read_result)
+        self.assertIn("Python Basics", new_doc.read_result)
+        self.assertNotIn("Java", new_doc.read_result)
 
     def test_ocr_read_image(self):
         frappe.set_user("Administrator")
         doc = frappe.get_doc({
             "doctype": "OCR Read",
             "file_to_read": os.path.join(os.path.dirname(__file__),
-                                        os.path.pardir, os.path.pardir, os.path.pardir,
-                                        "tests", "test_data", "sample1.jpg"),
+                                         os.path.pardir, os.path.pardir, os.path.pardir,
+                                         "tests", "test_data", "sample1.jpg"),
             "language": "eng"
         })
 
@@ -109,14 +163,13 @@ def test_ocr_read_image(self):
         self.assertIn("lazy dogs!", recognized_text)
         self.assertNotIn("And an elephant!", recognized_text)
 
-
     def test_ocr_read_pdf(self):
         frappe.set_user("Administrator")
         doc = frappe.get_doc({
             "doctype": "OCR Read",
             "file_to_read": os.path.join(os.path.dirname(__file__),
-                                        os.path.pardir, os.path.pardir, os.path.pardir,
-                                        "tests", "test_data", "sample2.pdf"),
+                                         os.path.pardir, os.path.pardir, os.path.pardir,
+                                         "tests", "test_data", "sample2.pdf"),
             "language": "eng"
         })
 
@@ -128,21 +181,20 @@ def test_ocr_read_pdf(self):
         self.assertIn("Python Basics", recognized_text)
         self.assertNotIn("Java", recognized_text)
 
-
     def test_force_attach_file_doc(self):
         doc = frappe.get_doc({
             "doctype": "OCR Read",
             "file_to_read": os.path.join(os.path.dirname(__file__),
-                                        os.path.pardir, os.path.pardir, os.path.pardir,
-                                        "tests", "test_data", "Picture_010.png"),
+                                         os.path.pardir, os.path.pardir, os.path.pardir,
+                                         "tests", "test_data", "Picture_010.png"),
             "language": "eng"
         })
 
         force_attach_file_doc('test.tif', doc.name)
 
         forced_doc = frappe.get_doc({
             "doctype": "OCR Read",
-            #"name": doc.name,
+            # "name": doc.name,
             "file_to_read": "/private/files/test.tif",
             "language": "eng"
         })
@@ -154,7 +206,7 @@ def test_ocr_read_list(self):
         # frappe.set_user("test1@example.com")
         frappe.set_user("Administrator")
         res = frappe.get_list("OCR Read", filters=[
-                              ["OCR Read", "file_to_read", "like", "%sample%"]], fields=["name", "file_to_read"])
+            ["OCR Read", "file_to_read", "like", "%sample%"]], fields=["name", "file_to_read"])
         self.assertEqual(len(res), 2)
         files_to_read = [r.file_to_read for r in res]
         self.assertTrue(os.path.join(os.path.dirname(__file__),
@@ -163,3 +215,6 @@ def test_ocr_read_list(self):
         self.assertTrue(os.path.join(os.path.dirname(__file__),
                                      os.path.pardir, os.path.pardir, os.path.pardir,
                                      "tests", "test_data", "sample2.pdf") in files_to_read)
+
+    def test_read_ocr(self):
+        self.assertRaises(frappe.ValidationError, read_ocr, obj=None)