Merge lp:~sylvain-pineau/checkbox-editor/xls_test_export into lp:checkbox-editor

[Sylvain Pineau]

This change allows XLS compatible output for test procedure in addition of the existing TXT and HTML formats.

Internally, test tree is exported as a json file in a temp file then a perl script performs the full export thanks to the Spreadsheet::WriteExcel module.

Dependencies have been added to the control file and setup.py modified to install the perl script.

[Javier Collado (javier.collado)]

Sylvain, thanks for this merge proposal. Since I haven't found yet the perfect python library for writing xls files, let's go with the perl code.

Let me make a couple of comments:
* bin/_testplanxls.pl: This isn't a good path (it ends up in /usr/bin after package installation). Could you use something under /usr/share/checkbox-editor or under the python package directory (look at the glade files for example)?

* f.close isn't needed. Since you're opening using the with statement to create a context manager, the file will be closed automatically.

* os.close and os.remove are fine, but maybe you can get rid of those lines also if you use tempfile.NamedTemporaryFile in the with statement instead of open. What do you think about this?

* Could you use subprocess instead of pexpect? I know pexpect works better for some use cases, but but I prefer not to add a new dependency (by the way, python-pexpect is missing in the debian/control file) if that's not really needed.

review: Needs Fixing

[lp:~sylvain-pineau/checkbox-editor/xls_test_export]

136. By Sylvain Pineau on 2011-10-10

Use subprocess instead of pexpect
Store perl code in dist-packages

137. By Sylvain Pineau on 2011-10-10

Use a sequence instead of a simple string to execute perl code from subprocess

138. By Sylvain Pineau on 2011-10-10

Remove the need to have a shell started by subprocess

[Sylvain Pineau (sylvain-pineau)]

Thanks for your review, I've fixed the need of pexpect and change the location of my perl code once installed.

review: Needs Resubmitting

[Javier Collado (javier.collado)]

Thanks for your changes.

I've just pushed the changes with a couple of minor changes:
- Moved _testplanxls.pl to script/_testplanxls.pl
- Added lintian override for the script not being executable
  (setup.py probably removes executable permissions, but since the script is run using perl, there's no need to install it with those permissions.

=== added file 'checkbox_editor/_testplanxls.pl'
--- checkbox_editor/_testplanxls.pl	1970-01-01 00:00:00 +0000
+++ checkbox_editor/_testplanxls.pl	2011-10-10 12:38:10 +0000
@@ -0,0 +1,156 @@
+#!/usr/bin/perl
+
+use strict;
+use JSON::XS;
+use Spreadsheet::WriteExcel;
+
+die "$0 expects two filenames, aborting !" unless $#ARGV;
+
+my $plan = shift;
+my $dest = shift;
+
+open( F, $plan ) || die "Can't open JSON test plan, aborting !";
+my $f = join( "", <F> );
+close F;
+my $json_obj = JSON::XS->new->allow_nonref(1);
+my $json     = $json_obj->decode($f);
+
+#require Data::Dumper;
+#print "JSON content is: ", Data::Dumper::Dumper( $json ), "\n";
+
+my $workbook = Spreadsheet::WriteExcel->new($dest);
+$workbook->compatibility_mode();
+my $worksheet4 = $workbook->add_worksheet('Test Descriptions');
+$worksheet4->freeze_panes( 6, 0 );
+$_->outline_settings( 1, 0, 0, 1 ) for $workbook->sheets();
+$_->hide_gridlines(2) for $workbook->sheets();
+$workbook->set_custom_color( 22, 230, 230, 230 );    # == Gray 10% (OOo)
+$workbook->set_custom_color( 53, 220, 76,  0 );      # == Ubuntu Orange
+my $i = 1;
+
+my $format01 = $workbook->add_format(                # Titles
+    align => 'left',
+    size  => 12,
+    bold  => 1,
+);
+my $format02 = $workbook->add_format(                # Headlines
+    align => 'center',
+    size  => 10,
+    bold  => 1,
+);
+my $format03 = $workbook->add_format(
+    align     => 'left',
+    valign    => 'vcenter',
+    text_wrap => 1,
+    size      => 8,
+);
+my $format04 = $workbook->add_format(
+    align     => 'left',
+    valign    => 'vcenter',
+    text_wrap => 1,
+    size      => 8,
+    bg_color  => 22,
+);
+my $format05 = $workbook->add_format(
+    align => 'left',
+    size  => 24,
+    color => 53,
+);
+my $format10 = $workbook->add_format(    # Comments with indent lvl 1
+    align     => 'left',
+    valign    => 'vcenter',
+    text_wrap => 1,
+    size      => 8,
+    indent    => 1,
+);
+my $format11 = $workbook->add_format(    # Comments with indent lvl 1
+    align     => 'left',
+    valign    => 'vcenter',
+    text_wrap => 1,
+    size      => 8,
+    indent    => 1,
+    bg_color  => 22,
+);
+my $format12 = $workbook->add_format(    # Test categories
+    align => 'left',
+    size  => 10,
+    bold  => 1,
+);
+$_->set_font('Verdana') for @{ $workbook->{_formats} };
+
+# Create the test descriptions sheet
+$i = 1;
+$worksheet4->write( $i, 1, 'System Test Plan', $format05 );
+$worksheet4->set_row( $i, 30 );
+$i += 2;
+$worksheet4->set_row( $i, 15 );
+$worksheet4->write( $i++, 1, 'Tests Descriptions', $format01 );
+$i++;
+
+my $level     = 1;
+my $max_level = 1;
+
+sub find_max_level {    # Find the maximum depth of the test tree
+    my $tree = shift;
+    foreach my $job ( @{$tree} ) {
+        if ( scalar @{ $job->{'children'} } ) {
+            $level++;
+            find_max_level( $job->{'children'} );
+            $level--;
+        }
+        else {
+            $max_level = $level if $level > $max_level;
+        }
+    }
+}
+
+sub write_test {
+    my $tree = shift;
+    foreach my $job ( @{$tree} ) {
+        unless ( scalar @{ $job->{'children'} } ) {
+            my $name = $job->{'description'}->{'name'};
+            my $desc = $job->{'description'}->{'description'};
+            s/\n//g for $name;
+            $name =~ s/.*\///;
+            my @lines = $desc =~ /\n/gm;
+            my $lines = scalar(@lines);
+            $worksheet4->set_row( $i, 12 + 11 * $lines, undef, 0, $level )
+              if $level;
+            $worksheet4->write( $i, $max_level + 1,
+                $name, $i % 2 ? $format04 : $format03 );
+
+            $worksheet4->write( $i, $max_level + 2,
+                $desc, $i % 2 ? $format11 : $format10 );
+            $i++;
+        }
+        else {
+            $worksheet4->set_row( $i, undef, undef, 0, $level, 0 );
+            if ( ref $job->{'description'} eq 'HASH' ) {
+                $worksheet4->write( $i++, $level + 1,
+                    $job->{'description'}->{'name'}, $format12 );
+            }
+            else {
+                my $title = $job->{'description'};
+                $title =~ s/\.txt(\.in)?$//;
+                $worksheet4->write( $i++, $level + 1, $title, $format12 );
+            }
+            $level++;
+            write_test( $job->{'children'} );
+            $level--;
+        }
+    }
+}
+
+find_max_level($json);
+$level = 0;
+
+$worksheet4->set_column( 0, 0, 5 );
+$worksheet4->set_column( $_, $_, 2 ) for ( 1 .. $max_level );
+$worksheet4->set_column( $max_level + 1, $max_level + 1, 55 );
+$worksheet4->set_column( $max_level + 2, $max_level + 2, 90 );
+
+$worksheet4->write( $i++, $max_level + 1, [ 'Name', 'Description' ],
+    $format02 );
+
+write_test($json);
+$worksheet4->autofilter( 5, $max_level + 1, $i, $max_level + 2 );

=== modified file 'checkbox_editor/data.py'
--- checkbox_editor/data.py	2010-09-23 17:30:29 +0000
+++ checkbox_editor/data.py	2011-10-10 12:38:10 +0000
@@ -2,8 +2,11 @@
 This module contains a simple test suite parser class that can be used
 by other modules to extract information from a test suite
 """
-import os, sys, re
+import os, sys, re, json
+import logging
+import subprocess
 from cStringIO import StringIO
+from tempfile import NamedTemporaryFile
 
 class InternalParsingError(Exception):
     def __init__(self, filename, lines, failed_line, message):
@@ -268,6 +271,7 @@
     @staticmethod
     def get(report_type, *args, **kwargs):
         report_type_to_factory = {'Text file': 'TxtReporter',
+                                  'XLS file': 'XlsReporter',
                                   'Single HTML file': 'SingleHtmlReporter',
                                   'Multiple HTML files': 'MultipleHtmlReporter'}
 
@@ -276,6 +280,31 @@
         return factory(*args, **kwargs)
 
 
+class XlsReporter(Reporter):
+    """
+    Write a report of selected data
+    """
+    def write_report(self):
+        """
+        Write XLS report
+        """
+        with NamedTemporaryFile(delete=False) as f:
+            f.write(json.dumps(self.tree, indent=4))
+
+        reporter = os.path.join(os.path.dirname(os.path.realpath(__file__)),
+                               '_testplanxls.pl')
+
+        try:
+            output = subprocess.check_output(
+                ["perl", reporter, f.name, self.destination],
+                stderr=subprocess.STDOUT)
+            logging.info("XLS Test Plan generated successfully %s" % output)
+        except subprocess.CalledProcessError, e:
+            logging.error("XLS Test Plan:\n%s" % e.output)
+
+        os.unlink(f.name)
+
+
 class TxtReporter(Reporter):
     """
     Write a report of selected data

=== modified file 'checkbox_editor/editor.py'
--- checkbox_editor/editor.py	2011-10-07 15:13:36 +0000
+++ checkbox_editor/editor.py	2011-10-10 12:38:10 +0000
@@ -731,6 +731,7 @@
 
 
         filter_patterns = {'Text file': '*.txt',
+                           'XLS file': '*.xls',
                            'Single HTML file': '*.html',
                            'Multiple HTML files': '*'}
         for name, pattern in filter_patterns.items():

=== modified file 'debian/control'
--- debian/control	2011-06-17 15:12:07 +0000
+++ debian/control	2011-10-10 12:38:10 +0000
@@ -10,7 +10,9 @@
 Package: checkbox-editor
 Section: python
 Architecture: all
-Depends: ${misc:Depends}, ${python:Depends}, python-gtk2, yelp, bzr, apport-gtk, python-jinja2, python-apt
+Depends: ${misc:Depends}, ${python:Depends}, python-gtk2, yelp, bzr, apport-gtk, python-jinja2, python-apt,
+         libjson-xs-perl,
+         libspreadsheet-writeexcel-perl
 Recommends: packager
 Suggests: make
 XB-Python-Version: ${python:Versions}

=== modified file 'setup.py'
--- setup.py	2011-04-08 16:16:46 +0000
+++ setup.py	2011-10-10 12:38:10 +0000
@@ -48,6 +48,7 @@
 interface.""",
     packages = ['checkbox_editor'],
     package_data={'checkbox_editor': ['glade/*',
+                                      '*.pl',
                                       'help/*.xml',
                                       'help/figures/*']},
     scripts = ['bin/checkbox-editor'],