Skip to content

Commit 69899af

Browse files
Siman-hubSiman-hub
authored
[Test] Add Spring Cloud Gateway 4.3.3 to gateway scenario (#787)
* test(gateway-4.3.x): add scenario coverage for 4.3.x * test(plugin): install bash in agent-test-jvm image and add gateway 4.3.x scenario
1 parent 2a61027 commit 69899af

22 files changed

Lines changed: 847 additions & 2 deletions

File tree

‎changes/changes-9.5.0.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Release Notes.
2020
* Fix the `CreateAopProxyInterceptor` in the Spring core-patch changes the AOP proxy type when a class is
2121
enhanced by both SkyWalking and Spring AOP.
2222
* Build: Centralized plugin version management in the root POM and remove redundant declarations.
23+
* Support Spring Cloud Gateway 4.3.x.
2324

2425
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/236?closed=1)
2526

‎docs/en/setup/service-agent/java-agent/Supported-list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ metrics based on the tracing data.
4242
* [Hutool-http](https://www.hutool.cn/) client 5.x
4343
* [Micronaut HTTP Client](https://github.com/micronaut-projects/micronaut-core) 3.2.x -> 3.6.x
4444
* HTTP Gateway
45-
* [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway) 2.0.2.RELEASE -> 4.1.x (Optional²)
45+
* [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway) 2.0.2.RELEASE -> 4.3.x (Optional²)
4646
* [Apache ShenYu](https://shenyu.apache.org) (Rich protocol support: `HTTP`,`Spring Cloud`,`gRPC`,`Dubbo`,`SOFARPC`,`Motan`,`Tars`) 2.4.x (Optional²)
4747
* JDBC
4848
* Mysql Driver 5.x, 6.x, 8.x

‎test/plugin/containers/jvm-container/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
<run>chmod +x /usr/local/skywalking/run.sh</run>
5454
<run>tar -xvf ../tools/skywalking-mock-collector.tar.gz -C ../tools</run>
5555
<run>apt-get update -y</run>
56-
<run>apt-get install -y unzip</run>
56+
<run>apt-get install -y unzip bash</run>
5757
<run>rm -rf /var/lib/apt/lists/*</run>
5858
</runCmds>
5959
<cmd>["/usr/local/skywalking/run.sh"]</cmd>

‎test/plugin/run.sh‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ remove_dir() {
159159
start_stamp=`date +%s`
160160
parse_commandline "$@"
161161

162+
echo "Scenario=$scenario_name JavaImage=$base_image_java TomcatImage=$base_image_tomcat"
163+
162164
if [[ "$cleanup" == "on" ]]; then
163165
do_cleanup
164166
[[ -z "${scenario_name}" ]] && exit 0

‎test/plugin/scenarios/gateway-4.3.x-scenario/config/expectedData.yaml‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
ignoreSegmentNames:
18+
- HEAD:/provider/b/healthCheck
19+
- /provider/b/healthCheck
20+
21+
segmentItems:
22+
- serviceName: gateway-projectB-scenario
23+
segmentSize: nq 0
24+
segments:
25+
- segmentId: not null
26+
spans:
27+
- operationName: GET:/provider/b/testcase
28+
parentSpanId: -1
29+
spanId: 0
30+
spanLayer: Http
31+
startTime: nq 0
32+
endTime: nq 0
33+
componentId: nq 0
34+
isError: false
35+
spanType: Entry
36+
peer: ''
37+
tags:
38+
- {key: url, value: not null}
39+
- {key: http.method, value: GET}
40+
- {key: http.status_code, value: '200'}
41+
refs:
42+
- {parentEndpoint: SpringCloudGateway/GatewayFilter, networkAddress: not null,
43+
refType: CrossProcess, parentSpanId: 2, parentTraceSegmentId: not null, parentServiceInstance: not
44+
null, parentService: not null, traceId: not null}
45+
skipAnalysis: 'false'
46+
47+
- serviceName: gateway-projectA-scenario
48+
segmentSize: nq 0
49+
segments:
50+
# --------------------------------------------------------
51+
# Case 1: Timeout Error
52+
# --------------------------------------------------------
53+
# A. Entry Span
54+
- segmentId: not null
55+
spans:
56+
- operationName: /provider/timeout/error
57+
parentSpanId: -1
58+
spanId: 0
59+
spanLayer: Http
60+
startTime: nq 0
61+
endTime: nq 0
62+
componentId: nq 0
63+
isError: true
64+
spanType: Entry
65+
peer: ''
66+
tags:
67+
- {key: url, value: not null }
68+
- {key: http.method, value: GET}
69+
- {key: http.status_code, value: '500'}
70+
skipAnalysis: 'false'
71+
72+
# B. Exit Span (Contains Logs)
73+
- segmentId: not null
74+
spans:
75+
- operationName: SpringCloudGateway/sendRequest
76+
parentSpanId: 1
77+
spanId: 2
78+
spanLayer: Http
79+
startTime: nq 0
80+
endTime: nq 0
81+
componentId: nq 0
82+
isError: true
83+
spanType: Exit
84+
peer: not null
85+
skipAnalysis: 'false'
86+
tags:
87+
- { key: url, value: not null }
88+
logs:
89+
- logEvent:
90+
- { key: event, value: error }
91+
- { key: error.kind, value: not null }
92+
- { key: message, value: not null }
93+
- { key: stack, value: not null}
94+
- operationName: SpringCloudGateway/RoutingFilter
95+
parentSpanId: 0
96+
spanId: 1
97+
startTime: nq 0
98+
endTime: nq 0
99+
componentId: nq 0
100+
isError: false
101+
spanType: Local
102+
peer: ''
103+
skipAnalysis: 'false'
104+
refs:
105+
- { parentEndpoint: '/provider/timeout/error', networkAddress: '', refType: CrossThread,
106+
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
107+
null, parentService: not null, traceId: not null }
108+
- operationName: SpringCloudGateway/GatewayFilter
109+
parentSpanId: -1
110+
spanId: 0
111+
startTime: nq 0
112+
endTime: nq 0
113+
componentId: nq 0
114+
isError: false
115+
spanType: Local
116+
peer: ''
117+
skipAnalysis: 'false'
118+
refs:
119+
- { parentEndpoint: '/provider/timeout/error', networkAddress: '', refType: CrossThread,
120+
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
121+
null, parentService: not null, traceId: not null }
122+
123+
# --------------------------------------------------------
124+
# Case 2: Success Case
125+
# --------------------------------------------------------
126+
# A. Entry Span
127+
- segmentId: not null
128+
spans:
129+
- operationName: /provider/b/testcase
130+
parentSpanId: -1
131+
spanId: 0
132+
spanLayer: Http
133+
startTime: nq 0
134+
endTime: nq 0
135+
componentId: nq 0
136+
isError: false
137+
spanType: Entry
138+
peer: ''
139+
tags:
140+
- { key: url, value: not null }
141+
- { key: http.method, value: GET }
142+
- { key: http.status_code, value: '200' }
143+
skipAnalysis: 'false'
144+
145+
# B. Exit Span
146+
- segmentId: not null
147+
spans:
148+
- operationName: SpringCloudGateway/sendRequest
149+
parentSpanId: 1
150+
spanId: 2
151+
spanLayer: Http
152+
startTime: nq 0
153+
endTime: nq 0
154+
componentId: nq 0
155+
isError: false
156+
spanType: Exit
157+
peer: not null
158+
tags:
159+
- {key: url, value: not null}
160+
- {key: http.status_code, value: '200'}
161+
skipAnalysis: 'false'
162+
- operationName: SpringCloudGateway/RoutingFilter
163+
parentSpanId: 0
164+
spanId: 1
165+
startTime: nq 0
166+
endTime: nq 0
167+
componentId: nq 0
168+
isError: false
169+
spanType: Local
170+
peer: ''
171+
skipAnalysis: 'false'
172+
refs:
173+
- {parentEndpoint: '/provider/b/testcase', networkAddress: '', refType: CrossThread,
174+
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
175+
null, parentService: not null, traceId: not null}
176+
- operationName: SpringCloudGateway/GatewayFilter
177+
parentSpanId: -1
178+
spanId: 0
179+
startTime: nq 0
180+
endTime: nq 0
181+
componentId: nq 0
182+
isError: false
183+
spanType: Local
184+
peer: ''
185+
skipAnalysis: 'false'
186+
refs:
187+
- {parentEndpoint: '/provider/b/testcase', networkAddress: '', refType: CrossThread,
188+
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
189+
null, parentService: not null, traceId: not null}

‎test/plugin/scenarios/gateway-4.3.x-scenario/configuration.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
type: jvm
18+
entryService: http://localhost:8080/provider/b/testcase
19+
healthCheck: http://localhost:8080/provider/b/healthCheck
20+
startScript: ./bin/startup.sh
21+
runningMode: with_optional
22+
withPlugins: apm-spring-cloud-gateway-4.x-plugin-*.jar
23+

‎test/plugin/scenarios/gateway-4.3.x-scenario/gateway-dist/bin/startup.sh‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#!/bin/bash
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS,
15+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
# See the License for the specific language governing permissions and
17+
# limitations under the License.
18+
19+
home="$(cd "$(dirname $0)"; pwd)"
20+
21+
java -jar ${agent_opts} "-Dskywalking.agent.service_name=gateway-projectA-scenario" ${home}/../libs/gateway-projectA-scenario.jar &
22+
sleep 1
23+
24+
java -jar ${agent_opts} "-Dskywalking.agent.service_name=gateway-projectB-scenario" ${home}/../libs/gateway-projectB-scenario.jar &

‎test/plugin/scenarios/gateway-4.3.x-scenario/gateway-dist/pom.xml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed to the Apache Software Foundation (ASF) under one or more
4+
~ contributor license agreements. See the NOTICE file distributed with
5+
~ this work for additional information regarding copyright ownership.
6+
~ The ASF licenses this file to You under the Apache License, Version 2.0
7+
~ (the "License"); you may not use this file except in compliance with
8+
~ the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing, software
13+
~ distributed under the License is distributed on an "AS IS" BASIS,
14+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
~ See the License for the specific language governing permissions and
16+
~ limitations under the License.
17+
~
18+
-->
19+
<project xmlns="http://maven.apache.org/POM/4.0.0"
20+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
22+
<parent>
23+
<groupId>org.apache.skywalking</groupId>
24+
<artifactId>gateway-4.3.x-scenario</artifactId>
25+
<version>5.0.0</version>
26+
</parent>
27+
<modelVersion>4.0.0</modelVersion>
28+
29+
<artifactId>gateway-dist</artifactId>
30+
31+
<build>
32+
<finalName>gateway-4.3.x-scenario</finalName>
33+
<plugins>
34+
<plugin>
35+
<groupId>org.apache.maven.plugins</groupId>
36+
<artifactId>maven-assembly-plugin</artifactId>
37+
<executions>
38+
<execution>
39+
<id>assemble</id>
40+
<phase>package</phase>
41+
<goals>
42+
<goal>single</goal>
43+
</goals>
44+
<configuration>
45+
<finalName>gateway-4.3.x-scenario</finalName>
46+
<appendAssemblyId>false</appendAssemblyId>
47+
<descriptors>
48+
<descriptor>src/main/assembly/assembly.xml</descriptor>
49+
</descriptors>
50+
<outputDirectory>../target/</outputDirectory>
51+
</configuration>
52+
</execution>
53+
</executions>
54+
</plugin>
55+
</plugins>
56+
</build>
57+
</project>

‎test/plugin/scenarios/gateway-4.3.x-scenario/gateway-dist/src/main/assembly/assembly.xml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed to the Apache Software Foundation (ASF) under one or more
4+
~ contributor license agreements. See the NOTICE file distributed with
5+
~ this work for additional information regarding copyright ownership.
6+
~ The ASF licenses this file to You under the Apache License, Version 2.0
7+
~ (the "License"); you may not use this file except in compliance with
8+
~ the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing, software
13+
~ distributed under the License is distributed on an "AS IS" BASIS,
14+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
~ See the License for the specific language governing permissions and
16+
~ limitations under the License.
17+
~
18+
-->
19+
<assembly
20+
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
21+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
22+
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
23+
<id>gateway-dist</id>
24+
<formats>
25+
<format>zip</format>
26+
</formats>
27+
28+
<fileSets>
29+
<fileSet>
30+
<directory>./bin</directory>
31+
<fileMode>0775</fileMode>
32+
</fileSet>
33+
</fileSets>
34+
35+
<files>
36+
<file>
37+
<source>../gateway-projectA-scenario/target/gateway-projectA-scenario.jar</source>
38+
<outputDirectory>./libs</outputDirectory>
39+
<fileMode>0775</fileMode>
40+
</file>
41+
<file>
42+
<source>../gateway-projectB-scenario/target/gateway-projectB-scenario.jar</source>
43+
<outputDirectory>./libs</outputDirectory>
44+
<fileMode>0775</fileMode>
45+
</file>
46+
</files>
47+
</assembly>

0 commit comments

Comments
 (0)