From 70eafef79842b0916298f5a089b5b432432a4e16 Mon Sep 17 00:00:00 2001 From: salman2013 Date: Wed, 4 Oct 2023 15:28:49 +0500 Subject: [PATCH] chore: fixed comments as per review, code improvements --- .../pytest_plugin.py | 3 - pavelib/utils/envs.py | 4 - pavelib/utils/test/suites/js_suite.py | 98 +++++++++---------- 3 files changed, 49 insertions(+), 56 deletions(-) diff --git a/openedx/testing/coverage_context_listener/pytest_plugin.py b/openedx/testing/coverage_context_listener/pytest_plugin.py index 6ed194b91b..a3679027e8 100644 --- a/openedx/testing/coverage_context_listener/pytest_plugin.py +++ b/openedx/testing/coverage_context_listener/pytest_plugin.py @@ -3,9 +3,6 @@ A pytest plugin that reports test contexts to coverage running in another proces """ import pytest -# import requests - -# from pavelib.utils.envs import Env class RemoteContextPlugin: diff --git a/pavelib/utils/envs.py b/pavelib/utils/envs.py index 40b616571e..4cfbec7790 100644 --- a/pavelib/utils/envs.py +++ b/pavelib/utils/envs.py @@ -85,10 +85,6 @@ class Env: TEST_DIR = REPO_ROOT / ".testids" # Configured browser to use for the js test suites - SELENIUM_BROWSER = os.environ.get('SELENIUM_BROWSER', 'firefox') - # if USING_DOCKER: - # KARMA_BROWSER = 'ChromeDocker' if SELENIUM_BROWSER == 'chrome' else 'FirefoxDocker' - # else: KARMA_BROWSER = 'FirefoxNoUpdates' # Files used to run each of the js test suites diff --git a/pavelib/utils/test/suites/js_suite.py b/pavelib/utils/test/suites/js_suite.py index 40f491f5d6..d96d95f39c 100644 --- a/pavelib/utils/test/suites/js_suite.py +++ b/pavelib/utils/test/suites/js_suite.py @@ -39,63 +39,63 @@ class JsTestSuite(TestSuite): if self.mode == 'run' and not self.run_under_coverage: test_utils.clean_dir(self.report_dir) - # @property - # def _default_subsuites(self): - # """ - # Returns all JS test suites - # """ - # return [JsTestSubSuite(test_id, **self.opts) for test_id in Env.JS_TEST_ID_KEYS if test_id != 'jest-snapshot'] + @property + def _default_subsuites(self): + """ + Returns all JS test suites + """ + return [JsTestSubSuite(test_id, **self.opts) for test_id in Env.JS_TEST_ID_KEYS if test_id != 'jest-snapshot'] -# class JsTestSubSuite(TestSuite): -# """ -# Class for JS suites like cms, cms-squire, lms, common, -# common-requirejs and xmodule -# """ -# def __init__(self, *args, **kwargs): -# super().__init__(*args, **kwargs) -# self.test_id = args[0] -# self.run_under_coverage = kwargs.get('with_coverage', True) -# self.mode = kwargs.get('mode', 'run') -# self.port = kwargs.get('port') -# self.root = self.root + ' javascript' -# self.report_dir = Env.JS_REPORT_DIR +class JsTestSubSuite(TestSuite): + """ + Class for JS suites like cms, cms-squire, lms, common, + common-requirejs and xmodule + """ + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.test_id = args[0] + self.run_under_coverage = kwargs.get('with_coverage', True) + self.mode = kwargs.get('mode', 'run') + self.port = kwargs.get('port') + self.root = self.root + ' javascript' + self.report_dir = Env.JS_REPORT_DIR -# try: -# self.test_conf_file = Env.KARMA_CONFIG_FILES[Env.JS_TEST_ID_KEYS.index(self.test_id)] -# except ValueError: -# self.test_conf_file = Env.KARMA_CONFIG_FILES[0] + try: + self.test_conf_file = Env.KARMA_CONFIG_FILES[Env.JS_TEST_ID_KEYS.index(self.test_id)] + except ValueError: + self.test_conf_file = Env.KARMA_CONFIG_FILES[0] -# self.coverage_report = self.report_dir / f'coverage-{self.test_id}.xml' -# self.xunit_report = self.report_dir / f'javascript_xunit-{self.test_id}.xml' + self.coverage_report = self.report_dir / f'coverage-{self.test_id}.xml' + self.xunit_report = self.report_dir / f'javascript_xunit-{self.test_id}.xml' -# @property -# def cmd(self): -# """ -# Run the tests using karma runner. -# """ -# cmd = [ -# "node", -# "--max_old_space_size=4096", -# "node_modules/.bin/karma", -# "start", -# self.test_conf_file, -# "--single-run={}".format('false' if self.mode == 'dev' else 'true'), -# "--capture-timeout=60000", -# f"--junitreportpath={self.xunit_report}", -# f"--browsers={Env.KARMA_BROWSER}", -# ] + @property + def cmd(self): + """ + Run the tests using karma runner. + """ + cmd = [ + "node", + "--max_old_space_size=4096", + "node_modules/.bin/karma", + "start", + self.test_conf_file, + "--single-run={}".format('false' if self.mode == 'dev' else 'true'), + "--capture-timeout=60000", + f"--junitreportpath={self.xunit_report}", + f"--browsers={Env.KARMA_BROWSER}", + ] -# if self.port: -# cmd.append(f"--port={self.port}") + if self.port: + cmd.append(f"--port={self.port}") -# if self.run_under_coverage: -# cmd.extend([ -# "--coverage", -# f"--coveragereportpath={self.coverage_report}", -# ]) + if self.run_under_coverage: + cmd.extend([ + "--coverage", + f"--coveragereportpath={self.coverage_report}", + ]) -# return cmd + return cmd class JestSnapshotTestSuite(TestSuite):