class SunPyTest(AstropyTest):
description = 'Run the tests for this package'
user_options = [
# Package to test
('package=', 'P',
"The name of a specific package to test, e.g. 'io' or 'utils'. "
"If nothing is specified, all default tests are run."),
# Print all the things
('verbose-results', 'V', 'Turn on verbose output from pytest.'),
# plugins to enable
('plugins=', 'p', 'Plugins to enable when running pytest.'),
# Run online tests?
('online', 'R', 'Also run tests that do require a internet connection.'
),
# Run only online tests?
('online-only', None,
'Only run test that do require a internet connection.'),
# Run tests that check figure generation
('figure', None,
'Run tests that compare figures against stored hashes.'),
# Calculate test coverage
('coverage', 'c',
'Create a coverage report. Requires the coverage package.'),
('cov-report=', None,
'Specify the type of coverage report to generate. (Default terminal)'
),
# Run tests in parallel
('parallel=', 'j',
'Run the tests in parallel on the specified number of '
'CPUs. If negative, all the cores on the machine will be '
'used. Requires the pytest-xdist plugin.'),
# Pass additional cli args to pytest
('args=', 'a', 'Additional arguments to be passed to pytest.')
]
user_options = _fix_user_options(user_options)
package_name = ''
def initialize_options(self):
self.package = ''
#self.test_path = None
self.verbose_results = False
self.plugins = None
self.args = None
self.online = False
self.online_only = False
self.figure = False
self.coverage = False
self.cov_report = 'term' if self.coverage else None
self.docs_path = os.path.abspath('doc')
self.parallel = 0
self.temp_root = None
def _validate_required_deps(self):
"""
This method checks that any required modules are installed before
running the tests.
"""
try:
import sunpy
except ImportError:
raise ImportError(
"The 'test' command requires the sunpy package to be "
"installed and importable.")
def generate_testing_command(self):
"""
Build a Python script to run the tests.
"""
cmd_pre = '' # Commands to run before the test function
cmd_post = '' # Commands to run after the test function
if self.coverage:
pre, post = self._generate_coverage_commands()
cmd_pre += pre
cmd_post += post
online = self.online
offline = not self.online_only
cmd = ('{cmd_pre}{0}; import {1.package_name}, sys; result = ('
'{1.package_name}.self_test('
'modulename={1.package!r}, '
'args={1.args!r}, '
'verbose={1.verbose_results!r}, '
'parallel={1.parallel!r}, '
'online={online!r}, '
'offline={offline!r}, '
'figure={figure!r}, '
'coverage={1.coverage!r}, '
'cov_report={1.cov_report!r})); '
'{cmd_post}'
'sys.exit(result)')
x = cmd.format('pass',
self,
online=online,
offline=offline,
figure=self.figure,
cmd_pre=cmd_pre,
cmd_post=cmd_post)
return x
class SunPyTest(AstropyTest):
description = 'Run the tests for this package'
user_options = copy.copy(AstropyTest.user_options)
user_options.remove(('remote-data=', 'R',
'Run tests that download remote data. Should be '
'one of none/astropy/any (defaults to none).'))
user_options += [('online', 'R',
'Also run tests that do require a internet connection.'),
('online-only', None,
'Only run test that do require a internet connection.'),
('figure', None,
'Run the figure tests.'),
# Run only tests that check figure generation
('figure-only', None,
'Only run tests that compare figures against stored hashes.')]
user_options = _fix_user_options(user_options)
package_name = ''
def initialize_options(self):
super().initialize_options()
self.online = False
self.online_only = False
self.figure = False
self.figure_only = False
def generate_testing_command(self):
"""
Build a Python script to run the tests.
"""
cmd_pre = '' # Commands to run before the test function
cmd_post = '' # Commands to run after the test function
if self.coverage:
pre, post = self._generate_coverage_commands()
cmd_pre += pre
cmd_post += post
cmd = ('{cmd_pre}{0}; import {1.package_name}, sys; result = ('
'{1.package_name}.self_test('
'package={1.package!r}, '
'test_path={1.test_path!r}, '
'args={1.args!r}, '
'plugins={1.plugins!r}, '
'verbose={1.verbose_results!r}, '
'pastebin={1.pastebin!r}, '
'online={1.online!r}, '
'online_only={1.online_only!r}, '
'figure={1.figure!r}, '
'figure_only={1.figure_only!r}, '
'pep8={1.pep8!r}, '
'pdb={1.pdb!r}, '
'open_files={1.open_files!r}, '
'parallel={1.parallel!r}, '
'docs_path={1.docs_path!r}, '
'skip_docs={1.skip_docs!r}, '
'repeat={1.repeat!r})); '
'{cmd_post}'
'sys.exit(result)')
return cmd.format('pass',
self,
cmd_pre=cmd_pre,
cmd_post=cmd_post)
