Added tags to yaml definition to be used in CLI run filter (#528)

* fixed unit test: Services_UnrecognizedKey * TyeAssert - duplicated check removed * YAML service.tags added to parser and unit tests * filter services by tags - run argument + ApplicationFactory filter * filter ingress by tags * Make tags work for all scenarios Co-authored-by: Justin Kotalik <jukotali@microsoft.com>
dotnet · Jun 18, 2020 · c9561a4 · c9561a4
1 parent 18712f9
commit c9561a4
Show file tree

Hide file tree

Showing 19 changed files with 228 additions and 56 deletions.
diff --git a/src/Microsoft.Tye.Core/ApplicationFactory.cs b/src/Microsoft.Tye.Core/ApplicationFactory.cs
@@ -4,7 +4,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
@@ -15,7 +14,7 @@ namespace Microsoft.Tye
 {
     public static class ApplicationFactory
     {
-        public static async Task<ApplicationBuilder> CreateAsync(OutputContext output, FileInfo source)
+        public static async Task<ApplicationBuilder> CreateAsync(OutputContext output, FileInfo source, ApplicationFactoryFilter? filter = null)
         {
             if (source is null)
             {
@@ -71,7 +70,11 @@ public static async Task<ApplicationBuilder> CreateAsync(OutputContext output, F
                     root.Extensions.Add(extension);
                 }
 
-                foreach (var configService in config.Services)
+                var services = filter?.ServicesFilter != null ?
+                    config.Services.Where(filter.ServicesFilter).ToList() :
+                    config.Services;
+
+                foreach (var configService in services)
                 {
                     ServiceBuilder service;
                     if (root.Services.Any(s => s.Name == configService.Name))
@@ -320,7 +323,11 @@ service is ProjectServiceBuilder project2 &&
                     }
                 }
 
-                foreach (var configIngress in config.Ingress)
+                var ingresses = filter?.IngressFilter != null ?
+                    config.Ingress.Where(filter.IngressFilter).ToList() :
+                    config.Ingress;
+
+                foreach (var configIngress in ingresses)
                 {
                     var ingress = new IngressBuilder(configIngress.Name!);
                     ingress.Replicas = configIngress.Replicas ?? 1;

diff --git a/src/Microsoft.Tye.Core/ApplicationFactoryFilter.cs b/src/Microsoft.Tye.Core/ApplicationFactoryFilter.cs
@@ -0,0 +1,32 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Linq;
+using Microsoft.Tye.ConfigModel;
+
+namespace Microsoft.Tye
+{
+    public class ApplicationFactoryFilter
+    {
+        public Func<ConfigService, bool>? ServicesFilter { get; set; }
+        public Func<ConfigIngress, bool>? IngressFilter { get; set; }
+
+        public static ApplicationFactoryFilter? GetApplicationFactoryFilter(string[] tags)
+        {
+            ApplicationFactoryFilter? filter = null;
+
+            if (tags != null && tags.Any())
+            {
+                filter = new ApplicationFactoryFilter
+                {
+                    ServicesFilter = service => tags.Any(b => service.Tags.Contains(b)),
+                    IngressFilter = service => tags.Any(b => service.Tags.Contains(b))
+                };
+            }
+
+            return filter;
+        }
+    }
+}
diff --git a/src/Microsoft.Tye.Core/ConfigModel/ConfigIngress.cs b/src/Microsoft.Tye.Core/ConfigModel/ConfigIngress.cs
@@ -14,5 +14,6 @@ public class ConfigIngress
         public int? Replicas { get; set; }
         public List<ConfigIngressRule> Rules { get; set; } = new List<ConfigIngressRule>();
         public List<ConfigIngressBinding> Bindings { get; set; } = new List<ConfigIngressBinding>();
+        public List<string> Tags { get; set; } = new List<string>();
     }
 }
diff --git a/src/Microsoft.Tye.Core/ConfigModel/ConfigService.cs b/src/Microsoft.Tye.Core/ConfigModel/ConfigService.cs
@@ -4,7 +4,6 @@
 
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
-using Tye;
 using YamlDotNet.Serialization;
 
 namespace Microsoft.Tye.ConfigModel
@@ -37,6 +36,7 @@ public class ConfigService
         [YamlMember(Alias = "env")]
         public List<ConfigConfigurationSource> Configuration { get; set; } = new List<ConfigConfigurationSource>();
         public List<BuildProperty> BuildProperties { get; set; } = new List<BuildProperty>();
+        public List<string> Tags { get; set; } = new List<string>();
         public ConfigProbe? Liveness { get; set; }
         public ConfigProbe? Readiness { get; set; }
     }

diff --git a/src/Microsoft.Tye.Core/Serialization/ConfigIngressParser.cs b/src/Microsoft.Tye.Core/Serialization/ConfigIngressParser.cs
@@ -59,6 +59,14 @@ private static void HandleIngressMapping(YamlMappingNode yamlMappingNode, Config
                         }
                         HandleIngressBindings((child.Value as YamlSequenceNode)!, configIngress.Bindings);
                         break;
+                    case "tags":
+                        if (child.Value.NodeType != YamlNodeType.Sequence)
+                        {
+                            throw new TyeYamlException(child.Value.Start, CoreStrings.FormatExpectedYamlSequence(key));
+                        }
+
+                        HandleIngressTags((child.Value as YamlSequenceNode)!, configIngress.Tags);
+                        break;
                     default:
                         throw new TyeYamlException(child.Key.Start, CoreStrings.FormatUnrecognizedKey(key));
                 }
@@ -137,5 +145,14 @@ private static void HandleIngressBindingMapping(YamlMappingNode yamlMappingNode,
                 }
             }
         }
+
+        private static void HandleIngressTags(YamlSequenceNode yamlSequenceNode, List<string> tags)
+        {
+            foreach (var child in yamlSequenceNode!.Children)
+            {
+                var tag = YamlParser.GetScalarValue(child);
+                tags.Add(tag);
+            }
+        }
     }
 }
diff --git a/src/Microsoft.Tye.Core/Serialization/ConfigServiceParser.cs b/src/Microsoft.Tye.Core/Serialization/ConfigServiceParser.cs
@@ -3,8 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Collections.Generic;
-using System.Linq;
-using Microsoft.Build.Evaluation;
 using Microsoft.Tye.ConfigModel;
 using YamlDotNet.RepresentationModel;
 
@@ -131,6 +129,14 @@ private static void HandleServiceNameMapping(YamlMappingNode yamlMappingNode, Co
                         service.Readiness = new ConfigProbe();
                         HandleServiceProbe((YamlMappingNode)child.Value, service.Readiness!);
                         break;
+                    case "tags":
+                        if (child.Value.NodeType != YamlNodeType.Sequence)
+                        {
+                            throw new TyeYamlException(child.Value.Start, CoreStrings.FormatExpectedYamlSequence(key));
+                        }
+
+                        HandleServiceTags((child.Value as YamlSequenceNode)!, service.Tags);
+                        break;
                     default:
                         throw new TyeYamlException(child.Key.Start, CoreStrings.FormatUnrecognizedKey(key));
                 }
@@ -444,5 +450,14 @@ private static void HandleServiceBuildPropertyNameMapping(YamlMappingNode yamlMa
                 }
             }
         }
+
+        private static void HandleServiceTags(YamlSequenceNode yamlSequenceNode, List<string> tags)
+        {
+            foreach (var child in yamlSequenceNode!.Children)
+            {
+                var tag = YamlParser.GetScalarValue(child);
+                tags.Add(tag);
+            }
+        }
     }
 }
diff --git a/src/Microsoft.Tye.Core/Serialization/YamlParser.cs b/src/Microsoft.Tye.Core/Serialization/YamlParser.cs
@@ -62,12 +62,14 @@ public ConfigApplication ParseConfigApplication()
                 service.Bindings ??= new List<ConfigServiceBinding>();
                 service.Configuration ??= new List<ConfigConfigurationSource>();
                 service.Volumes ??= new List<ConfigVolume>();
+                service.Tags ??= new List<string>();
             }
 
             foreach (var ingress in app.Ingress)
             {
                 ingress.Bindings ??= new List<ConfigIngressBinding>();
                 ingress.Rules ??= new List<ConfigIngressRule>();
+                ingress.Tags ??= new List<string>();
             }
 
             return app;

diff --git a/src/Microsoft.Tye.Core/StandardOptions.cs b/src/Microsoft.Tye.Core/StandardOptions.cs
@@ -30,6 +30,22 @@ public static Option Environment
             }
         }
 
+        public static Option Tags
+        {
+            get
+            {
+                return new Option("--tags", "--filter")
+                {
+                    Argument = new Argument<List<string>>("tags")
+                    {
+                        Arity = ArgumentArity.OneOrMore
+                    },
+                    Description = "Filter the group of running services by tag.",
+                    Required = false
+                };
+            }
+        }
+
         public static Option Force
         {
             get

diff --git a/src/tye/BuildHost.cs b/src/tye/BuildHost.cs
@@ -11,10 +11,11 @@ namespace Microsoft.Tye
 {
     public static class BuildHost
     {
-        public static async Task BuildAsync(IConsole console, FileInfo path, Verbosity verbosity, bool interactive)
+        public static async Task BuildAsync(IConsole console, FileInfo path, Verbosity verbosity, bool interactive, string[] tags)
         {
             var output = new OutputContext(console, verbosity);
-            var application = await ApplicationFactory.CreateAsync(output, path);
+            var filter = ApplicationFactoryFilter.GetApplicationFactoryFilter(tags);
+            var application = await ApplicationFactory.CreateAsync(output, path, filter);
             if (application.Services.Count == 0)
             {
                 throw new CommandException($"No services found in \"{application.Source.Name}\"");

diff --git a/src/tye/GenerateHost.cs b/src/tye/GenerateHost.cs
@@ -13,12 +13,13 @@ namespace Microsoft.Tye
 {
     public static class GenerateHost
     {
-        public static async Task GenerateAsync(IConsole console, FileInfo path, Verbosity verbosity, bool interactive, string ns)
+        public static async Task GenerateAsync(IConsole console, FileInfo path, Verbosity verbosity, bool interactive, string ns, string[] tags)
         {
             var output = new OutputContext(console, verbosity);
 
             output.WriteInfoLine("Loading Application Details...");
-            var application = await ApplicationFactory.CreateAsync(output, path);
+            var filter = ApplicationFactoryFilter.GetApplicationFactoryFilter(tags);
+            var application = await ApplicationFactory.CreateAsync(output, path, filter);
             if (application.Services.Count == 0)
             {
                 throw new CommandException($"No services found in \"{application.Source.Name}\"");

diff --git a/src/tye/Program.BuildCommand.cs b/src/tye/Program.BuildCommand.cs
@@ -21,17 +21,18 @@ public static Command CreateBuildCommand()
                 CommonArguments.Path_Required,
                 StandardOptions.Interactive,
                 StandardOptions.Verbosity,
+                StandardOptions.Tags
             };
 
-            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool>((console, path, verbosity, interactive) =>
+            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, string[]>((console, path, verbosity, interactive, tags) =>
             {
                 // Workaround for https://github.com/dotnet/command-line-api/issues/723#issuecomment-593062654
                 if (path is null)
                 {
                     throw new CommandException("No project or solution file was found.");
                 }
 
-                return BuildHost.BuildAsync(console, path, verbosity, interactive);
+                return BuildHost.BuildAsync(console, path, verbosity, interactive, tags);
             });
 
             return command;

diff --git a/src/tye/Program.DeployCommand.cs b/src/tye/Program.DeployCommand.cs
@@ -7,6 +7,7 @@
 using System.CommandLine;
 using System.CommandLine.Invocation;
 using System.IO;
+using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 using Microsoft.Tye.ConfigModel;
@@ -23,6 +24,7 @@ public static Command CreateDeployCommand()
                 StandardOptions.Interactive,
                 StandardOptions.Verbosity,
                 StandardOptions.Namespace,
+                StandardOptions.Tags,
             };
 
             command.AddOption(new Option(new[] { "-f", "--force" })
@@ -31,7 +33,7 @@ public static Command CreateDeployCommand()
                 Required = false
             });
 
-            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, bool, string>(async (console, path, verbosity, interactive, force, @namespace) =>
+            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, bool, string, string[]>(async (console, path, verbosity, interactive, force, @namespace, tags) =>
             {
                 // Workaround for https://github.com/dotnet/command-line-api/issues/723#issuecomment-593062654
                 if (path is null)
@@ -42,12 +44,15 @@ public static Command CreateDeployCommand()
                 var output = new OutputContext(console, verbosity);
 
                 output.WriteInfoLine("Loading Application Details...");
-                var application = await ApplicationFactory.CreateAsync(output, path);
+
+                var filter = ApplicationFactoryFilter.GetApplicationFactoryFilter(tags);
+
+                var application = await ApplicationFactory.CreateAsync(output, path, filter);
                 if (application.Services.Count == 0)
                 {
                     throw new CommandException($"No services found in \"{application.Source.Name}\"");
                 }
-                if (!String.IsNullOrEmpty(@namespace))
+                if (!string.IsNullOrEmpty(@namespace))
                 {
                     application.Namespace = @namespace;
                 }

diff --git a/src/tye/Program.GenerateCommand.cs b/src/tye/Program.GenerateCommand.cs
@@ -22,21 +22,22 @@ public static Command CreateGenerateCommand()
                 StandardOptions.Interactive,
                 StandardOptions.Verbosity,
                 StandardOptions.Namespace,
+                StandardOptions.Tags
             };
 
             // This is a super-secret VIP-only command! It's useful for testing, but we're 
             // not documenting it right now.
             command.IsHidden = true;
 
-            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, string>((console, path, verbosity, interactive, @namespace) =>
+            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, string, string[]>((console, path, verbosity, interactive, @namespace, tags) =>
             {
                 // Workaround for https://github.com/dotnet/command-line-api/issues/723#issuecomment-593062654
                 if (path is null)
                 {
                     throw new CommandException("No project or solution file was found.");
                 }
 
-                return GenerateHost.GenerateAsync(console, path, verbosity, interactive, @namespace);
+                return GenerateHost.GenerateAsync(console, path, verbosity, interactive, @namespace, tags);
             });
 
             return command;

diff --git a/src/tye/Program.PushCommand.cs b/src/tye/Program.PushCommand.cs
@@ -18,6 +18,7 @@ public static Command CreatePushCommand()
                 CommonArguments.Path_Required,
                 StandardOptions.Interactive,
                 StandardOptions.Verbosity,
+                StandardOptions.Tags
             };
 
             command.AddOption(new Option(new[] { "-f", "--force" })
@@ -26,7 +27,7 @@ public static Command CreatePushCommand()
                 Required = false
             });
 
-            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, bool>(async (console, path, verbosity, interactive, force) =>
+            command.Handler = CommandHandler.Create<IConsole, FileInfo, Verbosity, bool, bool, string[]>(async (console, path, verbosity, interactive, force, tags) =>
             {
                 // Workaround for https://github.com/dotnet/command-line-api/issues/723#issuecomment-593062654
                 if (path is null)
@@ -37,7 +38,9 @@ public static Command CreatePushCommand()
                 var output = new OutputContext(console, verbosity);
 
                 output.WriteInfoLine("Loading Application Details...");
-                var application = await ApplicationFactory.CreateAsync(output, path);
+                var filter = ApplicationFactoryFilter.GetApplicationFactoryFilter(tags);
+
+                var application = await ApplicationFactory.CreateAsync(output, path, filter);
                 if (application.Services.Count == 0)
                 {
                     throw new CommandException($"No services found in \"{application.Source.Name}\"");