Skip to content

Commit

Permalink
Refactor project speciffic transform to separate file
Browse files Browse the repository at this point in the history
  • Loading branch information
@mkoura
mkoura committed Apr 5, 2019
1 parent fde666e commit 16a9330
Show file tree
Hide file tree
Showing 6 changed files with 284 additions and 260 deletions.
6 changes: 4 additions & 2 deletions dump2polarion/exporters/requirements_exporter.py
View file
Expand Up @@ -35,7 +35,7 @@

from dump2polarion import utils
from dump2polarion.exceptions import Dump2PolarionException, NothingToDoException
from dump2polarion.exporters import transform
from dump2polarion.exporters import transform_projects

# pylint: disable=invalid-name
logger = logging.getLogger(__name__)
Expand All @@ -62,7 +62,9 @@ def __init__(self, requirements_data, config, transform_func=None):
self.requirements_data = requirements_data
self.config = config
self._lookup_prop = ""
self._transform_func = transform_func or transform.get_requirements_transform(config)
self._transform_func = transform_func or transform_projects.get_requirements_transform(
config
)

def _transform_result(self, result):
"""Calls transform function on result."""
Expand Down
4 changes: 2 additions & 2 deletions dump2polarion/exporters/testcases_exporter.py
View file
Expand Up @@ -48,7 +48,7 @@

from dump2polarion import utils
from dump2polarion.exceptions import Dump2PolarionException, NothingToDoException
from dump2polarion.exporters import transform
from dump2polarion.exporters import transform_projects

# pylint: disable=invalid-name
logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -95,7 +95,7 @@ def __init__(self, testcases_data, config, transform_func=None):
self.testcases_data = testcases_data
self.config = config
self._lookup_prop = ""
self._transform_func = transform_func or transform.get_testcases_transform(config)
self._transform_func = transform_func or transform_projects.get_testcases_transform(config)

default_fields = self.config.get("default_fields") or {}
default_fields = [
Expand Down
260 changes: 9 additions & 251 deletions dump2polarion/exporters/transform.py
View file
@@ -1,14 +1,10 @@
# -*- coding: utf-8 -*-
"""
Functions for validating and transforming results. These are specific per Polarion project.
If the 'polarion-lookup-method' is set to 'custom', this is the place where you can
set the 'id' of the test case to desired value.
Helper functions for transforming results.
"""

from __future__ import absolute_import, unicode_literals

import copy
import hashlib
import logging
import os
Expand Down Expand Up @@ -53,23 +49,28 @@ def insert_source_info(result):

def setup_parametrization(result, parametrize):
"""Modifies result's data according to the parametrization settings."""
parameters = result.get("params", {})

if parametrize:
# remove parameters from title
title = result.get("title")
if title:
result["title"] = TEST_PARAM_RE.sub("", title)
else:
# don't parametrize if not specifically configured
if parameters:
if "params" in result:
del result["params"]


def include_class_in_title(result):
"""Makes sure that test class is included in "title".
e.g. "TestServiceRESTAPI.test_power_parent_service"
>>> result = {"title": "test_foo", "classname": "foo.bar.baz.TestFoo",
... "file": "foo/bar/baz.py"}
>>> include_class_in_title(result)
>>> str(result.get("title"))
'TestFoo.test_foo'
>>> result.get("classname")
"""
classname = result.get("classname", "")
if classname:
Expand Down Expand Up @@ -115,24 +116,6 @@ def get_testcase_id(testcase, append_str):
return testcase_id


def set_cfme_caselevel(testcase, caselevels):
"""Converts tier to caselevel."""
tier = testcase.get("caselevel")
if tier is None:
return

try:
caselevel = caselevels[int(tier)]
except IndexError:
# invalid value
caselevel = "component"
except ValueError:
# there's already string value
return

testcase["caselevel"] = caselevel


def parse_rst_description(testcase):
"""Creates an HTML version of the RST formatted description."""
description = testcase.get("description")
Expand Down Expand Up @@ -199,228 +182,3 @@ def add_automation_link(testcase):
else ""
)
testcase["description"] = "{}<br/>{}".format(testcase.get("description") or "", automation_link)


def get_xunit_transform_cfme(config):
"""Return result transformation function for CFME."""
skip_searches = [
"SKIPME:",
"Skipping due to these blockers",
"BZ ?[0-9]+",
"GH ?#?[0-9]+",
"GH#ManageIQ",
]
skips = re.compile("(" + ")|(".join(skip_searches) + ")")

parametrize = config.get("cfme_parametrize", False)

def results_transform(result):
"""Results transform for CFME."""
verdict = result.get("verdict")
if not verdict:
return None

result = copy.deepcopy(result)

setup_parametrization(result, parametrize)
include_class_in_title(result)
insert_source_info(result)

verdict = verdict.strip().lower()
# we want to submit PASS and WAIT results
if verdict in Verdicts.PASS + Verdicts.WAIT:
return result
comment = result.get("comment")
# ... and SKIP results where there is a good reason (blocker etc.)
if verdict in Verdicts.SKIP and comment and skips.search(comment):
# found reason for skip
result["comment"] = comment.replace("SKIPME: ", "").replace("SKIPME", "")
return result
if verdict in Verdicts.FAIL and comment and "FAILME" in comment:
result["comment"] = comment.replace("FAILME: ", "").replace("FAILME", "")
return result
# we don't want to report this result if here
return None

return results_transform


# pylint: disable=unused-argument
def get_xunit_transform_cmp(config):
"""Return result transformation function for CFME."""
skip_searches = [
"SKIPME:",
"Skipping due to these blockers",
"BZ ?[0-9]+",
"GH ?#?[0-9]+",
"GH#ManageIQ",
]
skips = re.compile("(" + ")|(".join(skip_searches) + ")")

def results_transform(result):
"""Results transform for CMP."""
verdict = result.get("verdict")
if not verdict:
return None

result = copy.deepcopy(result)

# don't parametrize if not specifically configured
if result.get("params"):
del result["params"]

classname = result.get("classname", "")
if classname:
# we don't need to pass classnames?
del result["classname"]

# if the "test_id" property is present, use it as test case ID
test_id = result.get("test_id", "")
if test_id:
result["id"] = test_id

verdict = verdict.strip().lower()
# we want to submit PASS and WAIT results
if verdict in Verdicts.PASS + Verdicts.WAIT:
return result
comment = result.get("comment")
# ... and SKIP results where there is a good reason (blocker etc.)
if verdict in Verdicts.SKIP and comment and skips.search(comment):
# found reason for skip
result["comment"] = comment.replace("SKIPME: ", "").replace("SKIPME", "")
return result
if verdict in Verdicts.FAIL and comment and "FAILME" in comment:
result["comment"] = comment.replace("FAILME: ", "").replace("FAILME", "")
return result
# we don't want to report this result if here
return None

return results_transform


def get_testcases_transform_cfme(config):
"""Return test cases transformation function for CFME."""

parametrize = config.get("cfme_parametrize", False)
run_id = config.get("cfme_run_id")

caselevels = config.get("docstrings") or {}
caselevels = caselevels.get("valid_values") or {}
caselevels = caselevels.get("caselevel") or []

def testcase_transform(testcase):
"""Test cases transform for CFME."""
testcase = copy.deepcopy(testcase)

setup_parametrization(testcase, parametrize)
set_cfme_caselevel(testcase, caselevels)
preformat_plain_description(testcase)
add_unique_runid(testcase, run_id)
add_automation_link(testcase)

return testcase

return testcase_transform


def get_requirements_transform_cfme(config):
"""Return requirement transformation function for CFME."""

def requirement_transform(requirement):
"""Requirements transform for CFME."""
requirement = copy.deepcopy(requirement)

if "id" in requirement:
del requirement["id"]

return requirement

return requirement_transform


def get_requirements_transform_cloudtp(config):
"""Return requirement transformation function for CLOUDTP."""

def requirement_transform(requirement):
"""Requirements transform for CLOUDTP."""
requirement = copy.deepcopy(requirement)

if "id" in requirement:
del requirement["id"]
# TODO: testing purposes, remove once ready
if not requirement.get("assignee-id"):
requirement["assignee-id"] = "mkourim"
if not requirement.get("approver-ids"):
requirement["approver-ids"] = "mkourim:approved"

return requirement

return requirement_transform


PROJECT_MAPPING_XUNIT = {
"RHCF3": get_xunit_transform_cfme,
"CMP": get_xunit_transform_cmp,
"CLOUDTP": get_xunit_transform_cfme,
}

PROJECT_MAPPING_TESTCASES = {"RHCF3": get_testcases_transform_cfme}

PROJECT_MAPPING_REQ = {
"RHCF3": get_requirements_transform_cfme,
"CLOUDTP": get_requirements_transform_cloudtp,
}


def get_xunit_transform(config):
"""Returns results transformation function.
The transformation function is returned by calling corresponding "getter" function.
This allows customizations of results data according to requirements
of the specific project.
When no results data are returned, this result will be ignored
and will not be written to the resulting XML.
"""

project = config["polarion-project-id"]
if project in PROJECT_MAPPING_XUNIT:
return PROJECT_MAPPING_XUNIT[project](config)
return None


def get_testcases_transform(config):
"""Returns test cases transformation function.
The transformation function is returned by calling corresponding "getter" function.
This allows customizations of test cases data according to requirements
of the specific project.
When no test cases data are returned, this test case will be ignored
and will not be written to the resulting XML.
"""

project = config["polarion-project-id"]
if project in PROJECT_MAPPING_TESTCASES:
return PROJECT_MAPPING_TESTCASES[project](config)
return None


def get_requirements_transform(config):
"""Returns requirements transformation function.
The transformation function is returned by calling corresponding "getter" function.
This allows customizations of requirements data according to needs
of the specific project.
When no requirements data are returned, this requirement will be ignored
and will not be written to the resulting XML.
"""

project = config["polarion-project-id"]
if project in PROJECT_MAPPING_REQ:
return PROJECT_MAPPING_REQ[project](config)
return None

0 comments on commit 16a9330

Please sign in to comment.