Skip to content

Commit 3a96f42

Browse files
authored
Dev (#2)
* remove unused code and update readme file
1 parent 0d2bbad commit 3a96f42

File tree

8 files changed

+325
-67
lines changed

8 files changed

+325
-67
lines changed

LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

README.md

Lines changed: 107 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,107 @@
1-
- arex-agent: agent start
2-
- arex-agent-bootstrap:Loaded by BootStrapClassLoader, including core classes such as agent initialization and Context transfer
3-
- agent-agent-core: Instrumentation install
4-
- arex-instrumentation-foudation:arex framework,context、api
5-
- arex-instrumentation:Instrumentation plugins
6-
- arex-client: Command line tool, which can be replay locally
7-
- arex-storage-extension: Storage service for recording, replay and difference data
8-
9-
## Manual setup with -javaagent flag
10-
11-
### setup-generic
12-
13-
-javaagent:/path/to/arex-agent-0.0.1.jar -Darex.service.name=your-service-name -Darex.storage.service.host=10.3.2.42:8093 -Darex.config.service.host=10.3.2.42:8091
14-
15-
### setup-local
16-
-javaagent:/path/to/arex-agent-0.0.1.jar -Darex.service.name=your-service-name -Darex.storage.mode=local
17-
18-
### set arex.agent.conf
19-
20-
-javaagent:/path/to/arex-agent-0.0.1.jar -Darex.config.path=/path/to/arex.agent.conf
21-
22-
> arex.agent.conf
23-
24-
arex.service.name=spring-petclinc
25-
arex.storage.service.host=10.3.2.42:8093
26-
arex.config.service.host=10.3.2.42:8091
1+
# <img src="https://avatars.githubusercontent.com/u/103105168?s=200&v=4" alt="Arex Icon" width="27" height=""> AREX
2+
3+
##### An Open Source Testing Framework with Real World Data
4+
5+
6+
* [Introduction](#introduction)
7+
* [Installation](#installation)
8+
* [Getting Started](#getting-started)
9+
* [Contributing](#contributing)
10+
* [License](#license)
11+
12+
## Introduction
13+
14+
As your application evolves more complex, the effort required to thoroughly test against it also becomes tremendous. Arex is a framework designed around a quite straightforward principle of leveraging your real world data(i.e. database record, service payload, cache items etc.) for regression testing. Simple is powerful. The idea behind makes it incredibly powerful.
15+
16+
Arex provides an out-of-box agent file that could be attached to any applications with Java 8+ and dynamically weaves solid bytecode into your existing code to record the real data of live traffic, and further use and replay it for mocking, testing, and debugging purpose.
17+
18+
Arex is implemented with an unique mechanism for recording. Instead of being a proxy like other similar framework, `Arex` sits in the background without awareness of your application to record realistic data in live traffic which means that no intrusive code changes are required when integrating it to your existing application.
19+
20+
Arex utilizes the advanced Java technique, Instrument API, and is capable of instrumenting various libraries and frameworks which are widely used.
21+
22+
**Libraries and frameworks supported by Arex (to be added...)**
23+
- Java Executors
24+
- Apache HttpAsyncClient 4.x
25+
- Apache HttpClient 4.x
26+
- Hibernate 5.x
27+
- MyBatis 3.x
28+
- Spring Boot 1.4+-2.x+, Servlet API 3+
29+
30+
## Installation
31+
32+
Simply download the latest binary from [github]( https://github.com/arextest/releases) or compile it by yourself.\
33+
There are two agent files provided in the `arex-agent-jar` folder like below. They must be placed in the same directory.
34+
35+
```
36+
arex-agent-<version>.jar
37+
arex-agent-bootstrap-<version>.jar
38+
```
39+
40+
## Getting Started
41+
42+
You can get arex started by:
43+
44+
***Enable the instrumentation agent by configuring a `javaagent` flag to the JVM to run arex in local mode:***
45+
46+
```
47+
java -javaagent:/path/to/arex-agent-<version>.jar
48+
-Darex.service.name=your-service-name (should be unique)
49+
-Darex.storge.model=local
50+
-jar your-application.jar
51+
```
52+
53+
By default, Arex uses [H2](https://www.h2database.com) as a local storage to save the recorded data for testing purpose.
54+
55+
***Run with CLI***
56+
57+
Simply click the [script]("http://www.google.com") in the `arex-agent-java/bin` directory to start the command line tool, or run it by following `java` command
58+
59+
```
60+
java -cp "/path/to/arex-client/target/arex-client-<version>-jar-with-dependencies.jar" io.arex.cli.ArexCli
61+
```
62+
The supported commands are as follows:
63+
- **replay**- replay recorded data and view differences
64+
`[option: -n/--num]` replay numbers, default the latest 10 \
65+
`[option: -r/--replayId]` replay id, multiple are separated by spaces
66+
- **debug**- local debugging of specific cases
67+
`[option: -r/--recordId]` record id, required Option
68+
69+
***Run with entire AREX solution, refer to [arex-dev-ops](https://github.com/arextest/dev-ops/wiki):***
70+
71+
AREX agent works along with the [AREX config service](https://github.com/arextest/arex-config) and the [AREX storage service](https://github.com/arextest/arex-storage).
72+
You could just configure the host and port of them respectively, like below
73+
74+
```
75+
java -javaagent:/path/to/arex-agent-<version>.jar
76+
-Darex.service.name=your-service-name
77+
-Darex.storage.service.host=[storage.service.host:port](storage.service.host:port)
78+
-Darex.config.service.host=[config.service.host:port](config.service.host:port)
79+
-jar your-application.jar
80+
```
81+
82+
Alternatively, you can put those configuration item in `arex.agent.conf` file, like below
83+
84+
```
85+
arex.service.name=your-service-name
86+
arex.storage.service.host=<storage.service.host:port>
87+
arex.config.service.host=<config.service.host:port>
88+
```
89+
90+
Then simply run:
91+
92+
```
93+
java -javaagent:/path/to/arex-agent-<version>.jar
94+
-Darex.config.path=/path/to/arex.agent.conf
95+
```
96+
97+
98+
## Contributing
99+
100+
1. Fork it
101+
2. Create your feature branch
102+
3. Commit your code changes and push to your feature branch
103+
4. Create a new Pull Request
104+
105+
106+
## License
107+
- Code: [Apache-2.0](https://github.com/arextest/arex-agent-java/blob/LICENSE)
Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package io.arex.foundation.api;
22

33
import net.bytebuddy.description.method.MethodDescription;
4-
import net.bytebuddy.description.type.TypeDescription;
54
import net.bytebuddy.matcher.ElementMatcher;
65

76
public class MethodInstrumentation {
@@ -15,11 +14,7 @@ public MethodInstrumentation(ElementMatcher<? super MethodDescription> matcher,
1514
}
1615

1716
public MethodInstrumentation(ElementMatcher<? super MethodDescription> matcher, String adviceClassName, boolean isInterceptor) {
18-
if (adviceClassName.contains("StartAdvice")) {
19-
this.matcher = new ElementMatcherWrapper<>(matcher);
20-
} else {
21-
this.matcher = matcher;
22-
}
17+
this.matcher = matcher;
2318
this.adviceClassName = adviceClassName;
2419
this.isInterceptor = isInterceptor;
2520
}
@@ -35,24 +30,4 @@ public String getAdviceClassName() {
3530
public boolean isInterceptor() {
3631
return this.isInterceptor;
3732
}
38-
39-
public static class ElementMatcherWrapper<T extends MethodDescription> implements ElementMatcher<T> {
40-
41-
private ElementMatcher<? super MethodDescription> delegate;
42-
43-
public ElementMatcherWrapper(ElementMatcher<? super MethodDescription> matcher) {
44-
delegate = matcher;
45-
}
46-
47-
@Override
48-
public boolean matches(T t) {
49-
boolean m = delegate.matches(t);
50-
if (!m) {
51-
System.out.println("arex:" + t.toGenericString());
52-
} else {
53-
System.out.println("arex method matched." + t.toGenericString());
54-
}
55-
return m;
56-
}
57-
}
5833
}

arex-instrumentation-foundation/src/main/java/io/arex/foundation/context/SequenceProvider.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ public class SequenceProvider {
77
static final int OFFSET_BASIS = 0x811C9DC5;
88
static final int FNV_PRIME = 16777619;
99

10+
public static final SequenceProvider DEFAULT = new SequenceProvider();
11+
1012
private final ConcurrentHashMap<Integer, AtomicInteger> sequence = new ConcurrentHashMap<>(10);
1113

1214
public int get(String target) {

0 commit comments

Comments
 (0)