Adding support for source as an Object for CLI

src/Cli/src/CommandLineOptions.cs

@@ -81,6 +81,9 @@ public class EntityOptions : Options
     {
         public EntityOptions(
             string entity,
+            string? sourceType,
+            IEnumerable<string>? sourceParameters,
+            IEnumerable<string>? sourceKeyFields,
             string? restRoute,
             string? graphQLType,
             IEnumerable<string>? fieldsToInclude,
@@ -91,6 +94,9 @@ public EntityOptions(
             : base(config)
         {
             Entity = entity;
+            SourceType = sourceType;
+            SourceParameters = sourceParameters;
+            SourceKeyFields = sourceKeyFields;
             RestRoute = restRoute;
             GraphQLType = graphQLType;
             FieldsToInclude = fieldsToInclude;
@@ -102,6 +108,15 @@ public EntityOptions(
         [Value(0, MetaName = "Entity", Required = true, HelpText = "Name of the entity.")]
         public string Entity { get; }
 
+        [Option("source.type", Required = false, HelpText = "Type of the database object.Must be one of: [table, view, stored-procedure]")]
+        public string? SourceType { get; }
+
+        [Option("source.params", Required = false, Separator = ',', HelpText = "Dictionary of parameters and their values for Source object.\"param1:val1,param2:value2,..\"")]
+        public IEnumerable<string>? SourceParameters { get; }
+
+        [Option("source.key-fields", Required = false, Separator = ',', HelpText = "The field(s) to be used as primary keys.")]
+        public IEnumerable<string>? SourceKeyFields { get; }
+
         [Option("rest", Required = false, HelpText = "Route for rest api.")]
         public string? RestRoute { get; }
 
@@ -131,6 +146,9 @@ public AddOptions(
             string source,
             IEnumerable<string> permissions,
             string entity,
+            string? sourceType,
+            IEnumerable<string>? sourceParameters,
+            IEnumerable<string>? sourceKeyFields,
             string? restRoute,
             string? graphQLType,
             IEnumerable<string>? fieldsToInclude,
@@ -139,6 +157,9 @@ public AddOptions(
             string? policyDatabase,
             string config)
             : base(entity,
+                  sourceType,
+                  sourceParameters,
+                  sourceKeyFields,
                   restRoute,
                   graphQLType,
                   fieldsToInclude,
@@ -176,6 +197,9 @@ public UpdateOptions(
             IEnumerable<string>? relationshipFields,
             IEnumerable<string>? map,
             string entity,
+            string? sourceType,
+            IEnumerable<string>? sourceParameters,
+            IEnumerable<string>? sourceKeyFields,
             string? restRoute,
             string? graphQLType,
             IEnumerable<string>? fieldsToInclude,
@@ -184,6 +208,9 @@ public UpdateOptions(
             string? policyDatabase,
             string config)
             : base(entity,
+                  sourceType,
+                  sourceParameters,
+                  sourceKeyFields,
                   restRoute,
                   graphQLType,
                   fieldsToInclude,

src/Cli/src/ConfigGenerator.cs

@@ -1,4 +1,5 @@
 using System.Collections;
+using System.Diagnostics.CodeAnalysis;
 using System.Text.Json;
 using Azure.DataApiBuilder.Config;
 using Microsoft.Extensions.Logging;
@@ -207,10 +208,19 @@ public static bool TryAddNewEntity(AddOptions options, ref string runtimeConfigJ
                 return false;
             }
 
+            // Try to get the source object as string or DatabaseObjectSource for new Entity
+            if (!TryCreateSourceObjectForNewEntity(
+                options,
+                out object? source))
+            {
+                Console.Error.WriteLine("Unable to create the source object.");
+                return false;
+            }
+
             // Create new entity.
             //
             Entity entity = new(
-                options.Source,
+                source!,
                 GetRestDetails(options.RestRoute),
                 GetGraphQLDetails(options.GraphQLType),
                 permissionSettings,
@@ -228,6 +238,66 @@ public static bool TryAddNewEntity(AddOptions options, ref string runtimeConfigJ
             return true;
         }
 
+        /// <summary>
+        /// This method creates the source object for a new entity
+        /// if the given source fields specified by the user are valid.
+        /// </summary>
+        public static bool TryCreateSourceObjectForNewEntity(
+            AddOptions options,
+            [NotNullWhen(true)] out object? sourceObject)
+        {
+            sourceObject = null;
+
+            // Try to Parse the SourceType
+            if (!SourceTypeEnumConverter.TryGetSourceType(
+                    options.SourceType,
+                    out SourceType objectType))
+            {
+                Console.Error.WriteLine(
+                    SourceTypeEnumConverter.GenerateMessageForInvalidSourceType(options.SourceType!)
+                );
+                return false;
+            }
+
+            // Verify that parameter is provided with stored-procedure only
+            // and keyfields with table/views.
+            if (!VerifyCorrectPairingOfParameterAndKeyFieldsWithType(
+                    objectType,
+                    options.SourceParameters,
+                    options.SourceKeyFields))
+            {
+                return false;
+            }
+
+            // Parses the string array to parameter Dictionary
+            if (!TryParseSourceParameterDictionary(
+                    options.SourceParameters,
+                    out Dictionary<string, object>? parametersDictionary))
+            {
+                return false;
+            }
+
+            string[]? sourceKeyFields = null;
+            if (options.SourceKeyFields is not null && options.SourceKeyFields.Any())
+            {
+                sourceKeyFields = options.SourceKeyFields.ToArray();
+            }
+
+            // Try to get the source object as string or DatabaseObjectSource
+            if (!TryCreateSourceObject(
+                    options.Source,
+                    objectType,
+                    parametersDictionary,
+                    sourceKeyFields,
+                    out sourceObject))
+            {
+                Console.Error.WriteLine("Unable to parse the given source.");
+                return false;
+            }
+
+            return true;
+        }
+
         /// <summary>
         /// Parse permission string to create PermissionSetting array.
         /// </summary>
@@ -241,7 +311,7 @@ public static bool TryAddNewEntity(AddOptions options, ref string runtimeConfigJ
             string? role, operations;
             if (!TryGetRoleAndOperationFromPermission(permissions, out role, out operations))
             {
-                Console.Error.Write($"Failed to fetch the role and operation from the given permission string: {string.Join(":", permissions.ToArray())}.");
+                Console.Error.Write($"Failed to fetch the role and operation from the given permission string: {string.Join(SEPARATOR, permissions.ToArray())}.");
                 return null;
             }
 
@@ -320,7 +390,12 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, ref string run
                 return false;
             }
 
-            object updatedSource = options.Source is null ? entity!.Source : options.Source;
+            if (!TryGetUpdatedSourceObjectWithOptions(options, entity, out object? updatedSource))
+            {
+                Console.Error.WriteLine("Failed to update the source object.");
+                return false;
+            }
+
             object? updatedRestDetails = options.RestRoute is null ? entity!.Rest : GetRestDetails(options.RestRoute);
             object? updatedGraphQLDetails = options.GraphQLType is null ? entity!.GraphQL : GetGraphQLDetails(options.GraphQLType);
             PermissionSetting[]? updatedPermissions = entity!.Permissions;
@@ -545,6 +620,85 @@ private static object[] GetUpdatedOperationArray(string[] newOperations,
             return updatedOperationArray.ToArray();
         }
 
+        /// <summary>
+        /// Parses updated options and uses them to create a new sourceObject
+        /// for the given entity.
+        /// Verifies if the given combination of fields is valid for update
+        /// and then it updates it, else it fails.
+        /// </summary>
+        private static bool TryGetUpdatedSourceObjectWithOptions(
+            UpdateOptions options,
+            Entity entity,
+            [NotNullWhen(true)] out object? updatedSourceObject)
+        {
+            entity.TryPopulateSourceFields();
+            updatedSourceObject = null;
+            string updatedSourceName = options.Source ?? entity.SourceName;
+            string[]? updatedKeyFields = entity.KeyFields;
+            SourceType updatedSourceType = entity.ObjectType;
+            Dictionary<string, object>? updatedSourceParameters = entity.Parameters;
+
+            // If SourceType provided by user is null,
+            // no update is required.
+            if (options.SourceType is not null)
+            {
+                if (!SourceTypeEnumConverter.TryGetSourceType(options.SourceType, out updatedSourceType))
+                {
+                    Console.Error.WriteLine(
+                        SourceTypeEnumConverter.GenerateMessageForInvalidSourceType(options.SourceType)
+                    );
+                    return false;
+                }
+            }
+
+            if (!VerifyCorrectPairingOfParameterAndKeyFieldsWithType(
+                    updatedSourceType,
+                    options.SourceParameters,
+                    options.SourceKeyFields))
+            {
+                return false;
+            }
+
+            // Changing source object from stored-procedure to table/view
+            // should automatically update the parameters to be null.
+            // Similarly from table/view to stored-procedure, key-fields
+            // should be marked null.
+            if (SourceType.StoredProcedure.Equals(updatedSourceType))
+            {
+                updatedKeyFields = null;
+            }
+            else
+            {
+                updatedSourceParameters = null;
+            }
+
+            // If given SourceParameter is null, no update is required.
+            // Else updatedSourceParameters will contain the parsed dictionary of parameters. 
+            if (options.SourceParameters is not null &&
+                !TryParseSourceParameterDictionary(options.SourceParameters, out updatedSourceParameters))
+            {
+                return false;
+            }
+
+            if (options.SourceKeyFields is not null)
+            {
+                updatedKeyFields = options.SourceKeyFields.ToArray();
+            }
+
+            // Try Creating Source Object with the updated values.
+            if (!TryCreateSourceObject(
+                    updatedSourceName,
+                    updatedSourceType,
+                    updatedSourceParameters,
+                    updatedKeyFields,
+                    out updatedSourceObject))
+            {
+                return false;
+            }
+
+            return true;
+        }
+
         /// <summary>
         /// This Method will verify the params required to update relationship info of an entity.
         /// </summary>

src/Cli/src/Program.cs

@@ -1,4 +1,5 @@
 using CommandLine;
+using static Cli.Utils;
 
 namespace Cli
 {
@@ -15,10 +16,11 @@ public class Program
         public static int Main(string[] args)
         {
             Parser parser = new(settings =>
-            {
-                settings.CaseInsensitiveEnumValues = true;
-                settings.HelpWriter = Console.Out;
-            });
+                {
+                    settings.CaseInsensitiveEnumValues = true;
+                    settings.HelpWriter = Console.Out;
+                }
+            );
             ParserResult<object>? result = parser.ParseArguments<InitOptions, AddOptions, UpdateOptions, StartOptions>(args)
                 .WithParsed<InitOptions>(options =>
                 {
@@ -38,12 +40,14 @@ public static int Main(string[] args)
                     bool isSuccess = ConfigGenerator.TryAddEntityToConfigWithOptions(options);
                     if (isSuccess)
                     {
-                        Console.WriteLine($"Added new entity:{options.Entity} with source: {options.Source} to config: {options.Config} with permissions: {string.Join(":", options.Permissions.ToArray())}.");
+                        Console.WriteLine($"Added new entity: {options.Entity} with source: {options.Source} to config: {options.Config}" +
+                            $" with permissions: {string.Join(SEPARATOR, options.Permissions.ToArray())}.");
                         Console.WriteLine($"SUGGESTION: Use 'dab update <options>' to update any entities in your config.");
                     }
                     else
                     {
-                        Console.WriteLine($"ERROR: Could not add entity:{options.Entity} source: {options.Source} to config: {options.Config} with permissions: {string.Join(":", options.Permissions.ToArray())}.");
+                        Console.WriteLine($"ERROR: Could not add entity: {options.Entity} source: {options.Source} to config: {options.Config}" +
+                            $" with permissions: {string.Join(SEPARATOR, options.Permissions.ToArray())}.");
                     }
                 })
                 .WithParsed<UpdateOptions>(options =>
@@ -56,7 +60,7 @@ public static int Main(string[] args)
                     }
                     else
                     {
-                        Console.WriteLine($"Could not update the entity:{options.Entity}.");
+                        Console.WriteLine($"Could not update the entity: {options.Entity}.");
                     }
                 })
                 .WithParsed<StartOptions>(options =>