Skip to content

Commit

Permalink
(chocolatey#2462) Deprecate remote args for list command
Browse files Browse the repository at this point in the history 
This commit updates the list command to deprecate
the argument `--local-only` and arguments only valid
for remote sources when running the list command,
with a message that list will be made local only by default
in v2.0.0. The same message mentions to use search or find
instead for remote searches.

There are additionally several messages other places to ensure
that it will be difficult to miss the deprecation of remote
sources when calling the list command.
  • Loading branch information
@AdmiringWorm
AdmiringWorm committed Mar 9, 2022
1 parent 641f627 commit 45265d9
Show file tree
Hide file tree
Showing 2 changed files with 388 additions and 19 deletions.
317 changes: 317 additions & 0 deletions src/chocolatey.tests/infrastructure.app/commands/ChocolateyListCommandSpecs.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,142 @@ public void should_implement_search()
{
results.ShouldContain("search");
}

[Fact]
public void should_implement_find()
{
results.ShouldContain("find");
}
}

public class when_configurating_the_argument_parser_for_list_command : ChocolateyListCommandSpecsBase
{
private OptionSet optionSet;

public override void Context()
{
base.Context();
optionSet = new OptionSet();
configuration.CommandName = "list";
}

public override void Because()
{
command.configure_argument_parser(optionSet, configuration);
}

[Fact]
public void should_add_source_to_the_option_set()
{
optionSet.Contains("source").ShouldBeTrue();
}

[Fact]
public void should_add_short_version_of_source_to_the_option_set()
{
optionSet.Contains("s").ShouldBeTrue();
}

[Fact, Obsolete("Local Only will be removed in v2.0.0 for the list command")]
public void should_add_localonly_to_the_option_set()
{
optionSet.Contains("localonly").ShouldBeTrue();
}

[Fact, Obsolete("Local Only will be removed in v2.0.0 for the list command")]
public void should_add_short_version_of_localonly_to_the_option_set()
{
optionSet.Contains("l").ShouldBeTrue();
}

[NUnit.Framework.Theory]
[NUnit.Framework.TestCase("localonly")]
[NUnit.Framework.TestCase("source")]
[NUnit.Framework.TestCase("user")]
[NUnit.Framework.TestCase("password")]
[NUnit.Framework.TestCase("cert")]
[NUnit.Framework.TestCase("certpassword")]
[NUnit.Framework.TestCase("approved-only")]
[NUnit.Framework.TestCase("download-cache-only")]
[NUnit.Framework.TestCase("disable-package-repository-optimizations")]
[Obsolete("Will be removed in v2.0.0 for the list command")]
public void should_add_deprecation_notice_to_option(string argument)
{
optionSet[argument].Description.ShouldContain("DEPRECATION NOTICE");
}

[Fact]
public void should_add_prerelease_to_the_option_set()
{
optionSet.Contains("prerelease").ShouldBeTrue();
}

[Fact]
public void should_add_short_version_of_prerelease_to_the_option_set()
{
optionSet.Contains("pre").ShouldBeTrue();
}

[Fact]
public void should_add_includeprograms_to_the_option_set()
{
optionSet.Contains("includeprograms").ShouldBeTrue();
}

[Fact]
public void should_add_short_version_of_includeprograms_to_the_option_set()
{
optionSet.Contains("i").ShouldBeTrue();
}

[Fact]
public void should_add_allversions_to_the_option_set()
{
optionSet.Contains("allversions").ShouldBeTrue();
}

[Fact]
public void should_add_short_version_of_allversions_to_the_option_set()
{
optionSet.Contains("a").ShouldBeTrue();
}

[Fact, Obsolete("Will be removed in v2.0.0")]
public void should_add_user_to_the_option_set()
{
optionSet.Contains("user").ShouldBeTrue();
}

[Fact, Obsolete("Will be removed in v2.0.0")]
public void should_add_short_version_of_user_to_the_option_set()
{
optionSet.Contains("u").ShouldBeTrue();
}

[Fact, Obsolete("Will be removed in v2.0.0")]
public void should_add_password_to_the_option_set()
{
optionSet.Contains("password").ShouldBeTrue();
}

[Fact, Obsolete("Will be removed in v2.0.0")]
public void should_add_short_version_of_password_to_the_option_set()
{
optionSet.Contains("p").ShouldBeTrue();
}
}

[NUnit.Framework.TestFixture("search")]
[NUnit.Framework.TestFixture("find")]
public class when_configurating_the_argument_parser : ChocolateyListCommandSpecsBase
{
private OptionSet optionSet;

public when_configurating_the_argument_parser(string commandName)
{
configuration.CommandName = commandName;
}

public override void Context()
{
base.Context();
Expand Down Expand Up @@ -162,6 +292,21 @@ public void should_add_short_version_of_password_to_the_option_set()
{
optionSet.Contains("p").ShouldBeTrue();
}

[NUnit.Framework.Theory]
[NUnit.Framework.TestCase("localonly")]
[NUnit.Framework.TestCase("source")]
[NUnit.Framework.TestCase("user")]
[NUnit.Framework.TestCase("password")]
[NUnit.Framework.TestCase("cert")]
[NUnit.Framework.TestCase("certpassword")]
[NUnit.Framework.TestCase("approved-only")]
[NUnit.Framework.TestCase("download-cache-only")]
[NUnit.Framework.TestCase("disable-package-repository-optimizations")]
public void should_add_deprecation_notice_to_option(string argument)
{
optionSet[argument].Description.ShouldNotContain("DEPRECATION NOTICE");
}
}

public class when_handling_additional_argument_parsing : ChocolateyListCommandSpecsBase
Expand Down Expand Up @@ -199,6 +344,61 @@ public void should_leave_source_as_set()
}
}

public class when_noop_is_called_with_list_command : ChocolateyListCommandSpecsBase
{
public override void Context()
{
base.Context();
configuration.CommandName = "list";
}

public override void Because()
{
command.noop(configuration);
}

[Fact]
public void should_call_service_list_noop()
{
packageService.Verify(c => c.list_noop(configuration), Times.Once);
}

[Fact]
public void should_report_deprecation_of_remote_sources()
{
MockLogger.Messages.Keys.ShouldContain("Warn");
MockLogger.Messages["Warn"].ShouldContain(@"Using list with remote sources is deprecated and will be made local only in v2.0.0,
use the commands search or find instead for remote sources.");
}
}

public class when_noop_is_called_with_list_command_and_local_only : ChocolateyListCommandSpecsBase
{
public override void Context()
{
base.Context();
configuration.CommandName = "list";
configuration.ListCommand.LocalOnly = true;
}

public override void Because()
{
command.noop(configuration);
}

[Fact]
public void should_call_service_list_noop()
{
packageService.Verify(c => c.list_noop(configuration), Times.Once);
}

[Fact]
public void should_not_report_any_warning_messages()
{
MockLogger.Messages.Keys.ShouldNotContain("Warn");
}
}

public class when_noop_is_called : ChocolateyListCommandSpecsBase
{
public override void Because()
Expand All @@ -211,6 +411,67 @@ public void should_call_service_list_noop()
{
packageService.Verify(c => c.list_noop(configuration), Times.Once);
}

[Fact]
public void should_not_report_any_warning_messages()
{
MockLogger.Messages.Keys.ShouldNotContain("Warn");
}
}

public class when_run_is_called_with_list_command : ChocolateyListCommandSpecsBase
{
public override void Context()
{
base.Context();
configuration.CommandName = "list";
}

public override void Because()
{
command.run(configuration);
}

[Fact]
public void should_call_service_list_run()
{
packageService.Verify(c => c.list_run(configuration), Times.Once);
}

[Fact]
public void should_not_report_any_warning_messages()
{
MockLogger.Messages.Keys.ShouldContain("Warn");
MockLogger.Messages["Warn"].ShouldContain(@"Using list with remote sources is deprecated and will be made local only in v2.0.0,
use the commands search or find instead for remote sources.");
}
}

public class when_run_is_called_with_list_command_and_local_only : ChocolateyListCommandSpecsBase
{
public override void Context()
{
base.Context();
configuration.CommandName = "list";
configuration.ListCommand.LocalOnly = true;
}

public override void Because()
{
command.run(configuration);
}

[Fact]
public void should_call_service_list_run()
{
packageService.Verify(c => c.list_run(configuration), Times.Once);
}

[Fact]
public void should_not_report_any_warning_messages()
{
MockLogger.Messages.Keys.ShouldNotContain("Warn");
}
}

public class when_run_is_called : ChocolateyListCommandSpecsBase
Expand All @@ -225,6 +486,62 @@ public void should_call_service_list_run()
{
packageService.Verify(c => c.list_run(configuration), Times.Once);
}

[Fact]
public void should_not_report_any_warning_messages()
{
MockLogger.Messages.Keys.ShouldNotContain("Warn");
}
}

public class when_outputting_help_message_for_list_command : ChocolateyListCommandSpecsBase
{
public override void Context()
{
base.Context();
configuration.CommandName = "list";
}

public override void Because()
{
command.help_message(configuration);
}

[Fact, Obsolete("Will be removed in v2.0.0")]
public void should_output_deprecation_notice_header()
{
MockLogger.Messages.Keys.ShouldContain("Warn");
MockLogger.Messages["Warn"].ShouldContain("DEPRECATION NOTICE");
}

[Fact]
public void should_ouput_removal_in_v2_0_0()
{
MockLogger.Messages.Keys.ShouldContain("Warn");
MockLogger.Messages["Warn"].ShouldContain(@"
Will be removed for the list command in v2.0.0.");
}
}

[NUnit.Framework.TestFixture("search")]
[NUnit.Framework.TestFixture("find")]
public class when_outputting_help_message : ChocolateyListCommandSpecsBase
{
public when_outputting_help_message(string commandName)
{
configuration.CommandName = commandName;
}

public override void Because()
{
command.help_message(configuration);
}

[Fact]
public void should_not_output_warnings()
{
MockLogger.Messages.Keys.ShouldNotContain("Warn");
}
}
}
}
Loading

0 comments on commit 45265d9

Please sign in to comment.