Merge lp:~jibel/mago/simple-scan into lp:~mago-contributors/mago/mago-1.0

[Jean-Baptiste Lallement]

[Nagappan Alagappan (nagappan)]

In Line # 144, I would just do, waittillguinotexist() as the default timeout is 30 seconds, also we can remove the rest of condition over there.

Thanks

review: Approve

[lp:~jibel/mago/simple-scan]

137. By Jean-Baptiste Lallement on 2010-11-08

* mago/application/simple_scan.py: rely on default timout in waittillguinotexist() in close()
* Add README

[Jean-Baptiste Lallement (jibel)]

Thanks for reviewing, I've applied the change you suggested.

=== added file 'mago/application/simple_scan.py'
--- mago/application/simple_scan.py	1970-01-01 00:00:00 +0000
+++ mago/application/simple_scan.py	2010-11-08 09:14:42 +0000
@@ -0,0 +1,154 @@
+PACKAGE = "mago"
+
+#-*- coding:utf-8 -*-
+"""
+This is the "simple_scan" module.
+
+This module provides a wrapper for LDTP to make writing Simple_scan tests easier.
+"""
+import ooldtp
+import ldtp
+import os
+from .main import Application
+from ..gconfwrapper import GConf
+from ..cmd import globals
+import time
+import gettext
+
+gettext.install (True)
+gettext.bindtextdomain (PACKAGE, globals.LOCALE_SHARE)
+gettext.textdomain (PACKAGE)
+t = gettext.translation(PACKAGE, globals.LOCALE_SHARE, fallback = True)
+_ = t.gettext
+
+
+class Simple_scan(Application):
+    """
+    simple_scan manages the Simple_scan application.
+    """
+
+    LAUNCHER = 'simple-scan'
+    LAUNCHER_ARGS = ['test']
+    WINDOW = 'frmSimpleScan'
+
+    BTNCHANGESCANNER = _('btnChangeScanner')
+    BTNCLOSE = _('btnClose')
+    BTNNEW = _('btnNew')
+    BTNROTATELEFT = _('btnRotateLeft')
+    BTNROTATERIGHT = _('btnRotateRight')
+    BTNSAVE = _('btnSave')
+    BTNSCAN = _('btnScan')
+    BTNSTOP = _('btnStop')
+    BTNQUITWITHOUTSAVING = _('btnQuitwithoutSaving')
+
+    DLGSAVEAS = _('dlgSaveAs...')
+    DLGWARNING = _('dlgWarning')
+
+    MNUABOUT = _('mnuAbout')
+    MNUALLPAGESFROMFEEDER = _('mnuAllPagesFromFeeder')
+    MNUCONTENTS = _('mnuContents')
+    MNUDELETE = _('mnuDelete')
+    MNUEMAIL = _('mnuEmail')
+    MNUGETHELPONLINE = _('mnuGetHelpOnline')
+    MNUMOVELEFT = _('mnuMoveLeft')
+    MNUMOVERIGHT = _('mnuMoveRight')
+    MNUNEW = _('mnuNew')
+    MNUPREFERENCES = _('mnuPreferences')
+    MNUPRINT = _('mnuPrint')
+    MNUQUIT = _('mnuQuit')
+    MNUREPORTAPROBLEM = _('mnuReportaProblem')
+    MNUROTATECROP = _('mnuRotateCrop')
+    MNUROTATELEFT = _('mnuRotateLeft')
+    MNUROTATERIGHT = _('mnuRotateRight')
+    MNUSAVE = _('mnuSave')
+    MNUSAVEAS = _('mnuSaveAs')
+    MNUSINGLEPAGE = _('mnuSinglePage')
+    MNUSTOPSCAN = _('mnuStopScan')
+    MNUPHOTO = _('mnuPhoto')
+    MNUTEXT = _('mnuText')
+    MNUTRANSLATETHISAPPLICATION = _('mnuTranslateThisApplication')
+
+    TXTNAME = _('txtName')
+
+    def __init__(self):
+        Application.__init__(self)
+        self.main_window = ooldtp.context(self.WINDOW)
+
+    def scan(self, scan_type = "text"):
+        if not Application.is_opened(self):
+            Application.open(self)
+
+        scan_type = scan_type.lower()
+
+        if scan_type == 'text' :
+            self.main_window.click(self.MNUTEXT)
+        elif scan_type == 'photo':
+            self.main_window.click(self.MNUPHOTO)
+        else:
+            # Unknown type
+            raise AssertionError("'%': Unknown type\n", scan_type)
+
+        rc = self.main_window.click(self.BTNSCAN)
+        ldtp.wait(20)
+        return 0
+
+    def save(self, filename):
+        """
+        It tries to save the current opened buffer to the filename passed as
+        parameter.
+
+        TODO: It does not manage the overwrite dialog yet.
+
+        @type filename: string
+        @param filename: The name of the file to save the buffer to.
+        """
+        Application.save(self, self.MNUSAVE)
+        ooldtp.context(self.name)
+
+        ldtp.waittillguiexist(self.DLGSAVEAS)
+        save_dialog = ooldtp.context(self.DLGSAVEAS)
+        
+        save_dlg_txt_filename = save_dialog.getchild(self.TXTNAME)
+        ldtp.wait(2)
+        save_dlg_txt_filename.settextvalue(filename)
+
+        save_dlg_btn_save = save_dialog.getchild(self.BTNSAVE)
+        
+        save_dlg_btn_save.click()
+
+        ldtp.waittillguinotexist(self.DLGSAVEAS)
+        ldtp.wait(1)
+
+    def close(self, save=False, filename=''):
+        """
+        Given a gedit window, it tries to close the application.
+        By default, it closes without saving. This behaviour can be changed to save (or save as) on close.
+         
+        @type save: boolean
+        @param save: If True, the edited file will be saved on close.
+
+        @type filename: string
+        @param filename: The file name to save the buffer to 
+        """
+        # Exit using the Quit menu 
+        app = ooldtp.context(self.name)
+        quit_menu = app.getchild(self.MNUQUIT)
+        quit_menu.selectmenuitem()
+
+        question_dialog = None
+        count = 0
+        while not app.waittillguinotexist():
+            try:
+                question_dialog = ooldtp.context(self.DLGWARNING)
+            except:
+                pass
+            else:
+                break
+
+        # If the text has changed, the save dialog will appear
+        if question_dialog:
+            question_dlg_btn_close = question_dialog.getchild(self.BTNQUITWITHOUTSAVING)
+            question_dlg_btn_close.click()
+
+            app.waittillguinotexist(guiTimeOut=20)
+

=== added file 'mago/test_suite/simple_scan.py'
--- mago/test_suite/simple_scan.py	1970-01-01 00:00:00 +0000
+++ mago/test_suite/simple_scan.py	2010-11-08 09:14:42 +0000
@@ -0,0 +1,20 @@
+"""
+This module contains the definition of the test suite for Simple_scan testing.
+"""
+import ldtp, ooldtp
+from .main import SingleApplicationTestSuite
+from ..application.simple_scan import Application, Simple_scan
+
+class Simple_scanTestSuite(SingleApplicationTestSuite):
+    """
+    Default test suite for Simple_scan
+    """
+    APPLICATION_FACTORY = Simple_scan
+    def setup(self):
+        self.application.open()
+
+    def teardown(self):
+        self.application.close()
+
+    def cleanup(self):
+        self.application.close()

=== added directory 'simple_scan'
=== added file 'simple_scan/README'
--- simple_scan/README	1970-01-01 00:00:00 +0000
+++ simple_scan/README	2010-11-08 09:14:42 +0000
@@ -0,0 +1,19 @@
+Simple-Scan Tests 
+---------------------
+Tests that verify simple-scan functionality.
+
+Safety
+------
+None of these tests touches any configuration or system files. They use the sane-test backend to simulate a scan.
+
+Configuration
+-------------
+Nothing
+
+Available Tests
+---------------
+ 
+* Simple Scan
+    - Text Scan
+    - Photo Scan
+

=== added directory 'simple_scan/data'
=== added file 'simple_scan/data/photo.jpeg'
Binary files simple_scan/data/photo.jpeg	1970-01-01 00:00:00 +0000 and simple_scan/data/photo.jpeg	2010-11-08 09:14:42 +0000 differ
=== added file 'simple_scan/data/text.jpeg'
Binary files simple_scan/data/text.jpeg	1970-01-01 00:00:00 +0000 and simple_scan/data/text.jpeg	2010-11-08 09:14:42 +0000 differ
=== added file 'simple_scan/simple_scan.py'
--- simple_scan/simple_scan.py	1970-01-01 00:00:00 +0000
+++ simple_scan/simple_scan.py	2010-11-08 09:14:42 +0000
@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+from os import path
+from time import time, gmtime, strftime
+
+from mago.check import ScreenshotCompare, FAIL
+from mago.test_suite.simple_scan import Simple_scanTestSuite 
+
+class Simple_scan(Simple_scanTestSuite):
+    """ Some basic scan testing """
+
+    def test_scan(self, scan_type=None, oracle=None):
+        test_file = strftime(
+            "/tmp/" + "%Y%m%d_%H%M%S" + ".jpeg", gmtime((time())))
+        self.application.scan(scan_type)
+        self.application.save(test_file)
+
+        oracle = path.join(self.get_test_dir(), oracle)
+        checker = ScreenshotCompare(oracle, test_file)
+
+        try:
+            passed = checker.perform_test()
+        except Exception, e:
+            checker.calibrate()
+            raise e
+        if passed == FAIL:
+            raise AssertionError('Scan file differs from reference', test_file)
+
+
+
+if __name__ == "__main__":
+    simple_scan_test =  Simple_scan()
+    simple_scan_test.run()

=== added file 'simple_scan/simple_scan.xml'
--- simple_scan/simple_scan.xml	1970-01-01 00:00:00 +0000
+++ simple_scan/simple_scan.xml	2010-11-08 09:14:42 +0000
@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<suite name="simple_scan">
+  <class>simple_scan.Simple_scan</class>
+  <description>
+    Tests which verify Simple_scan basics scan functionality.
+  </description>
+  <case name="Text Scan test">
+    <method>test_scan</method>
+    <description>Text Scan test</description>
+    <args>
+        <oracle>data/text.jpeg</oracle>
+        <scan_type>text</scan_type>
+    </args>
+  </case>
+  <case name="Photo Scan test">
+    <method>test_scan</method>
+    <description>Photo Scan test</description>
+    <args>
+        <oracle>data/photo.jpeg</oracle>
+        <scan_type>photo</scan_type>
+    </args>
+  </case>
+</suite>