Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Resolved issue GitHub issue #54, hangs when enumerating stream, and #61

Merged
merged 7 commits into from
Nov 10, 2016
Merged

Resolved issue GitHub issue #54, hangs when enumerating stream, and #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
af269ef
Resolved issue GitHub issue #54, hangs when enumerating stream, and a…
Aug 5, 2016
b65d006
Merge branch 'bugfix/54.Hangs_when_enumerating_stream' into develop_w…
Oct 12, 2016
ae7cdc5
Run appveyor tests as release
Oct 13, 2016
974762f
Fix infinite loop when expecting for more search results than available
Oct 14, 2016
10ea83f
Avoid false test failures when running on againt fresh Splunk instances
Oct 14, 2016
8d47542
Add a test to verity changes for PR #57
Oct 14, 2016
2c5d49b
Add additional test coverage
Nov 9, 2016
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
8 changes: 6 additions & 2 deletions appveyor.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ before_build:
build:
verbosity: minimal

# Avoid test failures from debug assertions by building in release mode
configuration:
- Release

test_script:
# Run the unit tests and acceptance tests
- ps: xunit.console.clr4.x86 test\unit-tests\bin\Debug\unit-tests.dll /appveyor
- ps: xunit.console.clr4.x86 test\acceptance-tests\bin\Debug\acceptance-tests.dll /appveyor
- ps: xunit.console.clr4.x86 test\unit-tests\bin\Release\unit-tests.dll /appveyor
- ps: xunit.console.clr4.x86 test\acceptance-tests\bin\Release\acceptance-tests.dll /appveyor
5 changes: 5 additions & 0 deletions src/Splunk.Client/Splunk/Client/SearchResultMetadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ public async Task ReadXmlAsync(XmlReader reader)
string preview = reader.GetRequiredAttribute("preview");
this.IsFinal = !BooleanConverter.Instance.Convert(preview);

if (reader.IsEmptyElement)
{
return;
}

if (!await reader.ReadAsync().ConfigureAwait(false))
{
return;
Expand Down
12 changes: 11 additions & 1 deletion src/Splunk.Client/Splunk/Client/SearchResultStream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,18 @@ async Task<SearchResultMetadata> ReadMetadataAsync()
break;
}

Debug.Assert(reader.NodeType == XmlNodeType.EndElement && reader.Name == "results", "Expected: </results>");
Debug.Assert(reader.Name == "results" && (reader.IsEmptyElement ||
reader.NodeType == XmlNodeType.EndElement),
"Expected: <results/> or </results>");

var isEmptyElement = reader.IsEmptyElement;
var readerNodeType = reader.NodeType;
await reader.ReadAsync().ConfigureAwait(false);

if (isEmptyElement || readerNodeType == XmlNodeType.EndElement)
{
break;
}
}

return metadata;
Expand Down
3 changes: 2 additions & 1 deletion test/acceptance-tests/TestService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1749,7 +1749,8 @@ public async Task CanExportSearchResultsToEnumerable()
{
using (var service = await SdkHelper.CreateService())
{
const string search = "search index=_internal | head 100";
// Changed to 10, we aren't guaranteed to have 100 events yet, especially when running in CI
const string search = "search index=_internal | head 10";
var args = new SearchExportArgs { Count = 0 };

using (SearchResultStream stream = await service.ExportSearchResultsAsync(search, args))
Expand Down
295 changes: 295 additions & 0 deletions test/unit-tests/Data/Client/AtomFeed.EmptyDictionaryKeyNameAtomEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,295 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--This is to override browser formatting; see server.conf[httpServer] to disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .-->
<?xml-stylesheet type="text/xml" href="/static/atom.xsl"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:s="http://dev.splunk.com/ns/rest">
<title>search index=_internal | head 10</title>
<id>http://localhost:8089/servicesNS/nobody/search/search/jobs/1474403860.123</id>
<updated>2016-09-20T13:37:40.375-07:00</updated>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123" rel="alternate"/>
<published>2016-09-20T13:37:40.000-07:00</published>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/search.log" rel="search.log"/>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/events" rel="events"/>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/results" rel="results"/>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/results_preview" rel="results_preview"/>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/timeline" rel="timeline"/>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/summary" rel="summary"/>
<link href="/servicesNS/nobody/search/search/jobs/1474403860.123/control" rel="control"/>
<author>
<name>admin</name>
</author>
<content type="text/xml">
<s:dict>
<s:key name="canSummarize">0</s:key>
<s:key name="cursorTime">1969-12-31T16:00:00.000-08:00</s:key>
<s:key name="defaultSaveTTL">604800</s:key>
<s:key name="defaultTTL">600</s:key>
<s:key name="delegate"/>
<s:key name="diskUsage">196608</s:key>
<s:key name="dispatchState">DONE</s:key>
<s:key name="doneProgress">1.00000</s:key>
<s:key name="dropCount">0</s:key>
<s:key name="earliestTime">2000-11-17T00:36:11.000-08:00</s:key>
<s:key name="eventAvailableCount">0</s:key>
<s:key name="eventCount">0</s:key>
<s:key name="eventFieldCount">0</s:key>
<s:key name="eventIsStreaming">1</s:key>
<s:key name="eventIsTruncated">1</s:key>
<s:key name="eventSearch">search index=_internal | head 10</s:key>
<s:key name="eventSorting">desc</s:key>
<s:key name="isBatchModeSearch">0</s:key>
<s:key name="isDone">1</s:key>
<s:key name="isFailed">0</s:key>
<s:key name="isFinalized">0</s:key>
<s:key name="isPaused">0</s:key>
<s:key name="isPreviewEnabled">0</s:key>
<s:key name="isRealTimeSearch">0</s:key>
<s:key name="isRemoteTimeline">0</s:key>
<s:key name="isSaved">0</s:key>
<s:key name="isSavedSearch">0</s:key>
<s:key name="isTimeCursored">1</s:key>
<s:key name="isZombie">0</s:key>
<s:key name="keywords">eventid::123 source::wineventlog:security username::admin</s:key>
<s:key name="label"/>
<s:key name="normalizedSearch">search index=_internal | head 0</s:key>
<s:key name="numPreviews">0</s:key>
<s:key name="pid">32111</s:key>
<s:key name="priority">5</s:key>
<s:key name="remoteSearch">search index=_internal | head 10</s:key>
<s:key name="reportSearch">table _time,summary,HostName,clientip,location</s:key>
<s:key name="resultCount">0</s:key>
<s:key name="resultIsStreaming">0</s:key>
<s:key name="resultPreviewCount">0</s:key>
<s:key name="runDuration">0.291000</s:key>
<s:key name="sampleRatio">1</s:key>
<s:key name="sampleSeed">0</s:key>
<s:key name="scanCount">0</s:key>
<s:key name="searchCanBeEventType">0</s:key>
<s:key name="searchTotalBucketsCount">6</s:key>
<s:key name="searchTotalEliminatedBucketsCount">5</s:key>
<s:key name="sid">1474403860.123</s:key>
<s:key name="statusBuckets">0</s:key>
<s:key name="ttl">600</s:key>
<s:key name="performance">
<s:dict>
<s:key name="command.dedup">
<s:dict>
<s:key name="duration_secs">0.008000</s:key>
<s:key name="invocations">8</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="command.eval">
<s:dict>
<s:key name="duration_secs">0.008000</s:key>
<s:key name="invocations">8</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="command.fields">
<s:dict>
<s:key name="duration_secs">0.005000</s:key>
<s:key name="invocations">7</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="command.lookup">
<s:dict>
<s:key name="duration_secs">0.008000</s:key>
<s:key name="invocations">8</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="command.prededup">
<s:dict>
<s:key name="duration_secs">0.007000</s:key>
<s:key name="invocations">7</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="command.search">
<s:dict>
<s:key name="duration_secs">0.007000</s:key>
<s:key name="invocations">7</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="command.search.index">
<s:dict>
<s:key name="duration_secs">0.009000</s:key>
<s:key name="invocations">9</s:key>
</s:dict>
</s:key>
<s:key name="command.search.summary">
<s:dict>
<s:key name="duration_secs">0.004000</s:key>
<s:key name="invocations">7</s:key>
</s:dict>
</s:key>
<s:key name="command.table">
<s:dict>
<s:key name="duration_secs">0.001000</s:key>
<s:key name="invocations">1</s:key>
<s:key name="input_count">0</s:key>
<s:key name="output_count">0</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.check_disk_usage">
<s:dict>
<s:key name="duration_secs">0.001000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.createdSearchResultInfrastructure">
<s:dict>
<s:key name="duration_secs">0.001000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.evaluate">
<s:dict>
<s:key name="duration_secs">0.127000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.evaluate.dedup">
<s:dict>
<s:key name="duration_secs">0.001000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.evaluate.eval">
<s:dict>
<s:key name="duration_secs">0.001000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.evaluate.lookup">
<s:dict>
<s:key name="duration_secs">0.003000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.evaluate.search">
<s:dict>
<s:key name="duration_secs">0.124000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.evaluate.table">
<s:dict>
<s:key name="duration_secs">0.001000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.fetch">
<s:dict>
<s:key name="duration_secs">0.121000</s:key>
<s:key name="invocations">8</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.localSearch">
<s:dict>
<s:key name="duration_secs">0.002000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.results_combiner">
<s:dict>
<s:key name="duration_secs">0.008000</s:key>
<s:key name="invocations">8</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.stream.local">
<s:dict>
<s:key name="duration_secs">0.007000</s:key>
<s:key name="invocations">7</s:key>
</s:dict>
</s:key>
<s:key name="dispatch.writeStatus">
<s:dict>
<s:key name="duration_secs">0.009000</s:key>
<s:key name="invocations">5</s:key>
</s:dict>
</s:key>
<s:key name="startup.configuration">
<s:dict>
<s:key name="duration_secs">0.022000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
<s:key name="startup.handoff">
<s:dict>
<s:key name="duration_secs">0.051000</s:key>
<s:key name="invocations">1</s:key>
</s:dict>
</s:key>
</s:dict>
</s:key>
<s:key name="fieldMetadataEvents">
<s:dict>
<s:key name="">
<s:dict>
<s:key name="type">str</s:key>
</s:dict>
</s:key>
</s:dict>
</s:key>
<s:key name="messages">
<s:dict>
<s:key name="info">
<s:list>
<s:item>No matching fields exist</s:item>
</s:list>
</s:key>
</s:dict>
</s:key>
<s:key name="request">
<s:dict>
<s:key name="count">0</s:key>
<s:key name="search">search index=_internal | head 10</s:key>
</s:dict>
</s:key>
<s:key name="runtime">
<s:dict>
<s:key name="auto_cancel">0</s:key>
<s:key name="auto_pause">0</s:key>
</s:dict>
</s:key>
<s:key name="eai:acl">
<s:dict>
<s:key name="perms">
<s:dict>
<s:key name="read">
<s:list>
<s:item>admin</s:item>
</s:list>
</s:key>
<s:key name="write">
<s:list>
<s:item>admin</s:item>
</s:list>
</s:key>
</s:dict>
</s:key>
<s:key name="owner">admin</s:key>
<s:key name="modifiable">1</s:key>
<s:key name="sharing">global</s:key>
<s:key name="app">search</s:key>
<s:key name="can_write">1</s:key>
<s:key name="ttl">600</s:key>
</s:dict>
</s:key>
<s:key name="searchProviders">
<s:list>
<s:item>localhost</s:item>
</s:list>
</s:key>
</s:dict>
</content>
</entry>
26 changes: 26 additions & 0 deletions test/unit-tests/Data/Client/AtomFeed.EmptyDictionaryKeyNameAtomFeed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--This is to override browser formatting; see server.conf[httpServer] to disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .-->
<?xml-stylesheet type="text/xml" href="/static/atom.xsl"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:s="http://dev.splunk.com/ns/rest" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
<title>foo</title>
<id>foo</id>
<updated>2014-05-29T12:13:01-07:00</updated>
<author>
<name>Splunk</name>
</author>
<entry>
<content>
<s:dict>
<s:key name="key">
<s:dict>
<s:key name="">
<s:dict>
<s:key name="type">num</s:key>
</s:dict>
</s:key>
</s:dict>
</s:key>
</s:dict>
</content>
</entry>
</feed>
2 changes: 2 additions & 0 deletions test/unit-tests/Data/Client/DVPL-6838.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<?xml version='1.0' encoding='UTF-8'?>
<results preview='0'/>
Loading