Add test annotation @NotYetImplemented

This feature is meant to be used with test classes with
@RunWith(SeleniumTestRunner.class)
It makes the runner executes the test method, and if
the method fails (as expected) then the build will be green,
and if the method succeeds, then the build is red complaining
"Test is marked as @NotYetImplemented but already works".

This feature ensures that anything marked with @NotYetImplemented
is still not implemented, and it is helpful to make
the test suite annotations correct.

This commit applies it to tests in TypingTest running with HtmlUnit
(which were previously @ignore), but it can be applied to other
classes or drivers.

Signed-off-by: Luke Inman-Semerau <[email protected]>

Author: asashour

Diff for: java/client/test/org/openqa/selenium/TypingTest.java

@@ -46,12 +46,13 @@
 import org.openqa.selenium.testing.Ignore;
 import org.openqa.selenium.testing.JUnit4TestBase;
 import org.openqa.selenium.testing.JavascriptEnabled;
+import org.openqa.selenium.testing.NotYetImplemented;
 import org.openqa.selenium.testing.drivers.Browser;
 
 public class TypingTest extends JUnit4TestBase {
 
   @JavascriptEnabled
-  @Ignore({MARIONETTE})
+  @Ignore(MARIONETTE)
   @Test
   public void testShouldFireKeyPressEvents() {
     driver.get(pages.javascriptPage);
@@ -162,7 +163,8 @@ public void testArrowKeysShouldNotBePrintable() {
     assertThat(keyReporter.getAttribute("value"), is(""));
   }
 
-  @Ignore(value = {HTMLUNIT, MARIONETTE})
+  @Ignore(MARIONETTE)
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testShouldBeAbleToUseArrowKeys() {
     driver.get(pages.javascriptPage);
@@ -275,7 +277,8 @@ private static void checkRecordedKeySequence(WebElement element, int expectedKey
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, IE, PHANTOMJS, MARIONETTE})
+  @Ignore(value = {IE, PHANTOMJS, MARIONETTE})
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testShouldReportKeyCodeOfArrowKeys() {
     assumeFalse(Browser.detect() == Browser.opera &&
@@ -303,8 +306,9 @@ public void testShouldReportKeyCodeOfArrowKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE},
+  @Ignore(value = MARIONETTE,
           reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testShouldReportKeyCodeOfArrowKeysUpDownEvents() {
     assumeFalse(Browser.detect() == Browser.opera &&
@@ -350,7 +354,8 @@ public void testNumericNonShiftKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agent")
+  @Ignore(value = MARIONETTE, reason = "untested user agent")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testNumericShiftKeys() {
     driver.get(pages.javascriptPage);
@@ -380,7 +385,8 @@ public void testLowerCaseAlphaKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testUppercaseAlphaKeys() {
     driver.get(pages.javascriptPage);
@@ -396,7 +402,8 @@ public void testUppercaseAlphaKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testAllPrintableKeys() {
     driver.get(pages.javascriptPage);
@@ -413,7 +420,8 @@ public void testAllPrintableKeys() {
     assertThat(result.getText().trim(), containsString(" up: 16"));
   }
 
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testArrowKeysAndPageUpAndDown() {
     driver.get(pages.javascriptPage);
@@ -426,7 +434,8 @@ public void testArrowKeysAndPageUpAndDown() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testHomeAndEndAndPageUpAndPageDownKeys() {
     assumeFalse("FIXME: macs don't have HOME keys, would PGUP work?",
@@ -443,7 +452,8 @@ public void testHomeAndEndAndPageUpAndPageDownKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testDeleteAndBackspaceKeys() {
     driver.get(pages.javascriptPage);
@@ -461,7 +471,8 @@ public void testDeleteAndBackspaceKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testSpecialSpaceKeys() {
     driver.get(pages.javascriptPage);
@@ -473,8 +484,9 @@ public void testSpecialSpaceKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE},
+  @Ignore(value = MARIONETTE,
           reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testNumberpadKeys() {
     driver.get(pages.javascriptPage);
@@ -503,9 +515,10 @@ public void testFunctionKeys() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, SAFARI, MARIONETTE},
+  @Ignore(value = {SAFARI, MARIONETTE},
           reason = "untested user agents; Safari: issue 4221",
           issues = {4221})
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testShiftSelectionDeletes() {
     driver.get(pages.javascriptPage);
@@ -521,7 +534,8 @@ public void testShiftSelectionDeletes() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testChordControlHomeShiftEndDelete() {
     assumeFalse("FIXME: macs don't have HOME keys, would PGUP work?",
@@ -543,7 +557,8 @@ public void testChordControlHomeShiftEndDelete() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testChordReveseShiftHomeSelectionDeletes() {
     assumeFalse("FIXME: macs don't have HOME keys, would PGUP work?",
@@ -576,7 +591,8 @@ public void testChordReveseShiftHomeSelectionDeletes() {
   // and linux, but not on the MAC.
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, reason = "untested user agents")
+  @Ignore(value = MARIONETTE, reason = "untested user agents")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testChordControlCutAndPaste() {
     assumeFalse("FIXME: macs don't have HOME keys, would PGUP work?",
@@ -651,8 +667,9 @@ public void testShouldNotTypeIntoElementsThatPreventKeyDownEvents() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {PHANTOMJS, HTMLUNIT},
+  @Ignore(value = PHANTOMJS,
           reason = "HtmlUnit: failure, others: not tested")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testGenerateKeyPressEventEvenWhenElementPreventsDefault() {
     assumeFalse(isFirefox(driver) && getFirefoxVersion(driver) < 25);
@@ -691,7 +708,8 @@ public void testTypingIntoAnIFrameWithContentEditableOrDesignModeSet() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, MARIONETTE}, issues = {6711})
+  @Ignore(value = MARIONETTE, issues = {6711})
+  @NotYetImplemented(HTMLUNIT)
   @NoDriverAfterTest // So that next test never starts with "inside a frame" base state.
   @Test
   public void testNonPrintableCharactersShouldWorkWithContentEditableOrDesignModeSet() {
@@ -719,18 +737,19 @@ public void testShouldBeAbleToTypeOnAnEmailInputField() {
     assertThat(email.getAttribute("value"), equalTo("foobar"));
   }
 
-  @Ignore(HTMLUNIT)
   @Test
+  @NotYetImplemented(HTMLUNIT)
   public void testShouldBeAbleToTypeOnANumberInputField() {
     driver.get(pages.formPage);
     WebElement email = driver.findElement(By.id("age"));
     email.sendKeys("33");
     assertThat(email.getAttribute("value"), equalTo("33"));
   }
 
-  @Ignore(value = {HTMLUNIT, SAFARI, MARIONETTE}, reason = "Untested browsers;" +
+  @Ignore(value = {SAFARI, MARIONETTE}, reason = "Untested browsers;" +
       " Safari: cannot type on contentEditable with synthetic events",
       issues = {3127})
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void testShouldBeAbleToTypeIntoEmptyContentEditableElement() {
     driver.get(pages.readOnlyPage);
@@ -754,10 +773,11 @@ public void testShouldBeAbleToTypeIntoContentEditableElementWithExistingValue()
     assertThat(editable.getText(), equalTo(initialText + ", edited"));
   }
 
-  @Ignore(value = {HTMLUNIT, IE, SAFARI, MARIONETTE},
+  @Ignore(value = {IE, SAFARI, MARIONETTE},
           reason = "Untested browsers;" +
                    " Safari: cannot type on contentEditable with synthetic events",
           issues = {3127})
+  @NotYetImplemented(HTMLUNIT)
   @NoDriverAfterTest // So that next test never starts with "inside a frame" base state.
   @Test
   public void testShouldBeAbleToTypeIntoTinyMCE() {
@@ -773,7 +793,8 @@ public void testShouldBeAbleToTypeIntoTinyMCE() {
   }
 
   @JavascriptEnabled
-  @Ignore(value = {HTMLUNIT, SAFARI}, reason = "Untested")
+  @Ignore(value = SAFARI, reason = "Untested")
+  @NotYetImplemented(HTMLUNIT)
   @Test
   public void canSafelyTypeOnElementThatIsRemovedFromTheDomOnKeyPress() {
     driver.get(appServer.whereIs("key_tests/remove_on_keypress.html"));

Diff for: java/client/test/org/openqa/selenium/testing/NotYetImplemented.java

@@ -0,0 +1,37 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you 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.openqa.selenium.testing;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.openqa.selenium.testing.Ignore.Driver;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface NotYetImplemented {
+
+  Driver[] value() default {Driver.ALL};
+
+  String reason() default ("Not implemented in driver yet");
+
+  int[] issues() default {};
+
+}