Merge pull request #235 from bgrainger/parameter-direction

Add better exception for unsupported ParameterDirection.

Author: bgrainger

src/MySqlConnector/MySqlClient/Caches/CachedProcedure.cs

@@ -75,7 +75,7 @@ internal MySqlParameterCollection AlignParamsWithDb(MySqlParameterCollection par
 					alignParam = index >= 0 ? parameterCollection[index] : throw new ArgumentException($"Parameter '{cachedParam.Name}' not found in the collection.");
 				}
 
-				if (alignParam.Direction == default(ParameterDirection))
+				if (!alignParam.HasSetDirection)
 					alignParam.Direction = cachedParam.Direction;
 				if (alignParam.DbType == default(DbType))
 					alignParam.DbType = cachedParam.DbType;
@@ -93,4 +93,4 @@ internal MySqlParameterCollection AlignParamsWithDb(MySqlParameterCollection par
 		readonly string m_component;
 		readonly ReadOnlyCollection<CachedParameter> m_parameters;
 	}
-}
+}

src/MySqlConnector/MySqlClient/CommandExecutors/StoredProcedureCommandExecutor.cs

@@ -37,7 +37,6 @@ public override async Task<DbDataReader> ExecuteReaderAsync(string commandText,
 				var outName = "@outParam" + i;
 				switch (param.Direction)
 				{
-					case 0:
 					case ParameterDirection.Input:
 					case ParameterDirection.InputOutput:
 						var inParam = param.WithParameterName(inName);
@@ -79,7 +78,7 @@ public override async Task<DbDataReader> ExecuteReaderAsync(string commandText,
 			var reader = (MySqlDataReader) await base.ExecuteReaderAsync(commandText, inParams, behavior, ioBehavior, cancellationToken).ConfigureAwait(false);
 			if (returnParam != null && await reader.ReadAsync(ioBehavior, cancellationToken).ConfigureAwait(false))
 				returnParam.Value = reader.GetValue(0);
-			
+
 			return reader;
 		}
 
@@ -115,4 +114,4 @@ internal void SetParams()
 		List<string> m_outParamNames;
 		private CancellationToken m_cancellationToken;
 	}
-}
+}

src/MySqlConnector/MySqlClient/CommandExecutors/TextCommandExecutor.cs

@@ -60,6 +60,8 @@ public virtual async Task<DbDataReader> ExecuteReaderAsync(string commandText, M
 					statementPreparerOptions |= StatementPreparerOptions.AllowUserVariables;
 				if (m_command.Connection.OldGuids)
 					statementPreparerOptions |= StatementPreparerOptions.OldGuids;
+				if (m_command.CommandType == CommandType.StoredProcedure)
+					statementPreparerOptions |= StatementPreparerOptions.AllowOutputParameters;
 				var preparer = new MySqlStatementPreparer(commandText, parameterCollection, statementPreparerOptions);
 				var payload = new PayloadData(preparer.ParseAndBindParameters());
 				try

src/MySqlConnector/MySqlClient/MySqlParameter.cs

@@ -13,7 +13,19 @@ public MySqlParameter()
 
 		public override DbType DbType { get; set; }
 
-		public override ParameterDirection Direction { get; set; }
+		public override ParameterDirection Direction
+		{
+			get => m_direction.GetValueOrDefault(ParameterDirection.Input);
+			set
+			{
+				if (value != ParameterDirection.Input && value != ParameterDirection.Output &&
+					value != ParameterDirection.InputOutput && value != ParameterDirection.ReturnValue)
+				{
+					throw new ArgumentOutOfRangeException(nameof(value), "{0} is not a supported value for ParameterDirection".FormatInvariant(value));
+				}
+				m_direction = value;
+			}
+		}
 
 		public override bool IsNullable { get; set; }
 
@@ -64,7 +76,7 @@ public override void ResetDbType()
 		private MySqlParameter(MySqlParameter other, string parameterName)
 		{
 			DbType = other.DbType;
-			Direction = other.Direction;
+			m_direction = other.m_direction;
 			IsNullable = other.IsNullable;
 			Size = other.Size;
 			ParameterName = parameterName ?? other.ParameterName;
@@ -75,6 +87,8 @@ private MySqlParameter(MySqlParameter other, string parameterName)
 #endif
 		}
 
+		internal bool HasSetDirection => m_direction.HasValue;
+
 		internal string NormalizedParameterName { get; private set; }
 
 		internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions options)
@@ -200,5 +214,6 @@ internal static string NormalizeParameterName(string name)
 		}
 
 		string m_name;
+		ParameterDirection? m_direction;
 	}
 }

src/MySqlConnector/MySqlClient/MySqlStatementPreparer.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Data;
 using System.IO;
 using System.Text;
 using MySql.Data.Serialization;
@@ -67,6 +68,9 @@ protected override void OnPositionalParameter(int index)
 			private void DoAppendParameter(int parameterIndex, int textIndex, int textLength)
 			{
 				AppendString(m_preparer.m_commandText, m_lastIndex, textIndex - m_lastIndex);
+				var parameter = m_preparer.m_parameters[parameterIndex];
+				if (parameter.Direction != ParameterDirection.Input && (m_preparer.m_options & StatementPreparerOptions.AllowOutputParameters) == 0)
+					throw new MySqlException("Only ParameterDirection.Input is supported when CommandType is Text (parameter name: {0})".FormatInvariant(parameter.ParameterName));
 				m_preparer.m_parameters[parameterIndex].AppendSqlString(m_writer, m_preparer.m_options);
 				m_lastIndex = textIndex + textLength;
 			}

src/MySqlConnector/MySqlClient/StatementPreparerOptions.cs

@@ -8,5 +8,6 @@ internal enum StatementPreparerOptions
 		None = 0,
 		AllowUserVariables = 1,
 		OldGuids = 2,
+		AllowOutputParameters = 4,
 	}
 }

tests/SideBySide/QueryTests.cs

@@ -609,6 +609,59 @@ private void UseReaderWithoutDisposingThread(object obj)
 			}
 		}
 
+		[Fact]
+		public void ParameterDefaults()
+		{
+			var parameter = new MySqlParameter();
+			Assert.Equal(DbType.AnsiString, parameter.DbType);
+			Assert.Equal(ParameterDirection.Input, parameter.Direction);
+			Assert.False(parameter.IsNullable);
+			Assert.Null(parameter.ParameterName);
+			Assert.Equal(0, parameter.Precision);
+			Assert.Equal(0, parameter.Scale);
+			Assert.Equal(0, parameter.Size);
+			Assert.Null(parameter.Value);
+		}
+
+		[Fact]
+		public void InputOutputParameter()
+		{
+			using (var cmd = m_database.Connection.CreateCommand())
+			{
+				cmd.CommandText = "set @param = 1234";
+
+				cmd.Parameters.Add(new MySqlParameter
+				{
+					ParameterName = "@param",
+					Direction = ParameterDirection.InputOutput,
+					Value = 123,
+				});
+
+				Assert.Throws<MySqlException>(() => cmd.ExecuteNonQuery());
+
+				// Issue #231: Assert.Equal(1234, cmd.Parameters["@param"].Value);
+			}
+		}
+
+		[Fact]
+		public void OutputParameter()
+		{
+			using (var cmd = m_database.Connection.CreateCommand())
+			{
+				cmd.CommandText = "set @param = 1234";
+
+				cmd.Parameters.Add(new MySqlParameter
+				{
+					ParameterName = "@param",
+					Direction = ParameterDirection.Output,
+				});
+
+				Assert.Throws<MySqlException>(() => cmd.ExecuteNonQuery());
+
+				// Issue #231: Assert.Equal(1234, cmd.Parameters["@param"].Value);
+			}
+		}
+
 		class BoolTest
 		{
 			public int Id { get; set; }