Skip to content

Commit

Permalink
Meta annotate TestResource (#7)
Browse files Browse the repository at this point in the history
Enables automatic registration of the extension without having to use `@ExtendWith` yourself on each class.
[minor]
  • Loading branch information
goughy000 authored Dec 3, 2023
1 parent 3e3c8aa commit efda27b
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 62 deletions.
45 changes: 19 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,31 @@ Easily inject file based resources into your jupiter tests

## Coordinates

Maven POM

```xml
<dependency>
<groupId>com.testingsyndicate</groupId>
<artifactId>jupiter-resources-extension</artifactId>
<version>x.y.z</version>
<scope>test</scope>
</dependency>
```
See [Releases](https://github.com/testingsyndicate/jupiter-resources-extension/releases) for the latest maven/gradle
coordinates and version

Gradle
## Enabling the extension

```groovy
testImplementation 'com.testingsyndicate:jupiter-resources-extension:x.y.z'
```
If you are using at least junit v5.8 then you don't need to do anything to enable the extension, you can
jump straight to [Injecting resources](#injecting-resources)

## Enabling the extension
<details>
<summary>I'm using junit &lt; v5.8</summary>

You can enable the extension on a per-test class basis using the `@ExtendWith` annotation to register
the `ResourcesExtension` like so:
You can enable the extension on a per-test class basis using the `@ExtendWith` annotation to register
the `ResourcesExtension` like so:

```java
@ExtendWith(ResourcesExtension.class)
class MyTests {
// ...
}
```
```java
@ExtendWith(ResourcesExtension.class)
class MyTests {
// ...
}
```

Alternatively the extension also advertises itself for automatic registration, providing you have enabled
it via setting the property `junit.jupiter.extensions.autodetection.enabled` to `true`. How you do this
will differ depending on your build tool.
Alternatively the extension also advertises itself for automatic registration, providing you have enabled
it via setting the property `junit.jupiter.extensions.autodetection.enabled` to `true`. How you do this
will differ depending on your build tool.
</details>

## Injecting resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;

/** Specifies the options for injecting a resource into a test parameter. */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
@ExtendWith(ResourcesExtension.class)
public @interface TestResource {
/** Name of the file of the resource to be injected */
String value();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
import java.nio.charset.UnsupportedCharsetException;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.extension.ParameterResolutionException;

@ExtendWith(ResourcesExtension.class)
class ResourcesExtensionIntegrationTest {

@Nested
Expand Down Expand Up @@ -108,7 +106,6 @@ void invalidCharset() {
.hasCauseInstanceOf(UnsupportedCharsetException.class);
}

@ExtendWith(ResourcesExtension.class)
static class TestStubs {

@TestKitTest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import com.testingsyndicate.jupiter.extensions.resources.resolver.ArchiveResolver.JarFileResolver;
import java.nio.charset.StandardCharsets;
import java.util.jar.JarFile;
import java.util.zip.ZipFile;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class ArchiveResolverTest {

@Nested
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import com.testingsyndicate.jupiter.extensions.resources.resolver.ByteArrayResolver.BoxedByteArrayResolver;
import com.testingsyndicate.jupiter.extensions.resources.resolver.ByteArrayResolver.ByteArrayInputStreamResolver;
Expand All @@ -12,12 +11,10 @@
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

class ByteArrayResolverTest {

@Nested
@ExtendWith(ResourcesExtension.class)
class PrimitiveByteArrayResolverTest extends AbstractResolverTest {
private static final PrimitiveByteArrayResolver SUT = new PrimitiveByteArrayResolver();

Expand All @@ -38,7 +35,6 @@ void throwsWithCharset() {
}

@Nested
@ExtendWith(ResourcesExtension.class)
class BoxedByteArrayResolverTest extends AbstractResolverTest {
private static final BoxedByteArrayResolver SUT = new BoxedByteArrayResolver();

Expand All @@ -60,7 +56,6 @@ void throwsWithCharset() {
}

@Nested
@ExtendWith(ResourcesExtension.class)
class ByteArrayInputStreamResolverTest extends AbstractResolverTest {
private static final ByteArrayInputStreamResolver SUT = new ByteArrayInputStreamResolver();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,13 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

class CharArrayResolverTest {

@Nested
@ExtendWith(ResourcesExtension.class)
class PrimitiveCharArrayResolverTest extends AbstractResolverTest {
@Test
void returnsCharArray(@TestResource("wibble.txt") char[] actual) {
Expand All @@ -28,7 +25,6 @@ void returnsCharArrayWithCharset(
}

@Nested
@ExtendWith(ResourcesExtension.class)
class BoxedCharArrayResolverTest extends AbstractResolverTest {
@Test
void returnsCharArray(@TestResource("wibble.txt") Character[] actual) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.io.File;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class FileResolverTest extends AbstractResolverTest {
private static final FileResolver SUT = new FileResolver();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class InputStreamResolverTest extends AbstractResolverTest {
private static final InputStreamResolver SUT = new InputStreamResolver();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class PathResolverTest extends AbstractResolverTest {
private static final PathResolver SUT = new PathResolver();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.util.Scanner;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class ScannerResolverTest extends AbstractResolverTest {

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.io.StringReader;
import java.util.Scanner;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class StringResolverTest {

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class URIResolverTest extends AbstractResolverTest {
private static final URIResolver SUT = new URIResolver();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.catchThrowable;

import com.testingsyndicate.jupiter.extensions.resources.ResourcesExtension;
import com.testingsyndicate.jupiter.extensions.resources.TestResource;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(ResourcesExtension.class)
class URLResolverTest extends AbstractResolverTest {
private static final URLResolver SUT = new URLResolver();

Expand Down

0 comments on commit efda27b

Please sign in to comment.