Back to Repositories
Validating GlideType Extension Annotations in Bumptech Glide

This test suite validates the functionality of GlideType extensions in the Bumptech Glide annotation processor. It ensures proper implementation of annotated methods for type-specific request builders and verifies various constraints and requirements for GlideType annotations.
Test Coverage Overview

The test suite comprehensively covers GlideType extension validation scenarios.

Key areas tested include:
Static method requirements for GlideType annotations
Parameter validation for RequestBuilder objects
Return type verification for annotated methods
Method signature compliance
Annotation constraint enforcement
Implementation Analysis

The testing approach uses JUnit4 framework with comprehensive assertion validation.

Implementation focuses on:
Compilation testing using javac processor
Runtime exception verification
Static analysis of generated code
Annotation processing validation
Technical Details

Testing infrastructure includes:
JUnit4 test runner
Google Truth assertion library
Java compilation testing utilities
GlideAnnotationProcessor for annotation processing
JavaFileObjects for source code testing
Best Practices Demonstrated

The test suite exemplifies high-quality testing practices:
Thorough edge case coverage
Clear test method naming conventions
Systematic validation of failure scenarios
Comprehensive assertion messages
Proper test isolation and setup
bumptech/glide

annotation/compiler/test/src/test/java/com/bumptech/glide/annotation/compiler/InvalidGlideTypeExtensionTest.java
            
package com.bumptech.glide.annotation.compiler;

import static com.bumptech.glide.annotation.compiler.test.Util.emptyAppModule;
import static com.bumptech.glide.annotation.compiler.test.Util.subpackage;
import static com.google.testing.compile.CompilationSubject.assertThat;
import static com.google.testing.compile.Compiler.javac;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.fail;

import com.google.common.truth.Truth;
import com.google.testing.compile.Compilation;
import com.google.testing.compile.JavaFileObjects;
import org.junit.Test;
import org.junit.function.ThrowingRunnable;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/**
 * Checks assertions on {@link com.bumptech.glide.annotation.GlideExtension}s for methods annotated
 * with {@link com.bumptech.glide.annotation.GlideType}.
 */
// Ignore warnings since most methods use assertThrows.
@SuppressWarnings("ResultOfMethodCallIgnored")
@RunWith(JUnit4.class)
public class InvalidGlideTypeExtensionTest {
  @Test
  public void compilation_withAnnotatedNonStaticMethod_fails() {
    assertThrows(
        "@GlideType methods must be static",
        RuntimeException.class,
        new ThrowingRunnable() {
          @Override
          public void run() {
            javac()
                .withProcessors(new GlideAnnotationProcessor())
                .compile(
                    emptyAppModule(),
                    JavaFileObjects.forSourceLines(
                        "Extension",
                        "package com.bumptech.glide.test;",
                        "import androidx.annotation.NonNull;",
                        "import com.bumptech.glide.annotation.GlideExtension;",
                        "import com.bumptech.glide.annotation.GlideType;",
                        "@GlideExtension",
                        "public class Extension {",
                        "  private Extension() {}",
                        "  @NonNull",
                        "  @GlideType(Number.class)",
                        "  public RequestBuilder<Number> doSomething(",
                        "      RequestBuilder<Number> builder) {",
                        "    return builder;",
                        "  }",
                        "}"));
          }
        });
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_withoutRequestBuilderArg_fails() {
    assertThrows(
        "@GlideType methods must take a RequestBuilder object as their first and only"
            + " parameter, but given multiple for:"
            + " com.bumptech.glide.test.Extension#doSomething()",
        RuntimeException.class,
        new ThrowingRunnable() {
          @Override
          public void run() {
            javac()
                .withProcessors(new GlideAnnotationProcessor())
                .compile(
                    emptyAppModule(),
                    JavaFileObjects.forSourceLines(
                        "Extension",
                        "package com.bumptech.glide.test;",
                        "import com.bumptech.glide.annotation.GlideExtension;",
                        "import com.bumptech.glide.annotation.GlideType;",
                        "@GlideExtension",
                        "public class Extension {",
                        "  private Extension() {}",
                        "  @GlideType(Number.class)",
                        "  public static RequestBuilder<Number> doSomething() {",
                        "    return null;",
                        "  }",
                        "}"));
          }
        });
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_withRequestBuilderArg_succeeds() {
    Compilation compilation =
        javac()
            .withProcessors(new GlideAnnotationProcessor())
            .compile(
                emptyAppModule(),
                JavaFileObjects.forSourceLines(
                    "Extension",
                    "package com.bumptech.glide.test;",
                    "import androidx.annotation.NonNull;",
                    "import com.bumptech.glide.RequestBuilder;",
                    "import com.bumptech.glide.annotation.GlideExtension;",
                    "import com.bumptech.glide.annotation.GlideType;",
                    "@GlideExtension",
                    "public class Extension {",
                    "  private Extension() {}",
                    "  @NonNull",
                    "  @GlideType(Number.class)",
                    "  public static RequestBuilder<Number> type(RequestBuilder<Number> builder) {",
                    "    return builder;",
                    "  }",
                    "}"));
    assertThat(compilation).succeededWithoutWarnings();
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_withNonRequestBuilderArg_fails() {
    try {
      javac()
          .withProcessors(new GlideAnnotationProcessor())
          .compile(
              emptyAppModule(),
              JavaFileObjects.forSourceLines(
                  "WrongParameterTypeExtension",
                  "package com.bumptech.glide.test;",
                  "import androidx.annotation.NonNull;",
                  "import com.bumptech.glide.RequestBuilder;",
                  "import com.bumptech.glide.annotation.GlideExtension;",
                  "import com.bumptech.glide.annotation.GlideType;",
                  "@GlideExtension",
                  "public class WrongParameterTypeExtension {",
                  "  private WrongParameterTypeExtension() {}",
                  "  @NonNull",
                  "  @GlideType(Number.class)",
                  "  public static RequestBuilder<Number> type(Object arg) {",
                  "    return null;",
                  "  }",
                  "}"));
    } catch (RuntimeException e) {
      String message = e.getCause().getMessage();
      Truth.assertThat(message).contains("RequestBuilder object as their first and only parameter");
      Truth.assertThat(message).contains("Object");
      Truth.assertThat(message).contains("WrongParameterTypeExtension");
    }
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_withRequestBuilderArgAndOtherArg_fails() {
    assertThrows(
        "@GlideType methods must take a RequestBuilder object as their first and only"
            + " parameter, but given multiple for:"
            + " com.bumptech.glide.test.Extension#type("
            + "com.bumptech.glide.RequestBuilder<java.lang.Number>,"
            + "java.lang.Object)",
        RuntimeException.class,
        new ThrowingRunnable() {
          @Override
          public void run() {
            javac()
                .withProcessors(new GlideAnnotationProcessor())
                .compile(
                    emptyAppModule(),
                    JavaFileObjects.forSourceLines(
                        "Extension",
                        "package com.bumptech.glide.test;",
                        "import androidx.annotation.NonNull;",
                        "import com.bumptech.glide.RequestBuilder;",
                        "import com.bumptech.glide.annotation.GlideExtension;",
                        "import com.bumptech.glide.annotation.GlideType;",
                        "@GlideExtension",
                        "public class Extension {",
                        "  private Extension() {}",
                        "  @NonNull",
                        "  @GlideType(Number.class)",
                        "  public static RequestBuilder<Number> type(",
                        "      RequestBuilder<Number> builder, Object arg2) {",
                        "    return builder;",
                        "  }",
                        "}"));
          }
        });
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_overridingExistingType_fails() {
    final Compilation compilation =
        javac()
            .withProcessors(new GlideAnnotationProcessor())
            .compile(
                emptyAppModule(),
                JavaFileObjects.forSourceLines(
                    "Extension",
                    "package com.bumptech.glide.test;",
                    "import android.graphics.drawable.Drawable;",
                    "import androidx.annotation.NonNull;",
                    "import com.bumptech.glide.RequestBuilder;",
                    "import com.bumptech.glide.annotation.GlideExtension;",
                    "import com.bumptech.glide.annotation.GlideType;",
                    "@GlideExtension",
                    "public class Extension {",
                    "  private Extension() {}",
                    "  @NonNull",
                    "  @GlideType(Drawable.class)",
                    "  public static RequestBuilder<Drawable> asDrawable(",
                    "      RequestBuilder<Drawable> builder) {",
                    "    return builder;",
                    "  }",
                    "}"));

    assertThrows(
        "error: method asDrawable() is already defined in class"
            + " com.bumptech.glide.test.GlideRequests",
        RuntimeException.class,
        new ThrowingRunnable() {
          @Override
          public void run() {
            compilation.generatedSourceFile(subpackage("GlideRequests"));
          }
        });
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_returningRequestBuilder_succeeds() {
    Compilation compilation =
        javac()
            .withProcessors(new GlideAnnotationProcessor())
            .compile(
                emptyAppModule(),
                JavaFileObjects.forSourceLines(
                    "Extension",
                    "package com.bumptech.glide.test;",
                    "import androidx.annotation.NonNull;",
                    "import com.bumptech.glide.RequestBuilder;",
                    "import com.bumptech.glide.annotation.GlideExtension;",
                    "import com.bumptech.glide.annotation.GlideType;",
                    "@GlideExtension",
                    "public class Extension {",
                    "  private Extension() {}",
                    "  @NonNull",
                    "  @GlideType(Number.class)",
                    "  public static RequestBuilder<Number> asNumber(",
                    "      RequestBuilder<Number> builder) {",
                    "    return builder;",
                    "  }",
                    "}"));
    assertThat(compilation).succeededWithoutWarnings();
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_returningNonRequestBuilder_fails() {
    try {
      javac()
          .withProcessors(new GlideAnnotationProcessor())
          .compile(
              emptyAppModule(),
              JavaFileObjects.forSourceLines(
                  "WrongReturnTypeExtension",
                  "package com.bumptech.glide.test;",
                  "import androidx.annotation.NonNull;",
                  "import com.bumptech.glide.RequestBuilder;",
                  "import com.bumptech.glide.annotation.GlideExtension;",
                  "import com.bumptech.glide.annotation.GlideType;",
                  "@GlideExtension",
                  "public class WrongReturnTypeExtension {",
                  "  private WrongReturnTypeExtension() {}",
                  "  @NonNull",
                  "  @GlideType(Number.class)",
                  "  public static Object asNumber(",
                  "      RequestBuilder<Number> builder) {",
                  "    return new Object();",
                  "  }",
                  "}"));
      fail();
    } catch (RuntimeException e) {
      String message = e.getCause().getMessage();
      Truth.assertThat(message).contains("@GlideType methods should return a RequestBuilder");
      Truth.assertThat(message).contains("Number");
      Truth.assertThat(message).contains("WrongReturnTypeExtension");
    }
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_returningBuilderWithIncorrectType_fails() {
    try {
      javac()
          .withProcessors(new GlideAnnotationProcessor())
          .compile(
              emptyAppModule(),
              JavaFileObjects.forSourceLines(
                  "WrongBuilderTypeExtension",
                  "package com.bumptech.glide.test;",
                  "import androidx.annotation.NonNull;",
                  "import com.bumptech.glide.RequestBuilder;",
                  "import com.bumptech.glide.annotation.GlideExtension;",
                  "import com.bumptech.glide.annotation.GlideType;",
                  "@GlideExtension",
                  "public class WrongBuilderTypeExtension {",
                  "  private WrongBuilderTypeExtension() {}",
                  "  @NonNull",
                  "  @GlideType(Number.class)",
                  "  public static RequestBuilder<Object> asNumber(",
                  "      RequestBuilder<Object> builder) {",
                  "    return builder;",
                  "  }",
                  "}"));
      fail();
    } catch (RuntimeException e) {
      String message = e.getCause().getMessage();
      Truth.assertThat(message)
          .contains("@GlideType methods should return a RequestBuilder<java.lang.Number>");
      Truth.assertThat(message).contains("WrongBuilderTypeExtension");
    }
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_returningBuilder_andMultipleParams_fails() {
    assertThrows(
        "@GlideType methods must take a RequestBuilder object as their first and only parameter,"
            + " but given multiple for:"
            + " com.bumptech.glide.test.Extension#asNumber("
            + "com.bumptech.glide.RequestBuilder<java.lang.Number>,java.lang.Object)",
        RuntimeException.class,
        new ThrowingRunnable() {
          @Override
          public void run() {
            javac()
                .withProcessors(new GlideAnnotationProcessor())
                .compile(
                    emptyAppModule(),
                    JavaFileObjects.forSourceLines(
                        "Extension",
                        "package com.bumptech.glide.test;",
                        "import androidx.annotation.NonNull;",
                        "import com.bumptech.glide.RequestBuilder;",
                        "import com.bumptech.glide.annotation.GlideExtension;",
                        "import com.bumptech.glide.annotation.GlideType;",
                        "@GlideExtension",
                        "public class Extension {",
                        "  private Extension() {}",
                        "  @NonNull",
                        "  @GlideType(Number.class)",
                        "  public static RequestBuilder<Number> asNumber(",
                        "      RequestBuilder<Number> builder, Object arg1) {",
                        "    return builder;",
                        "  }",
                        "}"));
          }
        });
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_returningBuilder_nonBuilderParam_fails() {
    try {
      javac()
          .withProcessors(new GlideAnnotationProcessor())
          .compile(
              emptyAppModule(),
              JavaFileObjects.forSourceLines(
                  "IncorrectParameterExtension",
                  "package com.bumptech.glide.test;",
                  "import androidx.annotation.NonNull;",
                  "import com.bumptech.glide.RequestBuilder;",
                  "import com.bumptech.glide.annotation.GlideExtension;",
                  "import com.bumptech.glide.annotation.GlideType;",
                  "@GlideExtension",
                  "public class IncorrectParameterExtension {",
                  "  private IncorrectParameterExtension() {}",
                  "  @NonNull",
                  "  @GlideType(Number.class)",
                  "  public static RequestBuilder<Number> asNumber(",
                  "      Object arg) {",
                  "    return null;",
                  "  }",
                  "}"));
      fail();
    } catch (RuntimeException e) {
      String message = e.getCause().getMessage();
      Truth.assertThat(message)
          .contains(
              "@GlideType methods must take a RequestBuilder object"
                  + " as their first and only parameter");
      Truth.assertThat(message).contains("Object");
      Truth.assertThat(message).contains("IncorrectParameterExtension");
    }
  }

  @Test
  public void compilation_withAnnotatedStaticMethod_returningRequestBuilder_missingNonNull_warns() {
    Compilation compilation =
        javac()
            .withProcessors(new GlideAnnotationProcessor())
            .compile(
                emptyAppModule(),
                JavaFileObjects.forSourceLines(
                    "Extension",
                    "package com.bumptech.glide.test;",
                    "import com.bumptech.glide.RequestBuilder;",
                    "import com.bumptech.glide.annotation.GlideExtension;",
                    "import com.bumptech.glide.annotation.GlideType;",
                    "@GlideExtension",
                    "public class Extension {",
                    "  private Extension() {}",
                    "  @GlideType(Number.class)",
                    "  public static RequestBuilder<Number> asNumber(",
                    "      RequestBuilder<Number> builder) {",
                    "    return builder;",
                    "  }",
                    "}"));
    assertThat(compilation).succeeded();
    assertThat(compilation).hadWarningCount(1);
    assertThat(compilation).hadWarningContaining("androidx.annotation.NonNull");
    assertThat(compilation).hadWarningContaining("com.bumptech.glide.test.Extension#asNumber");
  }
}