Merge lp:~dpniel/ubiquity/autopilot_fix_custominstall into lp:ubiquity

[Dan Chapman ]

Ok so this should fix the custom install tests and get them passing again. It still needs some further work to get rid of one more sleep.

The changes I made were to generate a dictionary of namedtuples from the all the items in the partition page treeview

Using the Row number as the dictionary key and and column headers as the access names for the named tuple

So now we get a mapped dictionary to any cell in the partition tree by something simple like

>>> table['Row2'].Mountpoint

which gives us the introspectable object of that cell so we can access any of it properties etc.

This fix doesn't fully use the above atm (soon it will) but basically to fix the current error I use the number of rows in the dict to assert it increments after creating a partition. Instead of blindly sleeping. But for now it's a good thing we can test the number of partitions are correct.

In the end I want to map the partition config file to the dict to assert the tree is displaying partitions correctly but that will take a fair bit more work.

Anyway this gets it going for now :-)

[Jean-Baptiste Lallement (jibel)]

168 + if num == self.part_table_rows:
...
172 + if num is not self.part_table_rows + 1:

This is inconsistent, in the first comparison you use the operator '==' and 4 lines below the operator 'is'. They have different meanings. '==' would be more appropriate since you're comparing 2 numbers which are the return len()

This line is unused and pyflakes tests will fail
144 + item_table = tree_view.get_partition_table_dict()

Okay for the TODO, it is still enhancements to the tests but it is not regressing compared to the previous version

I ran the test on ubuntu-desktop and it works fine.

review: Needs Fixing

[lp:~dpniel/ubiquity/autopilot_fix_custominstall]

6141. By Dan Chapman  on 2014-02-27

changed 'is' to == in _update_table_row_count and removed uneeded todo's and unused assignment

6142. By Dan Chapman  on 2014-02-27

fix pep8/ pyflakes and style inconsistencies

[Dan Chapman  (dpniel)]

I have made the suggested changes,

I will try and figure out a way to find the 'freespace' row and wait for it to change so we can remove the sleep

[Jean-Baptiste Lallement (jibel)]

LGTM

review: Approve

=== modified file 'autopilot/ubiquity_autopilot_tests/emulators/gtkcontrols.py'
--- autopilot/ubiquity_autopilot_tests/emulators/gtkcontrols.py	2013-11-19 09:07:08 +0000
+++ autopilot/ubiquity_autopilot_tests/emulators/gtkcontrols.py	2014-02-27 15:58:05 +0000
@@ -20,6 +20,8 @@
 from ubiquity_autopilot_tests.tools.compare import expectThat
 from ubiquity_autopilot_tests.emulators import gtkaccessible
 import logging
+import re
+from collections import namedtuple
 logger = logging.getLogger(__name__)
 
 
@@ -254,6 +256,77 @@
             raise ValueError("NoneType: Could not get list of items")
         return items
 
+    def get_partition_table_dict(self, ):
+        """ Returns a dict of named tuples generated by the list
+            of items returned from get_all_items.
+
+            This enables us to access any available table cell
+            using the Row number and column name
+
+            example usage:
+
+            >>> treeview = self.app.select_single('GtkTreeView')
+            >>> table = treeview.get_partition_table_dict()
+            # we can now access any cell using Row number as Key and
+            column name
+             i.e table['Row Number'].ColumnName
+
+            >>> item = table['Row2'].Mount
+
+            We now have an introspectable object for that particular
+            cell which we can use
+            to either assert the properties of the cell and also click etc....
+
+            >>> self.assertThat(item.accessible_name, Equals('/home'))
+            >>> self.mouse.click(item)
+        """
+        #first get accessible tree
+        treeview = self._get_gail_treeview()
+        # Now each column header is a GtkButton, so we get the label from each
+        # one and create a list
+        tree_column_objects = treeview.select_many('GtkButtonAccessible')
+        column_names = []
+        for column in tree_column_objects:
+            #We are only interested in columns with headers. Blank columns
+            # seem to usually be used for spacing and contain no cells
+            if column.accessible_name == '':
+                pass
+            else:
+                #strip all non alpaha chars
+                name = re.sub(r'\W+', '', column.accessible_name)
+                column_names.append(name)
+        # Create a named tuple using the column headers, which enables access
+        # to the column by name
+        Columns = namedtuple('Columns', column_names)
+        #generate a list of items
+        tree_items = treeview.get_all_items()
+        # lets create a temp list
+        temp_list = []
+        #TODO: we actually don't really need this
+        for item in tree_items:
+            temp_list.append(item)
+        # so we want to create a Columns tuple for each row in the table
+        # therefore picking only the n items where n is the number of column
+        # names
+        start, end = 0, len(column_names)
+        row_list, table_dict = [], {}
+        for i in range(0, int(len(temp_list) / len(column_names))):
+            # fill columns tuple
+            row = Columns(*temp_list[start:end])
+            # create a new tuple adding the current row number
+            # which we will use as dict key
+            row_list.append(('Row{0}'.format(i+1), row))
+            # update our table dict
+            table_dict.update(row_list)
+            # remove the items we just added from the temp list
+            del temp_list[start:end]
+        # return table_dict
+        return table_dict
+
+    def get_number_of_rows(self, ):
+        items = self.get_partition_table_dict()
+        return len(items)
+
     def _get_gail_treeview(self, ):
         """
         Gets the GtkTreeViews corresponding GtkTreeViewAccessible object

=== modified file 'autopilot/ubiquity_autopilot_tests/tests/__init__.py'
--- autopilot/ubiquity_autopilot_tests/tests/__init__.py	2014-02-26 10:57:42 +0000
+++ autopilot/ubiquity_autopilot_tests/tests/__init__.py	2014-02-27 15:58:05 +0000
@@ -70,6 +70,9 @@
         self.english_config.read('/tmp/english_config.ini')
         #delete config at end of test
         self.addCleanup(os.remove, '/tmp/english_config.ini')
+        # always starts with 1 row ('/dev/sda')
+        self.part_table_rows = 1
+        self.total_number_partitions = 0
 
     def tearDown(self):
         self._check_no_visible_dialogs()
@@ -413,6 +416,9 @@
                      "load")
         time.sleep(5)  # need to give time for all UI elements to load
         custom_page.create_new_partition_table()
+        #update number of table rows
+        self.part_table_rows = treeview.get_number_of_rows()
+        logger.debug("TOTAL NUMBER OF ROWS: {0}".format(self.part_table_rows))
         #lets create the partitions from here
         if part_config:
             logger.debug("Setting the given partition config")
@@ -420,6 +426,16 @@
         else:
             logger.debug("Selecting a random partition config")
             config = random.choice(custom_configs)
+            logger.debug("LENGTH OF CONFIG IS: {0}".format(len(config)))
+
+        logger.debug(
+            "TOTAL NUMBER OF PARTITIONS IN CONFIG: {0}".format(len(config))
+        )
+        self.total_number_partitions = len(config)
+        logger.debug(
+            "TOTAL NUMBER OF PARTITIONS TO BE IN TABLE: {0}".format(
+                self.total_number_partitions)
+        )
         for elem in config:
             self._add_new_partition()
 
@@ -812,15 +828,17 @@
     def _check_partition_created(self, config):
         """ Checks that the partition was created properly
         """
-        #before checking lets just wait a little while to ensure everything
-        # has finished loading, this doesn't affect outcome
-        time.sleep(7)
         logger.debug("Checking partition was created.....")
         custom_page = self.main_window.select_single(
             'GtkAlignment',
             BuilderName='stepPartAdvanced')
         tree_view = custom_page.select_single('GtkTreeView')
+        #assert a new row has been added to the partition table
+        total_rows = self._update_table_row_count(config)
+        logger.debug("TOTAL NUMBER OF ROWS: {0}".format(self.part_table_rows))
+        self.assertThat(total_rows, Equals(self.part_table_rows))
         items = tree_view.get_all_items()
+
         fsFormat = config['FileSystemType']
         mount_point = config['MountPoint']
         size_obj = config['PartitionSize']
@@ -906,6 +924,40 @@
         # Lets print current step
         print("Current step = {0}".format(self.current_step))
 
+    def _update_table_row_count(self, config):
+        " Returns number of rows in table"
+
+        custom_page = self.main_window.select_single(
+            'GtkAlignment',
+            BuilderName='stepPartAdvanced')
+        tree_view = custom_page.select_single('GtkTreeView')
+        num = tree_view.get_number_of_rows()
+        if num == self.total_number_partitions:
+            #TODO: assert 'free space' changes to a partition
+            # this will take some further work.
+            time.sleep(15)
+            return num
+
+        if num == self.part_table_rows:
+
+            timeout = 30
+            while True:
+                if num is not self.part_table_rows + 1:
+                    time.sleep(1)
+
+                    num = tree_view.get_number_of_rows()
+                    if num is self.part_table_rows + 1:
+                        break
+                    elif not timeout:
+
+                        raise ValueError("No new rows in partition table")
+                    else:
+                        timeout -= 1
+
+        self.assertThat(num, Equals(self.part_table_rows + 1))
+        self.part_table_rows = num
+        return num
+
     def _update_page_titles(self, ):
         self.previous_page_title = self.current_page_title
         self.current_page_title = self.main_window.select_single(