improved logging in GeneratePortNumberMacro

Author: vlada-shubina

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/LocalizableStrings.Designer.cs

@@ -199,6 +199,15 @@ Details: {1}</value>
     <value>Unrecognized evaluator: '{0}'.</value>
     <comment>{0} - invalid evaluator value</comment>
   </data>
+  <data name="GeneratePortNumberConfig_Warning_InvalidHighBound" xml:space="preserve">
+    <value>The high port bound '{0}' is greater than the maximum allowed, '{1}' will be used instead.</value>
+  </data>
+  <data name="GeneratePortNumberConfig_Warning_InvalidLowBound" xml:space="preserve">
+    <value>The low port bound '{0}' is less than the minimum allowed, '{1}' will be used instead.</value>
+  </data>
+  <data name="GeneratePortNumberConfig_Warning_InvalidLowHighBound" xml:space="preserve">
+    <value>The low port bound '{0}' is greater the high port bound '{1}', the default range [{2}-{3}] will be used instead.</value>
+  </data>
   <data name="JoinMacroConfig_Exception_ValuePropertyIsEmpty" xml:space="preserve">
     <value>Generated symbol '{0}': array '{1}' should contain JSON objects with property non-empty '{2}' when '{3}' is '{4}'.</value>
     <comment>{0} - name of generated symbol, {1} - the invalid property name; {2}, {3}, {4} - the property names and values.</comment>

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/LocalizableStrings.resx

@@ -22,15 +22,15 @@ public IMacroConfig CreateConfig(IEngineEnvironmentSettings environmentSettings,
             {
                 throw new InvalidCastException($"Couldn't cast the {nameof(rawConfig)} as {nameof(IGeneratedSymbolConfig)}.");
             }
-            return CreateConfig(deferredConfig);
+            return CreateConfig(environmentSettings, deferredConfig);
         }
 
         public void Evaluate(IEngineEnvironmentSettings environmentSettings, IVariableCollection vars, IGeneratedSymbolConfig deferredConfig)
         {
-            Evaluate(environmentSettings, vars, CreateConfig(deferredConfig));
+            Evaluate(environmentSettings, vars, CreateConfig(environmentSettings, deferredConfig));
         }
 
-        protected abstract T CreateConfig(IGeneratedSymbolConfig deferredConfig);
+        protected abstract T CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig);
     }
 
     /// <summary>
@@ -49,6 +49,6 @@ internal abstract class BaseNondeterministicMacro<T> : BaseGeneratedSymbolMacro<
     /// <typeparam name="T">The macro config.</typeparam>
     internal abstract class BaseNondeterministicGenSymMacro<T> : BaseNondeterministicMacro<T>, IDeterministicModeMacro<IGeneratedSymbolConfig> where T : BaseMacroConfig, IMacroConfig
     {
-        public void EvaluateDeterministically(IEngineEnvironmentSettings environmentSettings, IVariableCollection variables, IGeneratedSymbolConfig config) => EvaluateDeterministically(environmentSettings, variables, CreateConfig(config));
+        public void EvaluateDeterministically(IEngineEnvironmentSettings environmentSettings, IVariableCollection variables, IGeneratedSymbolConfig config) => EvaluateDeterministically(environmentSettings, variables, CreateConfig(environmentSettings, config));
     }
 }

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/BaseGeneratedSymbolMacro.cs

@@ -34,6 +34,6 @@ public override void Evaluate(IEngineEnvironmentSettings environmentSettings, IV
             environmentSettings.Host.Logger.LogDebug("[{macro}]: Assigned variable '{var}' to '{value}'.", nameof(CaseChangeMacro), config.VariableName, value);
         }
 
-        protected override CaseChangeMacroConfig CreateConfig(IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
+        protected override CaseChangeMacroConfig CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
     }
 }

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/CaseChangeMacro.cs

@@ -39,6 +39,6 @@ public override void Evaluate(IEngineEnvironmentSettings environmentSettings, IV
             environmentSettings.Host.Logger.LogDebug("[{macro}]: Variable '{var}' was not assigned, neither source nor fallback variable was found.", nameof(CoalesceMacro), config.VariableName);
         }
 
-        protected override CoalesceMacroConfig CreateConfig(IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
+        protected override CoalesceMacroConfig CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
     }
 }

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/CoalesceMacro.cs

@@ -21,6 +21,6 @@ public override void Evaluate(IEngineEnvironmentSettings environmentSettings, IV
             environmentSettings.Host.Logger.LogDebug("[{macro}]: Variable '{var}' was assigned to value '{value}'.", nameof(ConstantMacro), config.VariableName, config.Value);
         }
 
-        protected override ConstantMacroConfig CreateConfig(IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
+        protected override ConstantMacroConfig CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
     }
 }

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/ConstantMacro.cs

@@ -1,11 +1,13 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
 using System.Net.Sockets;
+using Microsoft.Extensions.Logging;
 using Microsoft.TemplateEngine.Orchestrator.RunnableProjects.Abstractions;
 
 namespace Microsoft.TemplateEngine.Orchestrator.RunnableProjects.Macros
@@ -45,29 +47,47 @@ internal class GeneratePortNumberConfig : BaseMacroConfig<GeneratePortNumberMacr
         internal GeneratePortNumberConfig(GeneratePortNumberMacro macro, string variableName, string? dataType, int fallback, int low, int high)
              : base(macro, variableName, dataType)
         {
+            if (low < LowPortDefault)
+            {
+                throw new ArgumentException($"{nameof(low)} should be greater than {LowPortDefault}.", nameof(low));
+            }
+
+            if (high > HighPortDefault)
+            {
+                throw new ArgumentException($"{nameof(high)} should be less than {HighPortDefault}.", nameof(high));
+            }
+
+            if (low > high)
+            {
+                throw new ArgumentException($"{nameof(low)} should be greater than {nameof(high)}.", nameof(low));
+            }
+
             Fallback = fallback;
             Low = low;
             High = high;
             Port = AllocatePort(low, high, fallback);
         }
 
-        internal GeneratePortNumberConfig(GeneratePortNumberMacro macro, IGeneratedSymbolConfig generatedSymbolConfig)
+        internal GeneratePortNumberConfig(ILogger logger, GeneratePortNumberMacro macro, IGeneratedSymbolConfig generatedSymbolConfig)
             : base(macro, generatedSymbolConfig.VariableName, generatedSymbolConfig.DataType)
         {
             int low = GetOptionalParameterValue(generatedSymbolConfig, "low", ConvertJTokenToInt, LowPortDefault);
             int high = GetOptionalParameterValue(generatedSymbolConfig, "high", ConvertJTokenToInt, HighPortDefault);
             if (low < LowPortDefault)
             {
+                logger.LogWarning(LocalizableStrings.GeneratePortNumberConfig_Warning_InvalidLowBound, low, LowPortDefault);
                 low = LowPortDefault;
             }
 
             if (high > HighPortDefault)
             {
+                logger.LogWarning(LocalizableStrings.GeneratePortNumberConfig_Warning_InvalidHighBound, high, HighPortDefault);
                 high = HighPortDefault;
             }
 
             if (low > high)
             {
+                logger.LogWarning(LocalizableStrings.GeneratePortNumberConfig_Warning_InvalidLowHighBound, low, high, LowPortDefault, HighPortDefault);
                 low = LowPortDefault;
                 high = HighPortDefault;
             }

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/GeneratePortNumberConfig.cs

@@ -27,6 +27,7 @@ public override void EvaluateDeterministically(IEngineEnvironmentSettings enviro
             environmentSettings.Host.Logger.LogDebug("[{macro}]: Variable '{var}' was assigned to value '{value}' in deterministic mode.", nameof(GeneratePortNumberMacro), config.VariableName, config.Low);
         }
 
-        protected override GeneratePortNumberConfig CreateConfig(IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
+        protected override GeneratePortNumberConfig CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig)
+            => new(environmentSettings.Host.Logger, this, deferredConfig);
     }
 }

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/GeneratePortNumberMacro.cs

@@ -27,7 +27,7 @@ public override void EvaluateDeterministically(IEngineEnvironmentSettings enviro
             EvaluateInternal(DeterministicModeValue, environmentSettings, variables, config);
         }
 
-        protected override GuidMacroConfig CreateConfig(IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
+        protected override GuidMacroConfig CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
 
         private void EvaluateInternal(Guid g, IEngineEnvironmentSettings environmentSettings, IVariableCollection vars, GuidMacroConfig config)
         {

src/Microsoft.TemplateEngine.Orchestrator.RunnableProjects/Macros/GuidMacro.cs

@@ -52,6 +52,6 @@ public override void Evaluate(IEngineEnvironmentSettings environmentSettings, IV
             environmentSettings.Host.Logger.LogDebug("[{macro}]: Variable '{var}' was assigned to value '{value}'.", nameof(JoinMacro), config.VariableName, result);
         }
 
-        protected override JoinMacroConfig CreateConfig(IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
+        protected override JoinMacroConfig CreateConfig(IEngineEnvironmentSettings environmentSettings, IGeneratedSymbolConfig deferredConfig) => new(this, deferredConfig);
     }
 }