Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myconsciousness/reflection-test-helper
The Reflection Test Helper is easy to use; all you need to be aware of when using it is the class in which the method to be reflected is defined, and the name and arguments of the method to be invoked in the reflection.
https://github.com/myconsciousness/reflection-test-helper
gradle helper java reflection test util
Last synced: 2 days ago
JSON representation
The Reflection Test Helper is easy to use; all you need to be aware of when using it is the class in which the method to be reflected is defined, and the name and arguments of the method to be invoked in the reflection.
- Host: GitHub
- URL: https://github.com/myconsciousness/reflection-test-helper
- Owner: myConsciousness
- License: apache-2.0
- Created: 2021-03-03T10:03:32.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-14T13:49:17.000Z (almost 4 years ago)
- Last Synced: 2024-10-19T09:19:49.524Z (3 months ago)
- Topics: gradle, helper, java, reflection, test, util
- Language: Java
- Homepage: https://myconsciousness.github.io/reflection-test-helper/
- Size: 329 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Reflection Test Helper
**Table of Contents**
- [What is it?](#what-is-it)
- [How To Use](#how-to-use)
- [1. Add the dependencies](#1-add-the-dependencies)
- [2. Import `Reflection Test Helper`](#2-import-reflection-test-helper)
- [3. Create new instance of `ReflectionTestHelper`](#3-create-new-instance-of-reflectiontesthelper)
- [4. Invoke method](#4-invoke-method)
- [5. Invoke method with the argument](#5-invoke-method-with-the-argument)
- [6. Invoke method with the field value](#6-invoke-method-with-the-field-value)
- [7. If you want to get the value of a specific field in the SUT](#7-if-you-want-to-get-the-value-of-a-specific-field-in-the-sut)
- [License](#license)
- [More Information](#more-information)
## What is it?
The `Reflection Test Helper` was designed and implemented to provide a simple and cool way to write reflections, which are verbose and relatively difficult to implement. This feature is especially useful when testing a specific class with limited access features such as private access modifiers.
The `Reflection Test Helper` is easy to use; all you need to be aware of when using it is the class in which the method to be reflected is defined, and the name and arguments of the method to be invoked in the reflection.
> **_Note:_**
> In the description that follows, you will see the keyword `SUT`, which is an abbreviation for `System Under Test` and represents the object to be tested.
## How To Use
### 1. Add the dependencies
> **_Note:_**
> Replace version you want to use. Check the latest [Packages](https://github.com/myConsciousness/reflection-test-helper/packages).
> Please contact me for a token to download the package.
**_Maven_**
```xml
org.thinkit.test.util
reflection-test-helper
v1.0.5
github
myConsciousness
xxxxxxxxxxxxxxxxxx
```
**_Gradle_**
```gradle
repositories {
maven {
name = "GitHubPackages"
url = uri("https://maven.pkg.github.com/myConsciousness/reflection-test-helper")
credentials {
username = "myConsciousness"
password = "xxxxxxxxxxxxxxxxxx"
}
}
}
dependencies {
implementation 'org.thinkit.test.util:reflection-test-helper:v1.0.5'
}
```
### 2. Import `Reflection Test Helper`
```java
import org.thinkit.test.util.ReflectionTestHelper;
```
### 3. Create new instance of `ReflectionTestHelper`
```java
// If the ConcreteClass is SUT, and the method returns the string
final ReflectionTestHelper reflectionTestHelper = ReflectionTestHelper.from(ConcreteClass.class);
```
> **_Note:_**
> The static constructor of the ReflectionTestHelper class, the from method, should be passed the class object of the class in which the method to be invoked by reflection is defined as an argument.
> Also, the ReflectionTestHelper generic should specify the type of SUT and the type of return value of the method to be called in reflection.
### 4. Invoke method
By executing the invoke method with the name of the method to be called in reflection as an argument, the specified method can be executed in reflection.
If you need to specify arguments for the method to be called by reflection, you can use [this way](#5-invoke-method-with-the-argument) to specify the arguments.
Or if the processing of the method depends on the value of the class field, you can use [this way](#6-invoke-method-with-the-field-value) to specify the arguments.
```java
// Specify the name of the method to be invoked as an argument
final String result = reflectionTestHelper.invokeMethod("methodName");
```
### 5. Invoke method with the argument
By calling the `addArgument` method with **_the first argument as the argument type_** and **_the second argument as the argument value_**, you can specify the arguments required to invoke the target method to be invoked by reflection.
```java
// Set the arguments required for method execution
reflectionTestHelper.addArgument(String.class, "firstArgument");
reflectionTestHelper.addArgument(Integer.class, 1000);
// Specify the name of the method to be invoked
final String result = reflectionTestHelper.invokeMethod("methodName");
```
### 6. Invoke method with the field value
By calling the `setFieldValue` method with **_the first argument as the field name_** and **_the second argument as the field value_**, you can specify the field required to invoke the process of target method to be invoked by reflection.
```java
// Set the field value required for method process
reflectionTestHelper.setFieldValue("testField1", "something...");
reflectionTestHelper.setFieldValue("testField2", 1000);
// Specify the name of the method to be invoked
final String result = reflectionTestHelper.invokeMethod("methodName");
```
### 7. If you want to get the value of a specific field in the SUT
The `ReflectionTestHelper` also provides the feature to return the specific field value from the SUT.
```java
// Specify the name of the field
final String fieldValue = (String) reflectionTestHelper.getFieldValue("fieldName");
```
## License
```license
Copyright 2021 Kato Shinya.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License.
```
## More Information
`Reflection Test Helper` was designed and implemented by Kato Shinya, who works as a freelance developer.
Regardless of the means or content of communication, I would love to hear from you if you have any questions or concerns. I do not check my email box very often so a response may be delayed, anyway thank you for your interest!
- [Creator Profile](https://github.com/myConsciousness)
- [Creator Website](https://myconsciousness.github.io/)
- [License](https://github.com/myConsciousness/reflection-test-helper/blob/master/LICENSE)
- [Release Note](https://github.com/myConsciousness/reflection-test-helper/releases)
- [Package](https://github.com/myConsciousness/reflection-test-helper/packages)
- [File a Bug](https://github.com/myConsciousness/reflection-test-helper/issues)
- [Guide](https://myconsciousness.github.io/reflection-test-helper/)
- [Reference](https://myconsciousness.github.io/reflection-test-helper/reference/org/thinkit/test/util/package-summary.html)