Migrate xml-helloworld groovy->java

This is a suggestion how to migrate the GebSpec based tests to Java / Selenium based tests.

Issue: gh-4939

samples/xml/helloworld/spring-security-samples-xml-helloworld.gradle

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2002-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 apply plugin: 'io.spring.convention.spring-sample-war'
 
 dependencies {
@@ -9,5 +25,9 @@ dependencies {
 
 	providedCompile 'javax.servlet:javax.servlet-api'
 
-	integrationTestCompile gebDependencies
+	testCompile project(':spring-security-test')
+	testCompile 'org.skyscreamer:jsonassert'
+	testCompile 'org.springframework:spring-test'
+
+	integrationTestCompile seleniumDependencies
 }

samples/xml/helloworld/src/integration-test/groovy/org/springframework/security/samples/HelloWorldXmlTests.groovy

@@ -1,57 +0,0 @@
-/*
- * Copyright 2002-2011 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.security.samples
-
-import geb.spock.*
-import org.junit.Ignore
-import spock.lang.Shared
-import spock.lang.Stepwise
-import org.springframework.security.samples.pages.*
-
-/**
- * Tests the CAS sample application using service tickets.
- *
- * @author Rob Winch
- */
-@Stepwise
-class HelloWorldXmlTests extends GebReportingSpec {
-	def 'access home page with unauthenticated user sends to login page'() {
-		when: 'Unauthenticated user accesses the Home Page'
-		via HomePage
-		then: 'The login page is displayed'
-		at LoginPage
-	}
-
-	def 'authenticated user is sent to original page'() {
-		when: 'user authenticates'
-		login()
-		then: 'The home page is displayed'
-		at HomePage
-		and: 'The username is displayed'
-		message == 'Hello user'
-	}
-
-	def 'authenticated user logs out'() {
-		when: 'user logs out'
-		logout()
-		then: 'the login page is displayed'
-		at LoginPage
-		when: 'Unauthenticated user accesses the Home Page'
-		via HomePage
-		then: 'The login page is displayed'
-		at LoginPage
-	}
-}

samples/xml/helloworld/src/integration-test/groovy/org/springframework/security/samples/pages/HomePage.groovy

@@ -1,32 +0,0 @@
-/*
- * Copyright 2002-2011 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.security.samples.pages;
-
-import geb.*
-
-/**
- * The home page
- *
- * @author Rob Winch
- */
-class HomePage extends Page {
-	static url = ''
-	static at = { assert driver.title == 'Hello Security'; true}
-	static content = {
-		message { $('p').text() }
-		logout { $('input', type: 'submit').click() }
-	}
-}

samples/xml/helloworld/src/integration-test/groovy/org/springframework/security/samples/pages/LoginPage.groovy

@@ -1,37 +0,0 @@
-/*
- * Copyright 2002-2011 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.security.samples.pages;
-
-import geb.*
-
-/**
- * The login page.
- *
- * @author Rob Winch
- */
-class LoginPage extends Page {
-	static url = 'login'
-	static at = { assert driver.title == 'Login Page'; true}
-	static content = {
-		login(required:false) { user='user', password='password' ->
-			loginForm.username = user
-			loginForm.password = password
-			submit.click()
-		}
-		loginForm { $('form') }
-		submit { $('input', type: 'submit') }
-	}
-}

samples/xml/helloworld/src/integration-test/java/org/springframework/security/samples/HelloWorldXmlTests.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2002-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.security.samples;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.htmlunit.HtmlUnitDriver;
+import org.springframework.security.samples.pages.HomePage;
+import org.springframework.security.samples.pages.LoginPage;
+
+/**
+ * @author Michael Simons
+ */
+public class HelloWorldXmlTests {
+
+	private WebDriver driver;
+
+	private int port;
+
+	@Before
+	public void setup() {
+		this.port = Integer.parseInt(System.getProperty("app.httpPort"));
+		this.driver = new HtmlUnitDriver();
+	}
+
+	@After
+	public void tearDown() {
+		this.driver.quit();
+	}
+
+	@Test
+	public void accessHomePageWithUnauthenticatedUserSendsToLoginPage() {
+		final LoginPage loginPage = HomePage.to(this.driver, this.port);
+		loginPage.assertAt();
+	}
+
+	@Test
+	public void authenticatedUserIsSentToOriginalPage() {
+		final HomePage homePage = HomePage.to(this.driver, this.port)
+			.loginForm()
+				.username("user")
+				.password("password")
+			.submit();
+		homePage
+			.assertAt()
+			.andTheUserNameIsDisplayed();
+	}
+
+	@Test
+	public void authenticatedUserLogsOut() {
+		LoginPage loginPage = HomePage.to(this.driver, this.port)
+			.loginForm()
+				.username("user")
+				.password("password")
+			.submit()
+			.logout();
+		loginPage.assertAt();
+
+		loginPage = HomePage.to(this.driver, this.port);
+		loginPage.assertAt();
+	}
+}

samples/xml/helloworld/src/integration-test/java/org/springframework/security/samples/pages/HomePage.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2002-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.security.samples.pages;
+
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.support.FindBy;
+import org.openqa.selenium.support.PageFactory;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Michael Simons
+ */
+public class HomePage {
+	private final WebDriver webDriver;
+
+	@FindBy(css = "p")
+	private WebElement message;
+
+	@FindBy(css = "input[type=submit]")
+	private WebElement logoutButton;
+
+	public static LoginPage to(WebDriver driver, int port) {
+		driver.get("http://localhost:" + port +"/");
+		return PageFactory.initElements(driver, LoginPage.class);
+	}
+
+	public HomePage(WebDriver webDriver) {
+		this.webDriver = webDriver;
+	}
+
+	public Content assertAt() {
+		assertThat(this.webDriver.getTitle()).isEqualTo("Hello Security");
+		return PageFactory.initElements(this.webDriver, Content.class);
+	}
+
+	public LoginPage logout() {
+		this.logoutButton.submit();
+		return PageFactory.initElements(this.webDriver, LoginPage.class);
+	}
+
+	public static class Content {
+		@FindBy(css = "p")
+		private WebElement message;
+
+		public Content andTheUserNameIsDisplayed() {
+			assertThat(message.getText()).isEqualTo("Hello user");
+			return this;
+		}
+	}
+}

samples/xml/helloworld/src/integration-test/java/org/springframework/security/samples/pages/LoginPage.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2002-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.security.samples.pages;
+
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.support.FindBy;
+import org.openqa.selenium.support.PageFactory;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Michael Simons
+ */
+public class LoginPage {
+
+	private final WebDriver webDriver;
+
+	private final LoginForm loginForm;
+
+	public LoginPage(WebDriver webDriver) {
+		this.webDriver = webDriver;
+		this.loginForm = PageFactory.initElements(this.webDriver, LoginForm.class);
+	}
+
+	public LoginPage assertAt() {
+		assertThat(this.webDriver.getTitle()).isEqualTo("Login Page");
+		return this;
+	}
+
+	public LoginForm loginForm() {
+		return this.loginForm;
+	}
+
+	public static class LoginForm {
+		private WebDriver webDriver;
+		private WebElement username;
+		private WebElement password;
+		@FindBy(css = "input[type=submit]")
+		private WebElement submit;
+
+		public LoginForm(WebDriver webDriver) {
+			this.webDriver = webDriver;
+		}
+
+		public LoginForm username(String username) {
+			this.username.sendKeys(username);
+			return this;
+		}
+
+		public LoginForm password(String password) {
+			this.password.sendKeys(password);
+			return this;
+		}
+
+		public HomePage submit() {
+			this.submit.click();
+			return PageFactory.initElements(this.webDriver, HomePage.class);
+		}
+	}
+}