Simplify Update Entity logic (#52)

* replace name to config

* symplifying update logic

* adding validations

* added more tests

* resolved comments

* adding test description

* updating file names for Add and Update EntityTests

* adding comments and tests

* adding class comments

* adding class comments

* adding more tests and comments

* updated accessebiity of some methods

* updating tests

* adding TODO for policy support

* updating few comments

* updated function summary

* minor change

* fixed comments

* refactoring changes

Author: abhishekkumams

Hawaii-Cli/.gitignore

@@ -6,6 +6,8 @@
 # Generated Files
 **/bin
 **/obj
+/coveragereport
+**/TestResults
 
 # Local History for Visual Studio
 .localhistory/

Hawaii-Cli/README.md

@@ -33,7 +33,7 @@ export PATH=$PATH:~/.dotnet/tools
 
 ### Generate the config:
 ```
-hawaii init -name <<filename>> --database-type <<db_type>> --connection-string <<connection_string>>
+hawaii init --name <<filename>> --database-type <<db_type>> --connection-string <<connection_string>>
 ```
 ### Add entity to the config:
 ```

Hawaii-Cli/src/Models/ConfigGenerator.cs

@@ -2,6 +2,7 @@
 using System.Text.Json.Serialization;
 using Azure.DataGateway.Config;
 using Humanizer;
+using Hawaii.Cli.Models;
 using Action = Azure.DataGateway.Config.Action;
 
 /// <summary>
@@ -18,6 +19,8 @@ public enum CRUD
     }
     public class Utils
     {
+        public const string WILDCARD = "*";
+
         /// <summary>
         /// creates the rest object which can be either a boolean value
         /// or a RestEntitySettings object containing api route based on the input
@@ -83,6 +86,11 @@ public static Action GetAction(string action, string? fieldsToInclude, string? f
         /// </summary>
         public static Action? ToActionObject(JsonElement element)
         {
+            if (element.ValueKind is JsonValueKind.String)
+            {
+                return new Action(element.GetRawText(), Policy: null, Fields: null);
+            }
+
             string json = element.GetRawText();
             return JsonSerializer.Deserialize<Action>(json);
         }
@@ -99,7 +107,7 @@ public static object[] CreateActions(string actions, string? fieldsToInclude, st
                 return actions.Split(",");
             }
 
-            if ("*".Equals(actions))
+            if (actions is WILDCARD)
             {
                 action_items = new object[] { GetAction(actions, fieldsToInclude, fieldsToExclude) };
             }
@@ -134,18 +142,6 @@ public static PermissionSetting CreatePermissions(string role, string actions, s
             return new PermissionSetting(role, CreateActions(actions, fieldsToInclude, fieldsToExclude));
         }
 
-        /// <summary>
-        /// Add a new PermissionSetting object(based on role, actions, fieldsToInclude, and fieldsToExclude) in the existing array of PermissionSetting.
-        /// returns the updated array of PermissionSetting.
-        /// </summary>
-        public static PermissionSetting[] AddNewPermissions(PermissionSetting[] currentPermissions, string role, string actions, string? fieldsToInclude, string? fieldsToExclude)
-        {
-            List<PermissionSetting>? currentPermissionsList = currentPermissions.ToList();
-            PermissionSetting? permissionSetting = CreatePermissions(role, actions, fieldsToInclude, fieldsToExclude);
-            currentPermissionsList.Add(permissionSetting);
-            return currentPermissionsList.ToArray();
-        }
-
         /// <summary>
         /// JsonNamingPolicy to convert all the keys in Json as lower case string.
         /// </summary>
@@ -167,8 +163,7 @@ public static JsonSerializerOptions GetSerializationOptions()
             {
                 WriteIndented = true,
                 DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
-                PropertyNamingPolicy = new LowerCaseNamingPolicy(),
-                PropertyNameCaseInsensitive = true
+                PropertyNamingPolicy = new LowerCaseNamingPolicy()
             };
 
             options.Converters.Add(new JsonStringEnumConverter(namingPolicy: new LowerCaseNamingPolicy()));
@@ -180,29 +175,14 @@ public static JsonSerializerOptions GetSerializationOptions()
         /// </summary>
         public static string GetCRUDOperation(JsonElement op)
         {
-            if (JsonValueKind.String.Equals(op.ValueKind))
+            if (op.ValueKind is JsonValueKind.String)
             {
                 return op.ToString();
             }
 
             return ToActionObject(op)!.Name;
         }
 
-        /// <summary>
-        /// returns the Cardinality from the given string(one, or many).
-        /// </summary>
-        public static Cardinality GetCardinalityTypeFromString(string cardinality)
-        {
-            if ("one".Equals(cardinality, StringComparison.OrdinalIgnoreCase))
-                return Cardinality.One;
-            else if ("many".Equals(cardinality, StringComparison.OrdinalIgnoreCase))
-                return Cardinality.Many;
-            else
-            {
-                throw new NotSupportedException();
-            }
-        }
-
         /// <summary>
         /// returns the default global settings based on dbType.
         /// </summary>
@@ -234,20 +214,81 @@ public static Dictionary<GlobalSettingsType, object> GetDefaultGlobalSettings(Da
         //         "allow-credentials": true
         //     },
         //     "authentication": {
-        //         "provider": "EasyAuth",
-        //         "jwt": {
-        //         "audience": "",
-        //         "issuer": "",
-        //         "issuerkey": ""
-        //         }
+        //         "provider": "EasyAuth"
         //     }
         // }
         /// </summary>
         public static HostGlobalSettings GetDefaultHostGlobalSettings(HostModeType hostMode)
         {
             Cors cors = new(new string[] { });
-            AuthenticationConfig authenticationConfig = new(Jwt: new Jwt(Audience: string.Empty, Issuer: string.Empty, IssuerKey: string.Empty));
+            AuthenticationConfig authenticationConfig = new();
             return new HostGlobalSettings(hostMode, cors, authenticationConfig);
         }
+
+        /// <summary>
+        /// Try to read and deserialize runtime config from a file.
+        /// </summary>
+        /// <param name="file">File path.</param>
+        /// <param name="runtimeConfigJson">Runtime config output. On failure, this will be null.</param>
+        /// <returns>True on success. On failure, return false and runtimeConfig will be set to null.</returns>
+        public static bool TryReadRuntimeConfig(string file, out string runtimeConfigJson)
+        {
+            runtimeConfigJson = string.Empty;
+
+            if (!File.Exists(file))
+            {
+                Console.WriteLine($"ERROR: Couldn't find config  file: {file}.");
+                Console.WriteLine($"Please run: hawaii init <options> to create a new config file.");
+
+                return false;
+            }
+
+            // Read existing config file content.
+            //
+            runtimeConfigJson = File.ReadAllText(file);
+            return true;
+        }
+
+        /// <summary>
+        /// this method will parse role and Action from permission string.
+        /// A valid permission string will be of the form "<<role>>:<<actions>>"
+        /// it will return true if parsing is successful and add the parsed value
+        /// to the out params role and action.
+        /// </summary>
+        public static bool TryGetRoleAndActionFromPermissionString(string permissions, out string? role, out string? actions)
+        {
+            // Split permission to role and actions
+            //
+            role = null;
+            actions = null;
+            string[] permission_array = permissions.Split(":");
+            if (permission_array.Length != 2)
+            {
+                Console.WriteLine("Please add permission in the following format. --permission \"<<role>>:<<actions>>\"");
+                return false;
+            }
+
+            role = permission_array[0];
+            actions = permission_array[1];
+            return true;
+        }
+
+        /// <summary>
+        /// this method will write all the json string in the given file.
+        /// </summary>
+        public static bool WriteJsonContentToFile(string file, string jsonContent)
+        {
+            try
+            {
+                File.WriteAllText(file, jsonContent);
+            }
+            catch (Exception e)
+            {
+                Console.Error.WriteLine($"Failed to generate the config file, operation failed with exception:{e}.");
+                return false;
+            }
+
+            return true;
+        }
     }
 }

Hawaii-Cli/src/Models/Utils.cs

@@ -1,7 +1,10 @@
 namespace Hawaii.Cli.Tests
 {
-    [TestClass]
-    public class AddEntityTest
+    /// <summary>
+    /// Tests for Adding new Entity.
+    /// </summary>
+    [TestClass, TestCategory("AddEntityTests")]
+    public class AddEntityTests
     {
         /// <summary>
         /// Simple test to add a new entity to json config when there is no existing entity.

Hawaii-Cli/tests/AddEntityTest.cs renamed to Hawaii-Cli/tests/AddEntityTests.cs

@@ -1,22 +1,26 @@
-namespace Hawaii.Cli;
+namespace Hawaii.Cli.Tests;
 
+/// <summary>
+/// End To End Tests for CLI.
+/// </summary>
 [TestClass]
 public class EndToEndTests
 {
+    /// <summary>
+    /// Initializing config for cosmos DB.
+    /// </summary>
+    private static string TEST_RUNTIME_CONFIG = "hawaii-config-test.json";
     [TestMethod]
     public void TestInitForCosmosDB()
     {
-        string[] args = { "init", "-n", "hawaii-config-test", "--database-type", "cosmos", "--connection-string", "localhost:5000", "--cosmos-database", "graphqldb", "--cosmos-container", "planet", "--graphql-schema", "schema.gql" };
+        string[] args = { "init", "-n", "hawaii-config-test", "--database-type", "cosmos",
+                          "--connection-string", "localhost:5000", "--cosmos-database",
+                          "graphqldb", "--cosmos-container", "planet", "--graphql-schema", "schema.gql" };
         Program.Main(args);
-        string jsonString = File.ReadAllText("hawaii-config-test.json");
 
-        RuntimeConfig? runtimeConfig = JsonSerializer.Deserialize<RuntimeConfig>(jsonString, RuntimeConfig.GetDeserializationOptions());
-
-        if (runtimeConfig is null)
-        {
-            Assert.Fail("Config was not genertaed correctly.");
-        }
+        RuntimeConfig? runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
 
+        Assert.IsNotNull(runtimeConfig);
         Assert.AreEqual(DatabaseType.cosmos, runtimeConfig.DatabaseType);
         Assert.IsNotNull(runtimeConfig.CosmosDb);
         Assert.AreEqual("graphqldb", runtimeConfig.CosmosDb.Database);
@@ -31,4 +35,132 @@ public void TestInitForCosmosDB()
         Assert.AreEqual(HostModeType.Production, runtimeConfig.HostGlobalSettings.Mode);
 
     }
+
+    /// <summary>
+    /// Test to verify adding a new Entity.
+    /// </summary>
+    [TestMethod]
+    public void TestAddEntity()
+    {
+        string[] initArgs = { "init", "-n", "hawaii-config-test", "--database-type", "mssql", "--connection-string", "localhost:5000" };
+        Program.Main(initArgs);
+
+        RuntimeConfig? runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
+
+        Assert.IsNotNull(runtimeConfig);
+        Assert.AreEqual(0, runtimeConfig.Entities.Count()); // No entities
+
+        string[] addArgs = {"add", "todo", "-n", "hawaii-config-test", "--source", "s001.todo",
+                            "--rest", "todo", "--graphql", "todo", "--permissions", "anonymous:*"};
+        Program.Main(addArgs);
+
+        runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
+        Assert.IsNotNull(runtimeConfig);
+        Assert.AreEqual(1, runtimeConfig.Entities.Count()); // 1 new entity added
+        Assert.IsTrue(runtimeConfig.Entities.ContainsKey("todo"));
+        Entity entity = runtimeConfig.Entities["todo"];
+        Assert.AreEqual("{\"route\":\"/todo\"}", JsonSerializer.Serialize(entity.Rest));
+        Assert.AreEqual("{\"type\":{\"singular\":\"todo\",\"plural\":\"todos\"}}", JsonSerializer.Serialize(entity.GraphQL));
+        Assert.AreEqual(1, entity.Permissions.Length);
+        Assert.AreEqual("anonymous", entity.Permissions[0].Role);
+        Assert.AreEqual(1, entity.Permissions[0].Actions.Length);
+        Assert.AreEqual(WILDCARD, GetCRUDOperation((JsonElement)entity.Permissions[0].Actions[0]));
+    }
+
+    /// <summary>
+    /// Test to verify updating an existing Entity.
+    /// It tests updating permissions as well as relationship
+    /// </summary>
+    [TestMethod]
+    public void TestUpdateEntity()
+    {
+        string[] initArgs = { "init", "-n", "hawaii-config-test", "--database-type",
+                              "mssql", "--connection-string", "localhost:5000" };
+        Program.Main(initArgs);
+
+        RuntimeConfig? runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
+
+        Assert.IsNotNull(runtimeConfig);
+        Assert.AreEqual(0, runtimeConfig.Entities.Count()); // No entities
+
+        string[] addArgs = {"add", "todo", "-n", "hawaii-config-test",
+                            "--source", "s001.todo", "--rest", "todo",
+                            "--graphql", "todo", "--permissions", "anonymous:*"};
+        Program.Main(addArgs);
+
+        runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
+        Assert.IsNotNull(runtimeConfig);
+        Assert.AreEqual(1, runtimeConfig.Entities.Count()); // 1 new entity added
+
+        // Adding another entity
+        //
+        string[] addArgs_2 = {"add", "books", "-n", "hawaii-config-test",
+                            "--source", "s001.books", "--rest", "books",
+                            "--graphql", "books", "--permissions", "anonymous:*"};
+        Program.Main(addArgs_2);
+
+        runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
+        Assert.IsNotNull(runtimeConfig);
+        Assert.AreEqual(2, runtimeConfig.Entities.Count()); // 1 more entity added
+
+        string[] updateArgs = {"update", "todo", "-n", "hawaii-config-test",
+                                "--source", "s001.todos","--graphql", "true",
+                                "--permissions", "anonymous:create,delete",
+                                "--fields.include", "id,content", "--fields.exclude", "rating,level",
+                                "--relationship", "r1", "--cardinality", "one",
+                                "--target.entity", "books", "--mapping.fields", "id:book_id",
+                                "--linking.object", "todo_books",
+                                "--linking.source.fields", "todo_id",
+                                "--linking.target.fields", "id" };
+        Program.Main(updateArgs);
+
+        runtimeConfig = TryGetRuntimeConfig(TEST_RUNTIME_CONFIG);
+        Assert.IsNotNull(runtimeConfig);
+        Assert.AreEqual(2, runtimeConfig.Entities.Count()); // No new entity added
+
+        Assert.IsTrue(runtimeConfig.Entities.ContainsKey("todo"));
+        Entity entity = runtimeConfig.Entities["todo"];
+        Assert.AreEqual("{\"route\":\"/todo\"}", JsonSerializer.Serialize(entity.Rest));
+        Assert.AreEqual("true", entity.GraphQL!.ToString());
+        Assert.AreEqual(1, entity.Permissions.Length);
+        Assert.AreEqual("anonymous", entity.Permissions[0].Role);
+        Assert.AreEqual(4, entity.Permissions[0].Actions.Length);
+        //Only create and delete are updated.
+        Assert.AreEqual("{\"action\":\"create\",\"fields\":{\"include\":[\"id\",\"content\"],\"exclude\":[\"rating\",\"level\"]}}", JsonSerializer.Serialize(entity.Permissions[0].Actions[0]));
+        Assert.AreEqual("{\"action\":\"delete\",\"fields\":{\"include\":[\"id\",\"content\"],\"exclude\":[\"rating\",\"level\"]}}", JsonSerializer.Serialize(entity.Permissions[0].Actions[1]));
+        Assert.AreEqual("\"read\"", JsonSerializer.Serialize(entity.Permissions[0].Actions[2]));
+        Assert.AreEqual("\"update\"", JsonSerializer.Serialize(entity.Permissions[0].Actions[3]));
+
+
+        Assert.IsTrue(entity.Relationships!.ContainsKey("r1"));
+        Relationship relationship = entity.Relationships["r1"];
+        Assert.AreEqual(1, entity.Relationships.Count());
+        Assert.AreEqual(Cardinality.One, relationship.Cardinality);
+        Assert.AreEqual("books", relationship.TargetEntity);
+        Assert.AreEqual("todo_books", relationship.LinkingObject);
+        CollectionAssert.AreEqual(new string[] {"id"}, relationship.SourceFields);
+        CollectionAssert.AreEqual(new string[] {"book_id"}, relationship.TargetFields);
+        CollectionAssert.AreEqual(new string[] {"todo_id"}, relationship.LinkingSourceFields);
+        CollectionAssert.AreEqual(new string[] {"id"}, relationship.LinkingTargetFields);
+    }
+
+    public static RuntimeConfig? TryGetRuntimeConfig(string testRuntimeConfig)
+    {
+        string jsonString;
+
+        if (!TryReadRuntimeConfig(testRuntimeConfig, out jsonString))
+        {
+            return null;
+        }
+
+        RuntimeConfig? runtimeConfig = JsonSerializer.Deserialize<RuntimeConfig>(jsonString, RuntimeConfig.GetDeserializationOptions());
+
+        if (runtimeConfig is null)
+        {
+            Assert.Fail("Config was not generated correctly.");
+        }
+
+        return runtimeConfig;
+    }
+
 }