Skip to content

Commit

Permalink
(chocolatey#1174)(chocolatey#1610) Add tests for installing/upgrading…
Browse files Browse the repository at this point in the history 
… with leading zeros

Also adds install tests for packages with a forth part zero
  • Loading branch information
@TheCakeIsNaOH
TheCakeIsNaOH committed Jan 13, 2023
1 parent 8f1eef6 commit 15b6368
Show file tree
Hide file tree
Showing 3 changed files with 520 additions and 1 deletion.
53 changes: 52 additions & 1 deletion src/chocolatey.tests.integration/Scenario.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ namespace chocolatey.tests.integration
using System;
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
using System.Linq;

using System.Xml.Linq;
using chocolatey.infrastructure.app;
using chocolatey.infrastructure.app.configuration;
using chocolatey.infrastructure.app.domain;
Expand All @@ -29,6 +30,8 @@ namespace chocolatey.tests.integration
using chocolatey.infrastructure.filesystem;
using chocolatey.infrastructure.guards;
using chocolatey.infrastructure.platforms;
using NuGet.Configuration;
using NuGet.Packaging;

public class Scenario
{
Expand Down Expand Up @@ -201,6 +204,54 @@ public static void create_directory(string directoryPath)
_fileSystem.create_directory(directoryPath);
}

public static void add_changed_version_package_to_source_location(ChocolateyConfiguration config, string pattern, string newVersion)
{
_fileSystem.create_directory_if_not_exists(config.Sources);
var contextDir = _fileSystem.combine_paths(get_top_level(), "context");
var files = _fileSystem.get_files(contextDir, pattern, SearchOption.AllDirectories);

foreach (var file in files.or_empty_list_if_null())
{
var copyToPath = _fileSystem.combine_paths(config.Sources, _fileSystem.get_file_name(file));
_fileSystem.copy_file(_fileSystem.get_full_path(file), copyToPath, overwriteExisting: true);
change_package_version(copyToPath, newVersion);
}
}

public static void change_package_version(string existingPackagePath, string newVersion)
{
string packageId;
XDocument nuspecXml;

using (var packageSteam = new FileStream(existingPackagePath, FileMode.Open, FileAccess.ReadWrite))
{

using (var packageReader = new PackageArchiveReader(packageSteam, true))
{
nuspecXml = packageReader.NuspecReader.Xml;
var metadataNode = nuspecXml.Root.Elements().FirstOrDefault(e => StringComparer.Ordinal.Equals(e.Name.LocalName, "metadata"));
var metadataNamespace = metadataNode.GetDefaultNamespace().NamespaceName;
var node = metadataNode.Elements(XName.Get("version", metadataNamespace)).FirstOrDefault();
node.Value = newVersion;
packageId = packageReader.GetIdentity().Id;
}

using (var zipArchive = new ZipArchive(packageSteam, ZipArchiveMode.Update))
{
var entry = zipArchive.GetEntry("{0}{1}".format_with(packageId, NuGetConstants.ManifestExtension));
using (var nuspecStream = entry.Open())
{
nuspecXml.Save(nuspecStream);
}
}
}

var renamedPath = _fileSystem.combine_paths(
_fileSystem.get_directory_name(existingPackagePath),
"{0}.{1}{2}".format_with(packageId, newVersion, NuGetConstants.PackageExtension));
_fileSystem.move_file(existingPackagePath, renamedPath);
}

private static ChocolateyConfiguration baseline_configuration()
{
delete_test_package_directories();
Expand Down
257 changes: 257 additions & 0 deletions src/chocolatey.tests.integration/scenarios/InstallScenarios.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5052,5 +5052,262 @@ public void should_have_executed_chocolateyInstall_script()
MockLogger.contains_message("unsupportedelements 1.0.0 Installed", LogLevel.Info).ShouldBeTrue();
}
}

public class when_installing_a_package_with_non_normalized_version : ScenariosBase
{
private PackageResult _packageResult;

protected virtual string NonNormalizedVersion => "2.02.0.0";
protected virtual string NormalizedVersion => "2.2.0";

public override void Context()
{
base.Context();
Scenario.add_changed_version_package_to_source_location(Configuration, "installpackage.1.0.0" + NuGetConstants.PackageExtension, NonNormalizedVersion);
Configuration.PackageNames = Configuration.Input = "installpackage";
}

public override void Because()
{
Results = Service.install_run(Configuration);
_packageResult = Results.FirstOrDefault().Value;
}

[Fact]
public void should_install_where_install_location_reports()
{
DirectoryAssert.Exists(_packageResult.InstallLocation);
}

[Fact]
public void should_install_the_package_in_the_lib_directory()
{
var packageDir = Path.Combine(Scenario.get_top_level(), "lib", Configuration.PackageNames);

DirectoryAssert.Exists(packageDir);
}

[Fact]
public void should_install_the_expected_version_of_the_package()
{
var packageFile = Path.Combine(Scenario.get_top_level(), "lib", Configuration.PackageNames, Configuration.PackageNames + NuGetConstants.PackageExtension);
using (var packageReader = new PackageArchiveReader(packageFile))
{
packageReader.NuspecReader.GetVersion().to_string().ShouldEqual(NonNormalizedVersion);
}
}

[Fact]
public void should_not_create_an_extensions_folder_for_the_package()
{
var extensionsDirectory = Path.Combine(Scenario.get_top_level(), "extensions", Configuration.PackageNames);

DirectoryAssert.DoesNotExist(extensionsDirectory);
}

[Fact]
public void should_not_create_an_hooks_folder_for_the_package()
{
var hooksDirectory = Path.Combine(Scenario.get_top_level(), "hooks", Configuration.PackageNames);

DirectoryAssert.DoesNotExist(hooksDirectory);
}

[Fact]
public void should_contain_a_warning_message_that_it_installed_successfully()
{
bool installedSuccessfully = false;
foreach (var message in MockLogger.MessagesFor(LogLevel.Warn).or_empty_list_if_null())
{
if (message.Contains("1/1")) installedSuccessfully = true;
}

installedSuccessfully.ShouldBeTrue();
}

[Fact]
public void should_have_a_successful_package_result()
{
_packageResult.Success.ShouldBeTrue();
}

[Fact]
public void should_not_have_inconclusive_package_result()
{
_packageResult.Inconclusive.ShouldBeFalse();
}

[Fact]
public void should_not_have_warning_package_result()
{
_packageResult.Warning.ShouldBeFalse();
}

[Fact]
public void config_should_match_package_result_name()
{
_packageResult.Name.ShouldEqual(Configuration.PackageNames);
}

[Fact]
public void result_should_have_the_correct_version()
{
_packageResult.Version.ShouldEqual(NonNormalizedVersion);
}

[Fact]
[WindowsOnly]
[Platform(Exclude = "Mono")]
public void should_have_executed_chocolateyInstall_script()
{
var message = "installpackage v{0} has been installed".format_with(NonNormalizedVersion);

MockLogger.contains_message(message, LogLevel.Info).ShouldBeTrue();
}

[Fact]
[WindowsOnly]
[Platform(Exclude = "Mono")]
public void should_create_a_shim_for_console_in_the_bin_directory()
{
var shimfile = Path.Combine(Scenario.get_top_level(), "bin", "console.exe");

FileAssert.Exists(shimfile);
}

[Fact]
[WindowsOnly]
[Platform(Exclude = "Mono")]
public void should_create_a_shim_for_graphical_in_the_bin_directory()
{
var shimfile = Path.Combine(Scenario.get_top_level(), "bin", "graphical.exe");

FileAssert.Exists(shimfile);
}

[Fact]
public void should_not_create_a_shim_for_ignored_executable_in_the_bin_directory()
{
var shimfile = Path.Combine(Scenario.get_top_level(), "bin", "not.installed.exe");

FileAssert.DoesNotExist(shimfile);
}

[Fact]
public void should_not_create_a_shim_for_mismatched_case_ignored_executable_in_the_bin_directory()
{
var shimfile = Path.Combine(Scenario.get_top_level(), "bin", "casemismatch.exe");

FileAssert.DoesNotExist(shimfile);
}

[Fact]
[WindowsOnly]
[Platform(Exclude = "Mono")]
public void should_have_a_console_shim_that_is_set_for_non_gui_access()
{
var messages = new List<string>();

var shimfile = Path.Combine(Scenario.get_top_level(), "bin", "console.exe");
CommandExecutor.execute(
shimfile,
"--shimgen-noop",
10,
stdOutAction: (s, e) => messages.Add(e.Data),
stdErrAction: (s, e) => messages.Add(e.Data)
);

var messageFound = false;

foreach (var message in messages.or_empty_list_if_null())
{
if (string.IsNullOrWhiteSpace(message)) continue;
if (message.Contains("is gui? False")) messageFound = true;
}

messageFound.ShouldBeTrue("GUI false message not found");
}

[Fact]
[WindowsOnly]
[Platform(Exclude = "Mono")]
public void should_have_a_graphical_shim_that_is_set_for_gui_access()
{
var messages = new List<string>();

var shimfile = Path.Combine(Scenario.get_top_level(), "bin", "graphical.exe");
CommandExecutor.execute(
shimfile,
"--shimgen-noop",
10,
stdOutAction: (s, e) => messages.Add(e.Data),
stdErrAction: (s, e) => messages.Add(e.Data)
);

var messageFound = false;

foreach (var message in messages.or_empty_list_if_null())
{
if (string.IsNullOrWhiteSpace(message)) continue;
if (message.Contains("is gui? True")) messageFound = true;
}

messageFound.ShouldBeTrue("GUI true message not found");
}
}

public class when_installing_a_package_specifying_normalized_version : when_installing_a_package_with_non_normalized_version
{
protected override string NormalizedVersion => "2.2.0";
protected override string NonNormalizedVersion => "2.02.0.0";

public override void Context()
{
base.Context();
Configuration.Version = NormalizedVersion;
}
}

public class when_installing_a_package_specifying_non_normalized_version : when_installing_a_package_with_non_normalized_version
{
protected override string NormalizedVersion => "2.2.0";
protected override string NonNormalizedVersion => "2.02.0.0";

public override void Context()
{
base.Context();
Configuration.Version = NonNormalizedVersion;
}
}

public class when_installing_a_package_with_multiple_leading_zeros : when_installing_a_package_with_non_normalized_version
{
protected override string NormalizedVersion => "4.4.5.1";
protected override string NonNormalizedVersion => "0004.0004.00005.01";
}

public class when_installing_a_package_with_multiple_leading_zeros_specifying_normalized_version : when_installing_a_package_with_non_normalized_version
{
protected override string NormalizedVersion => "4.4.5.1" ;
protected override string NonNormalizedVersion => "0004.0004.00005.01";

public override void Context()
{
base.Context();
Configuration.Version = NormalizedVersion;
}
}

public class when_installing_a_package_with_multiple_leading_zeros_specifying_non_normalized_version : when_installing_a_package_with_non_normalized_version
{
protected override string NormalizedVersion => "4.4.5.1";
protected override string NonNormalizedVersion => "0004.0004.00005.01";

public override void Context()
{
base.Context();
Configuration.Version = NonNormalizedVersion;
}
}
}
}
Loading

0 comments on commit 15b6368

Please sign in to comment.