-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(agama): add test cases for agama engine (#2673)
* chore: add Java test cases #2672 * docs: minor update #2672 * chore: add testNG configurations #2672 * chore: add agama resources for reference #2672 * chore: log statements optimization #2672
- Loading branch information
1 parent
f97bfce
commit c57c0dd
Showing
26 changed files
with
897 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| #The URL of your Jans installation | ||
| server=https://jgomer2001-guiding-herring.gluu.info | ||
|
|
||
| clientId=1800.5e01b3bb-1f68-4847-b9ba-d5c999a05e33 | ||
|
|
||
| custParamName=customParam1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
183 changes: 183 additions & 0 deletions
183
agama/engine/src/test/java/io/jans/agama/test/BaseTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| package io.jans.agama.test; | ||
|
|
||
| import com.gargoylesoftware.htmlunit.BrowserVersion; | ||
| import com.gargoylesoftware.htmlunit.Page; | ||
| import com.gargoylesoftware.htmlunit.WebClient; | ||
| import com.gargoylesoftware.htmlunit.WebClientOptions; | ||
| import com.gargoylesoftware.htmlunit.WebResponse; | ||
| import com.gargoylesoftware.htmlunit.html.DomElement; | ||
| import com.gargoylesoftware.htmlunit.html.HtmlForm; | ||
| import com.gargoylesoftware.htmlunit.html.HtmlPage; | ||
|
|
||
| import io.jans.inbound.oauth2.CodeGrantUtil; | ||
| import io.jans.inbound.oauth2.OAuthParams; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Hashtable; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Properties; | ||
| import java.net.URISyntaxException; | ||
| import java.net.URLEncoder; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.json.JSONObject; | ||
| import org.testng.ITestContext; | ||
| import org.testng.annotations.BeforeSuite; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| //import org.testng.annotations.Test; | ||
| import static org.testng.Assert.*; | ||
|
|
||
| public class BaseTest { | ||
|
|
||
| private static String AGAMA_ACR = "agama"; | ||
| private Map<String, String> map = null; | ||
|
|
||
| Logger logger = LogManager.getLogger(getClass()); | ||
| WebClient client = null; | ||
|
|
||
| BaseTest() { | ||
|
|
||
| client = new WebClient(BrowserVersion.CHROME); | ||
| WebClientOptions options = client.getOptions(); | ||
|
|
||
| options.setThrowExceptionOnFailingStatusCode(false); | ||
| //prevents the finish page to autosubmit the POST to AS's postlogin endpoint | ||
| options.setJavaScriptEnabled(false); | ||
|
|
||
| } | ||
|
|
||
| @BeforeSuite | ||
| public void init(ITestContext context) throws IOException { | ||
|
|
||
| String propertiesFile = context.getCurrentXmlTest().getParameter("propertiesFile"); | ||
| Properties prop = new Properties(); | ||
| prop.load(Files.newBufferedReader(Paths.get(propertiesFile), UTF_8)); | ||
|
|
||
| map = new Hashtable<>(); | ||
| //do not bother about empty keys... but | ||
| //If a value is found null, this will throw a NPE since we are using a Hashtable | ||
| prop.forEach((key, value) -> map.put(key.toString(), value.toString())); | ||
| context.getSuite().getXmlSuite().setParameters(map); | ||
|
|
||
| } | ||
|
|
||
| String authzRequestUrl(String flowQName, Map<String, Object> inputs) { | ||
|
|
||
| OAuthParams p = new OAuthParams(); | ||
| p.setAuthzEndpoint(map.get("authzEndpoint")); | ||
| p.setClientId(map.get("clientId")); | ||
| p.setRedirectUri(map.get("redirectUri")); | ||
| p.setScopes(Collections.singletonList("openid")); | ||
|
|
||
| String queryParam = URLEncoder.encode(map.get("custParamName"), UTF_8); | ||
|
|
||
| StringBuilder builder = new StringBuilder(flowQName); | ||
| if (inputs != null) { | ||
| JSONObject jo = new JSONObject(inputs); | ||
| builder.append("-").append(jo.toString()); | ||
| } | ||
|
|
||
| Map<String, String> custParams = new HashMap<>(); | ||
| custParams.put("acr_values", AGAMA_ACR); | ||
| custParams.put(queryParam, builder.toString()); | ||
| p.setCustParamsAuthReq(custParams); | ||
|
|
||
| String url = null; | ||
| CodeGrantUtil grant = new CodeGrantUtil(p); | ||
|
|
||
| try { | ||
| url = grant.makeAuthzRequest().getFirst(); | ||
| logger.debug("Authentication request built is: {}", url); | ||
| } catch (URISyntaxException e) { | ||
| fail(e.getMessage(), e); | ||
| } | ||
| return url; | ||
|
|
||
| } | ||
|
|
||
| HtmlPage launch(String flowQName, Map<String, Object> parameters) { | ||
|
|
||
| //Generate an authn request and launch it in the htmlUnit browser | ||
| String url = authzRequestUrl(flowQName, parameters); | ||
| logger.info("Starting flow {}", flowQName); | ||
| try { | ||
| Page p = client.getPage(url); | ||
|
|
||
| //Check it is an ok web page | ||
| assertTrue(p.isHtmlPage(), "Not an html page"); | ||
| assertOK(p); | ||
| return (HtmlPage) p; | ||
|
|
||
| } catch (IOException e) { | ||
| fail(e.getMessage(), e); | ||
| return null; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| void validateFinishPage(HtmlPage page, boolean success) { | ||
|
|
||
| assertOK(page); | ||
| //check we are effectively at the finish page | ||
| String title = page.getTitleText().toLowerCase(); | ||
|
|
||
| if (success) { | ||
| assertTrue(title.contains("redirect"), "'redirect' word not found in page title"); | ||
|
|
||
| List<HtmlForm> forms = page.getForms(); | ||
| assertEquals(forms.size(), 1, "Page should have one and only one form"); | ||
|
|
||
| HtmlForm form = forms.get(0); | ||
| assertTrue(form.getActionAttribute().contains("postlogin"), "Form does not have the expected action attribute"); | ||
| assertEquals(form.getMethodAttribute().toLowerCase(), "post", "Form does not use POST"); | ||
|
|
||
| } else { | ||
|
|
||
| assertTrue(title.contains("error"), "'error' word not found in page title"); | ||
|
|
||
| String text = page.getVisibleText().toLowerCase(); | ||
| assertTrue(text.contains("authentication"), "'authentication' word not found in page text"); | ||
| assertTrue(text.contains("failed"), "'failed' word not found in page text"); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| void assertOK(Page page) { | ||
| assertEquals(page.getWebResponse().getStatusCode(), WebResponse.OK); | ||
| } | ||
|
|
||
| void assertServerError(Page page) { | ||
| assertEquals(page.getWebResponse().getStatusCode(), WebResponse.INTERNAL_SERVER_ERROR); | ||
| } | ||
|
|
||
| <P extends Page> P doClick(DomElement el) { | ||
|
|
||
| try { | ||
| return el.click(); | ||
| } catch (IOException e) { | ||
| fail(e.getMessage(), e); | ||
| return null; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| void typeInInputWithName(HtmlForm form, String name, String text) { | ||
|
|
||
| try { | ||
| //See f1/index.ftl | ||
| form.getInputByName("something").type(text); | ||
| } catch (IOException e) { | ||
| fail(e.getMessage(), e); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
64 changes: 64 additions & 0 deletions
64
agama/engine/src/test/java/io/jans/agama/test/CustomConfigsFlowTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| package io.jans.agama.test; | ||
|
|
||
| import com.gargoylesoftware.htmlunit.html.HtmlPage; | ||
| import com.gargoylesoftware.htmlunit.html.HtmlSubmitInput; | ||
| import com.gargoylesoftware.htmlunit.WebResponse; | ||
|
|
||
| import org.testng.annotations.Parameters; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import static org.testng.Assert.*; | ||
|
|
||
| @org.testng.annotations.Ignore | ||
| public class CustomConfigsFlowTest extends BaseTest { | ||
|
|
||
| private static final String QNAME = "io.jans.agama.test.showConfig"; | ||
|
|
||
| @Test | ||
| public void withTimeout() { | ||
|
|
||
| HtmlPage page = launchAndWait(10); | ||
| //Flow should have timed out now - see flow impl | ||
| //The page currently shown may correspond to the Agama timeout template or to | ||
| //the mismatch (not found) page in case the cleaner job already wiped the flow execution | ||
|
|
||
| int status = page.getWebResponse().getStatusCode(); | ||
| String text = page.getVisibleText().toLowerCase(); | ||
|
|
||
| if (status == WebResponse.OK) { | ||
| //See timeout.ftlh | ||
| assertTrue(text.contains("took")); | ||
| assertTrue(text.contains("more")); | ||
| assertTrue(text.contains("expected")); | ||
| } else if (status == WebResponse.NOT_FOUND) { | ||
| //See mismatch.ftlh | ||
| assertTrue(text.contains("not")); | ||
| assertTrue(text.contains("found")); | ||
| } else { | ||
| fail("Unexpected status code " + status); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| @Test | ||
| public void noTimeout() { | ||
| HtmlPage page = launchAndWait(2); | ||
| validateFinishPage(page, false); | ||
| } | ||
|
|
||
| private HtmlPage launchAndWait(int wait) { | ||
|
|
||
| HtmlPage page = launch(QNAME, null); | ||
| try { | ||
| Thread.sleep(1000L * wait); | ||
| } catch (InterruptedException e) { | ||
| fail(e.getMessage(), e); | ||
| } | ||
|
|
||
| //click on the "Continue" button | ||
| HtmlSubmitInput button = page.getForms().get(0).getInputByValue("Continue"); | ||
| return doClick(button); | ||
|
|
||
| } | ||
|
|
||
| } |
Oops, something went wrong.