Refactor func pack (#4600)

Author: aishwaryabh

eng/ci/templates/jobs/test-e2e-linux.yml

@@ -22,6 +22,9 @@ jobs:
       python_linux_x64:
         languageWorker: 'Python'
         runtime: 'linux-x64'
+      custom_linux_x64:
+        languageWorker: 'Custom'
+        runtime: 'linux-x64'
 
   steps:
   - pwsh: ./eng/scripts/start-emulators.ps1

eng/ci/templates/jobs/test-e2e-osx.yml

@@ -22,6 +22,9 @@ jobs:
       python_osx_x64:
         languageWorker: 'Python'
         runtime: 'osx-x64'
+      custom_osx_x64:
+        languageWorker: 'Custom'
+        runtime: 'osx-x64'
 
   steps:
   - pwsh: ./eng/scripts/start-emulators.ps1

eng/ci/templates/jobs/test-e2e-windows.yml

@@ -22,6 +22,9 @@ jobs:
       python_win_x64:
         languageWorker: 'Python'
         runtime: 'win-x64'
+      custom_win_x64:
+        languageWorker: 'Custom'
+        runtime: 'win-x64'
 
   steps:
   - pwsh: ./eng/scripts/start-emulators.ps1 -NoWait

eng/ci/templates/steps/run-e2e-tests.yml

@@ -30,6 +30,7 @@ steps:
     Write-Host "##vso[task.setvariable variable=DURABLE_FUNCTION_PATH]$(Build.SourcesDirectory)/test/Azure.Functions.Cli.Tests/Resources/DurableTestFolder"
     Write-Host "##vso[task.setvariable variable=INPROC_RUN_SETTINGS]$(Build.SourcesDirectory)/test/Cli/Func.E2ETests/.runsettings/start_tests/ci_pipeline/dotnet_inproc.runsettings"
     Write-Host "##vso[task.setvariable variable=TEST_PROJECT_PATH]$(Build.SourcesDirectory)/test/TestFunctionApps"
+    Write-Host "##vso[task.setvariable variable=FUNCTIONS_PYTHON_DOCKER_IMAGE]mcr.microsoft.com/azure-functions/python:4-python3.11-buildenv"
   displayName: 'Set environment variables for E2E tests'
 
 

release_notes.md

@@ -1,10 +1,10 @@
-# Azure Functions CLI 4.2.3
+# Azure Functions CLI 4.3.0
+
 
 #### Host Version
 
 - Host Version: 4.1041.200
 - In-Proc Host Version: 4.41.100 (4.841.100, 4.641.100)
 
 #### Changes
-
-- Updated assemblies to sign: AppService, Functions, WebJobs; consolidated OpenTelemetry binaries; removed Python exec patterns (t32, t64, w32, w64) (#4621)
+- Add `func pack` basic functionality (#4600) 

src/Cli/func/ActionAttribute.cs

@@ -15,5 +15,7 @@ internal sealed class ActionAttribute : Attribute
         public string HelpText { get; set; } = "placeholder";
 
         public bool ShowInHelp { get; set; } = true;
+
+        public string ParentCommandName { get; set; } = string.Empty;
     }
 }

src/Cli/func/ActionType.cs

@@ -12,5 +12,7 @@ internal class ActionType
         public IEnumerable<Context> SubContexts { get; set; }
 
         public IEnumerable<string> Names { get; set; }
+
+        public IEnumerable<string> ParentCommandName { get; set; }
     }
 }

src/Cli/func/Actions/HelpAction.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using System.ComponentModel;
@@ -18,6 +18,9 @@ namespace Azure.Functions.Cli.Actions
 {
     internal class HelpAction : BaseAction
     {
+        // Standardized indentation
+        private const int IndentSize = 4;
+
         private readonly string _context;
         private readonly string _subContext;
         private readonly IAction _action;
@@ -42,7 +45,8 @@ public HelpAction(IEnumerable<TypeAttributePair> actions, Func<Type, IAction> cr
                         Type = type,
                         Contexts = attributes.Select(a => a.Context),
                         SubContexts = attributes.Select(a => a.SubContext),
-                        Names = attributes.Select(a => a.Name)
+                        Names = attributes.Select(a => a.Name),
+                        ParentCommandName = attributes.Select(a => a.ParentCommandName)
                     };
                 });
         }
@@ -54,6 +58,8 @@ public HelpAction(IEnumerable<TypeAttributePair> actions, Func<Type, IAction> cr
             _parseResult = parseResult;
         }
 
+        private static string Indent(int levels = 1) => new string(' ', IndentSize * (levels < 0 ? 0 : levels));
+
         public override async Task RunAsync()
         {
             var latestVersionMessageTask = VersionHelper.IsRunningAnOlderVersion();
@@ -187,7 +193,8 @@ private void DisplayGeneralHelp()
                 .WriteLine("Usage: func [context] <action> [-/--options]")
                 .WriteLine();
             DisplayContextsHelp(contexts);
-            var actions = _actionTypes.Where(a => a.Contexts.Contains(Context.None));
+            var actions = _actionTypes
+                .Where(a => a.Contexts.Contains(Context.None));
             DisplayActionsHelp(actions);
         }
 
@@ -211,15 +218,80 @@ private void DisplayActionsHelp(IEnumerable<ActionType> actions)
             if (actions.Any())
             {
                 ColoredConsole.WriteLine(TitleColor("Actions: "));
+
+                // Group actions by parent command
+                var parentCommands = actions
+                    .Where(a => a.ParentCommandName.All(p => string.IsNullOrEmpty(p))) // Actions with no parent
+                    .ToList();
+
+                var subCommands = actions
+                    .Where(a => a.ParentCommandName.Any(p => !string.IsNullOrEmpty(p))) // Actions with a parent
+                    .ToList();
+
                 var longestName = actions.Select(a => a.Names).SelectMany(n => n).Max(n => n.Length);
                 longestName += 2; // for coloring chars
-                foreach (var action in actions)
+
+                // Display parent commands first
+                foreach (var parentAction in parentCommands)
                 {
-                    ColoredConsole.WriteLine(GetActionHelp(action, longestName));
-                    DisplaySwitches(action);
+                    // Display parent command
+                    ColoredConsole.WriteLine(GetActionHelp(parentAction, longestName));
+                    DisplaySwitches(parentAction);
+
+                    // Find and display child commands for this parent
+                    var parentName = parentAction.Names.First();
+                    var childCommands = subCommands
+                        .Where(s => s.ParentCommandName.Any(p => p.Equals(parentName, StringComparison.OrdinalIgnoreCase)))
+                        .ToList();
+
+                    if (childCommands.Any())
+                    {
+                        ColoredConsole.WriteLine(); // Add spacing before subcommands
+
+                        foreach (var childCommand in childCommands)
+                        {
+                            DisplaySubCommandHelp(childCommand);
+                        }
+                    }
+
+                    ColoredConsole.WriteLine();
                 }
+            }
+        }
 
-                ColoredConsole.WriteLine();
+        private void DisplaySubCommandHelp(ActionType subCommand)
+        {
+            // Ensure subCommand is valid
+            if (subCommand is null)
+            {
+                return;
+            }
+
+            // Extract the runtime name from the full command name
+            // E.g., "pack dotnet" -> "Dotnet"
+            var fullCommandName = subCommand.Names?.FirstOrDefault();
+
+            string runtimeName = null;
+            if (!string.IsNullOrWhiteSpace(fullCommandName))
+            {
+                var parts = fullCommandName.Split(' ', StringSplitOptions.RemoveEmptyEntries);
+                runtimeName = parts.Length > 1 && !string.IsNullOrEmpty(parts[1])
+                    ? char.ToUpper(parts[1][0]) + parts[1].Substring(1).ToLower()
+                    : fullCommandName;
+            }
+
+            // Fall back to a safe default if we couldn't determine a runtime name
+            runtimeName ??= subCommand.Type?.Name ?? "subcommand";
+
+            var description = subCommand.Type?.GetCustomAttributes<ActionAttribute>()?.FirstOrDefault()?.HelpText;
+
+            // Display indented subcommand header with standardized indentation
+            ColoredConsole.WriteLine($"{Indent(1)}{runtimeName.DarkCyan()}{Indent(2)}{description}");
+
+            // Display subcommand switches with extra indentation
+            if (subCommand.Type != null)
+            {
+                DisplaySwitches(subCommand);
             }
         }
 
@@ -261,7 +333,7 @@ private void DisplayPositionalArguments(IEnumerable<CliArgument> arguments)
             longestName += 4; // 4 for coloring and <> characters
             foreach (var argument in arguments)
             {
-                var helpLine = string.Format($"    {{0, {-longestName}}} {{1}}", $"<{argument.Name}>".DarkGray(), argument.Description);
+                var helpLine = string.Format($"{Indent(1)}{{0, {-longestName}}} {{1}}", $"<{argument.Name}>".DarkGray(), argument.Description);
                 if (helpLine.Length < SafeConsole.BufferWidth)
                 {
                     ColoredConsole.WriteLine(helpLine);
@@ -277,7 +349,7 @@ private void DisplayPositionalArguments(IEnumerable<CliArgument> arguments)
             }
         }
 
-        private static void DisplayOptions(IEnumerable<ICommandLineOption> options)
+        private static void DisplayOptions(IEnumerable<ICommandLineOption> options, bool addExtraIndent = false)
         {
             var longestName = options.Max(o =>
             {
@@ -311,7 +383,7 @@ private static void DisplayOptions(IEnumerable<ICommandLineOption> options)
                     stringBuilder.Append($" [-{option.ShortName}]");
                 }
 
-                var helpSwitch = string.Format($"    {{0, {-longestName}}} ", stringBuilder.ToString().DarkGray());
+                var helpSwitch = string.Format($"{(addExtraIndent ? Indent(2) : Indent(1))}{{0, {-longestName}}} ", stringBuilder.ToString().DarkGray());
                 var helpSwitchLength = helpSwitch.Length - 2; // helpSwitch contains 2 formatting characters.
                 var helpText = option.Description;
                 if (string.IsNullOrWhiteSpace(helpText))

src/Cli/func/Actions/LocalActions/PackAction.cs

@@ -0,0 +1,34 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using Azure.Functions.Cli.Interfaces;
+using Fclp;
+
+namespace Azure.Functions.Cli.Actions.LocalActions.PackAction
+{
+    [Action(Name = "pack custom", ParentCommandName = "pack", ShowInHelp = false, HelpText = "Arguments specific to custom worker runtime apps when running func pack")]
+    internal class CustomPackSubcommandAction : PackSubcommandAction
+    {
+        public override ICommandLineParserResult ParseArgs(string[] args)
+        {
+            return base.ParseArgs(args);
+        }
+
+        public async Task RunAsync(PackOptions packOptions)
+        {
+            await ExecuteAsync(packOptions);
+        }
+
+        protected override Task<string> GetPackingRootAsync(string functionAppRoot, PackOptions options)
+        {
+            // Custom worker packs from the function app root without extra steps
+            return Task.FromResult(functionAppRoot);
+        }
+
+        public override Task RunAsync()
+        {
+            // Keep this since this subcommand is not meant to be run directly.
+            return Task.CompletedTask;
+        }
+    }
+}