Sql: Retrieve Foreign Key information from the database

DataGateway.Service.Tests/SqlTests/MsSqlRestApiTests.cs

@@ -190,7 +190,7 @@ public class MsSqlRestApiTests : RestApiTestBase
                 // the insertion.
                 $"SELECT [categoryid],[pieceid],[categoryName],[piecesAvailable]," +
                 $"[piecesRequired] FROM { _Composite_NonAutoGenPK } " +
-                $"WHERE [categoryid] = 5 AND [pieceid] = 2 AND [categoryName] = 'Thriller' " +
+                $"WHERE [categoryid] = 5 AND [pieceid] = 2 AND [categoryName] = 'FairyTales' " +
                 $"AND [piecesAvailable] = 0 AND [piecesRequired] = 0 " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },
@@ -237,9 +237,9 @@ public class MsSqlRestApiTests : RestApiTestBase
             },
             {
                 "PutOne_Update_CompositeNonAutoGenPK_Test",
-                $"SELECT [categoryid], [pieceid], [categoryName],[piecesAvailable]," +
+                $"SELECT [categoryid], [pieceid], [categoryName], [piecesAvailable]," +
                 $"[piecesRequired] FROM { _Composite_NonAutoGenPK } " +
-                $"WHERE [categoryid] = 2 AND [pieceid] = 1 AND [categoryName] = 'History' " +
+                $"WHERE [categoryid] = 2 AND [pieceid] = 1 AND [categoryName] = 'SciFi' " +
                 $"AND [piecesAvailable] = 10  AND [piecesRequired] = 5 " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },
@@ -265,16 +265,17 @@ public class MsSqlRestApiTests : RestApiTestBase
             },
             {
                 "PutOne_Insert_AutoGenNonPK_Test",
-                $"SELECT [id], [title], [volume] FROM { _integration_AutoGenNonPK_TableName } " +
+                $"SELECT [id], [title], [volume], [categoryName] FROM { _integration_AutoGenNonPK_TableName } " +
                 $"WHERE id = { STARTING_ID_FOR_TEST_INSERTS } AND [title] = 'Star Trek' " +
+                $"AND [categoryName] = 'Suspense' " +
                 $"AND [volume] IS NOT NULL " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },
             {
                 "PutOne_Insert_CompositeNonAutoGenPK_Test",
                 $"SELECT [categoryid], [pieceid], [categoryName],[piecesAvailable]," +
                 $"[piecesRequired] FROM { _Composite_NonAutoGenPK } " +
-                $"WHERE [categoryid] = 3 AND [pieceid] = 1 AND [categoryName] = 'comics' " +
+                $"WHERE [categoryid] = 3 AND [pieceid] = 1 AND [categoryName] = 'SciFi' " +
                 $"AND [piecesAvailable] = 2 AND [piecesRequired] = 1 " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },
@@ -297,15 +298,15 @@ public class MsSqlRestApiTests : RestApiTestBase
                 "PatchOne_Insert_CompositeNonAutoGenPK_Test",
                 $"SELECT [categoryid], [pieceid], [categoryName],[piecesAvailable]," +
                 $"[piecesRequired] FROM { _Composite_NonAutoGenPK } " +
-                $"WHERE [categoryid] = 4 AND [pieceid] = 1 AND [categoryName] = 'Suspense' " +
+                $"WHERE [categoryid] = 4 AND [pieceid] = 1 AND [categoryName] = 'FairyTales' " +
                 $"AND [piecesAvailable] = 5 AND [piecesRequired] = 4 " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },
             {
                 "PatchOne_Insert_Default_Test",
                 $"SELECT [categoryid], [pieceid], [categoryName],[piecesAvailable]," +
                 $"[piecesRequired] FROM { _Composite_NonAutoGenPK } " +
-                $"WHERE [categoryid] = 7 AND [pieceid] = 1 AND [categoryName] = 'Drama' " +
+                $"WHERE [categoryid] = 7 AND [pieceid] = 1 AND [categoryName] = 'SciFi' " +
                 $"AND [piecesAvailable] = 0 AND [piecesRequired] = 0 " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },
@@ -332,7 +333,7 @@ public class MsSqlRestApiTests : RestApiTestBase
                 "PatchOne_Update_CompositeNonAutoGenPK_Test",
                 $"SELECT [categoryid], [pieceid], [categoryName],[piecesAvailable]," +
                 $"[piecesRequired] FROM { _Composite_NonAutoGenPK } " +
-                $"WHERE [categoryid] = 1 AND [pieceid] = 1 AND [categoryName] = 'books' " +
+                $"WHERE [categoryid] = 1 AND [pieceid] = 1 AND [categoryName] = 'SciFi' " +
                 $"AND [piecesAvailable]= 10 AND [piecesRequired] = 0 " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },

DataGateway.Service.Tests/SqlTests/MySqlRestApiTests.cs

@@ -353,7 +353,7 @@ SELECT JSON_OBJECT('categoryid', categoryid, 'pieceid', pieceid, 'categoryName',
                     FROM (
                         SELECT categoryid, pieceid, categoryName,piecesAvailable,piecesRequired
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 5 AND pieceid = 2 AND categoryName ='Thriller' AND piecesAvailable = 0
+                        WHERE categoryid = 5 AND pieceid = 2 AND categoryName ='FairyTales' AND piecesAvailable = 0
                         AND piecesRequired = 0
                     ) AS subq
                 "
@@ -436,7 +436,7 @@ SELECT JSON_OBJECT('categoryid', categoryid, 'pieceid', pieceid, 'categoryName',
                     FROM (
                         SELECT categoryid, pieceid, categoryName,piecesAvailable,piecesRequired
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 2 AND pieceid = 1 AND categoryName ='History' AND piecesAvailable = 10
+                        WHERE categoryid = 2 AND pieceid = 1 AND categoryName ='SciFi' AND piecesAvailable = 10
                         AND piecesRequired = 5
                     ) AS subq
                 "
@@ -466,9 +466,9 @@ AND issue_number is NULL
             },
             {
                 "PutOne_Insert_AutoGenNonPK_Test",
-                @"SELECT JSON_OBJECT('id', id, 'title', title, 'volume', volume ) AS data
+                @"SELECT JSON_OBJECT('id', id, 'title', title, 'volume', volume, 'categoryName', categoryName) AS data
                     FROM (
-                        SELECT id, title, volume
+                        SELECT id, title, volume, categoryName
                         FROM " + _integration_AutoGenNonPK_TableName + @"
                         WHERE id = " + $"{STARTING_ID_FOR_TEST_INSERTS}" + @" AND title = 'Star Trek'
                         AND volume IS NOT NULL
@@ -483,7 +483,7 @@ SELECT JSON_OBJECT('categoryid', categoryid, 'pieceid', pieceid, 'categoryName',
                     FROM (
                         SELECT categoryid, pieceid, categoryName,piecesAvailable,piecesRequired
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 3 AND pieceid = 1 AND categoryName ='comics' AND piecesAvailable = 2
+                        WHERE categoryid = 3 AND pieceid = 1 AND categoryName ='SciFi' AND piecesAvailable = 2
                         AND piecesRequired = 1
                     ) AS subq
                 "
@@ -520,7 +520,7 @@ SELECT JSON_OBJECT('categoryid', categoryid, 'pieceid', pieceid, 'categoryName',
                     FROM (
                         SELECT categoryid, pieceid, categoryName,piecesAvailable,piecesRequired
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 4 AND pieceid = 1 AND categoryName ='Suspense' AND piecesAvailable = 5
+                        WHERE categoryid = 4 AND pieceid = 1 AND categoryName ='FairyTales' AND piecesAvailable = 5
                         AND piecesRequired = 4
                     ) AS subq
                 "
@@ -533,7 +533,7 @@ SELECT JSON_OBJECT('categoryid', categoryid, 'pieceid', pieceid, 'categoryName',
                     FROM (
                         SELECT categoryid, pieceid, categoryName,piecesAvailable,piecesRequired
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 7 AND pieceid = 1 AND categoryName ='Drama' AND piecesAvailable = 0
+                        WHERE categoryid = 7 AND pieceid = 1 AND categoryName ='SciFi' AND piecesAvailable = 0
                         AND piecesRequired = 0
                     ) AS subq
                 "
@@ -581,7 +581,7 @@ SELECT JSON_OBJECT('categoryid', categoryid, 'pieceid', pieceid, 'categoryName',
                     FROM (
                         SELECT categoryid, pieceid, categoryName,piecesAvailable,piecesRequired
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 1 AND pieceid = 1 AND categoryName ='books' AND piecesAvailable = 10
+                        WHERE categoryid = 1 AND pieceid = 1 AND categoryName ='SciFi' AND piecesAvailable = 10
                         AND piecesRequired = 0
                     ) AS subq
                 "

DataGateway.Service.Tests/SqlTests/PostgreSqlRestApiTests.cs

@@ -336,7 +336,7 @@ SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT categoryid, pieceid, ""categoryName"", ""piecesAvailable"", ""piecesRequired""
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 5 AND pieceid = 2 AND ""categoryName"" = 'Thriller'
+                        WHERE categoryid = 5 AND pieceid = 2 AND ""categoryName"" = 'FairyTales'
                             AND ""piecesAvailable"" = 0 AND ""piecesRequired"" = 0
                     ) AS subq
                 "
@@ -417,7 +417,7 @@ SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT categoryid, pieceid, ""categoryName"", ""piecesAvailable"", ""piecesRequired""
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 2 AND pieceid = 1 AND ""categoryName"" = 'History'
+                        WHERE categoryid = 2 AND pieceid = 1 AND ""categoryName"" = 'SciFi'
                             AND ""piecesAvailable"" = 10 AND ""piecesRequired"" = 5
                     ) AS subq
                 "
@@ -457,7 +457,7 @@ SELECT to_jsonb(subq) AS data
                 @"
                     SELECT to_jsonb(subq) AS data
                     FROM (
-                        SELECT id, title, volume
+                        SELECT id, title, volume, ""categoryName""
                         FROM " + _integration_AutoGenNonPK_TableName + @"
                         WHERE id = " + STARTING_ID_FOR_TEST_INSERTS + @"
                             AND title = 'Star Trek' AND volume IS NOT NULL
@@ -471,7 +471,7 @@ SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT categoryid, pieceid, ""categoryName"", ""piecesAvailable"", ""piecesRequired""
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 3 AND pieceid = 1 AND ""categoryName"" = 'comics'
+                        WHERE categoryid = 3 AND pieceid = 1 AND ""categoryName"" = 'SciFi'
                             AND ""piecesAvailable"" = 2 AND ""piecesRequired"" = 1
                     ) AS subq
                 "
@@ -506,7 +506,7 @@ SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT categoryid, pieceid, ""categoryName"", ""piecesAvailable"", ""piecesRequired""
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 4 AND pieceid = 1 AND ""categoryName"" = 'Suspense'
+                        WHERE categoryid = 4 AND pieceid = 1 AND ""categoryName"" = 'FairyTales'
                             AND ""piecesAvailable"" = 5 AND ""piecesRequired"" = 4
                     ) AS subq
                 "
@@ -518,7 +518,7 @@ SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT categoryid, pieceid, ""categoryName"", ""piecesAvailable"", ""piecesRequired""
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 7 AND pieceid = 1 AND ""categoryName"" = 'Drama'
+                        WHERE categoryid = 7 AND pieceid = 1 AND ""categoryName"" = 'SciFi'
                             AND ""piecesAvailable"" = 0 AND ""piecesRequired"" = 0
                     ) AS subq
                 "
@@ -563,7 +563,7 @@ SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT categoryid, pieceid, ""categoryName"", ""piecesAvailable"", ""piecesRequired""
                         FROM " + _Composite_NonAutoGenPK + @"
-                        WHERE categoryid = 1 AND pieceid = 1 AND ""categoryName"" = 'books'
+                        WHERE categoryid = 1 AND pieceid = 1 AND ""categoryName"" = 'SciFi'
                             AND ""piecesAvailable"" = 10 AND ""piecesRequired"" = 0
                     ) AS subq
                 "

DataGateway.Service.Tests/SqlTests/RestApiTestBase.cs

@@ -391,7 +391,7 @@ await SetupAndRunRestApiTest(
             {
                 ""categoryid"": ""5"",
                 ""pieceid"": ""2"",
-                ""categoryName"":""Thriller""
+                ""categoryName"":""FairyTales""
             }";
 
             expectedLocationHeader = $"categoryid/5/pieceid/2";
@@ -521,7 +521,7 @@ await SetupAndRunRestApiTest(
 
             requestBody = @"
             {
-               ""categoryName"":""History"",
+               ""categoryName"":""SciFi"",
                ""piecesAvailable"":""10"",
                ""piecesRequired"":""5""
             }";
@@ -633,7 +633,8 @@ await SetupAndRunRestApiTest(
             // that is autogenerated.
             requestBody = @"
             {
-                ""title"": ""Star Trek""
+                ""title"": ""Star Trek"",
+                ""categoryName"" : ""Suspense""
             }";
 
             expectedLocationHeader = $"id/{STARTING_ID_FOR_TEST_INSERTS}";
@@ -651,7 +652,7 @@ await SetupAndRunRestApiTest(
 
             requestBody = @"
             {
-               ""categoryName"":""comics"",
+               ""categoryName"":""SciFi"",
                ""piecesAvailable"":""2"",
                ""piecesRequired"":""1""
             }";
@@ -719,7 +720,7 @@ await SetupAndRunRestApiTest(
 
             requestBody = @"
             {
-                ""categoryName"": ""Suspense"",
+                ""categoryName"": ""FairyTales"",
                 ""piecesAvailable"":""5"",
                 ""piecesRequired"":""4""
             }";
@@ -739,7 +740,7 @@ await SetupAndRunRestApiTest(
 
             requestBody = @"
             {
-                ""categoryName"": ""Drama""
+                ""categoryName"": ""SciFi""
             }";
             expectedLocationHeader = $"categoryid/7/pieceid/1";
 

DataGateway.Service.Tests/SqlTests/SqlMetadataProviderTests.cs

@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.IO;
 using Azure.DataGateway.Service.Models;
 using Azure.DataGateway.Service.Services;
@@ -31,6 +32,13 @@ SqlGraphQLFileMetadataProvider expectedMetadataProvider
                     actualTableDefinition.PrimaryKey,
                     $"Did not find the expected primary keys for table {tableName}");
 
+                CollectionAssert.AreEqual(
+                    new SortedDictionary<string, ForeignKeyDefinition>
+                        (expectedTableDefinition.ForeignKeys),
+                    new SortedDictionary<string, ForeignKeyDefinition>
+                        (actualTableDefinition.ForeignKeys),
+                    $"Did not find the expected foreign keys for table {tableName}");
+
                 foreach ((string columnName, ColumnDefinition expectedColumnDefinition) in expectedTableDefinition.Columns)
                 {
                     ColumnDefinition actualColumnDefinition;

DataGateway.Service.Tests/SqlTests/SqlTestBase.cs

@@ -60,30 +60,30 @@ protected static async Task InitializeTestFixture(TestContext context, string te
             {
                 case TestCategory.POSTGRESQL:
                     _queryBuilder = new PostgresQueryBuilder();
-                    _metadataStoreProvider = new SqlGraphQLFileMetadataProvider(
-                        config,
-                        new PostgreSqlMetadataProvider(config));
                     _defaultSchemaName = "public";
                     _dbExceptionParser = new PostgresDbExceptionParser();
                     _queryExecutor = new QueryExecutor<NpgsqlConnection>(config, _dbExceptionParser);
+                    _metadataStoreProvider = new SqlGraphQLFileMetadataProvider(
+                        config,
+                        new PostgreSqlMetadataProvider(config, _queryExecutor, _queryBuilder));
                     break;
                 case TestCategory.MSSQL:
                     _queryBuilder = new MsSqlQueryBuilder();
-                    _metadataStoreProvider = new SqlGraphQLFileMetadataProvider(
-                        config,
-                        new MsSqlMetadataProvider(config));
                     _defaultSchemaName = "dbo";
                     _dbExceptionParser = new DbExceptionParserBase();
                     _queryExecutor = new QueryExecutor<SqlConnection>(config, _dbExceptionParser);
+                    _metadataStoreProvider = new SqlGraphQLFileMetadataProvider(
+                        config,
+                        new MsSqlMetadataProvider(config, _queryExecutor, _queryBuilder));
                     break;
                 case TestCategory.MYSQL:
                     _queryBuilder = new MySqlQueryBuilder();
-                    _metadataStoreProvider = new SqlGraphQLFileMetadataProvider(
-                        config,
-                        new MySqlMetadataProvider(config));
                     _defaultSchemaName = "mysql";
                     _dbExceptionParser = new MySqlDbExceptionParser();
                     _queryExecutor = new QueryExecutor<MySqlConnection>(config, _dbExceptionParser);
+                    _metadataStoreProvider = new SqlGraphQLFileMetadataProvider(
+                         config,
+                         new MySqlMetadataProvider(config, _queryExecutor, _queryBuilder));
                     break;
             }