Skip to content

Commit

Permalink
Adding additional exception types for .NET
Browse files Browse the repository at this point in the history
Introducing JavaScriptException, MoveTargetOutOfBoundsException, and
WebDriverArgumentException. These all descend from WebDriverException,
but having these distinct exception types allows users to better
distinguish between differing error conditions.
  • Loading branch information
jimevans committed Apr 2, 2019
1 parent ad4a366 commit 5239ddb
Show file tree
Hide file tree
Showing 4 changed files with 223 additions and 3 deletions.
73 changes: 73 additions & 0 deletions dotnet/src/webdriver/JavaScriptException.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// <copyright file="JavaScriptException.cs" company="WebDriver Committers">
// 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.
// </copyright>

using System;
using System.Runtime.Serialization;

namespace OpenQA.Selenium
{
/// <summary>
/// Represents exceptions that are thrown when an error occurs during execution of JavaScript.
/// </summary>
[Serializable]
public class JavaScriptException : WebDriverException
{
/// <summary>
/// Initializes a new instance of the <see cref="JavaScriptException"/> class.
/// </summary>
public JavaScriptException()
: base()
{
}

/// <summary>
/// Initializes a new instance of the <see cref="JavaScriptException"/> class with
/// a specified error message.
/// </summary>
/// <param name="message">The message that describes the error.</param>
public JavaScriptException(string message)
: base(message)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="JavaScriptException"/> class with
/// a specified error message and a reference to the inner exception that is the
/// cause of this exception.
/// </summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
/// <param name="innerException">The exception that is the cause of the current exception,
/// or <see langword="null"/> if no inner exception is specified.</param>
public JavaScriptException(string message, Exception innerException)
: base(message, innerException)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="JavaScriptException"/> class with serialized data.
/// </summary>
/// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized
/// object data about the exception being thrown.</param>
/// <param name="context">The <see cref="StreamingContext"/> that contains contextual
/// information about the source or destination.</param>
protected JavaScriptException(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
}
}
74 changes: 74 additions & 0 deletions dotnet/src/webdriver/MoveTargetOutOfBoundsException.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
// <copyright file="MoveTargetOutOfBoundsException.cs" company="WebDriver Committers">
// 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.
// </copyright>

using System;
using System.Runtime.Serialization;

namespace OpenQA.Selenium
{
/// <summary>
/// Represents exceptions that are thrown when an attempt is made to move the mouse
/// pointer outside the bounds of the browser view port.
/// </summary>
[Serializable]
public class MoveTargetOutOfBoundsException : WebDriverException
{
/// <summary>
/// Initializes a new instance of the <see cref="WebDriverTimeoutException"/> class.
/// </summary>
public MoveTargetOutOfBoundsException()
: base()
{
}

/// <summary>
/// Initializes a new instance of the <see cref="MoveTargetOutOfBoundsException"/> class with
/// a specified error message.
/// </summary>
/// <param name="message">The message that describes the error.</param>
public MoveTargetOutOfBoundsException(string message)
: base(message)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="MoveTargetOutOfBoundsException"/> class with
/// a specified error message and a reference to the inner exception that is the
/// cause of this exception.
/// </summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
/// <param name="innerException">The exception that is the cause of the current exception,
/// or <see langword="null"/> if no inner exception is specified.</param>
public MoveTargetOutOfBoundsException(string message, Exception innerException)
: base(message, innerException)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="MoveTargetOutOfBoundsException"/> class with serialized data.
/// </summary>
/// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized
/// object data about the exception being thrown.</param>
/// <param name="context">The <see cref="StreamingContext"/> that contains contextual
/// information about the source or destination.</param>
protected MoveTargetOutOfBoundsException(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
}
}
6 changes: 3 additions & 3 deletions dotnet/src/webdriver/Remote/RemoteWebDriver.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1406,13 +1406,13 @@ private static void UnpackAndThrowOnError(Response errorResponse)
throw new WebDriverException(errorMessage);

case WebDriverResult.InvalidArgument:
throw new WebDriverException(errorMessage);
throw new WebDriverArgumentException(errorMessage);

case WebDriverResult.UnexpectedJavaScriptError:
throw new WebDriverException(errorMessage);
throw new JavaScriptException(errorMessage);

case WebDriverResult.MoveTargetOutOfBounds:
throw new WebDriverException(errorMessage);
throw new MoveTargetOutOfBoundsException(errorMessage);

default:
throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, "{0} ({1})", errorMessage, errorResponse.Status));
Expand Down
73 changes: 73 additions & 0 deletions dotnet/src/webdriver/WebDriverArgumentException.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// <copyright file="WebDriverArgumentException.cs" company="WebDriver Committers">
// 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.
// </copyright>

using System;
using System.Runtime.Serialization;

namespace OpenQA.Selenium
{
/// <summary>
/// Represents exceptions that are thrown when an invalid argument is passed to a WebDriver command.
/// </summary>
[Serializable]
public class WebDriverArgumentException : WebDriverException
{
/// <summary>
/// Initializes a new instance of the <see cref="WebDriverArgumentException"/> class.
/// </summary>
public WebDriverArgumentException()
: base()
{
}

/// <summary>
/// Initializes a new instance of the <see cref="WebDriverArgumentException"/> class with
/// a specified error message.
/// </summary>
/// <param name="message">The message that describes the error.</param>
public WebDriverArgumentException(string message)
: base(message)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="WebDriverArgumentException"/> class with
/// a specified error message and a reference to the inner exception that is the
/// cause of this exception.
/// </summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
/// <param name="innerException">The exception that is the cause of the current exception,
/// or <see langword="null"/> if no inner exception is specified.</param>
public WebDriverArgumentException(string message, Exception innerException)
: base(message, innerException)
{
}

/// <summary>
/// Initializes a new instance of the <see cref="WebDriverArgumentException"/> class with serialized data.
/// </summary>
/// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized
/// object data about the exception being thrown.</param>
/// <param name="context">The <see cref="StreamingContext"/> that contains contextual
/// information about the source or destination.</param>
protected WebDriverArgumentException(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
}
}

0 comments on commit 5239ddb

Please sign in to comment.