Files
octokit.net/Octokit.Tests/Models/SearchIssuesRequestTests.cs
mkArtak 6577c3ccba Enable support for milestone-based issues queries (#1788)
* Added support for Milestone filter in SearchIssuesRequest

* Fixed some styling issues to match with the style of the existing code

* Wrap milestone value with double quotes as milestones can contain spaces

* Allow milestone filter to contain double quotes

* Ability to search by milestone exclusions

* Moved the EscapeDoubleQuotes method to StringExtensions
2018-03-28 16:45:51 +10:00

203 lines
7.7 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using Octokit;
using Octokit.Tests.Helpers;
using Xunit;
public class SearchIssuesRequestTests
{
public class TheMergedQualifiersMethod
{
[Fact]
public void ReturnsAReadOnlyDictionary()
{
var request = new SearchIssuesRequest("test");
var result = request.MergedQualifiers();
// If I can cast this to a writeable collection, then that defeats the purpose of a read only.
AssertEx.IsReadOnlyCollection<string>(result);
}
[Fact]
public void SortNotSpecifiedByDefault()
{
var request = new SearchIssuesRequest("test");
Assert.True(string.IsNullOrWhiteSpace(request.Sort));
Assert.False(request.Parameters.ContainsKey("sort"));
}
[Fact]
public void HandlesStringAttributesCorrectly()
{
var stringProperties = new Dictionary<string, Action<SearchIssuesRequest, string>>
{
{ "author:", (x,value) => x.Author = value },
{ "assignee:", (x,value) => x.Assignee = value },
{ "mentions:", (x,value) => x.Mentions = value },
{ "commenter:", (x,value) => x.Commenter = value },
{ "involves:", (x,value) => x.Involves = value },
{ "team:", (x,value) => x.Team = value },
{ "head:", (x,value) => x.Head = value },
{ "base:", (x,value) => x.Base = value },
{ "user:", (x,value) => x.User = value },
{ "milestone:", (x,value) => x.Milestone = value }
};
foreach (var property in stringProperties)
{
var request = new SearchIssuesRequest("query");
// Ensure the specified parameter does not exist when not set
Assert.False(request.MergedQualifiers().Any(x => x.Contains(property.Key)));
// Set the parameter
property.Value(request, "blah");
// Ensure the specified parameter now exists
Assert.True(request.MergedQualifiers().Count(x => x.Contains(property.Key)) == 1);
}
}
[Fact]
public void HandlesDateRangeAttributesCorrectly()
{
var dateProperties = new Dictionary<string, Action<SearchIssuesRequest, DateRange>>
{
{ "created:", (x,value) => x.Created = value },
{ "updated:", (x,value) => x.Updated = value },
{ "merged:", (x,value) => x.Merged = value },
{ "closed:", (x,value) => x.Closed = value }
};
foreach (var property in dateProperties)
{
var request = new SearchIssuesRequest("query");
// Ensure the specified parameter does not exist when not set
Assert.False(request.MergedQualifiers().Any(x => x.Contains(property.Key)));
// Set the parameter
property.Value(request, DateRange.GreaterThan(DateTime.Today.AddDays(-7)));
// Ensure the specified parameter now exists
Assert.True(request.MergedQualifiers().Count(x => x.Contains(property.Key)) == 1);
}
}
[Fact]
public void HandlesInAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("in:")));
request.In = new List<IssueInQualifier> { IssueInQualifier.Body, IssueInQualifier.Comment };
Assert.True(request.MergedQualifiers().Contains("in:body,comment"));
}
[Fact]
public void HandlesStateAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("state:")));
request.State = ItemState.Closed;
Assert.True(request.MergedQualifiers().Contains("state:closed"));
}
[Fact]
public void HandlesLabelsAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("label:")));
request.Labels = new[] { "label1", "label2" };
Assert.True(request.MergedQualifiers().Contains("label:label1"));
Assert.True(request.MergedQualifiers().Contains("label:label2"));
}
[Fact]
public void HandlesMilestoneAttributeWithoutQuotes()
{
var request = new SearchIssuesRequest("text");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("milestone:")));
request.Milestone = "testMilestone";
Assert.True(request.MergedQualifiers().Contains("milestone:\"testMilestone\""));
}
[Fact]
public void DoesntWrapMilestoneWithDoubleQuotesForQuotedMilestone()
{
var request = new SearchIssuesRequest("text");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("milestone:")));
request.Milestone = "\"testMilestone\"";
Assert.Contains<string>("milestone:\"\\\"testMilestone\\\"\"", request.MergedQualifiers());
}
[Fact]
public void HandlesNoMetadataAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("no:")));
request.No = IssueNoMetadataQualifier.Milestone;
Assert.True(request.MergedQualifiers().Contains("no:milestone"));
}
[Fact]
public void HandlesLanguageAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("language:")));
request.Language = Language.CSharp;
Assert.True(request.MergedQualifiers().Contains("language:CSharp"));
}
[Fact]
public void HandlesIsAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("is:")));
request.Is = new List<IssueIsQualifier> { IssueIsQualifier.Merged, IssueIsQualifier.PullRequest };
Assert.True(request.MergedQualifiers().Contains("is:merged"));
Assert.True(request.MergedQualifiers().Contains("is:pr"));
}
[Fact]
public void HandlesStatusAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("status:")));
request.Status = CommitState.Error;
Assert.True(request.MergedQualifiers().Contains("status:error"));
}
[Fact]
public void HandlesCommentsAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("comments:")));
request.Comments = Range.GreaterThan(5);
Assert.True(request.MergedQualifiers().Contains("comments:>5"));
}
[Fact]
public void HandlesRepoAttributeCorrectly()
{
var request = new SearchIssuesRequest("test");
Assert.False(request.MergedQualifiers().Any(x => x.Contains("repo:")));
request.Repos.Add("myorg", "repo1");
request.Repos.Add("myorg", "repo2");
Assert.True(request.MergedQualifiers().Contains("repo:myorg/repo1"));
Assert.True(request.MergedQualifiers().Contains("repo:myorg/repo2"));
}
}
}