/*
 * JBoss, Home of Professional Open Source
 * Copyright 2009, 2022 Red Hat Inc. and/or its affiliates and other contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.jboss.arquillian.protocol.rest;

import java.net.URL;

import org.jboss.arquillian.protocol.rest.test.MockTestRunner;
import org.jboss.arquillian.protocol.rest.test.TestCommandCallback;
import org.jboss.arquillian.protocol.servlet5.ServletProtocolConfiguration;
import org.jboss.arquillian.protocol.rest.runner.RESTTestRunner;
import org.jboss.arquillian.test.spi.TestResult;
import org.jboss.arquillian.test.spi.TestResult.Status;
import org.junit.Assert;
import org.junit.Test;

/**
 * ProtocolTestCase
 *
 * @author <a href="mailto:aslak@conduct.no">Aslak Knutsen</a>
 * @version $Revision: $
 */
public class ProtocolTestCase extends AbstractServerBase {

    @Test
    public void shouldReturnTestResult() throws Exception {
        MockTestRunner.add(TestResult.passed());

        RESTMethodExecutor executor = createExecutor();
        TestResult result = executor.invoke(new MockTestExecutor());

        Assert.assertEquals(
            "Should have returned a passed test",
            MockTestRunner.wantedResults.getStatus(),
            result.getStatus());

        Assert.assertNull(
            "No Exception should have been thrown",
            result.getThrowable());
    }

    @Test
    public void shouldUseLogicalMethodNameAndSupportUrlReservedCharactersInIt() throws Exception {
        final String testMethodNameWithReservedUrlCharacters = "non standard!test&name";

        MockTestRunner.add(TestResult.passed());

        RESTMethodExecutor executor = createExecutor();
        executor.invoke(new MockTestExecutor() {
            @Override
            public String getMethodName() {
                return testMethodNameWithReservedUrlCharacters;
            }
        });

        Assert.assertEquals(
            "Should use the logical method name",
            testMethodNameWithReservedUrlCharacters,
            MockTestRunner.testRequests.get(0).getMethodName()
        );
    }

    @Test
    public void shouldReturnThrownException() throws Exception {
        MockTestRunner.add(TestResult.failed(new Exception().fillInStackTrace()));

        RESTMethodExecutor executor = createExecutor();
        TestResult result = executor.invoke(new MockTestExecutor());

        Assert.assertEquals(
            "Should have returned a passed test",
            MockTestRunner.wantedResults.getStatus(),
            result.getStatus());

        Assert.assertNotNull(
            "Exception should have been thrown",
            result.getThrowable());
    }

    @Test
    public void shouldReturnExceptionWhenMissingTestClassParameter() throws Exception {
        URL url = createURL(RESTTestRunner.OUTPUT_MODE_SERIALIZED, null, null);
        TestResult result = (TestResult) TestUtil.execute(url);

        Assert.assertEquals(
            "Should have returned a passed test",
            Status.FAILED,
            result.getStatus());

        Assert.assertTrue(
            "No Exception should have been thrown",
            result.getThrowable() instanceof IllegalArgumentException);
    }

    @Test
    public void shouldReturnExceptionWhenMissingMethodParameter() throws Exception {
        URL url = createURL(RESTTestRunner.OUTPUT_MODE_SERIALIZED, "org.my.test", null);
        TestResult result = (TestResult) TestUtil.execute(url);

        Assert.assertEquals(
            "Should have returned a passed test",
            Status.FAILED,
            result.getStatus());

        Assert.assertTrue(
            "No Exception should have been thrown",
            result.getThrowable() instanceof IllegalArgumentException);
    }

    @Test
    public void shouldReturnExceptionWhenErrorLoadingClass() throws Exception {
        URL url = createURL(RESTTestRunner.OUTPUT_MODE_SERIALIZED, "org.my.test", "test");
        TestResult result = (TestResult) TestUtil.execute(url);

        Assert.assertEquals(
            "Should have returned a passed test",
            Status.FAILED,
            result.getStatus());

        Assert.assertTrue(
            "No Exception should have been thrown",
            result.getThrowable() instanceof ClassNotFoundException);
    }

    protected RESTMethodExecutor createExecutor() {
        return new RESTMethodExecutor(
            new ServletProtocolConfiguration(),
            createContexts(),
            new TestCommandCallback());
    }
}
