org.eclipse.microprofile.fault.tolerance.tck.RetryTimeoutTest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of microprofile-fault-tolerance-tck Show documentation
Fault Tolerance for MicroProfile :: TCK
There is a newer version: 4.1
Show newest version
/*
 *******************************************************************************
 * Copyright (c) 2016-2018 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package org.eclipse.microprofile.fault.tolerance.tck;

import static org.eclipse.microprofile.fault.tolerance.tck.util.TCKConfig.getConfig;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.fail;

import org.eclipse.microprofile.fault.tolerance.tck.config.ConfigAnnotationAsset;
import org.eclipse.microprofile.fault.tolerance.tck.retrytimeout.clientserver.RetryTimeoutClient;
import org.eclipse.microprofile.fault.tolerance.tck.util.TCKConfig;
import org.eclipse.microprofile.faulttolerance.Timeout;
import org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.testng.Arquillian;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.EmptyAsset;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.testng.Assert;
import org.testng.annotations.Test;

import jakarta.inject.Inject;

/**
 * Test the combination of the @Retry and @Timeout annotations.
 * 
 * @author Emily Jiang
 * @author Andrew Rouse
 *
 */
public class RetryTimeoutTest extends Arquillian {

    private @Inject RetryTimeoutClient clientForRetryTimeout;

    private TCKConfig config = TCKConfig.getConfig();

    @Deployment
    public static WebArchive deploy() {

        final ConfigAnnotationAsset config = new ConfigAnnotationAsset()
                .setValue(RetryTimeoutClient.class, "serviceA", Timeout.class, getConfig().getTimeoutInStr(500))
                .setValue(RetryTimeoutClient.class, "serviceWithoutRetryOn", Timeout.class,
                        getConfig().getTimeoutInStr(500))
                .setValue(RetryTimeoutClient.class, "serviceWithAbortOn", Timeout.class,
                        getConfig().getTimeoutInStr(500));

        JavaArchive testJar = ShrinkWrap
                .create(JavaArchive.class, "ftRetryTimeout.jar")
                .addClasses(RetryTimeoutClient.class)
                .addAsManifestResource(config, "microprofile-config.properties")
                .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml")
                .as(JavaArchive.class);

        WebArchive war = ShrinkWrap
                .create(WebArchive.class, "ftRetryTimeout.war")
                .addAsLibrary(testJar);
        return war;
    }

    /**
     * Test that a Service is retried the expected number of times.
     * 
     * A timeout is configured for serviceA and in this case the service should generate Timeout exceptions.
     * 
     * The service should be retried.
     */
    @Test
    public void testRetryTimeout() {
        try {
            String result = clientForRetryTimeout.serviceA(config.getTimeoutInMillis(1000));
        } catch (TimeoutException ex) {
            // Expected
        } catch (RuntimeException ex) {
            // Not Expected
            Assert.fail("serviceA should not throw a RuntimeException in testRetryTimeout");
        }

        Assert.assertEquals(clientForRetryTimeout.getCounterForInvokingServiceA(), 2,
                "The execution count should be 2 (1 retry + 1)");
    }

    /**
     * Test that a Service is retried the expected number of times.
     * 
     * A timeout is configured for serviceA but the service should fail before the timeout is reached and generate a
     * RuntimeException.
     * 
     * The service should be retried.
     */
    @Test
    public void testRetryNoTimeout() {
        try {
            String result = clientForRetryTimeout.serviceA(config.getTimeoutInMillis(10));
        } catch (TimeoutException ex) {
            // Not Expected
            Assert.fail("serviceA should not throw a TimeoutException in testRetrytNoTimeout");
        } catch (RuntimeException ex) {
            // Expected
        }

        Assert.assertEquals(clientForRetryTimeout.getCounterForInvokingServiceA(), 2,
                "The execution count should be 2 (1 retry + 1)");
    }

    /**
     * Test that a service is not retried if TimeoutException is not included in the retryOn attribute
     */
    @Test
    public void testRetryWithoutRetryOn() {
        try {
            clientForRetryTimeout.serviceWithoutRetryOn();
            fail("Timeout exception not thrown");
        } catch (TimeoutException e) {
            // expected
        }

        assertEquals(clientForRetryTimeout.getCounterForInvokingServiceWithoutRetryOn(), 1,
                "The execution count should be 1 (no retries)");
    }

    /**
     * Test that a service is not retried if TimeoutException is included in the abortOn attribute
     */
    @Test
    public void testRetryWithAbortOn() {
        try {
            clientForRetryTimeout.serviceWithAbortOn();
            fail("Timeout exception not thrown");
        } catch (TimeoutException e) {
            // expected
        }

        assertEquals(clientForRetryTimeout.getCounterForInvokingServiceWithAbortOn(), 1,
                "The execution count should be 1 (no retries)");
    }

}