Add EULA command to NuGet.exe

NuGet · Jun 14, 2024 · 787bcbc · 787bcbc
1 parent 50e3006
commit 787bcbc
Show file tree

Hide file tree

Showing 10 changed files with 318 additions and 4 deletions.
diff --git a/src/NuGet.Clients/NuGet.CommandLine/Commands/EulaCommand.cs b/src/NuGet.Clients/NuGet.CommandLine/Commands/EulaCommand.cs
@@ -0,0 +1,43 @@
+// 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.Collections.Generic;
+using System.IO;
+using System.Reflection;
+
+namespace NuGet.CommandLine.Commands
+{
+    // The Command abstract class automatically adds some unwanted arguments, like -ConfigFile.
+    // So this simple command will implement the interface directly instead.
+    [Command(typeof(NuGetCommand), "eula", "EulaDescription")]
+    internal class EulaCommand : ICommand
+    {
+        public string CurrentDirectory { get; set; }
+
+        public CommandAttribute CommandAttribute => GetType().GetCustomAttribute<CommandAttribute>();
+
+        public DeprecatedCommandAttribute DeprecatedCommandAttribute => null;
+
+        public IList<string> Arguments => Array.Empty<string>();
+
+        public void Execute()
+        {
+            Execute(System.Console.Out);
+        }
+
+        internal static void Execute(TextWriter writer)
+        {
+            using Stream resource = typeof(EulaCommand).Assembly.GetManifestResourceStream("NuGet.CommandLine.LICENSE.txt");
+            using StreamReader reader = new StreamReader(resource);
+
+            string line;
+            while ((line = reader.ReadLine()) != null)
+            {
+                writer.WriteLine(line);
+            }
+        }
+
+        public bool IncludedInHelp(string optionName) => true;
+    }
+}
diff --git a/src/NuGet.Clients/NuGet.CommandLine/NuGet.CommandLine.csproj b/src/NuGet.Clients/NuGet.CommandLine/NuGet.CommandLine.csproj
@@ -66,6 +66,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <EmbeddedResource Include="..\..\..\LICENSE.txt" />
     <EmbeddedResource Update="NuGetCommand.resx">
       <Generator>ResXFileCodeGenerator</Generator>
       <LastGenOutput>NuGetCommand.Designer.cs</LastGenOutput>

diff --git a/src/NuGet.Clients/NuGet.CommandLine/NuGetCommand.Designer.cs b/src/NuGet.Clients/NuGet.CommandLine/NuGetCommand.Designer.cs
diff --git a/src/NuGet.Clients/NuGet.CommandLine/NuGetCommand.resx b/src/NuGet.Clients/NuGet.CommandLine/NuGetCommand.resx
@@ -931,4 +931,7 @@ nuget client-certs List</value>
   <data name="SourcesCommandProtocolVersionDescription" xml:space="preserve">
     <value>The NuGet server protocol version to be used. Currently supported versions are 2 and 3. See https://learn.microsoft.com/nuget/api/overview for information about the version 3 protocol. Defaults to 2 if not specified.</value>
   </data>
-</root>
+  <data name="EulaDescription" xml:space="preserve">
+    <value>Display NuGet.exe's End User Liscence Agreement (EULA)</value>
+  </data>
+</root>
diff --git a/src/NuGet.Clients/NuGet.CommandLine/Program.cs b/src/NuGet.Clients/NuGet.CommandLine/Program.cs
@@ -156,7 +156,10 @@ public static int MainCore(string workingDirectory, string[] args)
                 }
                 else
                 {
-                    SetConsoleInteractivity(console, command as Command);
+                    if (command is Command baseCommand)
+                    {
+                        SetConsoleInteractivity(console, baseCommand);
+                    }
 
                     try
                     {

diff --git a/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/Commands/EulaCommandTests.cs b/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/Commands/EulaCommandTests.cs
@@ -0,0 +1,42 @@
+// 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.IO;
+using System.Text;
+using FluentAssertions;
+using NuGet.CommandLine.Commands;
+using Xunit;
+
+namespace NuGet.CommandLine.Test.Commands
+{
+    public class EulaCommandTests
+    {
+        [Fact]
+        public void Execute_ShowsRepoLicense()
+        {
+            // Arrange
+            using MemoryStream memoryStream = new MemoryStream();
+
+            // Act
+            using (TextWriter writer = new StreamWriter(memoryStream, Encoding.UTF8, 4096, leaveOpen: true))
+            {
+                EulaCommand.Execute(writer);
+            }
+
+            // Assert
+            memoryStream.Position = 0;
+            using MemoryStream repoLicenseStream = new MemoryStream(TestResource.LICENSE);
+
+            using TextReader actualText = new StreamReader(memoryStream);
+            using TextReader expectedText = new StreamReader(repoLicenseStream);
+
+            string actualLine;
+            do
+            {
+                actualLine = actualText.ReadLine();
+                string expectedLine = expectedText.ReadLine();
+                actualLine.Should().Be(expectedLine);
+            } while (actualLine != null);
+        }
+    }
+}
diff --git a/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/NuGet.CommandLine.Test.csproj b/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/NuGet.CommandLine.Test.csproj
@@ -39,6 +39,21 @@
              Condition="'$(PkgMicrosoft_TestPlatform_Portable)' != ''" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Update="TestResource.Designer.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>TestResource.resx</DependentUpon>
+    </Compile>
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Update="TestResource.resx">
+      <Generator>ResXFileCodeGenerator</Generator>
+      <LastGenOutput>TestResource.Designer.cs</LastGenOutput>
+    </EmbeddedResource>
+  </ItemGroup>
+
   <Target Name="AddProjectReferenceFilesToOutputDirectory" AfterTargets="ResolveProjectReferences">
     <ItemGroup>
       <ProjectReferenceFiles Include="@(SampleCommandLineExtensionsOutputGroup)"

diff --git a/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/NuGetHelpCommandTest.cs b/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/NuGetHelpCommandTest.cs
@@ -12,6 +12,7 @@ public class NuGetHelpCommandTest
         [InlineData("client-certs")]
         [InlineData("config")]
         [InlineData("delete")]
+        [InlineData("eula")]
         [InlineData("help")]
         [InlineData("init")]
         [InlineData("install")]

diff --git a/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/TestResource.Designer.cs b/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/TestResource.Designer.cs
diff --git a/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/TestResource.resx b/test/NuGet.Clients.Tests/NuGet.CommandLine.Test/TestResource.resx
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!-- 
+    Microsoft ResX Schema 
+    
+    Version 2.0
+    
+    The primary goals of this format is to allow a simple XML format 
+    that is mostly human readable. The generation and parsing of the 
+    various data types are done through the TypeConverter classes 
+    associated with the data types.
+    
+    Example:
+    
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+                
+    There are any number of "resheader" rows that contain simple 
+    name/value pairs.
+    
+    Each data row contains a name, and value. The row also contains a 
+    type or mimetype. Type corresponds to a .NET class that support 
+    text/value conversion through the TypeConverter architecture. 
+    Classes that don't support this are serialized and stored with the 
+    mimetype set.
+    
+    The mimetype is used for serialized objects, and tells the 
+    ResXResourceReader how to depersist the object. This is currently not 
+    extensible. For a given mimetype the value must be set accordingly:
+    
+    Note - application/x-microsoft.net.object.binary.base64 is the format 
+    that the ResXResourceWriter will generate, however the reader can 
+    read any of the formats listed below.
+    
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+    
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array 
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <assembly alias="System.Windows.Forms" name="System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
+  <data name="LICENSE" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\..\..\LICENSE.txt;System.Byte[]</value>
+  </data>
+</root>
-Original file line number
+Diff line change
@@ Expand Up @@
                     }
                     else
                     {
-                        SetConsoleInteractivity(console, command as Command);
+                        if (command is Command baseCommand)
+                        {
+                            SetConsoleInteractivity(console, baseCommand);
+                        }
                         try
                         {
@@ Expand Down @@