Class ServiceInterfaceTestCase

  • Direct Known Subclasses:
    DouiServiceInterfaceTestCase

    @StableMinor(version="14.1",
                 sinceVersion="5.6")
    public abstract class ServiceInterfaceTestCase
    extends Object

    Generic test case for Service Interfaces.

    This class provides the general structure needed to test service interfaces.

    The subclasses must override getServiceId and getServiceInterfaceId methods in order to provide the ids for service and interface respectively.

    The setUp creates an instance of the service interface, starts a user session and a transaction.

    The tearDown cleanups the service interface instance created and ends the session and transaction.

    Since:
    5.6.0
    Version:
    $Revision: 24684 $ $Date: 2021-08-23 18:58:35 -0300 (Mon, 23 Aug 2021) $
    • Field Detail

      • renderRequestCycle

        protected IRenderRequestCycle renderRequestCycle
        Instance of IRenderRequestCycle used to get request and response mocks for render method.
        Since:
        5.6.0
      • actionRequestCycle

        protected IActionRequestCycle actionRequestCycle
        Instance of IActionRequestCycle used to get request and response mocks for processAction method.
        Since:
        5.6.0
      • structureHelper

        protected StructureHelper structureHelper
        Instance of StructureHelper used to create service interface instances and the needed structure (channels, pages and service instances).
        Since:
        5.6.0
      • serviceInterfaceInstanceConfig

        protected ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig
        The service interface instance created for the tests.
        Since:
        5.6.0
      • transaction

        protected ITransaction transaction
        Transaction instance, initiated during setUp() and disposed in tearDown(). Structure automatically created is created within this transaction.
        Since:
        5.6.0
      • sessionConfig

        protected SessionConfig sessionConfig
        Instance of SessionConfig, created during setUp().
        Since:
        5.6.0
    • Constructor Detail

      • ServiceInterfaceTestCase

        public ServiceInterfaceTestCase()
    • Method Detail

      • setUp

        public void setUp()
                   throws PortalException
        Provides the structure needed to test a service interface:
        • Creates the service interface instance
        • Creates the render and action invocation contexts
          (needed to perform tests on render and processAction methods)
        • Starts an user session
        • Starts a transaction
        Throws:
        Exception - whenever an error occur
        PortalException
      • tearDown

        public void tearDown()
                      throws PortalException
        This method performs the cleanup for the test:
        • Disposes the transaction
        • Ends session
        • Delete the service interface instance created
        Throws:
        Exception - whenever an error occur.
        PortalException
        Since:
        5.6.0
      • initRequestCycles

        protected void initRequestCycles()
        Create the render request cycle and action request cycle.
        Since:
        5.6.0
      • getServiceId

        public abstract String getServiceId()
        Return the service id to be instantiated
        Returns:
        service id
        Since:
        5.6.0
      • getServiceInterfaceId

        public abstract String getServiceInterfaceId()
        Return the service interface id to be instantiated
        Returns:
        service interface id
        Since:
        5.6.0