add rest mapping such as GetMapping
This commit is contained in:
clevertension
parent
a2d2f410be
commit
423efc1e59
|
|
@ -8,3 +8,4 @@ target/
|
|||
.DS_Store
|
||||
*~
|
||||
packages/
|
||||
**/dependency-reduced-pom.xml
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
import org.skywalking.apm.agent.core.context.CarrierItem;
|
||||
import org.skywalking.apm.agent.core.context.ContextCarrier;
|
||||
import org.skywalking.apm.agent.core.context.ContextManager;
|
||||
|
|
@ -13,33 +10,30 @@ import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance
|
|||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
|
||||
import org.skywalking.apm.network.trace.component.ComponentsDefine;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.context.request.RequestContextHolder;
|
||||
import org.springframework.web.context.request.ServletRequestAttributes;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
/**
|
||||
* The <code>ControllerServiceMethodInterceptor</code> only use the first mapping value.
|
||||
* the abstract method inteceptor
|
||||
*/
|
||||
public class ControllerServiceMethodInterceptor implements InstanceMethodsAroundInterceptor {
|
||||
public abstract class AbstractMethodInteceptor implements InstanceMethodsAroundInterceptor {
|
||||
public abstract String getRequestURL(Method method);
|
||||
@Override
|
||||
public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes,
|
||||
MethodInterceptResult result) throws Throwable {
|
||||
PathMappingCache pathMappingCache = (PathMappingCache)objInst.getSkyWalkingDynamicField();
|
||||
String requestURL = pathMappingCache.findPathMapping(method);
|
||||
if (requestURL == null) {
|
||||
RequestMapping methodRequestMapping = method.getAnnotation(RequestMapping.class);
|
||||
if (methodRequestMapping.value().length > 0) {
|
||||
requestURL = methodRequestMapping.value()[0];
|
||||
} else if (methodRequestMapping.path().length > 0) {
|
||||
requestURL = methodRequestMapping.path()[0];
|
||||
} else {
|
||||
requestURL = "";
|
||||
}
|
||||
requestURL = getRequestURL(method);
|
||||
pathMappingCache.addPathMapping(method, requestURL);
|
||||
requestURL = pathMappingCache.findPathMapping(method);
|
||||
}
|
||||
|
||||
HttpServletRequest request = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
|
||||
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
|
||||
|
||||
ContextCarrier contextCarrier = new ContextCarrier();
|
||||
CarrierItem next = contextCarrier.items();
|
||||
|
|
@ -69,7 +63,8 @@ public class ControllerServiceMethodInterceptor implements InstanceMethodsAround
|
|||
return ret;
|
||||
}
|
||||
|
||||
@Override public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments,
|
||||
@Override
|
||||
public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments,
|
||||
Class<?>[] argumentsTypes, Throwable t) {
|
||||
ContextManager.activeSpan().errorOccurred().log(t);
|
||||
}
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
|
||||
/**
|
||||
* The <code>RequestMappingMethodInterceptor</code> only use the first mapping value.
|
||||
* it will inteceptor with <code>@RequestMapping</code>
|
||||
* @author clevertension
|
||||
*/
|
||||
public class RequestMappingMethodInterceptor extends AbstractMethodInteceptor {
|
||||
@Override
|
||||
public String getRequestURL(Method method) {
|
||||
String requestURL = "";
|
||||
RequestMapping methodRequestMapping = method.getAnnotation(RequestMapping.class);
|
||||
if (methodRequestMapping.value().length > 0) {
|
||||
requestURL = methodRequestMapping.value()[0];
|
||||
} else if (methodRequestMapping.path().length > 0) {
|
||||
requestURL = methodRequestMapping.path()[0];
|
||||
}
|
||||
return requestURL;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
|
||||
/**
|
||||
* The <code>RestMappingMethodInterceptor</code> only use the first mapping value.
|
||||
* it will inteceptor with
|
||||
* <code>@GetMapping</code>, <code>@PostMapping</code>, <code>@PutMapping</code>
|
||||
* <code>@DeleteMapping</code>, <code>@PatchMapping</code>
|
||||
* @author clevertension
|
||||
*/
|
||||
public class RestMappingMethodInterceptor extends AbstractMethodInteceptor {
|
||||
@Override
|
||||
public String getRequestURL(Method method) {
|
||||
String requestURL = "";
|
||||
GetMapping getMapping = method.getAnnotation(GetMapping.class);
|
||||
PostMapping postMapping = method.getAnnotation(PostMapping.class);
|
||||
PutMapping putMapping = method.getAnnotation(PutMapping.class);
|
||||
DeleteMapping deleteMapping = method.getAnnotation(DeleteMapping.class);
|
||||
PatchMapping patchMapping = method.getAnnotation(PatchMapping.class);
|
||||
if (getMapping != null) {
|
||||
if (getMapping.value().length > 0) {
|
||||
requestURL = getMapping.value()[0];
|
||||
} else if (getMapping.path().length > 0) {
|
||||
requestURL = getMapping.path()[0];
|
||||
}
|
||||
} else if (postMapping != null) {
|
||||
if (postMapping.value().length > 0) {
|
||||
requestURL = postMapping.value()[0];
|
||||
} else if (postMapping.path().length > 0) {
|
||||
requestURL = postMapping.path()[0];
|
||||
}
|
||||
} else if (putMapping != null) {
|
||||
if (putMapping.value().length > 0) {
|
||||
requestURL = putMapping.value()[0];
|
||||
} else if (putMapping.path().length > 0) {
|
||||
requestURL = putMapping.path()[0];
|
||||
}
|
||||
} else if (deleteMapping != null) {
|
||||
if (deleteMapping.value().length > 0) {
|
||||
requestURL = deleteMapping.value()[0];
|
||||
} else if (deleteMapping.path().length > 0) {
|
||||
requestURL = deleteMapping.path()[0];
|
||||
}
|
||||
} else if (patchMapping != null) {
|
||||
if (patchMapping.value().length > 0) {
|
||||
requestURL = patchMapping.value()[0];
|
||||
} else if (patchMapping.path().length > 0) {
|
||||
requestURL = patchMapping.path()[0];
|
||||
}
|
||||
}
|
||||
return requestURL;
|
||||
}
|
||||
}
|
||||
|
|
@ -20,8 +20,8 @@ import static org.skywalking.apm.agent.core.plugin.match.ClassAnnotationMatch.by
|
|||
* <code>org.skywalking.apm.plugin.spring.mvc.ControllerConstructorInterceptor</code> set the controller base path to
|
||||
* dynamic field before execute constructor.
|
||||
*
|
||||
* <code>org.skywalking.apm.plugin.spring.mvc.ControllerServiceMethodInterceptor</code> get the request path from
|
||||
* dynamic field first, if not found, <code>ControllerServiceMethodInterceptor</code> generate request path that
|
||||
* <code>org.skywalking.apm.plugin.spring.mvc.RequestMappingMethodInterceptor</code> get the request path from
|
||||
* dynamic field first, if not found, <code>RequestMappingMethodInterceptor</code> generate request path that
|
||||
* combine the path value of current annotation on current method and the base path and set the new path to the dynamic
|
||||
* filed
|
||||
*
|
||||
|
|
@ -56,7 +56,26 @@ public abstract class AbstractControllerInstrumentation extends ClassInstanceMet
|
|||
|
||||
@Override
|
||||
public String getMethodsInterceptor() {
|
||||
return "org.skywalking.apm.plugin.spring.mvc.ControllerServiceMethodInterceptor";
|
||||
return "org.skywalking.apm.plugin.spring.mvc.RequestMappingMethodInterceptor";
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isOverrideArgs() {
|
||||
return false;
|
||||
}
|
||||
},
|
||||
new InstanceMethodsInterceptPoint() {
|
||||
@Override
|
||||
public ElementMatcher<MethodDescription> getMethodsMatcher() {
|
||||
return isAnnotatedWith(named("org.springframework.web.bind.annotation.GetMapping"))
|
||||
.or(isAnnotatedWith(named("org.springframework.web.bind.annotation.PostMapping")))
|
||||
.or(isAnnotatedWith(named("org.springframework.web.bind.annotation.PutMapping")))
|
||||
.or(isAnnotatedWith(named("org.springframework.web.bind.annotation.DeleteMapping")))
|
||||
.or(isAnnotatedWith(named("org.springframework.web.bind.annotation.PatchMapping")));
|
||||
}
|
||||
@Override
|
||||
public String getMethodsInterceptor() {
|
||||
return "org.skywalking.apm.plugin.spring.mvc.RestMappingMethodInterceptor";
|
||||
}
|
||||
|
||||
@Override
|
||||
|
|
|
|||
|
|
@ -0,0 +1,107 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
import org.powermock.modules.junit4.PowerMockRunnerDelegate;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
|
||||
import org.skywalking.apm.agent.test.tools.TracingSegmentRunner;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PowerMockRunnerDelegate(TracingSegmentRunner.class)
|
||||
public class ControllerConstructorInterceptorTest {
|
||||
private ControllerConstructorInterceptor controllerConstructorInterceptor;
|
||||
private final MockEnhancedInstance1 inst1 = new MockEnhancedInstance1();
|
||||
private final MockEnhancedInstance2 inst2 = new MockEnhancedInstance2();
|
||||
private final MockEnhancedInstance3 inst3 = new MockEnhancedInstance3();
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
controllerConstructorInterceptor = new ControllerConstructorInterceptor();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testOnConstruct_Accuracy1() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(inst1, null);
|
||||
PathMappingCache cache = (PathMappingCache)inst1.getSkyWalkingDynamicField();
|
||||
Assert.assertNotNull(cache);
|
||||
|
||||
Object obj = new Object();
|
||||
Method m = obj.getClass().getMethods()[0];
|
||||
cache.addPathMapping(m, "#toString");
|
||||
|
||||
Assert.assertEquals("the two value should be equal", cache.findPathMapping(m), "/test1#toString");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testOnConstruct_Accuracy2() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(inst2, null);
|
||||
PathMappingCache cache = (PathMappingCache)inst2.getSkyWalkingDynamicField();
|
||||
Assert.assertNotNull(cache);
|
||||
|
||||
Object obj = new Object();
|
||||
Method m = obj.getClass().getMethods()[0];
|
||||
cache.addPathMapping(m, "#toString");
|
||||
|
||||
Assert.assertEquals("the two value should be equal", cache.findPathMapping(m), "#toString");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testOnConstruct_Accuracy3() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(inst3, null);
|
||||
PathMappingCache cache = (PathMappingCache)inst3.getSkyWalkingDynamicField();
|
||||
Assert.assertNotNull(cache);
|
||||
|
||||
Object obj = new Object();
|
||||
Method m = obj.getClass().getMethods()[0];
|
||||
cache.addPathMapping(m, "#toString");
|
||||
|
||||
Assert.assertEquals("the two value should be equal", cache.findPathMapping(m), "/test3#toString");
|
||||
}
|
||||
|
||||
@RequestMapping(value="/test1")
|
||||
private class MockEnhancedInstance1 implements EnhancedInstance {
|
||||
private Object value;
|
||||
@Override
|
||||
public Object getSkyWalkingDynamicField() {
|
||||
return value;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setSkyWalkingDynamicField(Object value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
|
||||
private class MockEnhancedInstance2 implements EnhancedInstance {
|
||||
private Object value;
|
||||
@Override
|
||||
public Object getSkyWalkingDynamicField() {
|
||||
return value;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setSkyWalkingDynamicField(Object value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
|
||||
@RequestMapping(path="/test3")
|
||||
private class MockEnhancedInstance3 implements EnhancedInstance {
|
||||
private Object value;
|
||||
@Override
|
||||
public Object getSkyWalkingDynamicField() {
|
||||
return value;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setSkyWalkingDynamicField(Object value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
import org.powermock.modules.junit4.PowerMockRunnerDelegate;
|
||||
import org.skywalking.apm.agent.test.tools.TracingSegmentRunner;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
import static org.powermock.api.mockito.PowerMockito.whenNew;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PowerMockRunnerDelegate(TracingSegmentRunner.class)
|
||||
public class PathMappingCacheTest {
|
||||
private PathMappingCache pathMappingCache;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
pathMappingCache = new PathMappingCache("org.skywalking.apm.plugin.spring.mvc");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testAddPathMapping1() throws Throwable {
|
||||
Object obj = new Object();
|
||||
Method m = obj.getClass().getMethods()[0];
|
||||
pathMappingCache.addPathMapping(m, "#toString");
|
||||
|
||||
Assert.assertEquals("the two value should be equal", pathMappingCache.findPathMapping(m), "org.skywalking.apm.plugin.spring.mvc#toString");
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.Mock;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
import org.powermock.modules.junit4.PowerMockRunnerDelegate;
|
||||
import org.skywalking.apm.agent.core.context.trace.*;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
|
||||
import org.skywalking.apm.agent.test.helper.SegmentHelper;
|
||||
import org.skywalking.apm.agent.test.helper.SegmentRefHelper;
|
||||
import org.skywalking.apm.agent.test.helper.SpanHelper;
|
||||
import org.skywalking.apm.agent.test.tools.AgentServiceRule;
|
||||
import org.skywalking.apm.agent.test.tools.SegmentStorage;
|
||||
import org.skywalking.apm.agent.test.tools.SegmentStoragePoint;
|
||||
import org.skywalking.apm.agent.test.tools.TracingSegmentRunner;
|
||||
import org.skywalking.apm.network.trace.component.ComponentsDefine;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.context.request.RequestContextHolder;
|
||||
import org.springframework.web.context.request.ServletRequestAttributes;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
import java.util.List;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.is;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
import static org.mockito.Mockito.when;
|
||||
import static org.skywalking.apm.agent.test.tools.SpanAssert.*;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PowerMockRunnerDelegate(TracingSegmentRunner.class)
|
||||
public class RequestMappingMethodInterceptorTest {
|
||||
private RequestMappingMethodInterceptor interceptor;
|
||||
|
||||
@SegmentStoragePoint
|
||||
private SegmentStorage segmentStorage;
|
||||
|
||||
@Rule
|
||||
public AgentServiceRule serviceRule = new AgentServiceRule();
|
||||
|
||||
private ServletRequestAttributes servletRequestAttributes;
|
||||
|
||||
@Mock
|
||||
private HttpServletRequest request;
|
||||
|
||||
@Mock
|
||||
private HttpServletResponse response;
|
||||
@Mock
|
||||
private MethodInterceptResult methodInterceptResult;
|
||||
|
||||
private Object[] arguments;
|
||||
private Class[] argumentType;
|
||||
|
||||
private EnhancedInstance enhancedInstance;
|
||||
|
||||
private ControllerConstructorInterceptor controllerConstructorInterceptor;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
interceptor = new RequestMappingMethodInterceptor();
|
||||
enhancedInstance = new MockEnhancedInstance1();
|
||||
controllerConstructorInterceptor = new ControllerConstructorInterceptor();
|
||||
servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
|
||||
when(request.getScheme()).thenReturn("http");
|
||||
when(request.getServerName()).thenReturn("localhost");
|
||||
when(request.getServerPort()).thenReturn(8080);
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/testRequestURL"));
|
||||
when(response.getStatus()).thenReturn(200);
|
||||
|
||||
arguments = new Object[] {request, response};
|
||||
argumentType = new Class[] {request.getClass(), response.getClass()};
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithoutSerializedContextData() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RequestMappingClass1 mappingClass1 = new RequestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("testRequestURL");
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithOccurException() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RequestMappingClass1 mappingClass1 = new RequestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("testRequestURL");
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.handleMethodException(enhancedInstance, m, arguments, argumentType, new RuntimeException());
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0));
|
||||
List<LogDataEntity> logDataEntities = SpanHelper.getLogs(spans.get(0));
|
||||
assertThat(logDataEntities.size(), is(1));
|
||||
assertException(logDataEntities.get(0), RuntimeException.class);
|
||||
}
|
||||
|
||||
private void assertTraceSegmentRef(TraceSegmentRef ref) {
|
||||
assertThat(SegmentRefHelper.getEntryApplicationInstanceId(ref), is(1));
|
||||
assertThat(SegmentRefHelper.getSpanId(ref), is(3));
|
||||
assertThat(SegmentRefHelper.getTraceSegmentId(ref).toString(), is("1.444.555"));
|
||||
}
|
||||
|
||||
private void assertHttpSpan(AbstractTracingSpan span) {
|
||||
assertThat(span.getOperationName(), is("/test/testRequestURL"));
|
||||
assertComponent(span, ComponentsDefine.SPRING_MVC_ANNOTATION);
|
||||
assertTag(span, 0, "http://localhost:8080/test/testRequestURL");
|
||||
assertThat(span.isEntry(), is(true));
|
||||
assertLayer(span, SpanLayer.HTTP);
|
||||
}
|
||||
|
||||
@RequestMapping(value = "/test")
|
||||
private class MockEnhancedInstance1 implements EnhancedInstance {
|
||||
private Object value;
|
||||
|
||||
@Override
|
||||
public Object getSkyWalkingDynamicField() {
|
||||
return value;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setSkyWalkingDynamicField(Object value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
|
||||
private class RequestMappingClass1 {
|
||||
@RequestMapping("/testRequestURL")
|
||||
public void testRequestURL() {
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,277 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.Mock;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
import org.powermock.modules.junit4.PowerMockRunnerDelegate;
|
||||
import org.skywalking.apm.agent.core.context.trace.*;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
|
||||
import org.skywalking.apm.agent.test.helper.SegmentHelper;
|
||||
import org.skywalking.apm.agent.test.helper.SegmentRefHelper;
|
||||
import org.skywalking.apm.agent.test.helper.SpanHelper;
|
||||
import org.skywalking.apm.agent.test.tools.AgentServiceRule;
|
||||
import org.skywalking.apm.agent.test.tools.SegmentStorage;
|
||||
import org.skywalking.apm.agent.test.tools.SegmentStoragePoint;
|
||||
import org.skywalking.apm.agent.test.tools.TracingSegmentRunner;
|
||||
import org.skywalking.apm.network.trace.component.ComponentsDefine;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
import org.springframework.web.context.request.RequestContextHolder;
|
||||
import org.springframework.web.context.request.ServletRequestAttributes;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
import java.lang.reflect.Method;
|
||||
import java.util.List;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.is;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
import static org.mockito.Mockito.when;
|
||||
import static org.skywalking.apm.agent.test.tools.SpanAssert.*;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PowerMockRunnerDelegate(TracingSegmentRunner.class)
|
||||
public class RestMappingMethodInterceptorTest {
|
||||
private RestMappingMethodInterceptor interceptor;
|
||||
|
||||
@SegmentStoragePoint
|
||||
private SegmentStorage segmentStorage;
|
||||
|
||||
@Rule
|
||||
public AgentServiceRule serviceRule = new AgentServiceRule();
|
||||
|
||||
@Mock
|
||||
private HttpServletRequest request;
|
||||
|
||||
@Mock
|
||||
private HttpServletResponse response;
|
||||
@Mock
|
||||
private MethodInterceptResult methodInterceptResult;
|
||||
|
||||
private Object[] arguments;
|
||||
private Class[] argumentType;
|
||||
|
||||
private EnhancedInstance enhancedInstance;
|
||||
|
||||
private ControllerConstructorInterceptor controllerConstructorInterceptor;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
interceptor = new RestMappingMethodInterceptor();
|
||||
enhancedInstance = new RestMappingMethodInterceptorTest.MockEnhancedInstance1();
|
||||
controllerConstructorInterceptor = new ControllerConstructorInterceptor();
|
||||
|
||||
when(request.getScheme()).thenReturn("http");
|
||||
when(request.getServerName()).thenReturn("localhost");
|
||||
when(request.getServerPort()).thenReturn(8080);
|
||||
when(response.getStatus()).thenReturn(200);
|
||||
|
||||
arguments = new Object[] {request, response};
|
||||
argumentType = new Class[] {request.getClass(), response.getClass()};
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetMapping() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("getRequestURL");
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/getRequestURL"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "/getRequestURL");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPostMapping() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("postRequestURL");
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/postRequestURL"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "/postRequestURL");
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testPutMapping() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("putRequestURL");
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/putRequestURL"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "/putRequestURL");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testDeleteMapping() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("deleteRequestURL");
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/deleteRequestURL"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "/deleteRequestURL");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPatchMapping() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("patchRequestURL");
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/patchRequestURL"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "/patchRequestURL");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testDummy() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("dummy");
|
||||
when(request.getRequestURI()).thenReturn("/test");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithOccurException() throws Throwable {
|
||||
controllerConstructorInterceptor.onConstruct(enhancedInstance, null);
|
||||
RestMappingClass1 mappingClass1 = new RestMappingClass1();
|
||||
Method m = mappingClass1.getClass().getMethod("getRequestURL");
|
||||
when(request.getRequestURI()).thenReturn("/test/testRequestURL");
|
||||
when(request.getRequestURL()).thenReturn(new StringBuffer("http://localhost:8080/test/getRequestURL"));
|
||||
ServletRequestAttributes servletRequestAttributes = new ServletRequestAttributes(request, response);
|
||||
RequestContextHolder.setRequestAttributes(servletRequestAttributes);
|
||||
|
||||
interceptor.beforeMethod(enhancedInstance, m, arguments, argumentType, methodInterceptResult);
|
||||
interceptor.handleMethodException(enhancedInstance, m, arguments, argumentType, new RuntimeException());
|
||||
interceptor.afterMethod(enhancedInstance, m, arguments, argumentType, null);
|
||||
|
||||
assertThat(segmentStorage.getTraceSegments().size(), is(1));
|
||||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0);
|
||||
List<AbstractTracingSpan> spans = SegmentHelper.getSpans(traceSegment);
|
||||
|
||||
assertHttpSpan(spans.get(0), "/getRequestURL");
|
||||
List<LogDataEntity> logDataEntities = SpanHelper.getLogs(spans.get(0));
|
||||
assertThat(logDataEntities.size(), is(1));
|
||||
assertException(logDataEntities.get(0), RuntimeException.class);
|
||||
}
|
||||
|
||||
private void assertTraceSegmentRef(TraceSegmentRef ref) {
|
||||
assertThat(SegmentRefHelper.getEntryApplicationInstanceId(ref), is(1));
|
||||
assertThat(SegmentRefHelper.getSpanId(ref), is(3));
|
||||
assertThat(SegmentRefHelper.getTraceSegmentId(ref).toString(), is("1.444.555"));
|
||||
}
|
||||
|
||||
private void assertHttpSpan(AbstractTracingSpan span, String suffix) {
|
||||
assertThat(span.getOperationName(), is("/test" + suffix));
|
||||
assertComponent(span, ComponentsDefine.SPRING_MVC_ANNOTATION);
|
||||
assertTag(span, 0, "http://localhost:8080/test" + suffix);
|
||||
assertThat(span.isEntry(), is(true));
|
||||
assertLayer(span, SpanLayer.HTTP);
|
||||
}
|
||||
|
||||
@RequestMapping(value = "/test")
|
||||
private class MockEnhancedInstance1 implements EnhancedInstance {
|
||||
private Object value;
|
||||
|
||||
@Override
|
||||
public Object getSkyWalkingDynamicField() {
|
||||
return value;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setSkyWalkingDynamicField(Object value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
|
||||
private class RestMappingClass1 {
|
||||
@GetMapping("/getRequestURL")
|
||||
public void getRequestURL() {
|
||||
|
||||
}
|
||||
@PostMapping("/postRequestURL")
|
||||
public void postRequestURL() {
|
||||
|
||||
}
|
||||
@PutMapping("/putRequestURL")
|
||||
public void putRequestURL() {
|
||||
|
||||
}
|
||||
@DeleteMapping("/deleteRequestURL")
|
||||
public void deleteRequestURL() {
|
||||
|
||||
}
|
||||
@PatchMapping("/patchRequestURL")
|
||||
public void patchRequestURL() {
|
||||
|
||||
}
|
||||
public void dummy() {
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc.define;
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
import org.powermock.modules.junit4.PowerMockRunnerDelegate;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
|
||||
import org.skywalking.apm.agent.test.tools.TracingSegmentRunner;
|
||||
|
||||
import net.bytebuddy.description.method.MethodDescription;
|
||||
import net.bytebuddy.matcher.ElementMatchers;
|
||||
|
||||
import static net.bytebuddy.matcher.ElementMatchers.isAnnotatedWith;
|
||||
import static net.bytebuddy.matcher.ElementMatchers.named;
|
||||
import static org.hamcrest.CoreMatchers.is;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PowerMockRunnerDelegate(TracingSegmentRunner.class)
|
||||
public class ControllerInstrumentationTest {
|
||||
private ControllerInstrumentation controllerInstrumentation;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
controllerInstrumentation = new ControllerInstrumentation();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetEnhanceAnnotations() throws Throwable {
|
||||
Assert.assertArrayEquals(new String[] {ControllerInstrumentation.ENHANCE_ANNOTATION},
|
||||
controllerInstrumentation.getEnhanceAnnotations());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetInstanceMethodsInterceptPoints() throws Throwable {
|
||||
InstanceMethodsInterceptPoint[] methodPoints = controllerInstrumentation.getInstanceMethodsInterceptPoints();
|
||||
assertThat(methodPoints.length, is(2));
|
||||
assertThat(methodPoints[0].getMethodsInterceptor(), is("org.skywalking.apm.plugin.spring.mvc.RequestMappingMethodInterceptor"));
|
||||
assertThat(methodPoints[1].getMethodsInterceptor(), is("org.skywalking.apm.plugin.spring.mvc.RestMappingMethodInterceptor"));
|
||||
|
||||
Assert.assertFalse(methodPoints[0].isOverrideArgs());
|
||||
Assert.assertFalse(methodPoints[1].isOverrideArgs());
|
||||
|
||||
Assert.assertNotNull(methodPoints[0].getMethodsMatcher());
|
||||
Assert.assertNotNull(methodPoints[1].getMethodsMatcher());
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetConstructorsInterceptPoints() throws Throwable {
|
||||
ConstructorInterceptPoint[] cips = controllerInstrumentation.getConstructorsInterceptPoints();
|
||||
Assert.assertEquals(cips.length, 1);
|
||||
ConstructorInterceptPoint cip = cips[0];
|
||||
Assert.assertNotNull(cip);
|
||||
|
||||
Assert.assertEquals(cip.getConstructorInterceptor(), "org.skywalking.apm.plugin.spring.mvc.ControllerConstructorInterceptor");
|
||||
Assert.assertTrue(cip.getConstructorMatcher().equals(ElementMatchers.any()));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
package org.skywalking.apm.plugin.spring.mvc.define;
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.powermock.modules.junit4.PowerMockRunner;
|
||||
import org.powermock.modules.junit4.PowerMockRunnerDelegate;
|
||||
import org.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
|
||||
import org.skywalking.apm.agent.test.tools.TracingSegmentRunner;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.is;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
|
||||
@RunWith(PowerMockRunner.class)
|
||||
@PowerMockRunnerDelegate(TracingSegmentRunner.class)
|
||||
public class RestControllerInstrumentationTest {
|
||||
private RestControllerInstrumentation restControllerInstrumentation;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
restControllerInstrumentation = new RestControllerInstrumentation();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetEnhanceAnnotations() throws Throwable {
|
||||
Assert.assertArrayEquals(new String[] {restControllerInstrumentation.ENHANCE_ANNOTATION},
|
||||
restControllerInstrumentation.getEnhanceAnnotations());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetInstanceMethodsInterceptPoints() throws Throwable {
|
||||
InstanceMethodsInterceptPoint[] methodPoints = restControllerInstrumentation.getInstanceMethodsInterceptPoints();
|
||||
assertThat(methodPoints.length, is(2));
|
||||
assertThat(methodPoints[0].getMethodsInterceptor(), is("org.skywalking.apm.plugin.spring.mvc.RequestMappingMethodInterceptor"));
|
||||
assertThat(methodPoints[1].getMethodsInterceptor(), is("org.skywalking.apm.plugin.spring.mvc.RestMappingMethodInterceptor"));
|
||||
|
||||
Assert.assertFalse(methodPoints[0].isOverrideArgs());
|
||||
Assert.assertFalse(methodPoints[1].isOverrideArgs());
|
||||
|
||||
Assert.assertNotNull(methodPoints[0].getMethodsMatcher());
|
||||
Assert.assertNotNull(methodPoints[1].getMethodsMatcher());
|
||||
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue