Differential D193

test direcitve_class variable existence
ClosedPublic
Actions

Authored by lbrabec on Jul 24 2014, 8:44 AM.

Details

Reviewers
kparal
jskladan
Maniphest Tasks
T268: unit test: make sure all directives have `directive_class` variable
Commits
rLTRNbad02425649e: test for directive class modules
Summary

New unit test that iterates through all available directives and checks that all directive_class variables are valid.

Test Plan

$ py.test

Diff Detail

Repository
rLTRN libtaskotron
Lint
Lint Skipped
Unit
Unit Tests Skipped
lbrabec retitled this revision from to test direcitve_class variable existence.Jul 24 2014, 8:44 AM
lbrabec updated this object.
lbrabec edited the test plan for this revision. (Show Details)
lbrabec added a reviewer: kparal.
kparal added a reviewer: jskladan.Jul 25 2014, 10:19 AM

Josef, could you give us an advice here, whether it is cleaner to list all .py files in a given directory, or use a different approach like this?
http://stackoverflow.com/questions/1707709/list-all-the-modules-that-are-part-of-a-python-package/1707786#1707786

Any preference to using __import__ or imp?

kparal added a comment.Jul 25 2014, 10:24 AM

Preliminary review.

Could you please rename testing/test_directive_class_vars.py into something like testing/test_directives.py? In future we might want to add additional generic directives tests and it would be silly create separate modules for each such test. Let's name this test module in a generic way.

testing/test_directive_class_vars.py
12–13 ↗(On Diff #558)

Please document either under the class or under the method the intended behavior that you are testing. This is something that's not immediately clear from the method name. Something like:

Every directive module must contain a global variable named ... and containing value ...

17 ↗(On Diff #558)

Please use [:-len('.py')] instead of [:-3]. It's much clearer what you're stripping and why.

lbrabec updated this revision to Diff 565.Jul 29 2014, 8:24 AM
  • polishing
lbrabec updated this revision to Diff 566.Jul 29 2014, 8:41 AM
  • oops, name problem fix
lbrabec updated this revision to Diff 567.Jul 29 2014, 1:03 PM
  • more tests
lbrabec updated this revision to Diff 568.Jul 29 2014, 2:16 PM
  • polishing 2
kparal accepted this revision.Jul 29 2014, 2:34 PM

Looks OK, please push.

This revision is now accepted and ready to land.Jul 29 2014, 2:34 PM
lbrabec closed this revision.Jul 30 2014, 11:49 AM
lbrabec updated this revision to Diff 571.

Closed by commit rLTRNbad02425649e (authored by @lbrabec).

Revision Contents

PathPackages
AMtesting/test_directive_modules.py (56 lines)

Diff 571

View Options

testing/test_directive_modules.py

  • This file was added.
1​# -*- coding: utf-8 -*-
2​# Copyright 2009-2014, Red Hat, Inc.
3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4​# See the LICENSE file for more details on Licensing
5​
6​
7​import pytest
8​import imp
9​import os
10​from glob import glob
11​
12​from libtaskotron import directives
13​
14​
15​
16​class TestDirectives():
17​ @classmethod
18​ def setup_class(cls):
19​ cls.directive_modules = []
20​
21​ # find all directive modules in libtaskotron.directives directory
22​ for filepath in glob(os.path.join(os.path.dirname(directives.__file__),
23​ '*.py')):
24​ if 'directive' in os.path.basename(filepath):
25​ real_name = os.path.basename(filepath)[:-len('.py')]
26​ cls.directive_modules.append((real_name, filepath))
27​
28​ def test_directive_class_var_exists(self):
29​ """Every directive module must contain a global variable named
30​ `directive_class` that contains classname of directive class
31​ """
32​ for module in self.directive_modules:
33​ loaded = imp.load_source(*module)
34​ class_name = getattr(loaded, 'directive_class')
35​ instance = getattr(loaded, class_name)()
36​
37​ assert class_name == instance.__class__.__name__
38​
39​ def test_directive_class_inherits_from_base(self):
40​ for module in self.directive_modules:
41​ loaded = imp.load_source(*module)
42​ class_name = getattr(loaded, 'directive_class')
43​ directive_class = getattr(loaded, class_name)
44​
45​ assert issubclass(directive_class, directives.BaseDirective)
46​
47​ def test_directive_class_process_method_exists(self):
48​ for module in self.directive_modules:
49​ loaded = imp.load_source(*module)
50​ class_name = getattr(loaded, 'directive_class')
51​ instance = getattr(loaded, class_name)()
52​
53​ process_method = getattr(instance, "process", None)
54​
55​ assert process_method is not None
56​ assert hasattr(process_method, '__call__')
57​No newline at end of file