Fields.py

Go to the documentation of this file.

#
# Copyright 2009, MeVis Medical Solutions AG
#
# The user may use this file in accordance with the license agreement provided with
# the Software or, alternatively, in accordance with the terms contained in a
# written agreement between the user and MeVis Medical Solutions AG.
#
# For further information use the contact form at https://www.mevislab.de/contact
#
 
 
 
# -- system imports ----------------------------------------------------------------------------{{{-
import os
import sys
import traceback
 
import TestSupport.ChangeSet
from TestSupport.ChangeSet import ChangeSet
# ----------------------------------------------------------------------------------------------}}}-
 
# -- local imports -----------------------------------------------------------------------------{{{-
import mevis
 
from . import Base
from . import Logging
from TestSupport.TestHelper import TestHelper
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def touch ---------------------------------------------------------------------------------{{{-
 
def touch (fieldName, verbose=True):
  TestHelper.getInstance().getChangeSet().setFieldValue(fieldName, None, verbose=verbose)
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def setValues -----------------------------------------------------------------------------{{{-
 
def setValues (fieldValueDict, verbose=True):
  changeSet = TestHelper.getInstance().getChangeSet()
  for key in fieldValueDict:
    changeSet.setFieldValue(key, fieldValueDict[key], verbose=verbose)
# --------------------------------------------------------------------------------------------}}}-
 
# -- def varyValues --------------------------------------------------------------------------{{{-
 
def varyValues (function, funcParams, fieldDict, parentChangeSet=None, verbose=True):
  if not parentChangeSet:
    parentChangeSet = TestHelper.getInstance().getChangeSet()
 
  # No more fields to set, call given function.
  if len(fieldDict) == 0:
    function(*funcParams)
  else:
    # Create change set for local changes.
    Base.pushChangeSet()
 
    fieldName, fieldValues = fieldDict.popitem()
    field = Base.getTestCaseContext().field(fieldName)
    # If list of field values is empty use available.
    if fieldValues == []:
      # TODO This is only valid for enums. Should find good handling for other
      #      data types or exclude using [] for those.
      fieldValues = list(field.items())
 
    changeSet = TestHelper().getInstance().getChangeSet()
 
    # For each value in the list call the sub dictionary.
    for fieldValue in fieldValues:
      changeSet.setFieldValue(fieldName, fieldValue, verbose=verbose)
      varyValues(function, funcParams, fieldDict, changeSet, verbose)
 
    Base.popChangeSet()
 
    fieldDict[fieldName] = fieldValues
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def getValue ------------------------------------------------------------------------------{{{-
 
def getValue (fieldName):
  field = Base.getTestCaseContext().field(fieldName)
  if not field:
    raise Exception("Field (%s) not found in current test's context!" % (fieldName))
  if field.type in ('String', 'Enum'):
    return field.stringValue()
  elif field.type == 'Bool':
    return field.boolValue()
  elif field.type == 'Integer':
    return field.intValue()
  elif field.type == 'Float':
    return field.floatValue()
  elif field.type == 'Double':
    return field.doubleValue()
  elif 'Vector6' in field.type:
    return field.stringValue()
  elif field.type in ('Vector2', 'Vector3', 'Vector4', 'Plane', 'Rotation'):
    return field.vectorValue()
  elif field.type in ('Matrix'):
    return field.matrixValue()
  elif field.type in ('Color'):
    return field.colorValue()
  elif field.type == 'Image':
    return field.image()
  elif 'MLBase' in field.type:
    return field.object()
  else:
    return field.value
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def setValue ------------------------------------------------------------------------------{{{-
 
def setValue (fieldName, fieldValue, verbose=True):
  TestHelper.getInstance().getChangeSet().setFieldValue(fieldName, fieldValue, verbose=verbose)
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def runFieldValueTestCase -----------------------------------------------------------------{{{-
 
def runFieldValueTestCase (fieldValueTestCaseSet, testCaseName, verbose=True):
  testCase = fieldValueTestCaseSet.get(testCaseName)
  testCase.applyParameterization(TestHelper.getInstance().getChangeSet(), verbose=verbose)
  if not testCase.verifyExpectedResults(verbose=verbose):
    Logging.error("Failed to verify expected results.", depth=1)
# ----------------------------------------------------------------------------------------------}}}-