Skip to content

Commit

Permalink
nosetests scheduler copyied instead of rebasing
Browse files Browse the repository at this point in the history
  • Loading branch information
jscotka committed Jul 25, 2018
1 parent aa03d43 commit 7a961cc
Show file tree
Hide file tree
Showing 3 changed files with 205 additions and 0 deletions.
188 changes: 188 additions & 0 deletions fmf_scheduler.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
#!/usr/bin/python3
"""
FMF scheduler for nosetests
Found test via fmf files and creates dynamic testclassed based on that.
"""


import os
import sys
import imp
import logging
import unittest

from colin.core.target import Target, is_compatible
from colin.core.checks.fmf_check import ExtendedTree, FMFAbstractCheck
from colin.core.constant import PASSED
from colin.core.ruleset.ruleset import get_checks_path

from colin.core.checks.dockerfile import DockerfileAbstractCheck, DockerfileLabelAbstractCheck,\
InstructionCountAbstractCheck, InstructionAbstractCheck

CLASS_MAPPING = {"DockerfileAbstractCheck": DockerfileAbstractCheck,
"DockerfileLabelAbstractCheck": DockerfileLabelAbstractCheck,
"InstructionCountAbstractCheck": InstructionCountAbstractCheck,
"InstructionAbstractCheck": InstructionAbstractCheck
}
logger = logging.getLogger(__name__)


def get_log_level():
return int(os.environ.get(("DEBUG")) or logging.INFO)


# COPYied from:
# https://eli.thegreenplace.net/2014/04/02/dynamically-generating-python-test-cases
class DynamicClassBase(unittest.TestCase):
"""
Basic Derived test Class
"""
backendclass = None
longMessage = True


def make_check_function(target):
"""
rename check function to test, to be able to find this function via testing frameworks
:return: function
"""

def test(self):
out = self.backendclass().check(target)
if out.status is not PASSED:
raise AssertionError("test:{} -> {}".format(
self.backendclass.name,
str(out))
)
return test


def make_base_fmf_class_abstract(node, target, base_class=DynamicClassBase, fmf_class=FMFAbstractCheck):
class_name = node.data["class"]
out_class_name = node.name.rsplit("/", 1)[-1]
outclass = type(out_class_name, (base_class,), {
'test': make_check_function(target=target),
'backendclass': type(class_name, (fmf_class, CLASS_MAPPING[class_name],), {
'__doc__': node.data.get("description"),
'name': out_class_name,
'metadata': node,
})
})
return outclass


def make_wrapped_fmf_class(node, target):
first_class_name = node.name.rsplit("/", 1)[-1]
second_class_name = node.data.get("class")
modulepath = os.path.join(os.path.dirname(
node.sources[-1]), node.data["test"])
modulename = os.path.basename(
node.sources[-1]).split(".", 1)[0]
# in case of referencing use original data tree for info
if "@" in node.name and not os.path.exists(modulepath):
modulepath = os.path.join(os.path.dirname(
node.sources[-2]), node.data["test"])
modulename = os.path.basename(
node.sources[-2]).split(".", 1)[0]
test_func = make_check_function(target=target)
logger.debug("Try to import: %s from path %s", modulename, modulepath)
moduleimp = imp.load_source(modulename, modulepath)
inernalclass = getattr(moduleimp, second_class_name)
# more verbose output
# full_class_name = '{0}_{1}'.format(first_class_name, second_class_name)
full_class_name = '{0}'.format(first_class_name)
return type(full_class_name, (DynamicClassBase,), {'test': test_func,
'backendclass': inernalclass
})

def nosetests_class_fmf_generator(fmfpath, target_name, log_level, ruleset_tree_path=None, filter_names=None, filters=None):
"""
generates dynamic test classes for nosetest or unittest scheduler based on FMF metadata.
:param fmfpath: path to checks
:param target_name: what is the target object
:param log_level:
:param ruleset_tree_path:
:return:
"""
target = Target(target_name, log_level)
test_classes = {}
if not ruleset_tree_path:
ruleset_tree_path = fmfpath
ruleset_metadatatree = ExtendedTree(ruleset_tree_path)
metadatatree = ExtendedTree(fmfpath)
ruleset_metadatatree.references(metadatatree)
for node in ruleset_metadatatree.prune(names=filter_names, filters=filters):
if node.data.get("class") or node.data.get("test"):
logger.debug("node (%s) contains test and class item", node.name)

if node.data.get("class") in CLASS_MAPPING:
logger.debug("Using pure FMF metadata for %s (class %s)", node.name, node.data.get("class"))
test_class = make_base_fmf_class_abstract(node=node, target=target)
else:
logger.debug("searching for %s", node.name)
test_class = make_wrapped_fmf_class(node=node, target=target)
if is_compatible(target_type=target.target_type, check_instance=test_class.backendclass()):
test_classes[test_class.__name__] = test_class
logger.debug("Test added: %s", node.name)
else:
logger.debug("Test (not target): %s", node.name)
else:
if "__pycache__" not in node.name:
logger.warning("error in fmf config for node (missing test and class items): %s (data: %s) ", node.name, node.data)
return test_classes


def scheduler_opts(target_name=None, checks=None, ruleset_path=None,
filter_names=None, filters=None, log_level=None):
"""
gather all options what have to be set for function class_fmf_generator
now it is able set via ENVVARS
:param target_name: override envvar TARGET
:param checks: override envvar CHECKS
:param ruleset_path: path to directory, where are fmf rulesets
:param filters: dict of filters, filter out just selected cases, use FMF filter format,
via FILTER envvar use ";" as filter separator
:param filter_names: dict of item names for filtering user ";" as separator for NAMES envvar
:return: dict of test classes
"""
if not target_name:
target_name = os.environ.get("TARGET")
if not target_name:
raise EnvironmentError("TARGET envvar is not set.")
if not checks:
checks = get_checks_path()
if not ruleset_path:
ruleset_path = os.environ.get("RULESETPATH")
if not filters:
filters = os.environ.get("FILTERS", "").split(";")
if not filter_names:
filter_names = os.environ.get("NAMES", "").split(";")
if not log_level:
log_level = get_log_level()
output = nosetests_class_fmf_generator(checks, target_name,
ruleset_tree_path=ruleset_path,
filter_names=filter_names,
filters=filters,
log_level=log_level)
return output


if __name__ == "__main__":
logging.basicConfig(stream=sys.stdout, level=get_log_level())
classes = scheduler_opts()
for item in classes:
globals()[item] = classes[item]

# try to schedule it via nosetests in case of direct schedule
import nose
logger.info("number of test classes: %s", len(classes))
module_name = sys.modules[__name__].__file__
logging.debug("running nose for package: %s", module_name)
result = nose.run(argv=[sys.argv[0], module_name, '-v'])
logging.info("all tests ok: %s", result)
else:
classes = scheduler_opts()
for item in classes:
globals()[item] = classes[item]
1 change: 1 addition & 0 deletions rulesets/.fmf/version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1
16 changes: 16 additions & 0 deletions rulesets/default.fmf
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/default:
version: 1
name: "Default ruleset for checking containers/images/dockerfiles."
description: "This set contains general checks applicable to any target."
contact_email: "[email protected]"
names:

/checks:
/check@maintainer_label:
tags+: ["required"]
/check@from_tag_not_latest:
tags+: ["required"]
usable_targets: ["dockerfile"]
/check@maintainer_deprecated:
tags+: ["required"]
usable_targets: ["dockerfile"]

0 comments on commit 7a961cc

Please sign in to comment.