-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #44 from dabutvin/ignored-files
adds support for ignoredFiles (#2)
- Loading branch information
Showing
13 changed files
with
257 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
using System.IO; | ||
using System.Linq; | ||
using ImgBot.Common; | ||
|
||
namespace ImgBot.Function | ||
{ | ||
public static class ImageQuery | ||
{ | ||
public static string[] FindImages(string localPath, RepoConfiguration repoConfiguration) | ||
{ | ||
var images = KnownImgPatterns.ImgPatterns | ||
.AsParallel() | ||
.SelectMany(pattern => Directory.EnumerateFiles(localPath, pattern, SearchOption.AllDirectories)); | ||
|
||
if(repoConfiguration.IgnoredFiles != null) | ||
{ | ||
// find all the ignored files and exclude them from the found images | ||
var ignoredFiles = repoConfiguration.IgnoredFiles | ||
.AsParallel() | ||
.SelectMany(pattern => Directory.EnumerateFiles(localPath, pattern, SearchOption.AllDirectories)); | ||
|
||
images = images.Except(ignoredFiles); | ||
} | ||
|
||
return images.ToArray(); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,190 @@ | ||
using System.Linq; | ||
using ImgBot.Common; | ||
using ImgBot.Function; | ||
using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
||
namespace ImgBot.Test | ||
{ | ||
[TestClass] | ||
public class ImageQueryTests | ||
{ | ||
[TestMethod] | ||
public void GivenDefaultConfiguration_ShouldFindAllImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration()); | ||
|
||
Assert.AreEqual(7, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
images.Contains("item1.png"); | ||
images.Contains("item2.png"); | ||
images.Contains("item3.jpg"); | ||
images.Contains("deepimage.png"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenFullIgnoreFullPath_ShouldIgnoreImage() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"folder/item2.png" | ||
} | ||
}); | ||
|
||
Assert.AreEqual(6, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
images.Contains("item1.png"); | ||
images.Contains("item3.jpg"); | ||
images.Contains("deepimage.png"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenFolderSlash_ShouldIgnoreImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"folder/" | ||
} | ||
}); | ||
|
||
Assert.AreEqual(3, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenFolderWildcard_ShouldIgnoreImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"folder/*" | ||
} | ||
}); | ||
|
||
Assert.AreEqual(3, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenWildcardExtension_ShouldIgnoreImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"*.png" | ||
} | ||
}); | ||
|
||
Assert.AreEqual(2, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("item3.jpg"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenWildcard_ShouldIgnoreAllImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"*" | ||
} | ||
}); | ||
|
||
Assert.AreEqual(0, images.Length); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenDifferentSlashPath_ShouldIgnoreImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"folder/item2.png", | ||
"folder\\item3.jpg" | ||
} | ||
}); | ||
|
||
Assert.AreEqual(5, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
images.Contains("item1.png"); | ||
images.Contains("deepimage.png"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenDeeplyNestedImage_ShouldIgnoreImage() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"deepimage.png", | ||
} | ||
}); | ||
|
||
Assert.AreEqual(6, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
images.Contains("item1.png"); | ||
images.Contains("item2.png"); | ||
images.Contains("item3.jpg"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenDeeplyNestedPath_ShouldIgnoreImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"folder/deep/nested/*", | ||
} | ||
}); | ||
|
||
Assert.AreEqual(6, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
images.Contains("item1.png"); | ||
images.Contains("item2.png"); | ||
images.Contains("item3.jpg"); | ||
} | ||
|
||
[TestMethod] | ||
public void GivenDeeplyNestedPathOneUp_ShouldIgnoreImages() | ||
{ | ||
var images = ImageQuery.FindImages("data", new RepoConfiguration | ||
{ | ||
IgnoredFiles = new[] | ||
{ | ||
"folder/deep/*", | ||
} | ||
}); | ||
|
||
Assert.AreEqual(6, images.Length); | ||
images.Contains("a.jpg"); | ||
images.Contains("b.png"); | ||
images.Contains("c.png"); | ||
images.Contains("item1.png"); | ||
images.Contains("item2.png"); | ||
images.Contains("item3.jpg"); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,6 +64,11 @@ This file should be placed in the root of the repository and set to your liking. | |
``` | ||
{ | ||
"schedule": "daily" // daily|weekly|monthly | ||
"ignoredFiles": [ | ||
"*.jpg", // by extension | ||
"image1.png", // by filename | ||
"public/special_images/*", // by folderpath | ||
] | ||
} | ||
``` | ||
|
||
|
@@ -77,6 +82,11 @@ to [email protected] | |
- Accepts: daily|weekly|monthly | ||
- Limits the PRs from ImgBot to once a day, once a week, or once a month respectively | ||
- The default behavior is to receive ImgBot PRs as images require optimization | ||
- ignoredFiles | ||
- optional | ||
- Accepts the syntax for searchPattern on [Directory.EnumerateFiles()](https://docs.microsoft.com/en-us/dotnet/api/system.io.directory.enumeratefiles) | ||
- Limits the images optimized by ImgBot by esentially ignoring them | ||
- When ignoring by filename no path is neccesary, when ignoring by foldername full path from root is necessary | ||
|
||
## The end result | ||
|
||
|