Merge pull request #3421 from abpframework/alper/cli-connection-string

Alper/cli connection string

framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/NewCommand.cs

@@ -73,6 +73,12 @@ namespace Volo.Abp.Cli.Commands
                 Logger.LogInformation("UI Framework: " + uiFramework);
             }
 
+            var connectionString = GetConnectionString(commandLineArgs);
+            if (connectionString != null)
+            {
+                Logger.LogInformation("Connection string: " + connectionString);
+            }
+
             var mobileApp = GetMobilePreference(commandLineArgs);
             if (mobileApp != MobileApp.None)
             {
@@ -122,7 +128,8 @@ namespace Volo.Abp.Cli.Commands
                     mobileApp,
                     gitHubLocalRepositoryPath,
                     templateSource,
-                    commandLineArgs.Options
+                    commandLineArgs.Options,
+                    connectionString
                 )
             );
 
@@ -168,6 +175,12 @@ namespace Volo.Abp.Cli.Commands
             Logger.LogInformation($"'{projectName}' has been successfully created to '{outputFolder}'");
         }
 
+        private static string GetConnectionString(CommandLineArgs commandLineArgs)
+        {
+            var connectionString = commandLineArgs.Options.GetOrNull(Options.ConnectionString.Short, Options.ConnectionString.Long);
+            return string.IsNullOrWhiteSpace(connectionString) ? null : connectionString;
+        }
+
         public string GetUsageInfo()
         {
             var sb = new StringBuilder();
@@ -309,6 +322,12 @@ namespace Volo.Abp.Cli.Commands
                 public const string Long = "template-source";
             }
 
+            public static class ConnectionString
+            {
+                public const string Short = "cs";
+                public const string Long = "connection-string";
+            }
+
             public static class CreateSolutionFolder
             {
                 public const string Short = "csf";

framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Building/Steps/ConnectionStringChangeStep.cs

@@ -0,0 +1,76 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using Volo.Abp.Cli.ProjectBuilding.Files;
+using Volo.Abp.Text;
+
+namespace Volo.Abp.Cli.ProjectBuilding.Building.Steps
+{
+    public class ConnectionStringChangeStep : ProjectBuildPipelineStep
+    {
+        private const string DefaultConnectionStringKey = "Default";
+
+        public override void Execute(ProjectBuildContext context)
+        {
+            var appSettingsJsonFiles = context.Files.Where(f =>
+                f.Name.EndsWith("appsettings.json", StringComparison.OrdinalIgnoreCase))
+                .ToArray();
+
+            if (!appSettingsJsonFiles.Any())
+            {
+                return;
+            }
+
+            var newConnectionString = $"\"{DefaultConnectionStringKey}: \"{context.BuildArgs.ConnectionString}\"";
+
+            foreach (var appSettingsJson in appSettingsJsonFiles)
+            {
+                try
+                {
+                    var appSettingJsonContentWithoutBom = StringHelper.ConvertFromBytesWithoutBom(appSettingsJson.Bytes);
+                    var jsonObject = JObject.Parse(appSettingJsonContentWithoutBom);
+
+                    var connectionStringContainer = (JContainer)jsonObject?["ConnectionStrings"];
+                    if (connectionStringContainer == null)
+                    {
+                        continue;
+                    }
+
+                    if (!connectionStringContainer.Any())
+                    {
+                        continue;
+                    }
+
+                    var connectionStrings = connectionStringContainer.ToList();
+
+                    foreach (var connectionString in connectionStrings)
+                    {
+                        var property = ((JProperty)connectionString);
+                        var connectionStringName = property.Name;
+
+                        if (connectionStringName == DefaultConnectionStringKey)
+                        {
+                            var defaultConnectionString = property.ToString();
+                            if (defaultConnectionString == null)
+                            {
+                                continue;
+                            }
+
+                            appSettingsJson.ReplaceText(defaultConnectionString, newConnectionString);
+                            break;
+                        }
+                    }
+                }
+                catch (Exception ex)
+                {
+                    Console.WriteLine("Cannot change the connection string in " + appSettingsJson.Name + ". Error: " + ex.Message);
+                }
+            }
+        }
+    }
+}

framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Building/TemplateProjectBuildPipelineBuilder.cs

@@ -28,6 +28,11 @@ namespace Volo.Abp.Cli.ProjectBuilding.Building
                 pipeline.Steps.Add(new RemoveRootFolderStep());
             }
 
+            if (context.BuildArgs.ConnectionString != null)
+            {
+                pipeline.Steps.Add(new ConnectionStringChangeStep());
+            }
+
             pipeline.Steps.Add(new CreateProjectResultZipStep());
 
             return pipeline;

framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/ProjectBuildArgs.cs

@@ -27,6 +27,9 @@ namespace Volo.Abp.Cli.ProjectBuilding
         [CanBeNull]
         public string TemplateSource { get; set; }
 
+        [CanBeNull]
+        public string ConnectionString { get; set; }
+
         [NotNull]
         public Dictionary<string, string> ExtraProperties { get; set; }
 
@@ -39,7 +42,8 @@ namespace Volo.Abp.Cli.ProjectBuilding
             MobileApp? mobileApp = null,
             [CanBeNull] string abpGitHubLocalRepositoryPath = null,
             [CanBeNull] string templateSource = null,
-            Dictionary<string, string> extraProperties = null)
+            Dictionary<string, string> extraProperties = null,
+            [CanBeNull] string connectionString = null)
         {
             SolutionName = Check.NotNull(solutionName, nameof(solutionName));
             TemplateName = templateName;
@@ -50,6 +54,7 @@ namespace Volo.Abp.Cli.ProjectBuilding
             AbpGitHubLocalRepositoryPath = abpGitHubLocalRepositoryPath;
             TemplateSource = templateSource;
             ExtraProperties = extraProperties ?? new Dictionary<string, string>();
+            ConnectionString = connectionString;
         }
     }
 }

framework/src/Volo.Abp.Core/Volo/Abp/IO/FileHelper.cs

@@ -1,8 +1,10 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Text;
 using System.Threading.Tasks;
 using JetBrains.Annotations;
+using Volo.Abp.Text;
 
 namespace Volo.Abp.IO
 {
@@ -73,6 +75,63 @@ namespace Volo.Abp.IO
             }
         }
 
-        //TODO: ReadAllLinesAsync
+        /// <summary>
+        /// Opens a text file, reads all lines of the file, and then closes the file.
+        /// </summary>
+        /// <param name="path">The file to open for reading.</param>
+        /// <param name="encoding">Encoding of the file. Default is UTF8</param>
+        /// <param name="fileMode">Specifies how the operating system should open a file. Default is Open</param>
+        /// <param name="fileAccess">Defines constants for read, write, or read/write access to a file. Default is Read</param>
+        /// <param name="fileShare">Contains constants for controlling the kind of access other FileStream objects can have to the same file. Default is Read</param>
+        /// <param name="bufferSize">Length of StreamReader buffer. Default is 4096.</param>
+        /// <param name="fileOptions">Indicates FileStream options. Default is Asynchronous (The file is to be used for asynchronous reading.) and SequentialScan (The file is to be accessed sequentially from beginning to end.) </param>
+        /// <returns>A string containing all lines of the file.</returns>
+        public static async Task<string[]> ReadAllLinesAsync(string path,
+            Encoding encoding = null,
+            FileMode fileMode = FileMode.Open,
+            FileAccess fileAccess = FileAccess.Read,
+            FileShare fileShare = FileShare.Read,
+            int bufferSize = 4096,
+            FileOptions fileOptions = FileOptions.Asynchronous | FileOptions.SequentialScan)
+        {
+            if (encoding == null)
+            {
+                encoding = Encoding.UTF8;
+            }
+
+            var lines = new List<string>();
+
+            using (var stream = new FileStream(
+                path,
+                fileMode,
+                fileAccess,
+                fileShare,
+                bufferSize,
+                fileOptions))
+            {
+                using (var reader = new StreamReader(stream, encoding))
+                {
+                    string line;
+                    while ((line = await reader.ReadLineAsync()) != null)
+                    {
+                        lines.Add(line);
+                    }
+                }
+            }
+
+            return lines.ToArray();
+        }
+
+        /// <summary>
+        /// Opens a text file, reads content without BOM
+        /// </summary>
+        /// <param name="path">The file to open for reading.</param>
+        /// <returns>A string containing all lines of the file.</returns>
+        public static async Task<string> ReadFileWithoutBomAsync(string path)
+        {
+            var content = await ReadAllBytesAsync(path);
+
+            return StringHelper.ConvertFromBytesWithoutBom(content);
+        }
     }
 }

framework/src/Volo.Abp.Core/Volo/Abp/Text/StringHelper.cs

@@ -0,0 +1,37 @@
+using System.Text;
+
+namespace Volo.Abp.Text
+{
+    public class StringHelper
+    {
+        /// <summary>
+        /// Converts a byte[] to string without BOM (byte order mark).
+        /// </summary>
+        /// <param name="bytes">The byte[] to be converted to string</param>
+        /// <param name="encoding">The encoding to get string. Default is UTF8</param>
+        /// <returns></returns>
+        public static string ConvertFromBytesWithoutBom(byte[] bytes, Encoding encoding = null)
+        {
+            if (bytes == null)
+            {
+                return null;
+            }
+
+            if (encoding == null)
+            {
+                encoding = Encoding.UTF8;
+            }
+
+            var hasBom = bytes.Length >= 3 && bytes[0] == 0xEF && bytes[1] == 0xBB && bytes[2] == 0xBF;
+
+            if (hasBom)
+            {
+                return encoding.GetString(bytes, 3, bytes.Length - 3);
+            }
+            else
+            {
+                return encoding.GetString(bytes);
+            }
+        }
+    }
+}