Merge pull request #228 from golemhq/feature/test-hooks

add test hooks for test file: before_test, before_each, after_each, a…

Author: luciano-renzi

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Changed
 
 - Added JSON as data source, internal data uses a Python code editor, test_data setting is deprecated [#225](https://github.com/golemhq/golem/issues/225)
+- Added 4 test hooks: before_test, before_each, after_each, after_test [#227](https://github.com/golemhq/golem/issues/227)
 
 ## [0.10.1] - 2021-07-30
 

golem/core/test.py

@@ -138,6 +138,15 @@ def _print_extra_blank_line():
             test_.append('')
             extra_blank_line = False
 
+    def _order_hooks(test_hooks):
+        """Put the test hooks in a predefined order"""
+        ordered = {}
+        order_list = ['before_test', 'setup', 'before_each', 'after_each', 'after_test', 'teardown']
+        for hook_name in order_list:
+            if hook_name in test_hooks:
+                ordered[hook_name] = test_hooks[hook_name]
+        return ordered
+
     path = Test(project, test_name).path
     settings = settings_manager.get_project_settings(project)
 
@@ -196,11 +205,14 @@ def _print_extra_blank_line():
             skip = "'{}'".format(skip)
         test_.append('skip = {}'.format(skip))
 
-    if steps['setup']:
-        test_.append('')
-        test_.append('')
-        test_.append('def setup(data):')
-        test_.append(_format_steps(steps['setup']))
+    if steps['hooks']:
+        ordered_hooks = _order_hooks(steps['hooks'])
+        for hook, hook_steps in ordered_hooks.items():
+            if hook_steps:
+                test_.append('')
+                test_.append('')
+                test_.append(f'def {hook}(data):')
+                test_.append(_format_steps(hook_steps))
 
     for test_function_name, test_function_steps in steps['tests'].items():
         test_.append('')
@@ -211,12 +223,6 @@ def _print_extra_blank_line():
         else:
             test_.append('    pass')
 
-    if steps['teardown']:
-        test_.append('')
-        test_.append('')
-        test_.append('def teardown(data):')
-        test_.append(_format_steps(steps['teardown']))
-
     test_.append('')
 
     with open(path, 'w', encoding='utf-8') as f:
@@ -284,22 +290,6 @@ def pages(self):
         imported_pages = test_parser.parse_imported_pages(self.code)
         return page_list + imported_pages
 
-    @property
-    def setup_steps(self):
-        setup_function = getattr(self.get_module(), 'setup', None)
-        if setup_function:
-            return test_parser.parse_function_steps(setup_function)
-        else:
-            return None
-
-    @property
-    def teardown_steps(self):
-        teardown_function = getattr(self.get_module(), 'teardown', None)
-        if teardown_function:
-            return test_parser.parse_function_steps(teardown_function)
-        else:
-            return None
-
     @property
     def test_functions(self):
         """Dictionary of parsed steps of each test function"""
@@ -319,6 +309,37 @@ def test_function_list(self):
         local_function_names = parsing_utils.top_level_functions(ast_module_node)
         return [f for f in local_function_names if f.startswith('test')]
 
+    @property
+    def test_hooks(self):
+        """Dictionary of parsed steps of each test hook function"""
+        hooks = {}
+        test_hooks = self.test_hook_list
+        for hook_name in test_hooks:
+            h = getattr(self.get_module(), hook_name)
+            # TODO setup / teardown are deprecated, returned as before_test/after_test
+            if hook_name == 'setup':
+                hook_name = 'before_test'
+            if hook_name == 'teardown':
+                hook_name = 'after_test'
+            hooks[hook_name] = test_parser.parse_function_steps(h)
+
+        from collections import OrderedDict
+        return OrderedDict(hooks)
+
+    @property
+    def test_hook_list(self):
+        """List of test hook functions"""
+        ast_module_node = parsing_utils.ast_parse_file(self.path)
+        local_function_names = parsing_utils.top_level_functions(ast_module_node)
+        test_hook_names = ['setup', 'teardown', 'before_test', 'before_each', 'after_each', 'after_test']
+        test_hooks = [f for f in local_function_names if f in test_hook_names]
+        # TODO: setup / teardown are deprecated
+        if 'setup' in test_hooks and 'before_test' in test_hooks:
+            test_hooks.remove('setup')
+        if 'teardown' in test_hooks and 'after_test' in test_hooks:
+            test_hooks.remove('teardown')
+        return test_hooks
+
     @property
     def skip(self):
         return getattr(self.get_module(), 'skip', False)
@@ -343,10 +364,10 @@ def components(self):
             'pages': self.pages,
             'tags': self.tags,
             'skip': self.skip,
-            'setup_steps': self.setup_steps,
-            'teardown_steps': self.teardown_steps,
             'test_functions': self.test_functions,
             'test_function_list': self.test_function_list,
+            'test_hooks': self.test_hooks,
+            'test_hook_list': self.test_hook_list,
             'code': self.code
         }
         return components

golem/execution_runner/execution_runner.py

@@ -86,7 +86,8 @@ def initialize_reports_for_test_files(project_name, test_sets):
         # will not be initialized
         if s.name in test_functions_cache:
             test_report.initialize_test_file_report(s.name, test_functions_cache[s.name],
-                                                    s.set_name, test_file_reportdir)
+                                                    s.set_name, test_file_reportdir, s.env,
+                                                    s.browser['name'])
 
 
 class ExecutionRunner:

golem/gui/static/js/test.js

@@ -8,7 +8,7 @@ var Test = new function(){
     this.importedPages = [];
     this.unsavedChanges = false;
 
-    this.initialize = function(file, importedPages, setupSteps, teardownSteps, testFunctions){
+    this.initialize = function(file, importedPages, testHooks, testFunctions){
 
         this.file = file;
 
@@ -18,15 +18,12 @@ var Test = new function(){
         });
         Test.getAllProjectPages();
         Test.getGolemActions();
-        Test.renderSectionSteps(Test.Utils.stepSection('setup'), setupSteps);
-        Test.renderSectionSteps(Test.Utils.stepSection('teardown'), teardownSteps);
+        Test.addTestHooks(testHooks);
         Test.addTestFunctions(testFunctions);
         Test.refreshActionInputsAutocomplete();
         Test.refreshValueInputsAutocomplete();
-        $('#pageModal').on('hidden.bs.modal', function(){
-            Test.importedPages.forEach(function(page){
-                Test.getPageContents(page.name)
-            })
+        $('#pageModal').on('hidden.bs.modal', function() {
+            Test.importedPages.forEach((page) => Test.getPageContents(page.name))
         });
         Test.Utils.watchForUnsavedChanges();
         Test.Utils.startSortableSteps();
@@ -47,38 +44,60 @@ var Test = new function(){
         }
     }
 
-    this.addTestFunction = function(testName, testSteps) {
-        testSteps = testSteps || [];
-        let testFunctionContainer = $('#testFunctions');
+    this.addTestFunction = function(functionName, steps) {
+        this.addXFunction(functionName, steps, $('#testFunctions'), true);
+    }
+
+    this.addTestHooks = function(testHooks) {
+        let orderedTestHooks = Test.Hooks.orderTestHooks(testHooks);
+
+        for (const testHook in orderedTestHooks) {
+            Test.addTestHook(testHook, testHooks[testHook]);
+        }
+    }
+
+    this.addTestHook = function(hookName, steps) {
+        Test.Hooks.addHook(hookName, steps);
+    }
+
+    this.addXFunction = function(functionName, testSteps, container, isTestFunction) {
+        // only test functions have on click to modify test function name
+        // test hooks names cannot be modified
+        if(isTestFunction) {
+            functionNameOnClick = 'Test.Utils.startTestFunctionInlineNameEdition(this)';
+            removeIconOnClick = 'Test.Utils.deleteTestFunction(this)';
+        } else {
+            functionNameOnClick = '';
+            removeIconOnClick = 'Test.Hooks.deleteHook(this)';
+        }
+
         let testFunctionTemplate = $(`
             <div class='test-function function'>
                 <div class='testFunctionNameContainer'>
                     <h4 class="testFunctionNameContainer">
-                        <span class="test-function-name" onclick="Test.Utils.startTestFunctionInlineNameEdition(this)">${testName}</span>
+                        <span class="test-function-name" onclick="${functionNameOnClick}">${functionName}</span>
                         <span class="test-function-name-input" style="display: none">
                             <input type="text">
                         </span>
                     </h4>
                     <div class="inline-remove-icon">
-                        <a href="javascript:void(0)" onclick="Test.Utils.deleteTestFunction(this)">
+                        <a href="javascript:void(0)" onclick="${removeIconOnClick}">
                             <span class="glyphicon glyphicon-remove" aria-hidden="true"></span>
                         </a>
                     </div>
                 </div>
                 <div class='steps'></div>
                 <button class='btn btn-default btn-sm add-step' style='margin-left: 21px;' onclick="Test.addStepInputToThis(this);">
                     <span class="glyphicon glyphicon-plus" aria-hidden="true"></span></button>
-            </div>
-            <div style='height: 10px'></div>
-        `);
+            </div>`);
 
         let stepContainer = testFunctionTemplate.find('.steps');
         if(testSteps.length) {
             Test.renderSectionSteps(stepContainer, testSteps);
         } else {
             Test.addStepInputToThis(stepContainer);
         }
-        testFunctionContainer.append(testFunctionTemplate);
+        container.append(testFunctionTemplate);
         Test.refreshActionInputsAutocomplete();
         Test.refreshValueInputsAutocomplete();
     }
@@ -133,7 +152,7 @@ var Test = new function(){
 
     this.addNewTestFunction = function() {
         let callback = (testName) => {
-            Test.addTestFunction(testName)
+            Test.addTestFunction(testName, [])
         }
         let validationCallback = (testName) => {
             return Test.Utils.validateTestFunctionName(testName);
@@ -299,7 +318,7 @@ var Test = new function(){
             Main.TestRunner.runTest(this.file.project, Test.file.fullName);
     }
 
-    this.save = function(config){
+    this.save = function(config) {
         runAfter = config.runAfter || false;
         let description = $("#description").val();
         let pageObjects = Test.importedPages.map(x => x.name);
@@ -480,10 +499,38 @@ var Test = new function(){
         return template
     }
 
+    this.Hooks = new function() {
 
-    this.Utils = new function(){
+        this.orderTestHooks = function(hooks) {
+            ordered = {}
+            orderList = ['before_test', 'setup', 'before_each', 'after_each', 'after_test', 'teardown']
+            for (hookName of orderList) {
+                if(hookName in hooks) {
+                    ordered[hookName] = hooks[hookName]
+                }
+            }
+            return ordered
+        }
 
-        this.getNotImportedPages = function(){
+        this.addHook = function(name, steps) {
+            steps = steps || [];
+            Test.addXFunction(name, steps, $('#testHooks'), false);
+            $(`#hookSelector a[hook-name='${name}']`).hide();
+        }
+
+        this.deleteHook = function(elem) {
+            let hookName = $(elem).closest('.test-function').find('h4 span').html();
+            Main.Utils.displayConfirmModal('Delete Test Hook?', '', () => {
+                $(elem).closest('.test-function').remove();
+                Test.unsavedChanges = true;
+                $(`#hookSelector a[hook-name='${hookName}']`).show();
+            });
+        }
+    }
+
+    this.Utils = new function() {
+
+        this.getNotImportedPages = function() {
             let notImported = [];
             let importedPagesNames = Test.importedPages.map(x => x.name);
             Test.allPages.forEach(function(page){
@@ -593,10 +640,13 @@ var Test = new function(){
 
         this.getSteps = function() {
             let steps = {
-                setup: Test.Utils.parseSteps($("#setupSteps .step")),
+                hooks: {},
                 tests: {},
-                teardown: Test.Utils.parseSteps($("#teardownSteps .step"))
             }
+            $('#testHooks > .test-function').each(function() {
+                let hookName = $(this).find('span.test-function-name').html().trim();
+                steps.hooks[hookName] = Test.Utils.parseSteps($(this).find('.step'))
+            })
             $('#testFunctions > .test-function').each(function() {
                 let testName = $(this).find('span.test-function-name').html().trim();
                 steps.tests[testName] = Test.Utils.parseSteps($(this).find('.step'))
@@ -659,7 +709,7 @@ var Test = new function(){
         }
 
         this.deleteTestFunction = function(elem) {
-            Main.Utils.displayConfirmModal('Delete Test', 'Delete test?', () => {
+            Main.Utils.displayConfirmModal('Delete Test?', '', () => {
                 $(elem).closest('.test-function').remove();
                 Test.unsavedChanges = true;
             });