Merge pull request #2199 from jtnord/adapt-to-junit-727

Introduce TestResult PO and update junit (plugin) related code

Author: jtnord

src/main/java/org/jenkinsci/test/acceptance/plugins/envinject/EnvInjectAction.java

@@ -28,11 +28,11 @@
 import org.jenkinsci.test.acceptance.po.Build;
 import org.jenkinsci.test.acceptance.po.ContainerPageObject;
 
-@ActionPageObject("injectedEnvVars")
+@ActionPageObject(relativePath = "injectedEnvVars", linkText = "Environment variables")
 public class EnvInjectAction extends Action {
 
-    public EnvInjectAction(Build build, String path) {
-        super(build, path);
+    public EnvInjectAction(Build build, String path, String linkText) {
+        super(build, path, linkText);
     }
 
     public EnvInjectAction shouldContain(String key, String value) {

src/main/java/org/jenkinsci/test/acceptance/plugins/html_publisher/HtmlReport.java

@@ -31,10 +31,10 @@
 import org.jenkinsci.test.acceptance.po.ContainerPageObject;
 import org.jenkinsci.test.acceptance.po.Job;
 
-@ActionPageObject("HTML_Report")
+@ActionPageObject(relativePath = "HTML_Report", linkText = "HTML Report")
 public class HtmlReport extends Action {
-    public HtmlReport(Job parent, String relative) {
-        super(parent, relative);
+    public HtmlReport(Job parent, String relative, String linkText) {
+        super(parent, relative, linkText);
     }
 
     public HtmlReport fileShouldMatch(String path, String content) {

src/main/java/org/jenkinsci/test/acceptance/plugins/job_config_history/JobConfigHistory.java

@@ -32,11 +32,11 @@
 import org.jenkinsci.test.acceptance.po.PageObject;
 import org.openqa.selenium.WebElement;
 
-@ActionPageObject("jobConfigHistory")
+@ActionPageObject(relativePath = "jobConfigHistory", linkText = "Job Config History")
 public class JobConfigHistory extends Action {
 
-    public JobConfigHistory(Job parent, String relative) {
-        super(parent, relative);
+    public JobConfigHistory(Job parent, String relative, String linkText) {
+        super(parent, relative, linkText);
     }
 
     public void showLastChange() {

src/main/java/org/jenkinsci/test/acceptance/plugins/junit/TestReport.java

@@ -0,0 +1,82 @@
+package org.jenkinsci.test.acceptance.plugins.junit;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.empty;
+import static org.hamcrest.Matchers.not;
+
+import java.util.List;
+import org.jenkinsci.test.acceptance.po.Action;
+import org.jenkinsci.test.acceptance.po.ActionPageObject;
+import org.jenkinsci.test.acceptance.po.Build;
+import org.jenkinsci.test.acceptance.po.CapybaraPortingLayerImpl;
+import org.jenkinsci.test.acceptance.po.ContainerPageObject;
+import org.openqa.selenium.By;
+import org.openqa.selenium.NoSuchElementException;
+import org.openqa.selenium.WebElement;
+
+@ActionPageObject(relativePath = "testReport", linkText = "Tests")
+public class TestReport extends Action {
+
+    public TestReport(Build build, String path, String linkText) {
+        super(build, path, linkText);
+    }
+
+    public int getTotalTestCount() {
+        // ugly hack as the junit plugin is not super friendly for testing.
+        WebElement tests = find(by.xpath("//span[class='jenkins-app-bar__subtitle']"));
+        return Integer.parseInt(tests.getText());
+    }
+
+    public int getSkippedTestCount() {
+        WebElement tests = getElement(by.xpath("//div[contains(@title, ' skipped')]"));
+        if (tests == null) {
+            return 0;
+        }
+        return Integer.parseInt(tests.getText());
+    }
+
+    public int getFailedTestCount() {
+        WebElement tests = getElement(by.xpath("//div[contains(@title, ' failing')]"));
+        if (tests == null) {
+            return 0;
+        }
+        return Integer.parseInt(tests.getText());
+    }
+
+    public void assertFailureContent(String test, String content) {
+        // Given that there may be several tests with the same name, we assert
+        // that at least one of the pages have the requested content
+
+        final List<WebElement> rows = all(by.xpath("//tr[@data='%s']", test));
+
+        boolean found = false;
+        for (WebElement row : rows) {
+            // this is a javascript expand
+            WebElement link = row.findElement(By.tagName("a"));
+            link.click();
+            WebElement details =
+                    waitFor(row).ignoring(NoSuchElementException.class).until(TestReport::getTestDetailsRow);
+            found = details.getText().contains(content);
+            link.click(); // hide the content
+            waitFor(details).until(CapybaraPortingLayerImpl::isStale);
+            if (found) {
+                break;
+            }
+        }
+        assertThat("No test found with name " + test, rows, not(empty()));
+        assertThat("No test found with given content", found);
+    }
+
+    @Override
+    public boolean isApplicable(ContainerPageObject po) {
+        return po instanceof Build;
+    }
+
+    private static WebElement getTestDetailsRow(WebElement testRow) {
+        WebElement sibling = testRow.findElement(By.xpath("following-sibling::*[1]"));
+        if ("foldout-row".equals(sibling.getDomAttribute("data-type"))) {
+            return sibling;
+        }
+        return null;
+    }
+}

src/main/java/org/jenkinsci/test/acceptance/plugins/priority_sorter/PriorityConfig.java

@@ -30,11 +30,11 @@
 import org.jenkinsci.test.acceptance.po.Jenkins;
 import org.jenkinsci.test.acceptance.po.PageAreaImpl;
 
-@ActionPageObject("advanced-build-queue")
+@ActionPageObject(relativePath = "advanced-build-queue", linkText = "Job Priorities")
 public class PriorityConfig extends Action {
 
-    public PriorityConfig(ContainerPageObject parent, String relative) {
-        super(parent, relative);
+    public PriorityConfig(ContainerPageObject parent, String relative, String linkText) {
+        super(parent, relative, linkText);
     }
 
     @Override

src/main/java/org/jenkinsci/test/acceptance/plugins/scriptler/Scriptler.java

@@ -32,11 +32,11 @@
 import org.jenkinsci.test.acceptance.po.Control;
 import org.jenkinsci.test.acceptance.po.Jenkins;
 
-@ActionPageObject("scriptler")
+@ActionPageObject(relativePath = "scriptler")
 public class Scriptler extends Action {
 
-    public Scriptler(Jenkins parent, String relative) {
-        super(parent, relative);
+    public Scriptler(Jenkins parent, String relative, String linkText) {
+        super(parent, relative, linkText);
     }
 
     public Script upload(Resource script) {

src/main/java/org/jenkinsci/test/acceptance/po/Action.java

@@ -23,6 +23,7 @@
  */
 package org.jenkinsci.test.acceptance.po;
 
+import java.util.Objects;
 import org.openqa.selenium.WebDriver;
 
 /**
@@ -33,25 +34,40 @@
 public abstract class Action extends PageObject {
 
     protected final ContainerPageObject parent;
+    private final String linkText;
 
-    public Action(ContainerPageObject parent, String relative) {
+    public Action(ContainerPageObject parent, String relative, String linkText) {
         super(parent.injector, parent.url(relative + "/"));
         this.parent = parent;
+        this.linkText = linkText;
     }
 
     @Override
     public WebDriver open() {
         WebDriver wd = super.open();
-
-        if (!wd.getCurrentUrl().startsWith(url.toString())) {
-            throw new AssertionError("Action " + url + " does not exist. Redirected to " + wd.getCurrentUrl());
-        }
-
+        assertCorrectUrl();
         return wd;
     }
 
+    /**
+     * Opens the Action page by clicking on the link on the parent page.
+     */
+    public <T extends Action> T openViaLink() {
+        Objects.requireNonNull(linkText, "The linkText must be provided in order to utilise this method");
+        parent.ensureOpen();
+        find(by.link(linkText)).click();
+        assertCorrectUrl();
+        return (T) this;
+    }
+
     /**
      * @return true if and action can be attached to given page object.
      */
     public abstract boolean isApplicable(ContainerPageObject po);
+
+    private void assertCorrectUrl() {
+        if (!driver.getCurrentUrl().startsWith(url.toString())) {
+            throw new AssertionError("Action " + url + " does not exist. Redirected to " + driver.getCurrentUrl());
+        }
+    }
 }

src/main/java/org/jenkinsci/test/acceptance/po/ActionPageObject.java

@@ -39,5 +39,7 @@
 @Indexed
 public @interface ActionPageObject {
     /** Relative path to parent */
-    String value();
+    String relativePath();
+    /** Text of the link for the action */
+    String linkText() default "";
 }

src/main/java/org/jenkinsci/test/acceptance/po/ContainerPageObject.java

@@ -86,13 +86,23 @@ public JsonNode getJson(String queryString) {
      * @param type Action type to create.
      */
     public <T extends Action> T action(Class<T> type) {
-        final String path = type.getAnnotation(ActionPageObject.class).value();
-        return action(type, path);
+        final String path = type.getAnnotation(ActionPageObject.class).relativePath();
+        final String linkText = type.getAnnotation(ActionPageObject.class).linkText();
+        return action(type, path, linkText.isBlank() ? null : linkText);
     }
 
-    public <T extends Action> T action(Class<T> type, String path) {
+    /**
+     * Create action of this page object.
+     * Preffer to use {@link #action(Class)} where fixed paths and link text is known.
+     * @param <T> The concrete action class to create.
+     * @param type Action type to create
+     * @param path the relative path from this PageObject
+     * @param linkText optional text of the link in the sidebar.
+     * @return the newly contructed Action of type T
+     */
+    public <T extends Action> T action(Class<T> type, String path, String linkText) {
 
-        T instance = newInstance(type, this, path);
+        T instance = newInstance(type, this, path, linkText);
 
         if (!instance.isApplicable(this)) {
             throw new AssertionError(

src/main/java/org/jenkinsci/test/acceptance/po/PageObject.java

@@ -78,6 +78,15 @@ public WebDriver open() {
         return visit(url);
     }
 
+    /**
+     * Ensures that the current page is the one represented by this PageObject, and opens it if not.
+     */
+    protected void ensureOpen() {
+        if (!url.toExternalForm().equals(driver.getCurrentUrl())) {
+            open();
+        }
+    }
+
     /**
      * Given the path relative to {@link #url}, visit that page
      */