Move the goog.exportSymbol statements in javascript/webdriver/atoms/inputs.js to a separate file.

These statements would prevent the exported symbols from being removed by the Closure
compiler in any target that included inputs.js. We only one to keep the symbols for
//javascript/webdriver/atoms:inputs

Author: jleyba

java/client/test/org/openqa/selenium/atoms/AtomsRhinoTests.java

@@ -0,0 +1,15 @@
+package org.openqa.selenium.atoms;
+
+import org.junit.runner.RunWith;
+import org.junit.runners.Suite;
+
+/**
+ * All rhino-based tests for the browser atoms.
+ */
+@RunWith(Suite.class)
+@Suite.SuiteClasses({
+    CompiledAtomsNotLeakingTest.class,
+    InputAtomsTest.class
+})
+public class AtomsRhinoTests {
+}

java/client/test/org/openqa/selenium/atoms/CompiledAtomsNotLeakingTest.java

@@ -20,34 +20,28 @@
 
 import static org.junit.Assert.assertEquals;
 
-import org.openqa.selenium.Build;
-import org.openqa.selenium.testing.InProject;
-
-import com.google.common.base.Charsets;
-import com.google.common.io.Files;
-import com.google.common.io.Resources;
 import net.sourceforge.htmlunit.corejs.javascript.Context;
 import net.sourceforge.htmlunit.corejs.javascript.ContextAction;
 import net.sourceforge.htmlunit.corejs.javascript.ContextFactory;
 import net.sourceforge.htmlunit.corejs.javascript.ScriptableObject;
+
 import org.json.JSONException;
 import org.json.JSONObject;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.BlockJUnit4ClassRunner;
+import org.junit.runners.JUnit4;
 
-import java.io.File;
 import java.io.IOException;
-import java.net.URL;
 
-@RunWith(BlockJUnit4ClassRunner.class)
+@RunWith(JUnit4.class)
 public class CompiledAtomsNotLeakingTest {
 
-  private static final String FRAGMENT_TASK = "//javascript/webdriver/atoms:execute_script";
+  private static final String FRAGMENT_TASK =
+      "//javascript/atoms/fragments:execute_script";
   private static final String FRAGMENT_PATH =
-      "build/javascript/webdriver/atoms/execute_script.js";
+      JavaScriptLoader.taskToBuildOutput(FRAGMENT_TASK);
   private static final String RESOURCE_PATH = "/org/openqa/selenium/atoms/execute_script.js";
 
   private static String fragment;
@@ -56,22 +50,13 @@ public class CompiledAtomsNotLeakingTest {
 
   @BeforeClass
   public static void loadFragment() throws IOException {
-    URL resourceUrl = CompiledAtomsNotLeakingTest.class.getResource(RESOURCE_PATH);
-    if (resourceUrl != null) {
-      fragment = Resources.toString(resourceUrl, Charsets.UTF_8);
-    } else {
-      File topDir = InProject.locate("Rakefile").getParentFile();
-      File atomFile = new File(topDir, FRAGMENT_PATH);
-      if (!atomFile.exists()) {
-        new Build().of(FRAGMENT_TASK).go();
-      }
-      fragment = Files.toString(atomFile, Charsets.UTF_8);
-    }
+    fragment = JavaScriptLoader.loadResource(RESOURCE_PATH, FRAGMENT_TASK);
   }
 
   @Before
   public void prepareGlobalObject() {
     ContextFactory.getGlobal().call(new ContextAction() {
+      @Override
       public Object run(Context context) {
         global = context.initStandardObjects();
         global.defineProperty("_", 1234, ScriptableObject.EMPTY);
@@ -95,6 +80,7 @@ public Object run(Context context) {
   @Test
   public void fragmentWillNotLeakVariablesToEnclosingScopes() {
     ContextFactory.getGlobal().call(new ContextAction() {
+      @Override
       public Object run(Context context) {
         eval(context, "(" + fragment + ")()", FRAGMENT_PATH);
         assertEquals(1234, eval(context, "_"));
@@ -121,6 +107,7 @@ public Object run(Context context) {
   @Test
   public void nestedFragmentsShouldNotLeakVariables() {
     ContextFactory.getGlobal().call(new ContextAction() {
+      @Override
       public Object run(Context context) {
         // executeScript atom recursing on itself to execute "return 1+2".
         // Should result in {status:0,value:{status:0,value:3}}

java/client/test/org/openqa/selenium/atoms/InputAtomsTest.java

@@ -0,0 +1,72 @@
+package org.openqa.selenium.atoms;
+
+import static org.junit.Assert.assertEquals;
+
+import net.sourceforge.htmlunit.corejs.javascript.Context;
+import net.sourceforge.htmlunit.corejs.javascript.ContextAction;
+import net.sourceforge.htmlunit.corejs.javascript.ContextFactory;
+import net.sourceforge.htmlunit.corejs.javascript.ScriptableObject;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+import java.io.IOException;
+
+/**
+ * Sanity tests against the //javascript/webdriver/atoms:inputs target.
+ */
+@RunWith(JUnit4.class)
+public class InputAtomsTest {
+
+  private static final String RESOURCE_PATH = "/org/openqa/selenium/atoms/atoms_inputs.js";
+  private static final String RESOURCE_TASK = "//javascript/webdriver/atoms:inputs";
+
+  @Test
+  public void exportsTheExpectedNames() throws IOException {
+    final String source = JavaScriptLoader.loadResource(RESOURCE_PATH, RESOURCE_TASK);
+    ContextFactory.getGlobal().call(new ContextAction() {
+      private ScriptableObject global;
+
+      @Override
+      public Object run(Context context) {
+        global = context.initStandardObjects();
+
+        // Check assumptions abut the global context, which the atoms assumes is a DOM window.
+        assertEquals(global, eval(context, "this.window=this;"));
+        assertEquals(global, eval(context, "this"));
+        assertEquals(global, eval(context, "window"));
+        assertEquals(true, eval(context, "this === window"));
+
+        eval(context, source, JavaScriptLoader.taskToBuildOutput(RESOURCE_TASK));
+
+        assertFunction(context, "webdriver.atoms.inputs.sendKeys");
+        assertFunction(context, "webdriver.atoms.inputs.click");
+        assertFunction(context, "webdriver.atoms.inputs.mouseMove");
+        assertFunction(context, "webdriver.atoms.inputs.mouseButtonDown");
+        assertFunction(context, "webdriver.atoms.inputs.mouseButtonUp");
+        assertFunction(context, "webdriver.atoms.inputs.doubleClick");
+        assertFunction(context, "webdriver.atoms.inputs.rightClick");
+
+        return null;
+      }
+
+      private void assertFunction(Context context, String property) {
+        assertEquals(
+            "Expected " + property + " to be a function",
+            "function",
+            eval(context, "typeof " + property));
+      }
+
+      @SuppressWarnings({"unchecked"})
+      private <T> T eval(Context context, String script) {
+        return (T) eval(context, script, "");
+      }
+
+      @SuppressWarnings({"unchecked"})
+      private <T> T eval(Context context, String script, String src) {
+        return (T) context.evaluateString(global, script, src, 1, null);
+      }
+    });
+  }
+}

java/client/test/org/openqa/selenium/atoms/JavaScriptLoader.java

@@ -0,0 +1,36 @@
+package org.openqa.selenium.atoms;
+
+import com.google.common.base.Charsets;
+import com.google.common.io.Files;
+import com.google.common.io.Resources;
+
+import org.openqa.selenium.Build;
+import org.openqa.selenium.testing.InProject;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URL;
+
+/**
+ * Utility class for loading JavaScript resources.
+ */
+class JavaScriptLoader {
+  private JavaScriptLoader() {}  // Utility class.
+
+  static String loadResource(String resourcePath, String resourceTask) throws IOException {
+    URL resourceUrl = JavaScriptLoader.class.getResource(resourcePath);
+    if (resourceUrl != null) {
+      return Resources.toString(resourceUrl, Charsets.UTF_8);
+    } else {
+      new Build().of(resourceTask).go();
+
+      File topDir = InProject.locate("Rakefile").getParentFile();
+      File builtFile = new File(topDir, taskToBuildOutput(resourceTask));
+      return Files.toString(builtFile, Charsets.UTF_8);
+    }
+  }
+
+  static String taskToBuildOutput(String taskName) {
+    return taskName.replace("//", "build/") .replace(":", "/") + ".js";
+  }
+}

java/client/test/org/openqa/selenium/atoms/build.desc

@@ -5,12 +5,20 @@ rename(
         "//javascript/atoms/fragments:execute_script.js",
     ])
 
+rename(
+    name = "atoms_inputs",
+    out = "atoms_inputs.js",
+    deps = [
+        "//javascript/webdriver/atoms:inputs.js",
+    ])
+
 
 java_test(name = "test",
   srcs = [ "*.java" ],
-  test_suite = "org.openqa.selenium.atoms.CompiledAtomsNotLeakingTest",
+  test_suite = "org.openqa.selenium.atoms.AtomsRhinoTests",
   embedded = [
     ":execute_script",
+    ":atoms_inputs",
   ],
   deps = [
     "//javascript/atoms/fragments:execute_script",

javascript/webdriver/atoms/build.desc

@@ -9,13 +9,16 @@ js_deps(name = "deps",
   ])
 
 js_binary(name = "inputs",
-  srcs = [ "inputs.js" ],
+  srcs = [
+      "inputs.js",
+      "exports/inputs.js",
+  ],
   flags = [
-    "--compilation_level=ADVANCED_OPTIMIZATIONS",
+      "--compilation_level=ADVANCED_OPTIMIZATIONS",
   ],
   no_format = "true",
   deps = [
-    ":deps",
+      ":deps",
   ])
 
 js_library(name = "atoms_lib",

javascript/webdriver/atoms/exports/inputs.js

@@ -0,0 +1,37 @@
+// Copyright 2013 WebDriver committers
+// Copyright 2013 Software Freedom Conservancy
+//
+// 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.
+
+/**
+ * @fileoverview Exports various symbols from the webdriver.atoms.inputs
+ * namespace.
+ */
+
+goog.require('webdriver.atoms.inputs');
+
+
+goog.exportSymbol('webdriver.atoms.inputs.click',
+                  webdriver.atoms.inputs.click);
+goog.exportSymbol('webdriver.atoms.inputs.doubleClick',
+                  webdriver.atoms.inputs.doubleClick);
+goog.exportSymbol('webdriver.atoms.inputs.rightClick',
+                  webdriver.atoms.inputs.rightClick);
+goog.exportSymbol('webdriver.atoms.inputs.mouseButtonDown',
+                  webdriver.atoms.inputs.mouseButtonDown);
+goog.exportSymbol('webdriver.atoms.inputs.mouseButtonUp',
+                  webdriver.atoms.inputs.mouseButtonUp);
+goog.exportSymbol('webdriver.atoms.inputs.mouseMove',
+                  webdriver.atoms.inputs.mouseMove);
+goog.exportSymbol('webdriver.atoms.inputs.sendKeys',
+                  webdriver.atoms.inputs.sendKeys);

javascript/webdriver/atoms/inputs.js

@@ -54,8 +54,6 @@ webdriver.atoms.inputs.sendKeys = function(
 
   return keyboard.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.sendKeys',
-                  webdriver.atoms.inputs.sendKeys);
 
 
 /**
@@ -76,8 +74,6 @@ webdriver.atoms.inputs.click = function(element, opt_state) {
   bot.action.click(element, null, mouse);
   return mouse.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.click',
-                  webdriver.atoms.inputs.click);
 
 
 /**
@@ -125,8 +121,6 @@ webdriver.atoms.inputs.mouseMove = function(element, x_offset, y_offset,
   mouse.move(target, coords);
   return mouse.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.mouseMove',
-                  webdriver.atoms.inputs.mouseMove);
 
 
 /**
@@ -140,8 +134,6 @@ webdriver.atoms.inputs.mouseButtonDown = function(opt_state) {
   mouse.pressButton(bot.Mouse.Button.LEFT);
   return mouse.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.mouseButtonDown',
-                  webdriver.atoms.inputs.mouseButtonDown);
 
 
 /**
@@ -155,8 +147,6 @@ webdriver.atoms.inputs.mouseButtonUp = function(opt_state) {
   mouse.releaseButton();
   return mouse.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.mouseButtonUp',
-                  webdriver.atoms.inputs.mouseButtonUp);
 
 
 /**
@@ -173,8 +163,6 @@ webdriver.atoms.inputs.doubleClick = function(opt_state) {
   mouse.releaseButton();
   return mouse.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.doubleClick',
-                  webdriver.atoms.inputs.doubleClick);
 
 
 /**
@@ -189,5 +177,3 @@ webdriver.atoms.inputs.rightClick = function(opt_state) {
   mouse.releaseButton();
   return mouse.getState();
 };
-goog.exportSymbol('webdriver.atoms.inputs.rightClick',
-                  webdriver.atoms.inputs.rightClick);