Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add page supplier, including support for multi-typed suppliers #31313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stianst merged 1 commit into from
Jul 16, 2024
Merged

Add page supplier, including support for multi-typed suppliers #31313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions test-poc/base/src/test/java/org/keycloak/test/base/PagesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package org.keycloak.test.base;

import org.junit.jupiter.api.Test;
import org.keycloak.test.framework.KeycloakIntegrationTest;
import org.keycloak.test.framework.page.LoginPage;
import org.keycloak.test.framework.page.TestPage;
import org.keycloak.test.framework.page.WelcomePage;

@KeycloakIntegrationTest
public class PagesTest {

@TestPage
WelcomePage welcomePage;

@TestPage
LoginPage loginPage;

@Test
public void testLoginFromWelcome() {
welcomePage.navigateTo();
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
Comment on lines +21 to +25
Copy link
Contributor

@jonkoops jonkoops Jul 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this debugger stuff

Suggested change
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}

loginPage.fillLogin("admin", "admin");
loginPage.submit();
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
Comment on lines +28 to +32
Copy link
Contributor

@jonkoops jonkoops Jul 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}

}

}
3 changes: 2 additions & 1 deletion ...ramework/src/main/java/org/keycloak/test/framework/admin/KeycloakAdminClientSupplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import org.keycloak.test.framework.injection.InstanceWrapper;
import org.keycloak.test.framework.injection.LifeCycle;
import org.keycloak.test.framework.injection.Registry;
import org.keycloak.test.framework.injection.RequestedInstance;
import org.keycloak.test.framework.injection.Supplier;
import org.keycloak.test.framework.server.KeycloakTestServer;

Expand Down Expand Up @@ -33,7 +34,7 @@ public InstanceWrapper<Keycloak, TestAdminClient> getValue(Registry registry, Te
}

@Override
public boolean compatible(InstanceWrapper<Keycloak, TestAdminClient> a, InstanceWrapper<Keycloak, TestAdminClient> b) {
public boolean compatible(InstanceWrapper<Keycloak, TestAdminClient> a, RequestedInstance<Keycloak, TestAdminClient> b) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion ...ramework/src/main/java/org/keycloak/test/framework/database/AbstractDatabaseSupplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import org.keycloak.test.framework.injection.InstanceWrapper;
import org.keycloak.test.framework.injection.LifeCycle;
import org.keycloak.test.framework.injection.Registry;
import org.keycloak.test.framework.injection.RequestedInstance;
import org.keycloak.test.framework.injection.Supplier;

public abstract class AbstractDatabaseSupplier implements Supplier<TestDatabase, KeycloakTestDatabase> {
Expand All @@ -26,7 +27,7 @@ public InstanceWrapper<TestDatabase, KeycloakTestDatabase> getValue(Registry reg
}

@Override
public boolean compatible(InstanceWrapper<TestDatabase, KeycloakTestDatabase> a, InstanceWrapper<TestDatabase, KeycloakTestDatabase> b) {
public boolean compatible(InstanceWrapper<TestDatabase, KeycloakTestDatabase> a, RequestedInstance<TestDatabase, KeycloakTestDatabase> b) {
return true;
}

Expand Down
49 changes: 25 additions & 24 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/injection/Registry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public class Registry {
private ExtensionContext currentContext;
private final List<Supplier<?, ?>> suppliers = new LinkedList<>();
private final List<InstanceWrapper<?, ?>> deployedInstances = new LinkedList<>();
private final List<InstanceWrapper<?, ?>> requestedInstances = new LinkedList<>();
private final List<RequestedInstance<?, ?>> requestedInstances = new LinkedList<>();

public Registry() {
loadSuppliers();
Expand Down Expand Up @@ -52,9 +52,9 @@ public <T> T getDependency(Class<T> typeClass, InstanceWrapper dependent) {
return (T) dependency.getValue();
}

dependency = getRequestedInstance(typeClass);
if (dependency != null) {
dependency = dependency.getSupplier().getValue(this, dependency.getAnnotation());
RequestedInstance requestedDependency = getRequestedInstance(typeClass);
if (requestedDependency != null) {
dependency = requestedDependency.getSupplier().getValue(this, requestedDependency.getAnnotation(), typeClass);
dependency.registerDependency(dependent);
deployedInstances.add(dependency);

Expand All @@ -69,8 +69,8 @@ public <T> T getDependency(Class<T> typeClass, InstanceWrapper dependent) {

Optional<Supplier<?, ?>> supplied = suppliers.stream().filter(s -> s.getValueType().equals(typeClass)).findFirst();
if (supplied.isPresent()) {
Supplier<?, ?> supplier = supplied.get();
dependency = supplier.getValue(this, null);
Supplier<T, ?> supplier = (Supplier<T, ?>) supplied.get();
dependency = supplier.getValue(this, null, typeClass);
deployedInstances.add(dependency);

if (LOGGER.isTraceEnabled()) {
Expand All @@ -87,13 +87,13 @@ public <T> T getDependency(Class<T> typeClass, InstanceWrapper dependent) {

public void beforeEach(Object testInstance) {
Class testClass = testInstance.getClass();
InstanceWrapper requestedServerInstance = createInstanceWrapper(testClass.getAnnotations());
RequestedInstance requestedServerInstance = createRequestedInstance(testClass.getAnnotations(), null);
requestedInstances.add(requestedServerInstance);

for (Field f : testClass.getDeclaredFields()) {
InstanceWrapper instanceWrapper = createInstanceWrapper(f.getAnnotations());
if (instanceWrapper != null) {
requestedInstances.add(instanceWrapper);
RequestedInstance requestedInstance = createRequestedInstance(f.getAnnotations(), f.getType());
if (requestedInstance != null) {
requestedInstances.add(requestedInstance);
}
}

Expand All @@ -102,10 +102,10 @@ public void beforeEach(Object testInstance) {
requestedInstances.stream().map(r -> r.getSupplier().getClass().getSimpleName()).collect(Collectors.joining(", ")));
}

Iterator<InstanceWrapper<?, ?>> itr = requestedInstances.iterator();
Iterator<RequestedInstance<?, ?>> itr = requestedInstances.iterator();
while (itr.hasNext()) {
InstanceWrapper<?, ?> requestedInstance = itr.next();
InstanceWrapper deployedInstance = getDeployedInstance(requestedInstance.getSupplier());
RequestedInstance<?, ?> requestedInstance = itr.next();
InstanceWrapper deployedInstance = getDeployedInstance(requestedInstance);
if (deployedInstance != null) {
if (deployedInstance.getSupplier().compatible(deployedInstance, requestedInstance)) {
if (LOGGER.isTraceEnabled()) {
Expand All @@ -127,9 +127,9 @@ public void beforeEach(Object testInstance) {

itr = requestedInstances.iterator();
while (itr.hasNext()) {
InstanceWrapper requestedInstance = itr.next();
RequestedInstance requestedInstance = itr.next();

InstanceWrapper instance = requestedInstance.getSupplier().getValue(this, requestedInstance.getAnnotation());
InstanceWrapper instance = requestedInstance.getSupplier().getValue(this, requestedInstance.getAnnotation(), requestedInstance.getValueType());

if (LOGGER.isTraceEnabled()) {
LOGGER.tracev("Created instance: {0}",
Expand All @@ -142,7 +142,7 @@ public void beforeEach(Object testInstance) {
}

for (Field f : testInstance.getClass().getDeclaredFields()) {
InstanceWrapper<?, ?> instance = getDeployedInstance(f.getAnnotations());
InstanceWrapper<?, ?> instance = getDeployedInstance(f.getType(), f.getAnnotations());
try {
f.setAccessible(true);
f.set(testInstance, instance.getValue());
Expand Down Expand Up @@ -170,21 +170,22 @@ public void onShutdown() {
destroy.forEach(this::destroy);
}

private InstanceWrapper<?, ?> createInstanceWrapper(Annotation[] annotations) {
private RequestedInstance<?, ?> createRequestedInstance(Annotation[] annotations, Class<?> valueType) {
for (Annotation a : annotations) {
for (Supplier s : suppliers) {
if (s.getAnnotationClass().equals(a.annotationType())) {
return new InstanceWrapper(s, a);
return new RequestedInstance(s, a, valueType);
}
}
}
return null;
}

private InstanceWrapper<?, ?> getDeployedInstance(Annotation[] annotations) {
private InstanceWrapper<?, ?> getDeployedInstance(Class<?> valueType, Annotation[] annotations) {
for (Annotation a : annotations) {
for (InstanceWrapper<?, ?> i : deployedInstances) {
if (i.getSupplier().getAnnotationClass().equals(a.annotationType())) {
Supplier<?, ?> supplier = i.getSupplier();
if (supplier.getAnnotationClass().equals(a.annotationType()) && valueType.isAssignableFrom(i.getValue().getClass())) {
return i;
}
}
Expand All @@ -197,7 +198,7 @@ private void destroy(InstanceWrapper instanceWrapper) {
if (removed) {
Set<InstanceWrapper> dependencies = instanceWrapper.getDependencies();
dependencies.forEach(this::destroy);
instanceWrapper.getSupplier().close(instanceWrapper.getValue());
instanceWrapper.getSupplier().close(instanceWrapper);

if (LOGGER.isTraceEnabled()) {
LOGGER.tracev("Closed instance: {0}",
Expand All @@ -206,8 +207,8 @@ private void destroy(InstanceWrapper instanceWrapper) {
}
}

private InstanceWrapper getDeployedInstance(Supplier supplier) {
return deployedInstances.stream().filter(i -> i.getSupplier().equals(supplier)).findFirst().orElse(null);
private InstanceWrapper getDeployedInstance(RequestedInstance requestedInstance) {
return deployedInstances.stream().filter(i -> i.getValue().equals(requestedInstance.getValueType())).findFirst().orElse(null);
}

private void loadSuppliers() {
Expand Down Expand Up @@ -260,7 +261,7 @@ private InstanceWrapper getDeployedInstance(Class typeClass) {
return deployedInstances.stream().filter(i -> i.getSupplier().getValueType().equals(typeClass)).findFirst().orElse(null);
}

private InstanceWrapper getRequestedInstance(Class typeClass) {
private RequestedInstance getRequestedInstance(Class typeClass) {
return requestedInstances.stream().filter(i -> i.getSupplier().getValueType().equals(typeClass)).findFirst().orElse(null);
}

Expand Down
28 changes: 28 additions & 0 deletions ...-poc/framework/src/main/java/org/keycloak/test/framework/injection/RequestedInstance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package org.keycloak.test.framework.injection;

import java.lang.annotation.Annotation;

public class RequestedInstance<T, A extends Annotation> {

private final Supplier<T, A> supplier;
private final A annotation;
private final Class<? extends T> valueType;

public RequestedInstance(Supplier<T, A> supplier, A annotation, Class<? extends T> valueType) {
this.supplier = supplier;
this.annotation = annotation;
this.valueType = valueType;
}

public Supplier<T, A> getSupplier() {
return supplier;
}

public A getAnnotation() {
return annotation;
}

public Class<? extends T> getValueType() {
return valueType;
}
}
13 changes: 11 additions & 2 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/injection/Supplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,18 @@ public interface Supplier<T, S extends Annotation> {

InstanceWrapper<T, S> getValue(Registry registry, S annotation);

boolean compatible(InstanceWrapper<T, S> a, InstanceWrapper<T, S> b);
default InstanceWrapper<T, S> getValue(Registry registry, S annotation, Class<? extends T> valueType) {
return getValue(registry, annotation);
}

boolean compatible(InstanceWrapper<T, S> a, RequestedInstance<T, S> b);

default void close(T instance) {}
default void close(T value) {
}

default void close(InstanceWrapper<T, S> instanceWrapper) {
close(instanceWrapper.getValue());
}

default String getAlias() {
return getClass().getSimpleName();
Expand Down
15 changes: 15 additions & 0 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/page/AbstractPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package org.keycloak.test.framework.page;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.support.PageFactory;

public class AbstractPage {

protected final WebDriver driver;

public AbstractPage(WebDriver driver) {
this.driver = driver;
PageFactory.initElements(driver, this);
}

}
31 changes: 31 additions & 0 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/page/LoginPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package org.keycloak.test.framework.page;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;

public class LoginPage extends AbstractPage {

@FindBy(id = "username")
private WebElement usernameInput;

@FindBy(id = "password")
private WebElement passwordInput;

@FindBy(css = "[type=submit]")
private WebElement submitButton;

public LoginPage(WebDriver driver) {
super(driver);
}

public void fillLogin(String username, String password) {
usernameInput.sendKeys(username);
passwordInput.sendKeys(password);
}

public void submit() {
submitButton.click();
}

}
50 changes: 50 additions & 0 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/page/PageSupplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
package org.keycloak.test.framework.page;

import org.keycloak.test.framework.injection.InstanceWrapper;
import org.keycloak.test.framework.injection.LifeCycle;
import org.keycloak.test.framework.injection.Registry;
import org.keycloak.test.framework.injection.RequestedInstance;
import org.keycloak.test.framework.injection.Supplier;
import org.openqa.selenium.WebDriver;

import java.lang.reflect.Constructor;

public class PageSupplier implements Supplier<AbstractPage, TestPage> {

@Override
public Class<TestPage> getAnnotationClass() {
return TestPage.class;
}

@Override
public Class<AbstractPage> getValueType() {
return AbstractPage.class;
}

public InstanceWrapper<AbstractPage, TestPage> getValue(Registry registry, TestPage annotation) {
throw new UnsupportedOperationException();
}

@Override
public InstanceWrapper<AbstractPage, TestPage> getValue(Registry registry, TestPage annotation, Class<? extends AbstractPage> valueType) {
InstanceWrapper<AbstractPage, TestPage> instanceWrapper = new InstanceWrapper<>(this, annotation);
WebDriver webDriver = registry.getDependency(WebDriver.class, instanceWrapper);
AbstractPage page = createPage(webDriver, valueType);
instanceWrapper.setValue(page, LifeCycle.CLASS);
return instanceWrapper;
}

@Override
public boolean compatible(InstanceWrapper<AbstractPage, TestPage> a, RequestedInstance<AbstractPage, TestPage> b) {
return true;
}

private <S extends AbstractPage> S createPage(WebDriver webDriver, Class<S> valueType) {
try {
Constructor<S> constructor = valueType.getDeclaredConstructor(WebDriver.class);
return constructor.newInstance(webDriver);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
11 changes: 11 additions & 0 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/page/TestPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package org.keycloak.test.framework.page;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TestPage {
}
7 changes: 2 additions & 5 deletions test-poc/framework/src/main/java/org/keycloak/test/framework/page/WelcomePage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.PageFactory;

public class WelcomePage {

private final WebDriver driver;
public class WelcomePage extends AbstractPage {

@FindBy(id = "username")
private WebElement usernameInput;
Expand All @@ -26,8 +24,7 @@ public class WelcomePage {
private WebElement pageAlert;

public WelcomePage(WebDriver driver) {
this.driver = driver;
PageFactory.initElements(driver, this);
super(driver);
}

public void navigateTo() {
Expand Down
Loading