Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
steps:
- name: "CLA Assistant"
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
uses: cla-assistant/github-action@v2.3.2
uses: cla-assistant/github-action@v2.4.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# the below token should have repo scope and must be manually added by you in the repository's secret
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@ Restrictions of Windows, Linux and OsX are alle combined to an replacemant patte
| Max length | Linux, Windows, OsX | | 255 chars |
| Unicode surrogates | OsX, Linux | Windows | U+D800 - U+DFFF |
| NotAssigned to unicode | OsX | Linux, Windows | U+67803, ... |
| Reserved codepoints OsX | OsX | Linux, Windows | [U+0ECE](https://codepoints.net/U+00ECE?lang=en), [U+0CF3](https://codepoints.net/U+00ECE), [U+11F02](https://codepoints.net/U+11F02) |
17 changes: 1 addition & 16 deletions SanitizeFilename/SanitizeFilename.cs
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,6 @@ public static class SanitizeFilename
(char)31,
];

/// <summary>
/// CodePoints proven to fail to be used on OsX github runner for filenames
/// </summary>
public static readonly int[] InvalidCodePointInOsXFileNames = [
// U+0ECE Lao Yamakkan https://codepoints.net/U+00ECE
3790,
// U+0CF3 Kannada Sign Combining Anusvara Above Right https://codepoints.net/U+00CF3
3315,
// U+11F02 Kawi Sign Repha https://codepoints.net/U+11F02
73474,
];

/// <summary>
/// These chars are invalid in Windows file names
/// </summary>
Expand Down Expand Up @@ -128,9 +116,6 @@ private static void ReplacementSanityCheck(char replacement)

if (InvalidCharsInWindowsFileNames.Contains(replacement))
throw new ArgumentException($"Replacement '{replacement}' is invalid for Windows", nameof(replacement));

if (InvalidCodePointInOsXFileNames.Any(c => char.ConvertFromUtf32(c).Contains(replacement, StringComparison.InvariantCulture)))
throw new ArgumentException($"Replacement '{replacement}' is invalid for MacOs", nameof(replacement));
}

private static string InternalSanitize(string filename, char replacement)
Expand All @@ -140,7 +125,7 @@ private static string InternalSanitize(string filename, char replacement)

private static string InternalSanitize(string filename, string replacement)
{
var invalidCharsFileNamesSanitized = InternalSanitizeChars(filename, replacement, InvalidCharsInWindowsFileNames, InvalidCodePointInOsXFileNames);
var invalidCharsFileNamesSanitized = InternalSanitizeChars(filename, replacement, InvalidCharsInWindowsFileNames);
var reservedFileNamesSanitized = InternalSanitizeReservedFileNames(invalidCharsFileNamesSanitized, $"{replacement}");
var reservedFileNamePrefixSanitized = InternalSanitizeReservedFileNamePrefix(reservedFileNamesSanitized, $"{replacement}");
var trailingCharSanitized = RemoveTrailingPeriodOrSpace(reservedFileNamePrefixSanitized, $"{replacement}");
Expand Down
62 changes: 16 additions & 46 deletions SanitizeFilenameTests/OsXSpecificTests.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
using Codeuctivity;
using System.Globalization;
using System.Runtime.InteropServices;

namespace SanitizeFilenameTests
Expand All @@ -20,16 +19,6 @@ public void TearDown()

public FileWriteAsserter FileWriteAsserter { get; }

[Test, TestCaseSource(typeof(SanitizeFilename), nameof(SanitizeFilename.InvalidCodePointInOsXFileNames))]
public void ShouldSanitizeOsXSpecificInvalidChars(int i)
{
string fileNameOsXSpecificException = "filename" + char.ConvertFromUtf32(i);
string sanitizedFileNameOsXSpecificException = fileNameOsXSpecificException.SanitizeFilename();
var actual = FileWriteAsserter.TryWriteFileToTempDirectory(sanitizedFileNameOsXSpecificException);
Assert.That(actual, $"Expected the fileNameOsXSpecificException {i:X4} to be sanitized and usable on any OS.");
Assert.That(fileNameOsXSpecificException, Is.Not.EqualTo(sanitizedFileNameOsXSpecificException));
}

[Test]
// https://codepoints.net/U+11F02?lang=en
[TestCase(73474)]
Expand All @@ -43,41 +32,6 @@ public void ShouldSanitizeOsXSpecificInvalidChar(int unicodeOnlyFailingOnOsX)
Assert.That(fileNameOsXSpecificException, Is.Not.EqualTo(sanitizedFileNameOsXSpecificException));
}

[Test, TestCaseSource(typeof(SanitizeFilename), nameof(SanitizeFilename.InvalidCodePointInOsXFileNames))]
public void ShouldBehaviorOsDependentOnWritingFilenameWithKnownOsXSpecificExceptions(int invalidOnMacOs)
{
var expected = !RuntimeInformation.IsOSPlatform(OSPlatform.OSX);
var filenameInvalidOnMacOs = char.ConvertFromUtf32(invalidOnMacOs) + "Filename.txt";
var actual = FileWriteAsserter.TryWriteFileToTempDirectory(filenameInvalidOnMacOs);
Assert.That(actual, Is.EqualTo(expected));
}

[Test]
public void ShouldProofThatThereAreOnlyKnownExceptionsInListOfInvalidUnicodeCodePoints()
{
foreach (var item in SanitizeFilename.InvalidCodePointInOsXFileNames)
{
var category = CharUnicodeInfo.GetUnicodeCategory(item);

if (item == 3315)
{
Assert.That(category, Is.EqualTo(UnicodeCategory.SpacingCombiningMark));
}
else if (item == 3790)
{
Assert.That(category, Is.EqualTo(UnicodeCategory.NonSpacingMark));
}
else if (item == 73474)
{
Assert.That(category, Is.EqualTo(UnicodeCategory.OtherLetter));
}
else
{
Assert.That(category, Is.EqualTo(UnicodeCategory.OtherNotAssigned));
}
}
}

[Test]
public void MacOsDoesNotSupportToWriteNotAssignedCodepointsWithSurrogates()
{
Expand All @@ -102,5 +56,21 @@ public void ShouldSanitizeValidSurrogatesWithoutFollowingCodepoint()
var actual = FileWriteAsserter.TryWriteFileToTempDirectory(filenameInvalidOnMacOs);
Assert.That(actual, Is.EqualTo(expected));
}

[Test]
// U+0ECE Lao Yamakkan https://codepoints.net/U+00ECE
[TestCase(3790)]
// U+0CF3 Kannada Sign Combining Anusvara Above Right https://codepoints.net/U+00CF3
[TestCase(3315)]
// U+11F02 Kawi Sign Repha https://codepoints.net/U+11F02
[TestCase(73474)]

public void MacOsSupportToWriteCodePointsThatFailedOnOsXGibhutRunnersInBeginOf2024(int bogusOsXValue)
{
// https://unicodelookup.com/#423939/1
var filenameInvalidOnMacOs = char.ConvertFromUtf32(bogusOsXValue) + "Filename.txt";
var actual = FileWriteAsserter.TryWriteFileToTempDirectory(filenameInvalidOnMacOs);
Assert.That(actual, Is.True);
}
}
}