Merge branch 'marcospereira-updates/scalatest-3.1.0' into selenium-3.141/3.1.1.x

Author: cheeseng

build.sbt

@@ -1,4 +1,4 @@
-name := "selenium-2.45"
+name := "selenium-3.141"
 
 organization := "org.scalatestplus"
 
@@ -23,13 +23,15 @@ developers := List(
   )
 )
 
+scalaVersion := "2.13.1"
 crossScalaVersions := List("2.10.7", "2.11.12", "2.12.10", "2.13.1")
 
 libraryDependencies ++= Seq(
   "org.scalatest" %% "scalatest" % "3.1.1",
-  "org.seleniumhq.selenium" % "selenium-java" % "2.45.0", 
-  "org.eclipse.jetty" % "jetty-server" % "9.4.12.v20180830" % "test",
-  "org.eclipse.jetty" % "jetty-webapp" % "9.4.12.v20180830" % "test"
+  "org.seleniumhq.selenium" % "selenium-java" % "3.141.59",
+  "org.seleniumhq.selenium" % "htmlunit-driver" % "2.39.0",
+  "org.eclipse.jetty" % "jetty-server" % "9.4.12.v20180830" % Test,
+  "org.eclipse.jetty" % "jetty-webapp" % "9.4.12.v20180830" % Test
 )
 
 import scala.xml.{Node => XmlNode, NodeSeq => XmlNodeSeq, _}
@@ -64,7 +66,7 @@ OsgiKeys.exportPackage := Seq(
 
 OsgiKeys.importPackage := Seq(
   "org.scalatest.*",
-  "org.scalactic.*", 
+  "org.scalactic.*",
   "scala.*;version=\"$<range;[==,=+);$<replace;"+scalaBinaryVersion.value+";-;.>>\"",
   "*;resolution:=optional"
 )
@@ -92,3 +94,12 @@ credentials += Credentials(Path.userHome / ".ivy2" / ".credentials")
 pgpSecretRing := file((Path.userHome / ".gnupg" / "secring.gpg").getAbsolutePath)
 
 pgpPassphrase := None
+
+scalacOptions ++= Seq(
+  "-deprecation",
+  "-encoding", "utf-8",
+  "-explaintypes",
+  "-feature",
+  "-unchecked",
+  "-Ywarn-dead-code",
+) ++ (if (scalaBinaryVersion.value == "2.10") Seq.empty else Seq("-Ywarn-unused"))

src/main/scala/org/scalatestplus/selenium/ScreenshotCapturer.scala

@@ -24,5 +24,5 @@ private[selenium] trait ScreenshotCapturer {
   /**
    * Captures a screenshot and saves it as a file in the specified directory.
    */
-  def captureScreenshot(directory: String)
+  def captureScreenshot(directory: String): Unit
 }

src/main/scala/org/scalatestplus/selenium/WebBrowser.scala

@@ -25,13 +25,11 @@ import org.openqa.selenium.By
 import org.openqa.selenium.WebElement
 import java.util.concurrent.TimeUnit
 
-import scala.collection.mutable.Buffer
 import scala.collection.JavaConverters._
 import org.openqa.selenium.Cookie
 import java.util.Date
 
 import org.scalatest.time.Span
-import org.scalatest.time.Milliseconds
 import org.openqa.selenium.TakesScreenshot
 import org.openqa.selenium.OutputType
 import java.io.File
@@ -43,9 +41,9 @@ import org.openqa.selenium.support.ui.Select
 import org.scalatest.exceptions.TestFailedException
 import org.scalatest.exceptions.StackDepthException
 import org.openqa.selenium.JavascriptExecutor
-import org.scalatest.time.Nanosecond
-import org.scalatest.Resources
 import org.scalactic.source
+import org.openqa.selenium.firefox.FirefoxOptions
+import java.io.Closeable
 
 /**
  * Trait that provides a domain specific language (DSL) for writing browser-based tests using <a href="http://seleniumhq.org">Selenium</a>.  
@@ -1577,7 +1575,7 @@ trait WebBrowser {
         case e: org.openqa.selenium.NoSuchFrameException => 
           throw new TestFailedException(
                      (_: StackDepthException) => Some("Frame at index '" + index + "' not found."),
-                     None,
+                     Option(e),
                      pos
                    )
       }
@@ -1611,7 +1609,7 @@ trait WebBrowser {
         case e: org.openqa.selenium.NoSuchFrameException =>
           throw new TestFailedException(
                      (_: StackDepthException) => Some("Frame with name or ID '" + nameOrId + "' not found."),
-                     None,
+                     Option(e),
                      pos
                    )
       }
@@ -1636,7 +1634,7 @@ trait WebBrowser {
         case e: org.openqa.selenium.NoSuchFrameException => 
           throw new TestFailedException(
                      (_: StackDepthException) => Some("Frame element '" + webElement + "' not found."),
-                     None,
+                     Option(e),
                      pos
                    )
       }
@@ -1661,7 +1659,7 @@ trait WebBrowser {
         case e: org.openqa.selenium.NoSuchFrameException => 
           throw new TestFailedException(
                      (_: StackDepthException) => Some("Frame element '" + element + "' not found."),
-                     None,
+                     Option(e),
                      pos
                    )
       }
@@ -1695,7 +1693,7 @@ trait WebBrowser {
         case e: org.openqa.selenium.NoSuchWindowException => 
           throw new TestFailedException(
                      (_: StackDepthException) => Some("Window with nameOrHandle '" + nameOrHandle + "' not found."),
-                     None,
+                     Option(e),
                      pos
                    )
       }
@@ -2849,7 +2847,7 @@ trait WebBrowser {
         Some(createTypedElement(driver.findElement(by), pos))
       }
       catch {
-        case e: org.openqa.selenium.NoSuchElementException => None
+        case _: org.openqa.selenium.NoSuchElementException => None
       }
 
     /**
@@ -4299,6 +4297,22 @@ trait WebBrowser {
    * </pre>
    */
   object capture {
+
+    private def copy(source: File, destination: File): Unit = {
+
+      def close(closeable: Closeable): Unit = if (closeable != null) closeable.close()
+
+      var outStream: FileOutputStream = null
+      var inputStream: FileInputStream = null
+      try {
+        inputStream = new FileInputStream(source)
+        outStream = new FileOutputStream(destination)
+        outStream.getChannel().transferFrom(inputStream.getChannel(), 0, Long.MaxValue)
+      } finally {
+        close(inputStream)
+        close(outStream)
+      }
+    }
 
     /**
      * Capture screenshot and save it as the specified name (if file name does not end with .png, it will be extended automatically) in capture directory, 
@@ -4311,8 +4325,7 @@ trait WebBrowser {
         case takesScreenshot: TakesScreenshot => 
           val tmpFile = takesScreenshot.getScreenshotAs(OutputType.FILE)
           val outFile = new File(targetDir, if (fileName.toLowerCase.endsWith(".png")) fileName else fileName + ".png")
-          new FileOutputStream(outFile).getChannel.transferFrom(
-            new FileInputStream(tmpFile).getChannel, 0, Long.MaxValue)
+          copy(tmpFile, outFile)
         case _ =>
           throw new UnsupportedOperationException("Screen capture is not support by " + driver.getClass.getName)
       }
@@ -4328,11 +4341,9 @@ trait WebBrowser {
         case takesScreenshot: TakesScreenshot =>
           val tmpFile = takesScreenshot.getScreenshotAs(OutputType.FILE)
           val dir = new File(dirName)
-          if (!dir.exists)
-            dir.mkdirs()
+          if (!dir.exists) dir.mkdirs()
           val outFile = new File(dir, if (tmpFile.getName.toLowerCase.endsWith(".png")) "ScalaTest-" + tmpFile.getName else "ScalaTest-" + tmpFile.getName + ".png")
-          new FileOutputStream(outFile).getChannel.transferFrom(
-            new FileInputStream(tmpFile).getChannel, 0, Long.MaxValue)
+          copy(tmpFile, outFile)
         case _ =>
           throw new UnsupportedOperationException("Screen capture is not support by " + driver.getClass.getName)
       }
@@ -4348,8 +4359,7 @@ trait WebBrowser {
           val tmpFile = takesScreenshot.getScreenshotAs(OutputType.FILE)
           val fileName = tmpFile.getName
           val outFile = new File(targetDir, if (fileName.toLowerCase.endsWith(".png")) fileName else fileName + ".png")
-          new FileOutputStream(outFile).getChannel.transferFrom(
-            new FileInputStream(tmpFile).getChannel, 0, Long.MaxValue)
+          copy(tmpFile, outFile)
           outFile
         case _ =>
           throw new UnsupportedOperationException("Screen capture is not support by " + driver.getClass.getName)
@@ -4630,15 +4640,26 @@ object HtmlUnit extends HtmlUnit
 trait Firefox extends WebBrowser with Driver with ScreenshotCapturer {
 
   /**
-   * The <code>FirefoxProfile</code> passed to the constructor of the <code>FirefoxDriver</code> returned by <code>webDriver</code>.
+   * The <code>FirefoxProfile</code> seet into <code>FirefoxOptions</code> returned by <code>firefoxOptions</code>.
    *
    * <p>
-   * The <code>FirefoxDriver</code> uses the <code>FirefoxProfile</code> defined as <code>firefoxProfile</code>. By default this is just a <code>new FirefoxProfile</code>.
+   * The <code>FirefoxOptions</code> uses the <code>FirefoxProfile</code> defined as <code>firefoxProfile</code>. By default this is just a <code>new FirefoxProfile</code>.
    * You can mutate this object to modify the profile, or override <code>firefoxProfile</code>.
    * </p>
    */
+  @deprecated("Use firefoxOptions instead", "3.1.0")
   val firefoxProfile = new FirefoxProfile()
 
+  /**
+   * The <code>FirefoxOptions</code> passed to the constructor of the <code>FirefoxDriver</code> returned by <code>webDriver</code>.
+   *
+   * <p>
+   * The <code>FirefoxDriver</code> uses the <code>FirefoxOptions</code> defined as <code>firefoxOptions</code>. By default this is just a <code>new FirefoxOptions</code>.
+   * You can mutate this object to modify the profile, or override <code>firefoxProfile</code>.
+   * </p>
+   */
+  val firefoxOptions = new FirefoxOptions().setProfile(firefoxProfile)
+
   /**
    * <code>WebBrowser</code> subtrait that defines an implicit <code>WebDriver</code> for Firefox (an <code>org.openqa.selenium.firefox.FirefoxDriver</code>), with a default
    * Firefox profile.
@@ -4648,7 +4669,7 @@ trait Firefox extends WebBrowser with Driver with ScreenshotCapturer {
    * You can mutate this object to modify the profile, or override <code>firefoxProfile</code>.
    * </p>
    */
-  implicit val webDriver: WebDriver = new FirefoxDriver(firefoxProfile)
+  implicit val webDriver: WebDriver = new FirefoxDriver(firefoxOptions)
 
   /**
    * Captures a screenshot and saves it as a file in the specified directory.

src/test/scala/org/scalatestplus/selenium/DriverSpec.scala

@@ -2,7 +2,7 @@ package org.scalatestplus.selenium
 
 import org.scalatest._
 import SharedHelpers.EventRecordingReporter
-import org.openqa.selenium.firefox.{FirefoxDriver, FirefoxProfile}
+import org.openqa.selenium.firefox.{FirefoxDriver, FirefoxOptions}
 import org.openqa.selenium.safari.SafariDriver
 import org.openqa.selenium.chrome.ChromeDriver
 import org.openqa.selenium.ie.InternetExplorerDriver
@@ -34,8 +34,6 @@ class DriverSpec extends funspec.AnyFunSpec {
     }
 
     class GoogleSearchSpecWithChrome extends GoogleSearchSpec with Chrome
-    class GoogleSearchSpecWithSafari extends GoogleSearchSpec with Safari
-    class GoogleSearchSpecWithInternetExplorer extends GoogleSearchSpec with InternetExplorer
     class GoogleSearchSpecWithFirefox extends GoogleSearchSpec with Firefox
 
     it("should work with Chrome", Slow) {
@@ -60,7 +58,7 @@ class DriverSpec extends funspec.AnyFunSpec {
 
     it("should work with Firefox", Slow) {
       // Cancel when Firefox is not available
-      try new FirefoxDriver(new FirefoxProfile) catch { case e: Throwable => cancel(e) }
+      try new FirefoxDriver(new FirefoxOptions) catch { case e: Throwable => cancel(e) }
       val s = new GoogleSearchSpecWithFirefox
       val rep = new EventRecordingReporter
       s.run(None, Args(reporter = rep))

src/test/scala/org/scalatestplus/selenium/ScreenshotSpec.scala

@@ -17,9 +17,6 @@ package org.scalatestplus.selenium
 
 import org.scalatest._
 import org.scalatest.time.SpanSugar
-import java.io.File
-import org.scalatest.Args
-import org.scalatestplus.selenium.SharedHelpers.SilentReporter
 import org.scalatest.Ignore
 import org.scalatest.matchers.should.Matchers