Implementation of Cake tab with instructions for NuGet packages (#8434)

* Add installation instructions for Cake for Addin, Module, Recipe

Co-authored-by: Nils Andresen <[email protected]>

Related to #8381

Author: augustoproiete

src/Bootstrap/dist/css/bootstrap-theme.css

@@ -1,6 +1,6 @@
 /*!
  * Bootstrap v3.4.1 (https://getbootstrap.com/)
- * Copyright 2011-2020 Twitter, Inc.
+ * Copyright 2011-2021 Twitter, Inc.
  * Licensed under the MIT license
  */
 

src/Bootstrap/dist/js/bootstrap.js

@@ -303,6 +303,7 @@
             border-width: 1px 0 1px 1px;
             user-select: all;
             vertical-align: middle;
+            word-break: break-word;
           }
 
           .copy-button {

src/Bootstrap/less/theme/page-display-package.less

@@ -0,0 +1,58 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Linq;
+
+namespace NuGetGallery
+{
+    public static class CakeBuildManagerExtensions
+    {
+        public static bool IsCakeExtension(this DisplayPackageViewModel model)
+        {
+            return IsCakeAddin(model) || IsCakeModule(model) || IsCakeRecipe(model);
+        }
+
+        public static string GetCakeInstallPackageCommand(this DisplayPackageViewModel model)
+        {
+            var reference = $"nuget:?package={model.Id}&version={model.Version}";
+
+            if (model.Prerelease)
+            {
+                reference += "&prerelease";
+            }
+
+            if (IsCakeAddin(model))
+            {
+                return $"#addin {reference}";
+            }
+
+            if (IsCakeModule(model))
+            {
+                return $"#module {reference}";
+            }
+
+            if (IsCakeRecipe(model))
+            {
+                return $"#load {reference}";
+            }
+
+            return string.Join(Environment.NewLine,
+                $"// Install {model.Id} as a Cake Addin",
+                $"#addin {reference}",
+                "",
+                $"// Install {model.Id} as a Cake Tool",
+                $"#tool {reference}"
+            );
+        }
+
+        private static bool IsCakeAddin(ListPackageItemViewModel model) =>
+            model.Tags?.Contains("cake-addin", StringComparer.OrdinalIgnoreCase) ?? false;
+
+        private static bool IsCakeModule(ListPackageItemViewModel model) =>
+            model.Tags?.Contains("cake-module", StringComparer.OrdinalIgnoreCase) ?? false;
+
+        private static bool IsCakeRecipe(ListPackageItemViewModel model) =>
+            model.Tags?.Contains("cake-recipe", StringComparer.OrdinalIgnoreCase) ?? false;
+    }
+}

src/NuGetGallery/Extensions/CakeBuildManagerExtensions.cs

@@ -212,6 +212,7 @@
     <Compile Include="Controllers\ExperimentsController.cs" />
     <Compile Include="Controllers\ManageDeprecationJsonApiController.cs" />
     <Compile Include="ExtensionMethods.cs" />
+    <Compile Include="Extensions\CakeBuildManagerExtensions.cs" />
     <Compile Include="Extensions\ImageExtensions.cs" />
     <Compile Include="Helpers\ValidationHelper.cs" />
     <Compile Include="Helpers\ViewModelExtensions\DeleteAccountListPackageItemViewModelFactory.cs" />

src/NuGetGallery/NuGetGallery.csproj

@@ -35,7 +35,7 @@
                 InstallPackageCommand = string.Format("dotnet tool install --global {0} --version {1}", Model.Id, Model.Version),
                 AlertLevel = AlertLevel.Info,
                 AlertMessage = "This package contains a <a href='https://aka.ms/global-tools'>.NET Core Global Tool</a> you can call from the shell/command line.",
-            }
+            },
         };
     }
     else if (Model.IsDotnetNewTemplatePackageType)
@@ -103,6 +103,12 @@
                     "For F# scripts that support <a href=\"{0}\">#r syntax</a>, copy this into the source code to reference the package.",
                     "https://docs.microsoft.com/en-us/dotnet/fsharp/tools/fsharp-interactive/#referencing-packages-in-f-interactive")
             },
+
+            new ThirdPartyPackageManagerViewModel("Cake", "https://cakebuild.net/support/nuget")
+            {
+                Id = Model.IsCakeExtension() ? "cake-extension" : "cake",
+                InstallPackageCommand = Model.GetCakeInstallPackageCommand()
+            },
         };
     }
 }

src/NuGetGallery/Views/Packages/DisplayPackage.cshtml

@@ -0,0 +1,207 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using System.Linq;
+using Xunit;
+
+namespace NuGetGallery.Extensions
+{
+    public class CakeBuildManagerExtensionsFacts
+    {
+        public class TheMethodIsCakeExtension
+        {
+            public class GivenAPackageWithKnownCakeTags
+            {
+                [Theory]
+                [MemberData(nameof(PackageTagsKnownToBeCakeExtensions), MemberType = typeof(CakeBuildManagerExtensionsFacts))]
+                public void ReturnsTrue(string[] tags)
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Tags = tags,
+                    };
+
+                    var actual = model.IsCakeExtension();
+
+                    Assert.True(actual);
+                }
+            }
+
+            public class GivenAPackageWithoutAnyKnownCakeTags
+            {
+                [Theory]
+                [MemberData(nameof(PackageTagsNotKnownToBeCakeExtensions), MemberType = typeof(CakeBuildManagerExtensionsFacts))]
+                public void ReturnsFalse(string[] tags)
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Tags = tags,
+                    };
+
+                    var actual = model.IsCakeExtension();
+
+                    Assert.False(actual);
+                }
+            }
+        }
+
+        public class TheMethodGetCakeInstallPackageCommand
+        {
+            public class GivenAPackageWithTheCakeAddinTag
+            {
+                [Fact]
+                public void ReturnsAnAddinDirective()
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Cake.7zip",
+                        Version = "1.0.0",
+                        Tags = new[] { "cake-addin" },
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Equal("#addin nuget:?package=Cake.7zip&version=1.0.0", actual);
+                }
+
+                [Fact]
+                public void ReturnsAnAddinDirectiveWithPrerelease()
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Cake.7zip",
+                        Version = "1.0.0",
+                        Tags = new[] { "cake-addin" },
+                        Prerelease = true,
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Equal("#addin nuget:?package=Cake.7zip&version=1.0.0&prerelease", actual);
+                }
+            }
+
+            public class GivenAPackageWithTheCakeModuleTag
+            {
+                [Fact]
+                public void ReturnsAModuleDirective()
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Cake.BuildSystems.Module",
+                        Version = "1.0.0",
+                        Tags = new[] {"cake-module"},
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Equal("#module nuget:?package=Cake.BuildSystems.Module&version=1.0.0", actual);
+                }
+
+                [Fact]
+                public void ReturnsAModuleDirectiveWithPrerelease()
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Cake.BuildSystems.Module",
+                        Version = "1.0.0",
+                        Tags = new[] { "cake-module" },
+                        Prerelease = true,
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Equal("#module nuget:?package=Cake.BuildSystems.Module&version=1.0.0&prerelease", actual);
+                }
+            }
+
+            public class GivenAPackageWithTheCakeRecipeTag
+            {
+                [Fact]
+                public void ReturnsALoadDirective()
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Cake.Recipe",
+                        Version = "1.0.0",
+                        Tags = new[] { "cake-recipe" },
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Equal("#load nuget:?package=Cake.Recipe&version=1.0.0", actual);
+                }
+
+                [Fact]
+                public void ReturnsALoadDirectiveWithPrerelease()
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Cake.Recipe",
+                        Version = "1.0.0",
+                        Tags = new[] { "cake-recipe" },
+                        Prerelease = true,
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Equal("#load nuget:?package=Cake.Recipe&version=1.0.0&prerelease", actual);
+                }
+            }
+
+            public class GivenAPackageWithoutAnyKnownCakeTags
+            {
+                [Theory]
+                [MemberData(nameof(PackageTagsNotKnownToBeCakeExtensions), MemberType = typeof(CakeBuildManagerExtensionsFacts))]
+                public void ReturnsMultipleDirectives(string[] tags)
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Polly",
+                        Version = "1.0.0",
+                        Tags = tags,
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Contains("#addin nuget:?package=Polly&version=1.0.0", actual);
+                    Assert.Contains("#tool nuget:?package=Polly&version=1.0.0", actual);
+                }
+
+                [Theory]
+                [MemberData(nameof(PackageTagsNotKnownToBeCakeExtensions), MemberType = typeof(CakeBuildManagerExtensionsFacts))]
+                public void ReturnsMultipleDirectivesWithPrerelease(string[] tags)
+                {
+                    var model = new DisplayPackageViewModel
+                    {
+                        Id = "Polly",
+                        Version = "1.0.0",
+                        Tags = tags,
+                        Prerelease = true,
+                    };
+
+                    var actual = model.GetCakeInstallPackageCommand();
+
+                    Assert.Contains("#addin nuget:?package=Polly&version=1.0.0&prerelease", actual);
+                    Assert.Contains("#tool nuget:?package=Polly&version=1.0.0&prerelease", actual);
+                }
+            }
+        }
+
+        public static IEnumerable<object[]> PackageTagsKnownToBeCakeExtensions => new[]
+        {
+            new[] { "cake-addin" },
+            new[] { "cake-module" },
+            new[] { "cake-recipe" },
+        }.Select(tags => new object[] { tags });
+
+        public static IEnumerable<object[]> PackageTagsNotKnownToBeCakeExtensions => new[]
+        {
+            null,
+            new string[0],
+            new string[] { null },
+            new[] { "json" },
+        }.Select(tags => new object[] { tags });
+    }
+}

tests/NuGetGallery.Facts/Extensions/CakeBuildManagerExtensionsFacts.cs

@@ -79,6 +79,7 @@
     <Compile Include="Authentication\AuthenticationServiceFacts.cs" />
     <Compile Include="Authentication\Providers\CommonAuth\AzureActiveDirectoryV2AuthenticatorFacts.cs" />
     <Compile Include="Authentication\TestCredentialHelper.cs" />
+    <Compile Include="Extensions\CakeBuildManagerExtensionsFacts.cs" />
     <Compile Include="Helpers\ValidationHelperFacts.cs" />
     <Compile Include="Infrastructure\ODataCacheOutputAttributeFacts.cs" />
     <Compile Include="Queries\AutocompleteDatabasePackageIdsQueryFacts.cs" />