CodeFirstTest.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.cxf.jaxws;

import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Executor;

import javax.wsdl.Definition;
import javax.wsdl.factory.WSDLFactory;
import javax.xml.namespace.QName;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

import jakarta.jws.WebMethod;
import jakarta.jws.WebParam;
import jakarta.jws.WebResult;
import jakarta.jws.WebService;
import jakarta.jws.soap.SOAPBinding;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.cxf.Bus;
import org.apache.cxf.endpoint.Client;
import org.apache.cxf.endpoint.Server;
import org.apache.cxf.ext.logging.LoggingFeature;
import org.apache.cxf.ext.logging.LoggingInInterceptor;
import org.apache.cxf.ext.logging.LoggingOutInterceptor;
import org.apache.cxf.frontend.ClientProxy;
import org.apache.cxf.frontend.ServerFactoryBean;
import org.apache.cxf.interceptor.Interceptor;
import org.apache.cxf.jaxws.service.AddNumbersException;
import org.apache.cxf.jaxws.service.AddNumbersSubException;
import org.apache.cxf.jaxws.service.ArrayService;
import org.apache.cxf.jaxws.service.ArrayServiceImpl;
import org.apache.cxf.jaxws.service.Entity;
import org.apache.cxf.jaxws.service.FooServiceImpl;
import org.apache.cxf.jaxws.service.GenericsService;
import org.apache.cxf.jaxws.service.GenericsService2;
import org.apache.cxf.jaxws.service.Hello;
import org.apache.cxf.jaxws.service.HelloInterface;
import org.apache.cxf.jaxws.service.QueryResult;
import org.apache.cxf.jaxws.service.QuerySummary;
import org.apache.cxf.jaxws.service.SayHi;
import org.apache.cxf.jaxws.service.SayHiImpl;
import org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean;
import org.apache.cxf.message.Message;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.model.BindingInfo;
import org.apache.cxf.service.model.InterfaceInfo;
import org.apache.cxf.transport.local.LocalTransportFactory;
import org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean;
import org.apache.cxf.wsdl11.ServiceWSDLBuilder;
import org.apache.ws.commons.schema.constants.Constants;

import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

public class CodeFirstTest extends AbstractJaxWsTest {

    String address = "local://localhost:9000/Hello";

    @Test
    public void testDocLitModel() throws Exception {
        Definition d = createService(false);

        Document wsdl = WSDLFactory.newInstance().newWSDLWriter().getDocument(d);
        addNamespace("svc", "http://service.jaxws.cxf.apache.org/");

        assertValid("/wsdl:definitions/wsdl:service[@name='HelloService']", wsdl);
        assertValid("//wsdl:port/wsdlsoap:address[@location='" + address + "']", wsdl);
        assertValid("//wsdl:portType[@name='Hello']", wsdl);

        assertValid("/wsdl:definitions/wsdl:types/xsd:schema"
                    + "[@targetNamespace='http://service.jaxws.cxf.apache.org/']"
                    + "/xsd:import[@namespace='http://jaxb.dev.java.net/array']", wsdl);

        assertValid("/wsdl:definitions/wsdl:types/xsd:schema"
                    + "[@targetNamespace='http://service.jaxws.cxf.apache.org/']"
                    + "/xsd:element[@type='ns0:stringArray']", wsdl);

        assertValid("/wsdl:definitions/wsdl:message[@name='sayHi']"
                    + "/wsdl:part[@element='tns:sayHi'][@name='sayHi']",
                    wsdl);

        assertValid("/wsdl:definitions/wsdl:message[@name='getGreetingsResponse']"
                    + "/wsdl:part[@element='tns:getGreetingsResponse'][@name='getGreetingsResponse']",
                    wsdl);

        assertValid("/wsdl:definitions/wsdl:binding/wsdl:operation[@name='getGreetings']"
                    + "/wsdlsoap:operation[@soapAction='myaction']",
                    wsdl);


    }

    @Test
    public void testWrappedModel() throws Exception {
        Definition d = createService(true);

        Document wsdl = WSDLFactory.newInstance().newWSDLWriter().getDocument(d);

        addNamespace("svc", "http://service.jaxws.cxf.apache.org");

        assertValid("/wsdl:definitions/wsdl:service[@name='HelloService']", wsdl);
        assertValid("//wsdl:port/wsdlsoap:address[@location='" + address + "']", wsdl);
        assertValid("//wsdl:portType[@name='Hello']", wsdl);
        assertValid("/wsdl:definitions/wsdl:message[@name='sayHi']"
                    + "/wsdl:part[@element='tns:sayHi'][@name='parameters']",
                    wsdl);
        assertValid("/wsdl:definitions/wsdl:message[@name='sayHiResponse']"
                    + "/wsdl:part[@element='tns:sayHiResponse'][@name='parameters']",
                    wsdl);
        assertValid("//xsd:complexType[@name='sayHi']"
                    + "/xsd:sequence/xsd:element[@name='arg0']",
                    wsdl);
    }

    private Definition createService(boolean wrapped) throws Exception {
        ReflectionServiceFactoryBean bean = new JaxWsServiceFactoryBean();

        Bus bus = getBus();
        bean.setBus(bus);
        bean.setServiceClass(Hello.class);
        bean.setWrapped(wrapped);

        Service service = bean.create();

        InterfaceInfo i = service.getServiceInfos().get(0).getInterface();
        assertEquals(5, i.getOperations().size());

        ServerFactoryBean svrFactory = new ServerFactoryBean();
        svrFactory.setBus(bus);
        svrFactory.setServiceFactory(bean);
        svrFactory.setAddress(address);
        svrFactory.create();

        Collection<BindingInfo> bindings = service.getServiceInfos().get(0).getBindings();
        assertEquals(1, bindings.size());

        ServiceWSDLBuilder wsdlBuilder =
            new ServiceWSDLBuilder(bus, service.getServiceInfos().get(0));
        return wsdlBuilder.build();
    }


    @Test
    public void testEndpoint() throws Exception {
        Hello service = new Hello();

        try (EndpointImpl ep = new EndpointImpl(getBus(), service, (String) null)) {
            ep.setExecutor(new Executor() {
                public void execute(Runnable r) {
                    new Thread(r).start();
                }
            });
            ep.publish("local://localhost:9090/hello");

            Node res = invoke("local://localhost:9090/hello",
                              LocalTransportFactory.TRANSPORT_ID,
                              "sayHi.xml");

            assertNotNull(res);

            addNamespace("h", "http://service.jaxws.cxf.apache.org/");
            assertValid("//s:Body/h:sayHiResponse/return", res);

            res = invoke("local://localhost:9090/hello",
                         LocalTransportFactory.TRANSPORT_ID,
                         "getGreetings.xml");

            assertNotNull(res);

            addNamespace("h", "http://service.jaxws.cxf.apache.org/");
            assertValid("//s:Body/h:getGreetingsResponse/return[1]", res);
            assertValid("//s:Body/h:getGreetingsResponse/return[2]", res);
        }
    }

    @Test
    public void testClient() throws Exception {
        Hello serviceImpl = new Hello();
        try (EndpointImpl ep = new EndpointImpl(getBus(), serviceImpl, (String) null)) {
            ep.publish("local://localhost:9090/hello");
            QName serviceName = new QName("http://service.jaxws.cxf.apache.org/", "HelloService");
            QName portName = new QName("http://service.jaxws.cxf.apache.org/", "HelloPort");

            // need to set the same bus with service , so use the ServiceImpl
            ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
            service.addPort(portName, "http://schemas.xmlsoap.org/soap/", "local://localhost:9090/hello");

            HelloInterface proxy = service.getPort(portName, HelloInterface.class, new LoggingFeature());
            Client client = ClientProxy.getClient(proxy);
            boolean found = false;
            for (Interceptor<? extends Message> i : client.getOutInterceptors()) {
                if (i instanceof LoggingOutInterceptor) {
                    found = true;
                }
            }
            assertTrue(found);
            assertEquals("Get the wrong result", "hello", proxy.sayHi("hello"));
            String[] strInput = new String[2];
            strInput[0] = "Hello";
            strInput[1] = "Bonjour";
            String[] strings = proxy.getStringArray(strInput);
            assertEquals(strings.length, 2);
            assertEquals(strings[0], "HelloHello");
            assertEquals(strings[1], "BonjourBonjour");
            List<String> listInput = new ArrayList<>();
            listInput.add("Hello");
            listInput.add("Bonjour");
            List<String> list = proxy.getStringList(listInput);
            assertEquals(list.size(), 2);
            assertEquals(list.get(0), "HelloHello");
            assertEquals(list.get(1), "BonjourBonjour");
            //now the client side can't unmarshal the complex type without binding types annoutation
            List<String> result = proxy.getGreetings();
            assertEquals(2, result.size());
        }
    }

    @Test
    public void testException() throws Exception {
        Hello serviceImpl = new Hello();
        try (EndpointImpl ep = new EndpointImpl(getBus(), serviceImpl, (String) null)) {
            ep.publish("local://localhost:9090/hello");
            ep.getServer().getEndpoint().getInInterceptors().add(new LoggingInInterceptor());
            ep.getServer().getEndpoint().getOutInterceptors().add(new LoggingOutInterceptor());
            QName serviceName = new QName("http://service.jaxws.cxf.apache.org/", "HelloService");
            QName portName = new QName("http://service.jaxws.cxf.apache.org/", "HelloPort");

            // need to set the same bus with service , so use the ServiceImpl
            ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
            service.addPort(portName, "http://schemas.xmlsoap.org/soap/", "local://localhost:9090/hello");

            HelloInterface proxy = service.getPort(portName, HelloInterface.class);
            ClientProxy.getClient(proxy).getInFaultInterceptors().add(new LoggingInInterceptor());
            ClientProxy.getClient(proxy).getInInterceptors().add(new LoggingInInterceptor());
            try {
                proxy.addNumbers(1, -2);
                fail("should throw AddNumbersException");
            } catch (AddNumbersException e) {
                assertEquals(e.getInfo(), "Sum is less than 0.");
            }

            try {
                proxy.addNumbers(1, 99);
                fail("should throw AddNumbersSubException");
            } catch (AddNumbersSubException e) {
                assertEquals(e.getSubInfo(), "Sum is 100");
            } catch (AddNumbersException e) {
                fail("should throw AddNumbersSubException");
            }
            try (AutoCloseable c = (AutoCloseable)proxy) {
                assertEquals("Result = 2", proxy.addNumbers(1, 1));
            }
            try {
                proxy.addNumbers(1, 1);
                fail("Proxy should be closed");
            } catch (IllegalStateException t) {
                //this is expected as the client is closed.
            }
        }
    }


    @Test
    public void testRpcClient() throws Exception {
        SayHiImpl serviceImpl = new SayHiImpl();
        try (EndpointImpl ep = new EndpointImpl(getBus(), serviceImpl, (String) null)) {
            ep.publish("local://localhost:9090/hello");

            QName serviceName = new QName("http://mynamespace.com/", "SayHiService");
            QName portName = new QName("http://mynamespace.com/", "HelloPort");

            // need to set the same bus with service , so use the ServiceImpl
            ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
            service.addPort(portName, "http://schemas.xmlsoap.org/soap/", "local://localhost:9090/hello");

            SayHi proxy = service.getPort(portName, SayHi.class);
            long res = proxy.sayHi(3);
            assertEquals(3, res);
            String[] strInput = new String[2];
            strInput[0] = "Hello";
            strInput[1] = "Bonjour";
            String[] strings = proxy.getStringArray(strInput);
            assertEquals(strings.length, 2);
            assertEquals(strings[0], "HelloHello");
            assertEquals(strings[1], "BonjourBonjour");
        }
    }


    @Test
    public void testArrayAndList() throws Exception {
        ArrayServiceImpl serviceImpl = new ArrayServiceImpl();
        try (EndpointImpl ep = new EndpointImpl(getBus(), serviceImpl, (String) null)) {
            ep.publish("local://localhost:9090/array");
            ep.getServer().getEndpoint().getInInterceptors().add(new LoggingInInterceptor());
            ep.getServer().getEndpoint().getOutInterceptors().add(new LoggingOutInterceptor());
            QName serviceName = new QName("http://service.jaxws.cxf.apache.org/", "ArrayService");
            QName portName = new QName("http://service.jaxws.cxf.apache.org/", "ArrayPort");

            // need to set the same bus with service , so use the ServiceImpl
            ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
            service.addPort(portName, "http://schemas.xmlsoap.org/soap/", "local://localhost:9090/array");

            ArrayService proxy = service.getPort(portName, ArrayService.class);
            String[] arrayOut = proxy.arrayOutput();
            assertEquals(arrayOut.length, 3);
            assertEquals(arrayOut[0], "string1");
            assertEquals(arrayOut[1], "string2");
            assertEquals(arrayOut[2], "string3");
            String[] arrayIn = new String[3];
            arrayIn[0] = "string1";
            arrayIn[1] = "string2";
            arrayIn[2] = "string3";
            assertEquals(proxy.arrayInput(arrayIn), "string1string2string3");
            arrayOut = proxy.arrayInputAndOutput(arrayIn);
            assertEquals(arrayOut.length, 3);
            assertEquals(arrayOut[0], "string11");
            assertEquals(arrayOut[1], "string22");
            assertEquals(arrayOut[2], "string33");

            List<String> listOut = proxy.listOutput();
            assertEquals(listOut.size(), 3);
            assertEquals(listOut.get(0), "string1");
            assertEquals(listOut.get(1), "string2");
            assertEquals(listOut.get(2), "string3");
            List<String> listIn = new ArrayList<>();
            listIn.add("list1");
            listIn.add("list2");
            listIn.add("list3");
            assertEquals(proxy.listInput(listIn), "list1list2list3");
        }
    }

    @Test
    public void testNamespacedWebParamsBare() throws Exception {
        JaxWsServerFactoryBean sf = new JaxWsServerFactoryBean();
        sf.setAddress("local://localhost/test");
        sf.setServiceClass(FooServiceImpl.class);

        Server server = sf.create();

        Document doc = getWSDLDocument(server);

        assertValid("//xsd:schema[@targetNamespace='http://namespace3']", doc);
        assertValid("//xsd:schema[@targetNamespace='http://namespace5']", doc);

        assertValid("//xsd:element[@name='FooEcho2HeaderRequest'][1]", doc);
        assertInvalid("//xsd:element[@name='FooEcho2HeaderRequest'][2]", doc);
    }

    @Test
    public void testNamespacedWebParamsWrapped() throws Exception {
        JaxWsServerFactoryBean sf = new JaxWsServerFactoryBean();
        sf.setAddress("local://localhost/test");
        sf.setServiceBean(new FooServiceImpl());
        sf.getServiceFactory().setWrapped(true);

        Server server = sf.create();

        Document doc = getWSDLDocument(server);

        // DOMUtils.writeXml(doc, System.out);
        assertValid("//xsd:schema[@targetNamespace='http://namespace3']", doc);
        assertValid("//xsd:schema[@targetNamespace='http://namespace5']", doc);
    }

    @Test
    public void testCXF2509() throws Exception {
        JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
        //factory.setServiceClass(serviceInterface);
        factory.setServiceBean(new GenericsServiceImpl());
        factory.setAddress("local://localhost/test");
        Server server = factory.create();
        Document doc = getWSDLDocument(server);
        assertValid("//xsd:schema/xsd:complexType[@name='entity']", doc);
    }

    public static class GenericsServiceImpl implements GenericsService<Entity<String>, QuerySummary> {
        public QueryResult<Entity<String>, QuerySummary> read(String query, String uc) {
            return null;
        }
    }

    @Test
    public void testCXF1758() throws Exception {
        JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
        factory.setServiceBean(new GenericsService2Impl());
        factory.setAddress("local://localhost/test");
        Server server = factory.create();
        Document doc = getWSDLDocument(server);

        assertXPathEquals("//xsd:schema/xsd:complexType[@name='convert']/xsd:sequence/xsd:element/@type",
                          Constants.XSD_INT,
                          doc);

        factory = new JaxWsServerFactoryBean();
        factory.setServiceBean(new GenericsService2<Float, Double>() {
            public Double convert(Float t) {
                return t.doubleValue();
            }

            public GenericsService2.Value<Double> convert2(GenericsService2.Value<Float> in) {
                return new GenericsService2.Value<Double>(in.getValue().doubleValue());
            }
        });
        factory.setAddress("local://localhost/test2");
        server = factory.create();
        Document doc2 = getWSDLDocument(server);
        assertXPathEquals("//xsd:schema/xsd:complexType[@name='convert']/xsd:sequence/"
                    + "xsd:element/@type",
                    Constants.XSD_FLOAT,
                    doc2);

        QName serviceName = new QName("http://service.jaxws.cxf.apache.org/", "Generics2");
        QName portName = new QName("http://service.jaxws.cxf.apache.org/", "Generics2Port");

        ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
        service.addPort(portName, "http://schemas.xmlsoap.org/soap/",
                        "local://localhost/test2");

        GenericsService2Typed proxy = service.getPort(portName,
                                                      GenericsService2Typed.class);
        assertEquals("", 3.14d, proxy.convert(3.14f), 0.00001);
        assertEquals("", 3.14d, proxy.convert2(new GenericsService2.Value<Float>(3.14f)).getValue(), 0.00001);

    }

    public interface GenericsService2Typed extends GenericsService2<Float, Double> {

    }
    public static class GenericsService2Impl implements GenericsService2<Integer, String> {
        public String convert(Integer t) {
            return t.toString();
        }

        public GenericsService2.Value<String> convert2(GenericsService2.Value<Integer> in) {
            return new GenericsService2.Value<String>(in.getValue().toString());
        }
    }

    @Test
    public void testCXF1510() throws Exception {
        JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
        factory.setServiceClass(NoRootBare.class);
        factory.setServiceBean(new NoRootBareImpl());
        factory.setAddress("local://localhost/testNoRootBare");
        Server server = factory.create();
        server.start();

        QName serviceName = new QName("http://service.jaxws.cxf.apache.org/", "NoRootBareService");
        QName portName = new QName("http://service.jaxws.cxf.apache.org/", "NoRootBarePort");

        ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
        service.addPort(portName, "http://schemas.xmlsoap.org/soap/",
                        "local://localhost/testNoRootBare");

        NoRootBare proxy = service.getPort(portName, NoRootBare.class);
        assertEquals("hello", proxy.echoString(new NoRootRequest("hello")).getMessage());
    }

    @WebService
    @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
    public interface NoRootBare {
        NoRootResponse echoString(NoRootRequest request);
    }

    @WebService
    public static class NoRootBareImpl implements NoRootBare {
        public NoRootResponse echoString(NoRootRequest request) {
            return new NoRootResponse(request.getMessage());
        }
    }

    @XmlType(name = "")
    @XmlAccessorType(XmlAccessType.FIELD)
    public static class NoRootRequest {
        @XmlElement
        private String message;

        public NoRootRequest() {
        }
        public NoRootRequest(String m) {
            message = m;
        }

        public void setMessage(String message) {
            this.message = message;
        }

        public String getMessage() {
            return message;
        }
    }
    @XmlType(name = "")
    @XmlAccessorType(XmlAccessType.FIELD)
    public static class NoRootResponse {
        @XmlElement
        private String message;

        public NoRootResponse() {
        }
        public NoRootResponse(String m) {
            message = m;
        }

        public void setMessage(String message) {
            this.message = message;
        }

        public String getMessage() {
            return message;
        }
    }

    @Test
    public void testCXF2766() throws Exception {
        JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
        factory.setServiceClass(CXF2766.class);
        factory.setServiceBean(new CXF2766Impl());
        factory.setAddress("local://localhost/testcxf2766");
        Server server = factory.create();
        server.getEndpoint().getInInterceptors().add(new LoggingInInterceptor());
        server.getEndpoint().getOutInterceptors().add(new LoggingOutInterceptor());
        Document doc = getWSDLDocument(server);
        //org.apache.cxf.helpers.XMLUtils.printDOM(doc);
        assertValid("//wsdl:message[@name='doReturnResponse']/wsdl:part[@name='returnResponse']", doc);

        QName serviceName = new QName("http://cxf.apache.org/service.wsdl", "BareService");
        QName portName = new QName("http://cxf.apache.org/service.wsdl", "BarePort");

        ServiceImpl service = new ServiceImpl(getBus(), (URL)null, serviceName, null);
        service.addPort(portName, "http://schemas.xmlsoap.org/soap/",
                        "local://localhost/testcxf2766");
        CXF2766 proxy = service.getPort(portName, CXF2766.class);
        proxy.doReturn(new ReturnRequestType());
    }
    @WebService(targetNamespace = "http://cxf.apache.org/service.wsdl")
    @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
    public interface CXF2766 {
        @WebResult(name = "return-response",
                   targetNamespace = "http://cxf.apache.org/service.wsdl/types",
                   partName = "returnResponse")
        @WebMethod(action = "http://cxf.apache.org/doReturn")
        ReturnResponseType doReturn(@WebParam(partName = "returnTrx",
                                              name = "return-request",
                                              targetNamespace = "http://cxf.apache.org/service.wsdl/types")
                                    ReturnRequestType returnTrx);
    }
    @WebService(targetNamespace = "http://cxf.apache.org/service.wsdl")
    public static class CXF2766Impl implements CXF2766 {
        public ReturnResponseType doReturn(ReturnRequestType returnTrx) {
            return new ReturnResponseType();
        }
    }

    @XmlType(name = "ReturnRequestType", namespace = "http://cxf.apache.org/service.wsdl/types")
    public static class ReturnRequestType {
    }
    @XmlType(name = "ReturnResponseType", namespace = "http://cxf.apache.org/service.wsdl/types")
    public static class ReturnResponseType {
    }

}