Feedback changes - restructed project structure

2016-06-28 21:53:55 +01:00
parent 35c0942803
commit 27e4e9afee
18 changed files with 28 additions and 107 deletions
--- a/page-object/src/test/java/com/iluwatar/pageobject/AlbumListPageTest.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/AlbumListPageTest.java
@ -0,0 +1,45 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject;
+
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.iluwatar.pageobject.pages.AlbumListPage;
+import com.iluwatar.pageobject.pages.AlbumPage;
+import org.junit.Test;
+
+import static org.junit.Assert.assertTrue;
+
+
+public class AlbumListPageTest {
+
+  @Test
+  public void testSelectAlbum() {
+    AlbumListPage albumListPage = new AlbumListPage(new WebClient());
+
+    AlbumPage albumPage = albumListPage.selectAlbum("21");
+
+    assertTrue(albumPage.isAt());
+  }
+
+}
--- a/page-object/src/test/java/com/iluwatar/pageobject/AlbumPageTest.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/AlbumPageTest.java
@ -0,0 +1,56 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.iluwatar.pageobject.pages.AlbumListPage;
+import com.iluwatar.pageobject.pages.AlbumPage;
+import org.junit.Test;
+
+import static org.junit.Assert.assertTrue;
+
+public class AlbumPageTest {
+
+  private AlbumPage albumPage = new AlbumPage(new WebClient());
+
+  @Test
+  public void testSaveAlbum() {
+
+    AlbumPage albumPageAfterChanges = albumPage.changeAlbumTitle("25")
+        .changeArtist("Adele Laurie Blue Adkins")
+        .changeAlbumYear(2015)
+        .changeAlbumRating("B")
+        .changeNumberOfSongs(20)
+        .saveChanges();
+
+    assertTrue(albumPageAfterChanges.isAt());
+
+  }
+
+  @Test
+  public void testCancelChanges() {
+    AlbumListPage albumListPage = albumPage.cancelChanges();
+    assertTrue(albumListPage.isAt());
+  }
+
+}
--- a/page-object/src/test/java/com/iluwatar/pageobject/LoginPageTest.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/LoginPageTest.java
@ -0,0 +1,45 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.iluwatar.pageobject.pages.AlbumListPage;
+import com.iluwatar.pageobject.pages.LoginPage;
+import org.junit.Test;
+
+import static org.junit.Assert.assertTrue;
+
+public class LoginPageTest {
+
+  @Test
+  public void testLogin() {
+    LoginPage loginPage = new LoginPage(new WebClient());
+
+    AlbumListPage albumListPage = loginPage.enterUsername("admin")
+        .enterPassword("password")
+        .login();
+
+    assertTrue(albumListPage.isAt());
+  }
+
+}
--- a/page-object/src/test/java/com/iluwatar/pageobject/pages/AlbumListPage.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/pages/AlbumListPage.java
@ -0,0 +1,94 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject.pages;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.gargoylesoftware.htmlunit.html.HtmlAnchor;
+import com.gargoylesoftware.htmlunit.html.HtmlPage;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.util.List;
+
+/**
+ * Page Object encapsulating the Album List page (album-list.html)
+ */
+public class AlbumListPage extends Page {
+
+  private static final String ALBUM_LIST_HTML_FILE = "album-list.html";
+  private static final String PAGE_URL = "file:" + AUT_PATH + ALBUM_LIST_HTML_FILE;
+
+  private HtmlPage page;
+
+  private List<HtmlAnchor> albumLinks;
+
+
+  /**
+   * Constructor
+   */
+  public AlbumListPage(WebClient webClient) {
+    super(webClient);
+    try {
+      page = this.webClient.getPage(PAGE_URL);
+
+      // uses XPath to find list of html anchor tags with the class album in it
+      albumLinks = (List<HtmlAnchor>) page.getByXPath("//tr[@class='album']//a");
+
+    } catch (MalformedURLException e) {
+      e.printStackTrace();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public boolean isAt() {
+    return "Album List".equals(page.getTitleText());
+  }
+
+  /**
+   * Selects an album by the given album title
+   *
+   * @param albumTitle the title of the album to click
+   * @return the album page
+   */
+  public AlbumPage selectAlbum(String albumTitle) {
+    for (HtmlAnchor anchor : albumLinks) {
+      if (anchor.getTextContent().equals(albumTitle)) {
+        try {
+          anchor.click();
+          return new AlbumPage(webClient);
+        } catch (IOException e) {
+          e.printStackTrace();
+        }
+      }
+    }
+    throw new IllegalArgumentException("No links with the album title: " + albumTitle);
+  }
+
+
+}
--- a/page-object/src/test/java/com/iluwatar/pageobject/pages/AlbumPage.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/pages/AlbumPage.java
@ -0,0 +1,184 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject.pages;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.gargoylesoftware.htmlunit.html.HtmlNumberInput;
+import com.gargoylesoftware.htmlunit.html.HtmlOption;
+import com.gargoylesoftware.htmlunit.html.HtmlPage;
+import com.gargoylesoftware.htmlunit.html.HtmlSelect;
+import com.gargoylesoftware.htmlunit.html.HtmlSubmitInput;
+import com.gargoylesoftware.htmlunit.html.HtmlTextInput;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+
+/**
+ * Page Object encapsulating the Album Page (album-page.html)
+ */
+public class AlbumPage extends Page {
+
+  private static final String ALBUM_PAGE_HTML_FILE = "album-page.html";
+  private static final String PAGE_URL = "file:" + AUT_PATH + ALBUM_PAGE_HTML_FILE;
+
+  private HtmlPage page;
+
+  private HtmlTextInput albumTitleInputTextField;
+  private HtmlTextInput artistInputTextField;
+  private HtmlSelect albumYearSelectOption;
+  private HtmlTextInput albumRatingInputTextField;
+  private HtmlNumberInput numberOfSongsNumberField;
+
+  private HtmlSubmitInput cancelButton;
+  private HtmlSubmitInput saveButton;
+
+  /**
+   * Constructor
+   */
+  public AlbumPage(WebClient webClient) {
+    super(webClient);
+    try {
+      page = this.webClient.getPage(PAGE_URL);
+      initializeHtmlElements();
+    } catch (MalformedURLException e) {
+      e.printStackTrace();
+    } catch (IOException e) {
+      e.printStackTrace();
+    } catch (Exception e) {
+      e.printStackTrace();
+    }
+
+  }
+
+
+  private void initializeHtmlElements() {
+    albumTitleInputTextField = (HtmlTextInput) page.getElementById("albumTitle");
+    artistInputTextField = (HtmlTextInput) page.getElementById("albumArtist");
+    albumYearSelectOption = (HtmlSelect) page.getElementById("albumYear");
+    albumRatingInputTextField = (HtmlTextInput) page.getElementById("albumRating");
+    numberOfSongsNumberField = (HtmlNumberInput) page.getElementById("numberOfSongs");
+
+    cancelButton = (HtmlSubmitInput) page.getElementById("cancelButton");
+    saveButton = (HtmlSubmitInput) page.getElementById("saveButton");
+  }
+
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public boolean isAt() {
+    return "Album Page".equals(page.getTitleText());
+  }
+
+
+  /**
+   * Sets the album title input text field
+   *
+   * @param albumTitle the new album title value to set
+   * @return {@link AlbumPage}
+   */
+  public AlbumPage changeAlbumTitle(String albumTitle) {
+    albumTitleInputTextField.setText(albumTitle);
+    return this;
+  }
+
+
+  /**
+   * Sets the artist input text field
+   *
+   * @param artist the new artist value to set
+   * @return {@link AlbumPage}
+   */
+  public AlbumPage changeArtist(String artist) {
+    artistInputTextField.setText(artist);
+    return this;
+  }
+
+
+  /**
+   * Selects the select's option value based on the year value given
+   *
+   * @param year the new year value to set
+   * @return {@link AlbumPage}
+   */
+  public AlbumPage changeAlbumYear(int year) {
+    HtmlOption yearOption = albumYearSelectOption.getOptionByValue(Integer.toString(year));
+    albumYearSelectOption.setSelectedAttribute(yearOption, true);
+    return this;
+  }
+
+
+  /**
+   * Sets the album rating input text field
+   *
+   * @param albumRating the new album rating value to set
+   * @return {@link AlbumPage}
+   */
+  public AlbumPage changeAlbumRating(String albumRating) {
+    albumRatingInputTextField.setText(albumRating);
+    return this;
+  }
+
+  /**
+   * Sets the number of songs number input field
+   *
+   * @param numberOfSongs the new number of songs value to be set
+   * @return {@link AlbumPage}
+   */
+  public AlbumPage changeNumberOfSongs(int numberOfSongs) {
+    numberOfSongsNumberField.setText(Integer.toString(numberOfSongs));
+    return this;
+  }
+
+
+  /**
+   * Cancel changes made by clicking the cancel button
+   *
+   * @return {@link AlbumListPage}
+   */
+  public AlbumListPage cancelChanges() {
+    try {
+      cancelButton.click();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+    return new AlbumListPage(webClient);
+  }
+
+
+  /**
+   * Saves changes made by clicking the save button
+   *
+   * @return {@link AlbumPage}
+   */
+  public AlbumPage saveChanges() {
+    try {
+      saveButton.click();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+    return this;
+  }
+
+}
--- a/page-object/src/test/java/com/iluwatar/pageobject/pages/LoginPage.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/pages/LoginPage.java
@ -0,0 +1,119 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject.pages;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.gargoylesoftware.htmlunit.html.HtmlPage;
+import com.gargoylesoftware.htmlunit.html.HtmlPasswordInput;
+import com.gargoylesoftware.htmlunit.html.HtmlSubmitInput;
+import com.gargoylesoftware.htmlunit.html.HtmlTextInput;
+import java.io.IOException;
+import java.net.MalformedURLException;
+
+/**
+ * Page Object encapsulating the Login Page (login.html)
+ */
+public class LoginPage extends Page {
+
+  private static final String LOGIN_PAGE_HTML_FILE = "login.html";
+  private static final String PAGE_URL = "file:" + AUT_PATH + LOGIN_PAGE_HTML_FILE;
+
+  private HtmlPage page;
+
+  private HtmlTextInput usernameInputTextField;
+  private HtmlPasswordInput passwordInputPasswordField;
+  private HtmlSubmitInput loginButton;
+
+
+  /**
+   * Constructor
+   *
+   * @param webClient {@link WebClient}
+   */
+  public LoginPage(WebClient webClient) {
+    super(webClient);
+    try {
+      page = this.webClient.getPage(PAGE_URL);
+
+      usernameInputTextField = (HtmlTextInput) page.getElementById("username");
+      passwordInputPasswordField = (HtmlPasswordInput) page.getElementById("password");
+      loginButton = (HtmlSubmitInput) page.getElementById("loginButton");
+
+    } catch (MalformedURLException e) {
+      e.printStackTrace();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+  }
+
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public boolean isAt() {
+    return "Login".equals(page.getTitleText());
+  }
+
+
+  /**
+   * Enters the username into the username input text field
+   *
+   * @param username the username to enter
+   * @return {@link LoginPage}
+   */
+  public LoginPage enterUsername(String username) {
+    usernameInputTextField.setText(username);
+    return this;
+  }
+
+
+  /**
+   * Enters the password into the password input password field
+   *
+   * @param password the password to enter
+   * @return {@link LoginPage}
+   */
+  public LoginPage enterPassword(String password) {
+    passwordInputPasswordField.setText(password);
+    return this;
+  }
+
+
+  /**
+   * Clicking on the login button to 'login'
+   *
+   * @return {@link AlbumListPage}
+   *        - this is the page that user gets navigated to once successfully logged in
+   */
+  public AlbumListPage login() {
+    try {
+      loginButton.click();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+    return new AlbumListPage(webClient);
+  }
+
+
+}
--- a/page-object/src/test/java/com/iluwatar/pageobject/pages/Page.java
+++ b/page-object/src/test/java/com/iluwatar/pageobject/pages/Page.java
@ -0,0 +1,57 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.pageobject.pages;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+
+/**
+ * Encapsulation for a generic 'Page'
+ */
+public abstract class Page {
+
+  /**
+   * Application Under Test path
+   * This directory location is where html web pages are located
+   */
+  public static final String AUT_PATH = "src/main/resources/sample-ui/";
+
+  protected WebClient webClient;
+
+  /**
+   * Constructor
+   *
+   * @param webClient {@link WebClient}
+   */
+  public Page(WebClient webClient) {
+    this.webClient = webClient;
+  }
+
+  /**
+   * Checks that the current page is actually the page this page object represents
+   *
+   * @return true if so, otherwise false
+   */
+  public abstract boolean isAt();
+
+
+}