Refactor AppConfig feature flags.

bgrainger · bgrainger · commit 7d2f82751017 · 2017-06-27T05:02:36.000-07:00
Moving supported features to an enum will make it easier to extend
config.json with additional features.
diff --git a/.ci/config/config.buffer.json b/.ci/config/config.buffer.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;Use Affected Rows=true;BufferResultSets=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.compression+ssl.json b/.ci/config/config.compression+ssl.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=ssltest;password=test;port=3306;database=mysqltest;ssl mode=required;use compression=true;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.compression.json b/.ci/config/config.compression.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;UseCompression=true;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.json b/.ci/config/config.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.ssl.json b/.ci/config/config.ssl.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=ssltest;password=test;port=3306;database=mysqltest;ssl mode=required;certificate file=../../../../../.ci/server/certs/ssl-client.pfx;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.uds+ssl.json b/.ci/config/config.uds+ssl.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=./../../../../../.ci/mysqld/mysqld.sock;user id=ssltest;password=test;database=mysqltest;ssl mode=required;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.uds.json b/.ci/config/config.uds.json
@@ -3,8 +3,7 @@
       "ConnectionString": "server=./../../../../../.ci/run/mysql/mysqld.sock;user id=mysqltest;password='test;key=\"val';database=mysqltest;ssl mode=none;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportsCachedProcedures": true,
-      "SupportsJson": true,
+      "SupportedFeatures": "Json,StoredProcedures",
       "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/use-config.sh b/.ci/use-config.sh
@@ -2,7 +2,7 @@
 cd $(dirname $0)/config
 
 display_usage() {
-    echo -e "\nUsage:\n$0 [config.json script] [host] [port] [name] [supports json]\n"
+    echo -e "\nUsage:\n$0 [config.json script] [host] [port] [name] [features]\n"
 }
 
 # check whether user had supplied -h or --help . If yes display usage
@@ -45,5 +45,5 @@ fi
 
 if [ $# -ge 5 ]
 then
-    sed -i "s/\"SupportsJson\": true/\"SupportsJson\": $5/g" ../../tests/SideBySide/config.json
+    sed -i "s/\"SupportedFeatures\": \".*\"/\"SupportedFeatures\": \"$5\"/g" ../../tests/SideBySide/config.json
 fi
diff --git a/.travis.yml b/.travis.yml
@@ -5,13 +5,13 @@ services: docker
 env:
   - IMAGE=mysql:5.7
     NAME=mysql
-    SUPPORTS_JSON=true
+    FEATURES=Json,StoredProcedures
   - IMAGE=percona:5.7
     NAME=percona
-    SUPPORTS_JSON=true
+    FEATURES=Json,StoredProcedures
   - IMAGE=mariadb:10.3
     NAME=mariadb
-    SUPPORTS_JSON=false
+    FEATURES=StoredProcedures
 
 before_install:
 - .ci/docker-run.sh $IMAGE $NAME 3307
@@ -24,13 +24,13 @@ script:
 - dotnet restore
 - dotnet test tests/MySqlConnector.Tests/MySqlConnector.Tests.csproj -c Release -f netcoreapp1.1.1
 - dotnet build tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
-- echo 'Executing tests with No Compression, No SSL' && ./.ci/use-config.sh config.json 172.17.0.1 3307 $NAME $SUPPORTS_JSON && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with No Compression, No SSL' && ./.ci/use-config.sh config.json 172.17.0.1 3307 $NAME $FEATURES && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
 - echo 'Executing Debug Only tests' && time dotnet test tests/SideBySide/SideBySide.csproj -c Debug -f netcoreapp1.1.1 --filter "FullyQualifiedName~SideBySide.DebugOnlyTests"
-- echo 'Executing tests with Compression, No SSL' && ./.ci/use-config.sh config.compression.json 172.17.0.1 3307 $NAME $SUPPORTS_JSON && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
-- echo 'Executing tests with No Compression, SSL' && ./.ci/use-config.sh config.ssl.json 172.17.0.1 3307 $NAME $SUPPORTS_JSON && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
-- echo 'Executing tests with Compression, SSL' && ./.ci/use-config.sh config.compression+ssl.json 172.17.0.1 3307 $NAME $SUPPORTS_JSON && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
-- echo 'Executing tests with Unix Domain Socket, No Compression, No SSL' && ./.ci/use-config.sh config.uds.json 172.17.0.1 3307 $NAME $SUPPORTS_JSON && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
-- echo 'Executing tests with Buffering, No Compression, No SSL' && ./.ci/use-config.sh config.buffer.json 172.17.0.1 3307 $NAME $SUPPORTS_JSON && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with Compression, No SSL' && ./.ci/use-config.sh config.compression.json 172.17.0.1 3307 $NAME $FEATURES && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with No Compression, SSL' && ./.ci/use-config.sh config.ssl.json 172.17.0.1 3307 $NAME $FEATURES && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with Compression, SSL' && ./.ci/use-config.sh config.compression+ssl.json 172.17.0.1 3307 $NAME $FEATURES && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with Unix Domain Socket, No Compression, No SSL' && ./.ci/use-config.sh config.uds.json 172.17.0.1 3307 $NAME $FEATURES && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with Buffering, No Compression, No SSL' && ./.ci/use-config.sh config.buffer.json 172.17.0.1 3307 $NAME $FEATURES && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
 
 after_script:
 - chmod +x .ci/build-docs.sh && ./.ci/build-docs.sh
diff --git a/tests/SideBySide/AppConfig.cs b/tests/SideBySide/AppConfig.cs
@@ -51,9 +51,9 @@ public static IConfiguration Config
 
 		public static string SecondaryDatabase => Config.GetValue<string>("Data:SecondaryDatabase");
 
-		public static bool SupportsCachedProcedures => Config.GetValue<bool>("Data:SupportsCachedProcedures");
+		public static ServerFeatures SupportedFeatures => (ServerFeatures) Enum.Parse(typeof(ServerFeatures), Config.GetValue<string>("Data:SupportedFeatures"));
 
-		public static bool SupportsJson => Config.GetValue<bool>("Data:SupportsJson");
+		public static bool SupportsJson => SupportedFeatures.HasFlag(ServerFeatures.Json);
 
 		public static string MySqlBulkLoaderCsvFile => ExpandVariables(Config.GetValue<string>("Data:MySqlBulkLoaderCsvFile"));
 		public static string MySqlBulkLoaderLocalCsvFile => ExpandVariables(Config.GetValue<string>("Data:MySqlBulkLoaderLocalCsvFile"));
diff --git a/tests/SideBySide/Attributes.cs b/tests/SideBySide/Attributes.cs
@@ -4,22 +4,64 @@
 
 namespace SideBySide
 {
-	public class CachedProcedureTheoryAttribute : TheoryAttribute
+	public class RequiresFeatureFactAttribute : FactAttribute
 	{
-		public CachedProcedureTheoryAttribute()
+		public RequiresFeatureFactAttribute()
 		{
-			if(!AppConfig.SupportsCachedProcedures)
-				Skip = "No Cached Procedure Support";
 		}
+
+		public RequiresFeatureFactAttribute(ServerFeatures features)
+		{
+			if ((AppConfig.SupportedFeatures & features) != features)
+				Skip = "Doesn't support " + features;
+		}
+
+		public bool RequiresSsl
+		{
+			get => m_requiresSsl;
+			set
+			{
+				m_requiresSsl = value;
+				if (m_requiresSsl)
+				{
+					var csb = AppConfig.CreateConnectionStringBuilder();
+					if (csb.SslMode == MySqlSslMode.None || csb.SslMode == MySqlSslMode.Preferred)
+						Skip = "SSL not explicitly required";
+				}
+			}
+		}
+
+		private bool m_requiresSsl;
 	}
 
-	public class JsonTheoryAttribute : TheoryAttribute
+	public class RequiresFeatureTheoryAttribute : TheoryAttribute
 	{
-		public JsonTheoryAttribute()
+		public RequiresFeatureTheoryAttribute()
+		{
+		}
+
+		public RequiresFeatureTheoryAttribute(ServerFeatures features)
+		{
+			if ((AppConfig.SupportedFeatures & features) != features)
+				Skip = "Doesn't support " + features;
+		}
+
+		public bool RequiresSsl
 		{
-			if(!AppConfig.SupportsJson)
-				Skip = "No JSON Support";
+			get => m_requiresSsl;
+			set
+			{
+				m_requiresSsl = value;
+				if (m_requiresSsl)
+				{
+					var csb = AppConfig.CreateConnectionStringBuilder();
+					if (csb.SslMode == MySqlSslMode.None || csb.SslMode == MySqlSslMode.Preferred)
+						Skip = "SSL not explicitly required";
+				}
+			}
 		}
+
+		private bool m_requiresSsl;
 	}
 
 	public class PasswordlessUserFactAttribute : FactAttribute
@@ -97,24 +139,4 @@ public SecondaryDatabaseRequiredFactAttribute()
 				Skip = "No SecondaryDatabase specified.";
 		}
 	}
-
-	public class SslRequiredConnectionFactAttribute : FactAttribute
-	{
-		public SslRequiredConnectionFactAttribute()
-		{
-			var csb = AppConfig.CreateConnectionStringBuilder();
-			if(csb.SslMode == MySqlSslMode.None || csb.SslMode == MySqlSslMode.Preferred)
-				Skip = "SSL not explicitly required";
-		}
-	}
-
-	public class SslRequiredConnectionTheoryAttribute : TheoryAttribute
-	{
-		public SslRequiredConnectionTheoryAttribute()
-		{
-			var csb = AppConfig.CreateConnectionStringBuilder();
-			if(csb.SslMode == MySqlSslMode.None || csb.SslMode == MySqlSslMode.Preferred)
-				Skip = "SSL not explicitly required";
-		}
-	}
 }
diff --git a/tests/SideBySide/DataTypes.cs b/tests/SideBySide/DataTypes.cs
@@ -617,15 +617,15 @@ private static byte[] CreateByteArray(int size)
 			return data;
 		}
 
-		[JsonTheory]
+		[RequiresFeatureTheory(ServerFeatures.Json)]
 		[InlineData("Value", new[] { null, "NULL", "BOOLEAN", "ARRAY", "ARRAY", "ARRAY", "INTEGER", "INTEGER", "OBJECT", "OBJECT" })]
 		public void JsonType(string column, string[] expectedTypes)
 		{
 			var types = m_database.Connection.Query<string>(@"select JSON_TYPE(value) from datatypes_json_core order by rowid;").ToList();
 			Assert.Equal(expectedTypes, types);
 		}
 
-		[JsonTheory]
+		[RequiresFeatureTheory(ServerFeatures.Json)]
 		[InlineData("value", new[] { null, "null", "true", "[]", "[0]", "[1]", "0", "1", "{}", "{\"a\": \"b\"}" })]
 		public void QueryJson(string column, string[] expected)
 		{
diff --git a/tests/SideBySide/ServerFeatures.cs b/tests/SideBySide/ServerFeatures.cs
@@ -0,0 +1,12 @@
+﻿using System;
+
+namespace SideBySide
+{
+	[Flags]
+	public enum ServerFeatures
+	{
+		None = 0,
+		Json = 1,
+		StoredProcedures = 2,
+	}
+}
diff --git a/tests/SideBySide/SslTests.cs b/tests/SideBySide/SslTests.cs
@@ -1,6 +1,4 @@
-﻿using System;
-using System.Data;
-using System.IO;
+﻿using System.IO;
 using System.Threading.Tasks;
 using MySql.Data.MySqlClient;
 using Xunit;
@@ -14,7 +12,7 @@ public SslTests(DatabaseFixture database)
 			m_database = database;
 		}
 
-		[SslRequiredConnectionFact]
+		[RequiresFeatureFact(RequiresSsl = true)]
 		public async Task ConnectSslPreferred()
 		{
 			var csb = AppConfig.CreateConnectionStringBuilder();
@@ -43,7 +41,7 @@ public async Task ConnectSslPreferred()
 			}
 		}
 
-		[SslRequiredConnectionTheory]
+		[RequiresFeatureTheory(RequiresSsl = true)]
 		[InlineData("ssl-client.pfx", null, null)]
 		[InlineData("ssl-client-pw-test.pfx", "test", null)]
 		[InlineData("ssl-client-cert.pem", null, null)]
@@ -76,7 +74,7 @@ public async Task ConnectSslClientCertificate(string certFile, string certFilePa
 			}
 		}
 
-		[SslRequiredConnectionFact]
+		[RequiresFeatureFact(RequiresSsl = true)]
 		public async Task ConnectSslBadClientCertificate()
 		{
 			var csb = AppConfig.CreateConnectionStringBuilder();
@@ -96,7 +94,7 @@ public async Task ConnectSslBadClientCertificate()
 #if BASELINE
 		[Fact(Skip = "MySql.Data does not support CACertificateFile")]
 #else
-		[SslRequiredConnectionFact]
+		[RequiresFeatureFact(RequiresSsl = true)]
 #endif
 		public async Task ConnectSslBadCaCertificate()
 		{
diff --git a/tests/SideBySide/StoredProcedureTests.cs b/tests/SideBySide/StoredProcedureTests.cs
@@ -55,7 +55,7 @@ public async Task StoredProcedureEcho(string procedureType, string executorType)
 			}
 		}
 
-		[CachedProcedureTheory]
+		[RequiresFeatureTheory(ServerFeatures.StoredProcedures)]
 		[InlineData("FUNCTION")]
 		[InlineData("PROCEDURE")]
 		public async Task StoredProcedureEchoException(string procedureType)
@@ -138,7 +138,7 @@ public async Task StoredProcedureCircle(string executorType)
 			}
 		}
 
-		[CachedProcedureTheory]
+		[RequiresFeatureTheory(ServerFeatures.StoredProcedures)]
 		[InlineData("NonQuery")]
 		[InlineData("Scalar")]
 		[InlineData("Reader")]
