Support reference file parser and custom parser

Author: atthaboon

ExcelDataDriver/ExcelParser/ABCParserStrategy.py

@@ -11,7 +11,7 @@ class ABCParserStrategy:
     def __init__(self):
         self.MANDATORY_TEST_DATA_COLUMN = MANDATORY_TEST_DATA_COLUMN
         self.DEFAULT_COLUMN_INDEXS = self.MANDATORY_TEST_DATA_COLUMN.values()
-        self.start_row = 2
+        self.start_row = 1
         self.max_column = 50
         self.maximum_column_index_row = 5
 
@@ -56,8 +56,8 @@ def parsing_column_indexs(self, ws):
                 continue
             for cell in row:
                 if (cell.value is not None) and (cell.value not in self.DEFAULT_COLUMN_INDEXS):
-                    ws_column_indexs[cell.value.lower().strip()] = column_index_from_string(coordinate_from_string(cell.coordinate)[0])
-                    print('Optional : '+str(cell.value.lower().strip()) + ' : ' + str(cell.coordinate) + ' : ' + str(column_index_from_string(coordinate_from_string(cell.coordinate)[0])))
+                    ws_column_indexs[str(cell.value).lower().strip()] = column_index_from_string(coordinate_from_string(cell.coordinate)[0])
+                    print('Optional : '+str(str(cell.value).lower().strip()) + ' : ' + str(cell.coordinate) + ' : ' + str(column_index_from_string(coordinate_from_string(cell.coordinate)[0])))
             break
         print('Done parsing column indexes')
         return ws_column_indexs

ExcelDataDriver/ExcelParser/DefaultReferenceParserStrategy.py

@@ -7,6 +7,9 @@ class DefaultReferenceParserStrategy(ABCParserStrategy):
     def __init__(self):
         ABCParserStrategy.__init__(self)
 
+    def is_ws_column_valid(self, ws, validate_result):
+        return validate_result
+
     def is_test_data_valid(self, ws_column_indexes, ws_title, row_index, row):
         return True
 

ExcelDataDriver/ExcelParser/ParserContext.py

@@ -14,20 +14,20 @@ def parse(self, wb):
         validate_result = {'is_pass': True, 'error_message': ''}
 
         # Validate column
-        print('Validate column')
+        print('Validate reference column')
         for ws in self.parser_strategy.get_all_worksheet(wb):
             validate_result = self.parser_strategy.is_ws_column_valid(ws, validate_result)
         if validate_result['is_pass'] is not True:
             raise ValueError(validate_result['error_message'])
-        print('Done validate column')
+        print('Done validate reference column')
 
         # Parsing test data
-        print('Parsing test data')
+        print('Parsing reference data')
         ws_test_data_rows = OrderedDict()
         for ws in self.parser_strategy.get_all_worksheet(wb):
             ws_column_indexs = self.parser_strategy.parsing_column_indexs(ws)
             test_data_rows = self.parser_strategy.parse_test_data_properties(ws, ws_column_indexs)
             ws_test_data_rows[ws.title] = test_data_rows
-        print('Done validate test data')
+        print('Done validate reference data')
 
         return ws_test_data_rows

ExcelDataDriver/ExcelReferenceDataRow/ExcelReferenceDataRow.py

@@ -14,7 +14,7 @@ def __init__(self, excel_title, excel_row_index, excel_row, column_indexes):
             if self.row_no is None:
                 self.row_no = excel_row[column_indexes[column_index_key] - 1].row
                 self.sheet_name = excel_row[column_indexes[column_index_key] - 1].parent.title
-            self.properties_list[column_index_key] = excel_row[column_indexes[column_index_key] - 1].value
+            self.properties_list[column_index_key.lower().strip().replace(' ', '_')] = excel_row[column_indexes[column_index_key] - 1].value
 
     def get_data_type(self):
         return DataTypes.REFERENCE_DATA
@@ -28,6 +28,5 @@ def get_sheet_name(self):
     def get_test_data_property(self, property_name):
         try:
             return self.properties_list[property_name.lower().strip()]
-            # return self.excel_row[self.column_indexes[property_name.lower().strip()] - 1].value
         except:
             raise Exception('Can\'t find property name '+property_name+' under test data row index '+str(self.get_row_no()))

ExcelDataDriver/Keywords/CoreExcelKeywords.py

@@ -48,7 +48,7 @@ def load_reference_data(self, alias_name, filename, custom_parser_module='ExcelD
         reference_wb.close()
 
     def _load_customer_class_from_module(self, module_name, class_name):
-        MyClass = getattr(importlib.import_module('ExcelDataDriver.ExcelParser.DefaultReferenceParserStrategy'), 'DefaultReferenceParserStrategy')
+        MyClass = getattr(importlib.import_module(module_name), class_name)
         return MyClass
 
     ####################################################

ExcelDataDriver/__init__.py

@@ -20,6 +20,7 @@
     https://github.com/robotframework/robotframework/tree/master/doc/userguide/src/ExtendingRobotFramework
 """
 import glob
+import importlib
 import re
 import sys
 import os.path
@@ -76,6 +77,8 @@ def __init__(self, file=None, custom_parser=None, capture_screenshot='Always', m
             self.custom_parser = CustomExcelParser.CustomExcelParser()
         self.capture_screenshot_option = CaptureScreenShotOption[capture_screenshot]
         self.manually_test = manually_test
+        if self.file is None:
+            self.manually_test = True
 
         self.excelTestDataService = ExcelTestDataService()
         self.suite_source = None
@@ -93,6 +96,8 @@ def __init__(self, file=None, custom_parser=None, capture_screenshot='Always', m
 
         self.screenshot_running_id = 0
 
+        self.reference_data = dict()
+
     def load_module(self, module):
         """``Important`` using by local library only."""
         # module_path = "mypackage.%s" % module
@@ -516,3 +521,63 @@ def save_report(self, newfile=None):
 
         """
         self.excelTestDataService.save_report(newfile)
+
+    ####################################################
+    #
+    # Load reference excel data
+    #
+    ####################################################
+    @keyword
+    def load_reference_data(self, alias_name, filename,
+                            custom_parser_module='ExcelDataDriver.ExcelParser.DefaultReferenceParserStrategy',
+                            custom_parser_class='DefaultReferenceParserStrategy'):
+        """
+        Load reference data with specific Parser
+
+        Arguments:
+        |  alias_name           |   alias_name for refer to the reference data |
+        |  filename (string)    |   The file name string value that will be used to open the excel file to perform tests upon. |
+        |  custom_parser_module |   Test data parser module is ExcelDataDriver.ExcelParser.DefaultReferenceParserStrategy |
+        |  custom_parser_class  |   Test data parser class is DefaultReferenceParserStrategy |
+        """
+        reference_wb = OpenpyxlHelper.load_excel_file(filename)
+        CustomExcelParser = getattr(importlib.import_module(custom_parser_module), custom_parser_class)
+        # CustomExcelParser = __import__(custom_parser_module)
+        # parser_context = ParserContext(CustomExcelParser.CustomExcelBreakdownParser())
+        parser_context = ParserContext(CustomExcelParser())
+        references_data_sheets = parser_context.parse(reference_wb)
+        reference_row_data = []
+        for sheet_name in references_data_sheets:
+            reference_row_data += references_data_sheets[sheet_name]
+        self.reference_data[alias_name] = {
+            'selected': None,
+            'data': reference_row_data
+        }
+        reference_wb.close()
+
+    @keyword
+    def select_reference_data_based_on_condition(self, alias_name, condition):
+        """
+        Select reference data based on condition
+
+        Arguments:
+        |  alias_name   | alias_name for refer to the reference data |
+        |  condition    | refer variable name 'data' |
+
+        Default Data Properties:
+            excel_title         string
+            excel_row_index     string
+            row_no              string
+            sheet_name          string
+            properties_list     dictionary: access to excel property with lower case and use _ instead of space
+        """
+        self.reference_data[alias_name]['selected'] = next(data for data in self.reference_data[alias_name]['data'] if eval(condition))
+
+    @keyword
+    def get_selected_reference_data_property(self, alias_name, property_name):
+        return self.reference_data[alias_name]['selected'].properties_list[property_name]
+
+    @keyword
+    def get_reference_data_property(self, alias_name, property_name, condition):
+        select = next(data for data in self.reference_data[alias_name]['data'] if eval(condition))
+        return select.properties_list[property_name]

tests/test_ExcelParser/test_DefaultReferenceParserStrategy.py

@@ -0,0 +1,36 @@
+import os
+import sys
+from unittest import TestCase
+
+from astroid import module
+
+from ExcelDataDriver import ExcelDataDriver
+
+
+class TestDefaultReferenceParserStrategy(TestCase):
+
+    """
+    Load and count test data
+    """
+    def test_load_test_data_WithValidPostComRunTestData_LoadExcelSuccessfully(self):
+        # Arrange
+        core_rpa = ExcelDataDriver()
+
+        # Act
+        core_rpa.load_reference_data('ref1', os.getcwd()+'../../../Examples/test_data/DefaultDemoData.xlsx')
+
+    def test_select_reference_data_with_condition(self):
+        # Arrange
+        core_rpa = ExcelDataDriver()
+        core_rpa.load_reference_data('ref1', os.getcwd() + '../../../Examples/test_data/DefaultDemoData.xlsx')
+
+        # Act
+        core_rpa.select_reference_data_based_on_condition('ref1', 'data.properties_list["username"] == "john"')
+
+    #def test_local_import(self):
+    #    module_path = 'CustomExcelParser'
+    #    if module_path in sys.modules.keys():
+    #        return sys.modules[module_path]
+    #    __import__(module_path)
+    #    x = 10
+