Merge branch 'develop'

Author: olivier-spinelli

Code.Cake/CodeCakeApplication.cs

@@ -141,7 +141,7 @@ public RunResult Run( string[] args, string appRoot = null)
             if( !AvailableBuilds.TryGetValue( options.Script, out choosenBuild ) )
             {
                 logger.Error( "Build script '{0}' not found.", options.Script );
-                return new RunResult( -1, context.IsInteractiveMode(), context.IsAutoInteractiveMode() );
+                return new RunResult( -1, context.InteractiveMode() );
             }
 
             // Set the working directory: the solution directory.
@@ -175,7 +175,7 @@ public RunResult Run( string[] args, string appRoot = null)
                 {
                     case CakeTerminationOption.Error:
                         logger.Error( "Termination with Error: '{0}'.", ex.Message );
-                        return new RunResult( -2, context.IsInteractiveMode(), context.IsAutoInteractiveMode() );
+                        return new RunResult( -2, context.InteractiveMode() );
                     case CakeTerminationOption.Warning:
                         logger.Warning( "Termination with Warning: '{0}'.", ex.Message );
                         break;
@@ -188,14 +188,14 @@ public RunResult Run( string[] args, string appRoot = null)
             catch( TargetInvocationException ex )
             {
                 logger.Error( "Error occurred: '{0}'.", ex.InnerException?.Message ?? ex.Message );
-                return new RunResult( -3, context.IsInteractiveMode(), context.IsAutoInteractiveMode() );
+                return new RunResult( -3, context.InteractiveMode() );
             }
             catch( Exception ex )
             {
                 logger.Error( "Error occurred: '{0}'.", ex.Message );
-                return new RunResult( -4, context.IsInteractiveMode(), context.IsAutoInteractiveMode() );
+                return new RunResult( -4, context.InteractiveMode() );
             }
-            return new RunResult( 0, context.IsInteractiveMode(), context.IsAutoInteractiveMode() );
+            return new RunResult( 0, context.InteractiveMode() );
         }
 
         /// <summary>

Code.Cake/CodeCakeSpecific/InteractiveAliases.cs

@@ -23,11 +23,28 @@ public static class InteractiveAliases
         /// </summary>
         public static readonly string AutoInteractionArgument = "autointeraction";
 
+
+        /// <summary>
+        /// Gets the current <see cref="CodeCake.InteractiveMode"/>.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <returns>The mode.</returns>
+        [CakeAliasCategory( "Interactive mode" )]
+        [CakeMethodAlias]
+        public static InteractiveMode InteractiveMode( this ICakeContext context )
+        {
+            if( context.HasArgument( NoInteractionArgument ) ) return CodeCake.InteractiveMode.NoInteraction;
+            if( context.HasArgument( AutoInteractionArgument ) ) return CodeCake.InteractiveMode.AutoInteraction;
+            return CodeCake.InteractiveMode.NoInteraction;
+        }
+
         /// <summary>
-        /// Gets whether the context supports interaction with the user (depends on -nointeraction argument).
+        /// Gets whether the context requires interaction with the user:
+        /// False if -nointeraction or -autointeraction argument has been provided, true if no specific argument have been provided.
         /// </summary>
         /// <param name="context">The context.</param>
         /// <returns>True if interactive mode is available, false otherwise.</returns>
+        [Obsolete( "Use the less ambiguous InteractiveMode() enum value instead.", false)]
         [CakeAliasCategory( "Interactive mode" )]
         [CakeMethodAlias]
         public static bool IsInteractiveMode( this ICakeContext context )
@@ -36,11 +53,12 @@ public static bool IsInteractiveMode( this ICakeContext context )
         }
 
         /// <summary>
-        /// Gets whether the context supports interaction with the user (this can be true only if <see cref="IsInteractiveMode(ICakeContext)"/>
-        /// is true) in automatic mode.
+        /// Gets whether the context supports automatic interaction (argument -autointeraction has been provided).
+        /// When this is true, <see cref="IsInteractiveMode"/> is false. 
         /// </summary>
         /// <param name="context">The context.</param>
         /// <returns>True if interactive mode is available, false otherwise.</returns>
+        [Obsolete( "Use the less ambiguous InteractiveMode() enum value instead.", false )]
         [CakeAliasCategory( "Interactive mode" )]
         [CakeMethodAlias]
         public static bool IsAutoInteractiveMode( this ICakeContext context )
@@ -90,7 +108,8 @@ public static char ReadInteractiveOption( this ICakeContext context, string argu
         static char DoReadInteractiveOption( ICakeContext context, string argumentName, string message, char[] options )
         {
             if( options == null || options.Length == 0 ) throw new ArgumentException( "At least one (uppercase) character for options must be provided." );
-            if( !IsInteractiveMode( context ) ) throw new InvalidOperationException( "Interactions are not allowed." );
+            var mode = InteractiveMode( context );
+            if( mode == CodeCake.InteractiveMode.NoInteraction ) throw new InvalidOperationException( "Interactions are not allowed." );
             if( options.Any( c => char.IsLower( c ) ) ) throw new ArgumentException( "Options must be uppercase letter." );
 
             string choices = String.Join( "/", options );
@@ -116,7 +135,7 @@ static char DoReadInteractiveOption( ICakeContext context, string argumentName,
                     return c;
                 }
             }
-            if( IsAutoInteractiveMode( context ) )
+            if( mode == CodeCake.InteractiveMode.AutoInteraction )
             {
                 char c = options[0];
                 Console.WriteLine( c );
@@ -152,10 +171,11 @@ static char DoReadInteractiveOption( ICakeContext context, string argumentName,
         public static string InteractiveEnvironmentVariable( this ICakeContext context, string variable, bool setCache = true )
         {
             string v = context.EnvironmentVariable( variable );
-            if( v == null && IsInteractiveMode( context ) )
+            var mode = InteractiveMode( context );
+            if( v == null && mode != CodeCake.InteractiveMode.NoInteraction )
             {
                 Console.Write( $"Environment Variable '{variable}' not found. Enter its value: " );
-                if( IsAutoInteractiveMode( context ) )
+                if( mode == CodeCake.InteractiveMode.AutoInteraction )
                 {
                     string fromArgName = "ENV:" + variable;
                     string fromArg = context.Arguments.HasArgument( fromArgName ) ? context.Arguments.GetArgument( fromArgName ) : null;

Code.Cake/CodeCakeSpecific/InteractiveMode.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CodeCake
+{
+    /// <summary>
+    /// Defines the 3 interactive mode handled by <see cref="InteractiveAliases"/>.
+    /// </summary>
+    public enum InteractiveMode
+    {
+        /// <summary>
+        /// No user interaction are supported (command line argument -nointeraction).
+        /// </summary>
+        NoInteraction,
+
+        /// <summary>
+        /// Auto interaction (command line argument -autointeraction) is an hybrid mode where answers
+        /// are read from the command line or, for <see cref="InteractiveAliases.ReadInteractiveOption(Cake.Core.ICakeContext, string, string, char[])"/>,
+        /// the first choice is choosen.
+        /// </summary>
+        AutoInteraction,
+
+        /// <summary>
+        /// User has to answer the questions.
+        /// </summary>
+        Interactive
+    }
+}

Code.Cake/RunResult.cs

@@ -17,26 +17,19 @@ public struct RunResult
         public readonly int ReturnCode;
 
         /// <summary>
-        /// Gets whether the context is in interactive
-        /// mode (see <see cref="InteractiveAliases.IsInteractiveMode(Cake.Core.ICakeContext)"/>).
+        /// Gets the context's interactive mode.
         /// </summary>
-        public readonly bool IsInteractiveMode;
-
-        /// <summary>
-        /// Gets whether the context is in auto interactive
-        /// mode (see <see cref="InteractiveAliases.IsAutoInteractiveMode(Cake.Core.ICakeContext)"/>).
-        /// </summary>
-        public readonly bool IsAutoInteractiveMode;
+        public readonly InteractiveMode InteractiveMode;
 
         /// <summary>
         /// Gets whether the run succeeded (<see cref="ReturnCode"/> is 0).
         /// </summary>
         public bool Success => ReturnCode == 0;
 
-        internal RunResult( int returnCode, bool isInteractiveMode, bool isAutoInteractiveMode )
-        {            ReturnCode = returnCode;
-            IsInteractiveMode = isInteractiveMode;
-            IsAutoInteractiveMode = isAutoInteractiveMode;
+        internal RunResult( int returnCode, InteractiveMode mode )
+        {
+            ReturnCode = returnCode;
+            InteractiveMode = mode;
         }
 
         /// <summary>

CodeCakeBuilder/Build.StandardCheckRepository.cs

@@ -15,7 +15,7 @@ string StandardCheckRepository( IEnumerable<SolutionProject> projectsToPublish,
             string configuration = "Debug";
             if( !gitInfo.IsValid )
             {
-                if( Cake.IsInteractiveMode()
+                if( Cake.InteractiveMode() != InteractiveMode.NoInteraction
                     && Cake.ReadInteractiveOption( "PublishDirtyRepo", "Repository is not ready to be published. Proceed anyway?", 'Y', 'N' ) == 'Y' )
                 {
                     Cake.Warning( "GitInfo is not valid, but you choose to continue..." );

CodeCakeBuilder/Build.StandardPushNuGetPackages.cs

@@ -15,7 +15,7 @@ public partial class Build
 
         void StandardPushNuGetPackages( IEnumerable<FilePath> nugetPackages, SimpleRepositoryInfo gitInfo )
         {
-            if( Cake.IsInteractiveMode() )
+            if( Cake.InteractiveMode() != InteractiveMode.NoInteraction )
             {
                 var localFeed = Cake.FindDirectoryAbove( "LocalFeed" );
                 if( localFeed != null )

CodeCakeBuilder/Build.cs

@@ -132,7 +132,7 @@ void ShouldFindTestTxtFileFromDynamicPaths( bool shouldFind )
             Task( "Push-NuGet-Packages" )
                 .IsDependentOn( "Create-NuGet-Packages" )
                 .WithCriteria( () => gitInfo.IsValid )
-                .Does( () =>
+               .Does( () =>
                 {
                     StandardPushNuGetPackages( Cake.GetFiles( releasesDir.Path + "/*.nupkg" ), gitInfo );
                 } );

CodeCakeBuilder/Program.cs

@@ -10,19 +10,18 @@ class Program
         /// </summary>
         /// <param name="args">The command line arguments.</param>
         /// <returns>An error code (typically negative), 0 on success.</returns>
-        static int Main(string[] args)
+        static int Main( string[] args )
         {
             var app = new CodeCakeApplication();
-            RunResult result = app.Run(args);
-            if (result.IsInteractiveMode)
+            RunResult result = app.Run( args );
+            if( result.InteractiveMode == InteractiveMode.Interactive )
             {
                 Console.WriteLine();
-                Console.WriteLine($"Hit any key to exit.");
-                Console.WriteLine($"Use -{InteractiveAliases.NoInteractionArgument} or -{InteractiveAliases.AutoInteractionArgument} parameter to exit immediately.");
+                Console.WriteLine( $"Hit any key to exit." );
+                Console.WriteLine( $"Use -{InteractiveAliases.NoInteractionArgument} or -{InteractiveAliases.AutoInteractionArgument} parameter to exit immediately." );
                 Console.ReadKey();
             }
             return result.ReturnCode;
-
         }
     }
 }

CodeCakeBuilder/Properties/launchSettings.json

@@ -0,0 +1,8 @@
+{
+  "profiles": {
+    "Run": {
+      "commandName": "project",
+      "commandLineArgs": "-autointeraction"
+    }
+  }
+}