Class CheckTestBase

java.lang.Object
com.e1c.g5.v8.dt.testing.check.CheckTestBase
Direct Known Subclasses:
CheckTemplateTest, SingleProjectReadOnlyCheckTestBase

public abstract class CheckTestBase extends Object
Base implementation for the check tests
  • Field Details

  • Constructor Details

    • CheckTestBase

      public CheckTestBase()
  • Method Details

    • enableCleanUp

      protected boolean enableCleanUp()
      Cleanup flag definition
      Returns:
      True if the WS should be cleaned after each test
    • getCheckIdFromMarker

      protected String getCheckIdFromMarker(Marker marker, IDtProject project)
      Gets the check identifier from the marker
      Parameters:
      marker - The marker to get check identifier from. May not be null
      project - The target project. May not be null
      Returns:
      The identifier of the check. May not be null
    • getCheckIdFromMarker

      protected String getCheckIdFromMarker(String shortUid, org.eclipse.core.resources.IProject project)
      Gets the check identifier from the marker's short UID
      Parameters:
      marker - The marker to get check identifier from. May not be null
      project - The target project. May not be null
      Returns:
      The identifier of the check. May not be null
    • getFirstMarker

      protected Marker getFirstMarker(String checkId, Object objectIdOrObject, IDtProject project)
      Gets the first matching marker from the object
      Parameters:
      checkId - The indentifier of the check. May not be null
      objectIdOrObject - The object identifier. Accepts BM ids (Long), URI's of modules, URI of module in the form of String, or IBmObject directly. May not be null
      project - The target project to get markers for. May not be null
      Returns:
      The found marker if any. null otherwise
    • getMarkersByCheckIds

      protected List<Marker> getMarkersByCheckIds(Set<String> checkIds, Object objectIdOrObject, IDtProject project)
      Gets the collection of markers from the object by selected checkIds
      Parameters:
      checkIds - The set of the check indentifiers, cannot be null, cannot be empty
      objectIdOrObject - The object identifier. Accepts BM ids (Long), URI's of modules, URI of module in the form of String, or IBmObject directly. May not be null
      project - The target project to get markers for. May not be null
      Returns:
      The found markers if any. Empty collection otherwise
    • getFirstNestedMarker

      protected Marker getFirstNestedMarker(String checkId, Object objectIdOrObject, IDtProject project)
      Gets the first matching marker from the object or its containments/refernces
      Parameters:
      checkId - The indentifier of the check. May not be null
      objectIdOrObject - The object identifier. Accepts BM ids (Long), URI's of modules, URI of module in the form of String, or IBmObject directly. May not be null
      project - The target project to get markers for. May not be null
      Returns:
      The found marker if any. null otherwise
    • getTopObjectByFqn

      protected IBmObject getTopObjectByFqn(String fqn, IDtProject dtProject)
    • getTopObjectIdByFqn

      protected Long getTopObjectIdByFqn(String fqn, IDtProject dtProject)
    • openProjectAndWaitForValidationFinish

      protected IDtProject openProjectAndWaitForValidationFinish(String configurationName) throws org.eclipse.core.runtime.CoreException
      Imports the test EDT project from the standard test location and waits until all validation operations are finished
      Parameters:
      configurationName - The name of the test configuration. Should match the sub-folder name of the 'workspaces' folder
      Returns:
      The opened IDtProject project handle. May not be null
      Throws:
      org.eclipse.core.runtime.CoreException - In case of improper project start
    • waitForDD

      protected void waitForDD(IDtProject project)
    • extractMarkerContainerId

      protected Object extractMarkerContainerId(Object objectIdOrObject)
    • getMarkersByCheckIds

      protected List<Marker> getMarkersByCheckIds(Set<String> checkIds, Object sourceObject, org.eclipse.core.resources.IProject project, Marker[] markers)
      Gets the collection of markers from the markers array by selected checkIds
      Parameters:
      checkIds - The set of the check indentifiers, cannot be null, cannot be empty
      sourceObject - The object identifier. Accepts BM ids (Long), URI's of modules, URI of module in the form of String, or IBmObject directly. May not be null
      project - The target project to get markers for. May not be null
      markers - The markers array. May not be null
      Returns:
      The found markers if any. Empty collection otherwise
    • getMarkersByCheckIds

      protected List<Marker> getMarkersByCheckIds(Set<String> checkIds, Object sourceObject, IDtProject project, Marker[] markers)
      Gets the collection of markers from the markers array by selected checkIds
      Parameters:
      checkIds - The set of the check indentifiers, cannot be null, cannot be empty
      sourceObject - The object identifier. Accepts BM ids (Long), URI's of modules, URI of module in the form of String, or IBmObject directly. May not be null
      project - The target DT project to get markers for. May not be null
      markers - The markers array. May not be null
      Returns:
      The found markers if any. Empty collection otherwise
    • getMdObjectByFqn

      protected MdObject getMdObjectByFqn(String fqn, IDtProject dtProject)
      Gets the MD object by its FQN and project
      Parameters:
      fqn - the FQN, cannot be null
      dtProject - the projectcannot be null
      Returns:
      The found MD object, can be null