Renaming annotations (and fixed javadoc) to align with current MP ann…

…otations.
helidon-io · Aug 30, 2024 · 3491e58 · 3491e58
1 parent d391909
commit 3491e58
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 17 deletions.
diff --git a/testing/testing/src/main/java/io/helidon/testing/ConfigRegistrySupport.java b/testing/testing/src/main/java/io/helidon/testing/ConfigRegistrySupport.java
@@ -104,13 +104,13 @@ private static void sourceMethods(ServiceRegistryConfig.Builder serviceRegistryC
     }
 
     private static void values(ServiceRegistryConfig.Builder serviceRegistryConfig, Class<?> testClass) {
-        TestConfig.Values annotation = testClass.getAnnotation(TestConfig.Values.class);
+        TestConfig.Block annotation = testClass.getAnnotation(TestConfig.Block.class);
         if (annotation == null) {
             return;
         }
-        var mediaType = MediaTypes.detectExtensionType(annotation.format());
+        var mediaType = MediaTypes.detectExtensionType(annotation.type());
         if (mediaType.isEmpty()) {
-            throw new TestException("No extension media type found for extension " + annotation.format() + ", for "
+            throw new TestException("No extension media type found for extension " + annotation.type() + ", for "
                                             + "annotation " + annotation.annotationType().getName());
         }
         var source = ConfigSources.create(annotation.value(), mediaType.get());

diff --git a/testing/testing/src/main/java/io/helidon/testing/SetUpUtil.java b/testing/testing/src/main/java/io/helidon/testing/SetUpUtil.java
@@ -27,7 +27,7 @@ private SetUpUtil() {
     }
 
     static List<TestConfig.File> file(Class<?> testClass) {
-        TestConfig.ConfigFiles annotation = testClass.getAnnotation(TestConfig.ConfigFiles.class);
+        TestConfig.Files annotation = testClass.getAnnotation(TestConfig.Files.class);
         if (annotation == null) {
             TestConfig.File file = testClass.getAnnotation(TestConfig.File.class);
             if (file == null) {
@@ -39,7 +39,7 @@ static List<TestConfig.File> file(Class<?> testClass) {
     }
 
     static List<TestConfig.Value> value(Class<?> testClass) {
-        TestConfig.ConfigValues annotation = testClass.getAnnotation(TestConfig.ConfigValues.class);
+        TestConfig.Values annotation = testClass.getAnnotation(TestConfig.Values.class);
         if (annotation == null) {
             TestConfig.Value value = testClass.getAnnotation(TestConfig.Value.class);
             if (value == null) {

diff --git a/testing/testing/src/main/java/io/helidon/testing/TestConfig.java b/testing/testing/src/main/java/io/helidon/testing/TestConfig.java
@@ -99,7 +99,7 @@ static void register(TestConfigSource source) {
      */
     @Retention(RetentionPolicy.RUNTIME)
     @Target(ElementType.TYPE)
-    @Repeatable(ConfigValues.class)
+    @Repeatable(Values.class)
     public @interface Value {
         /**
          * Key of the added configuration option.
@@ -128,7 +128,7 @@ static void register(TestConfigSource source) {
      */
     @Retention(RetentionPolicy.RUNTIME)
     @Target(ElementType.TYPE)
-    public @interface ConfigValues {
+    public @interface Values {
         /**
          * Config values.
          *
@@ -138,24 +138,25 @@ static void register(TestConfigSource source) {
     }
 
     /**
-     * Custom configuration key/value pairs.
+     * Defines the configuration as a String in {@link #value()} for the
+     * given {@link #type()}.
      */
     @Retention(RetentionPolicy.RUNTIME)
     @Target(ElementType.TYPE)
-    public @interface Values {
+    public @interface Block {
         /**
-         * Key of the added configuration option.
+         * Text block with configuration data.
          *
-         * @return key
+         * @return configuration data
          */
         String value();
 
         /**
-         * Format of the value (file suffix).
+         * Type of the value (file suffix).
          *
-         * @return format to use, defaults to {@code properties}
+         * @return type to use, defaults to {@code properties}
          */
-        String format() default "properties";
+        String type() default "properties";
 
         /**
          * Weight of this configuration option.
@@ -170,7 +171,7 @@ static void register(TestConfigSource source) {
      */
     @Retention(RetentionPolicy.RUNTIME)
     @Target(ElementType.TYPE)
-    @Repeatable(ConfigFiles.class)
+    @Repeatable(Files.class)
     public @interface File {
         /**
          * File path, relative to the module (either classpath, or file system path).
@@ -192,7 +193,7 @@ static void register(TestConfigSource source) {
      */
     @Retention(RetentionPolicy.RUNTIME)
     @Target(ElementType.TYPE)
-    public @interface ConfigFiles {
+    public @interface Files {
         /**
          * Config values.
          *

diff --git a/testing/tests/junit5/src/test/java/io/helidon/testing/tests/junit5/Junit5Test.java b/testing/tests/junit5/src/test/java/io/helidon/testing/tests/junit5/Junit5Test.java
@@ -37,7 +37,7 @@
  */
 @TestConfig.Value(key = "test.first", value = "first")
 @TestConfig.Value(key = "test.second", value = "second")
-@TestConfig.Values("""
+@TestConfig.Block("""
         test.first=wrong
         test.third=third
         test.fourth=fourth