Want to test an extension with KeycloakTestcontainer but missing resources. What am I doing wrong?

[carstenSpraener]

Dear Keycloakers.

I'm trying to test a little extension with the keycloak test container. I'm using gradle as a build system. I added the provider classes to the container with:

.withProviderClassesFrom("java/main")

The container starts, but the extension is not loaded. I'm using gradle as built system.

So I derived the class ExtendableKeycloakContainer and added a method to set the resource directory also. Now it works. But may I missed something and there is an easier way. Here is my XKeycloakContainer:

public class XKeycloakContainer extends ExtendableKeycloakContainer<XKeycloakContainer> {
    private String extensionResourceFolder = null;

    public XKeycloakContainer() {
        super();
    }

    public XKeycloakContainer(String dockerImageName) {
        super(dockerImageName);
    }

    public XKeycloakContainer withExtensionResourceFolder(String extensionResourceFolder) {
        this.extensionResourceFolder = extensionResourceFolder;
        return (XKeycloakContainer)self();
    }

    @Override
    protected void createKeycloakExtensionDeployment(String deploymentLocation, String extensionName, String extensionClassFolder) {
        requireNonNull(deploymentLocation, "deploymentLocation must not be null");
        requireNonNull(extensionName, "extensionName must not be null");
        requireNonNull(extensionClassFolder, "extensionClassFolder must not be null");
        requireNonNull(extensionResourceFolder, "extensionResourceFolder must not be null");

        String classesLocation = resolveExtensionClassLocation(extensionClassFolder);
        if (new File(classesLocation).exists()) {
            final File file;
            try {
                file = Files.createTempFile("keycloak", ".jar").toFile();
                file.setReadable(true, false);
                file.deleteOnExit();
                ShrinkWrap.create(JavaArchive.class, extensionName)
                        .as(ExplodedImporter.class)
                        .importDirectory(classesLocation)
                        .importDirectory(this.extensionResourceFolder)
                        .as(ZipExporter.class)
                        .exportTo(file, true);
                withCopyFileToContainer(MountableFile.forHostPath(file.getAbsolutePath()), deploymentLocation + "/" + extensionName);
            } catch (IOException e) {
                throw new UncheckedIOException(e);
            }
        }
    }
}

In the Test i can now write:

    @Container
    private XKeycloakContainer keycloak = new XKeycloakContainer()
            .withProviderClassesFrom("java/main")
            .withExtensionResourceFolder("build/resources/main")
            ;

[dasniko]

Hi,
unfortunately I don't have any experience with Gradle.
But perhaps #112 and #115 (comment) might help you!?

[carstenSpraener]

OK. Thank you for the response (and for the KeycloakTestcontainer!). As i see in #112 you have no option to test the behaviour with gradle. Would it be an option to give the problem back to the user by supporting a list of "ImporterContentModifiers"? I changed my implementation to this:

public class XKeycloakContainer extends ExtendableKeycloakContainer<XKeycloakContainer> {
    private List<Consumer<ExplodedImporter>> importerModifierList = null;
...

    @Override
    protected void configure() {
        super.configure();
        if( this.importerModifierList!=null && !this.importerModifierList.isEmpty() ) {
            createKeycloakExtensionDeployment(
                           DEFAULT_KEYCLOAK_PROVIDERS_LOCATION, 
                           DEFAULT_KEYCLOAK_PROVIDERS_NAME
            );
        }
    }

    public XKeycloakContainer withJarContentModifier(Consumer<ExplodedImporter> importerModifier) {
        if( importerModifierList==null ) {
            this.importerModifierList = new ArrayList<>();
        }
        this.importerModifierList.add(importerModifier);
        return self();
    }
...
    @Override
    protected void createKeycloakExtensionDeployment(String deploymentLocation, String extensionName) {
        requireNonNull(deploymentLocation, "deploymentLocation must not be null");
        requireNonNull(extensionName, "extensionName must not be null");

        if (importerModifierList!=null && !importerModifierList.isEmpty()) {
            final File file;
            try {
                file = Files.createTempFile("keycloak", ".jar").toFile();
                file.setReadable(true, false);
                file.deleteOnExit();
                ExplodedImporter importer = ShrinkWrap.create(JavaArchive.class, extensionName)
                        .as(ExplodedImporter.class)
                        ;
                if( this.importerModifierList != null ) {
                    for (Consumer<ExplodedImporter> explodedImporterConsumer : this.importerModifierList) {
                        explodedImporterConsumer.accept(importer);
                    }
                }
                importer
                        .as(ZipExporter.class)
                        .exportTo(file, true);
                withCopyFileToContainer(MountableFile.forHostPath(file.getAbsolutePath()), deploymentLocation + "/" + extensionName);
            } catch (IOException e) {
                throw new UncheckedIOException(e);
            }
        }
    }
}

With this approach you should be able to write some test cases and a gradle user can do:

    @Container
    private XKeycloakContainer keycloak = new XKeycloakContainer()
            .withJarContentModifier(i -> i.importDirectory(resolveExtensionClassLocation("java/main")))
            .withJarContentModifier(i -> i.importDirectory("build/resources/main"))
            ;

[cprouveu]

Hello,
With maven, I tried to test our custom provider (and I can reach it), for import I use :

.withProviderClassesFrom("target/classes");

Maybe it can help.

[carstenSpraener]

Thank you for your tip. Under maven there is no problem. The Problem is with gradle. Gradle stores the resources in a second directory, and this directory is not copied into the container. For gradle there are two options:

1: Extend the KeycloakTestcontainer, so it can handle more than one directory for the provider jar (As shown above)

2: Use the @autoservice annotation from googles auto-service utility package. This compiler annotation handler will genereate the service-file into the classes directory.

I took option one. This was a piece of cake.