Merge pull request #92 from splunk/release/2.2.9

fantavlik · web-flow · commit 20c3421877ca · 2019-09-09T13:00:22.000-07:00
Release/2.2.9
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Splunk SDK for C# PCL
 
+## Version 2.2.9
+
+### Bug Fixes
+
+* Allow search jobs to be created if going into a queued state (GitHub pull request https://github.com/splunk/splunk-sdk-csharp-pcl/pull/91)
+* Fix to preview action enums (GitHub pull request https://github.com/splunk/splunk-sdk-csharp-pcl/pull/53)
+
 ## Version 2.2.8
 
 ### Bug Fixes
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # Splunk SDK for C# 
-## Version 2.2.8
+## Version 2.2.9
 
 > **Note:** For the most up to date documentation for the Splunk SDK for C#, 
 > see http://dev.splunk.com/csharp.
@@ -98,7 +98,7 @@ Here's what you need to get going with the Splunk SDK for C# version 2.x.
 If you haven't already installed Splunk Enterprise, download it at
 <http://www.splunk.com/download>. For more information about installing and
 running Splunk Enterprise and system requirements, see the
-[Splunk Installation Manual](http://docs.splunk.com/Documentation/Splunk/latest/Installation).
+[Splunk Installation Manual](http://docs.splunk.com/Documentation/Splunk/latest/Installation). The Splunk SDK for .NET has been tested with Splunk Enterprise 7.0 and 7.2.
 
 #### Developer environments
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -7,12 +7,12 @@ init:
 # Build 6.2 and 6.3
 environment:
   matrix:
-  - SPLUNK_VERSION: 6.6.5
-    SPLUNK_BUILD: b119a2a8b0ad 
-    SDK_APP_VERSION: 1.0.0
   - SPLUNK_VERSION: 7.0.1
     SPLUNK_BUILD: 2b5b15c4ee89
     SDK_APP_VERSION: 1.0.0
+  - SPLUNK_VERSION: 7.2.0
+    SPLUNK_BUILD: 8c86330ac18
+    SDK_APP_VERSION: 1.0.0
 
 
 install:
@@ -27,7 +27,9 @@ install:
 - cmd: dir c:\splunk\splunk\etc\apps
 
 # temp workaround to resolve tsl1.2 not supported by .net, downgrade splunk to use tsl1.0
-- cmd: type server_ssl.conf >> C:\splunk\splunk\etc\system\local\server.conf
+- cmd: type ci\server_ssl.conf >> C:\splunk\splunk\etc\system\local\server.conf
+# Create admin:changme user
+- cmd: type ci\user-seed.conf >> C:\splunk\splunk\etc\system\local\user-seed.conf
  
 # Install the Splunk service and start it
 - cmd: cmd /C "set PATH=C:\splunk\splunk && C:\splunk\splunk\bin\splunk.exe enable boot-start"
diff --git a/ci/server_ssl.conf b/ci/server_ssl.conf
diff --git a/ci/user-seed.conf b/ci/user-seed.conf
@@ -0,0 +1,4 @@
+# create admin user
+[user_info]
+USERNAME = admin
+PASSWORD = changeme
diff --git a/src/Splunk.Client.Helpers/Properties/AssemblyInfo.cs b/src/Splunk.Client.Helpers/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.2.8.0")]
-[assembly: AssemblyFileVersion("2.2.8.0")]
+[assembly: AssemblyVersion("2.2.9.0")]
+[assembly: AssemblyFileVersion("2.2.9.0")]
diff --git a/src/Splunk.Client/Properties/AssemblyInfo.cs b/src/Splunk.Client/Properties/AssemblyInfo.cs
@@ -41,5 +41,5 @@
 
 //// Version information
 
-[assembly: AssemblyVersion("2.2.8.0")]
-[assembly: AssemblyFileVersion("2.2.8.0")]
+[assembly: AssemblyVersion("2.2.9.0")]
+[assembly: AssemblyFileVersion("2.2.9.0")]
diff --git a/src/Splunk.Client/Splunk/Client/Context.cs b/src/Splunk.Client/Splunk/Client/Context.cs
@@ -101,7 +101,7 @@ public Context(Scheme scheme, string host, int port, TimeSpan timeout, HttpMessa
             this.Host = host;
             this.Port = port;
             this.httpClient = handler == null ? new HttpClient(new HttpClientHandler { UseCookies = false }) : new HttpClient(handler, disposeHandler);
-            this.httpClient.DefaultRequestHeaders.Add("User-Agent", "splunk-sdk-csharp/2.2.8");
+            this.httpClient.DefaultRequestHeaders.Add("User-Agent", "splunk-sdk-csharp/2.2.9");
             this.CookieJar = new CookieStore();
 
             if (timeout != default(TimeSpan))
diff --git a/src/Splunk.Client/Splunk/Client/DateTimeConverter.cs b/src/Splunk.Client/Splunk/Client/DateTimeConverter.cs
@@ -58,9 +58,14 @@ public override DateTime Convert(object input)
                 return x.Value;
             }
 
-            DateTime value;
+            var dateString = input.ToString();
+            if (dateString.Trim().Equals(""))
+            {
+                return DateTime.MinValue;
+            }
 
-            if (DateTime.TryParse(input.ToString(), result: out value))
+            DateTime value;
+            if (DateTime.TryParse(dateString, result: out value))
             {
                 return value;
             }
diff --git a/src/Splunk.Client/Splunk/Client/Job.cs b/src/Splunk.Client/Splunk/Client/Job.cs
@@ -458,6 +458,7 @@ public virtual async Task GetAsync(DispatchState dispatchState, int delay = 3000
         {
             using (var cancellationTokenSource = new CancellationTokenSource())
             {
+                // Timeout if Job is never at least the requiredState
                 cancellationTokenSource.CancelAfter(delay);
                 var token = cancellationTokenSource.Token;
 
@@ -470,7 +471,8 @@ public virtual async Task GetAsync(DispatchState dispatchState, int delay = 3000
                             await response.EnsureStatusCodeAsync(HttpStatusCode.OK).ConfigureAwait(false);
                             await this.ReconstructSnapshotAsync(response).ConfigureAwait(false);
 
-                            if (this.DispatchState >= dispatchState)
+                            // None or Parsing are the only states to continue checking status for
+                            if (this.DispatchState >= dispatchState || this.DispatchState == DispatchState.Queued)
                             {
                                 break;
                             }
@@ -702,12 +704,12 @@ protected internal override async Task<bool> ReconstructSnapshotAsync(Response r
 
         static readonly Argument[] DisablePreview = new Argument[] 
         { 
-            new Argument("action", "disable_preview") 
+            new Argument("action", "disablepreview") 
         };
 
         static readonly Argument[] EnablePreview = new Argument[] 
         { 
-            new Argument("action", "enable_preview") 
+            new Argument("action", "enablepreview") 
         };
 
         static readonly Argument[] Finalize = new Argument[] 
diff --git a/src/Splunk.Client/Splunk/Client/JobCollection.cs b/src/Splunk.Client/Splunk/Client/JobCollection.cs
@@ -195,6 +195,31 @@ public virtual async Task<Job> CreateAsync(string search, int count = 0,
             return job;
         }
 
+        public virtual async Task<Job> Create(string search, int count = 0, // This version doesn't wait
+            ExecutionMode mode = ExecutionMode.Normal, JobArgs args = null,
+            CustomJobArgs customArgs = null)
+        {
+            var arguments = new Argument[]
+            {
+               new Argument("search", search),
+               new Argument("count", count)
+            }
+            .AsEnumerable();
+
+            if (args != null)
+            {
+                arguments = arguments.Concat(args);
+            }
+
+            if (customArgs != null)
+            {
+                arguments = arguments.Concat(customArgs);
+            }
+
+            var job = await this.Create(arguments).ConfigureAwait(false);
+            return job;
+        }
+
         /// <summary>
         /// Asynchronously retrieves a filtered collection of all running search jobs.
         /// </summary>
@@ -234,12 +259,27 @@ async Task<Job> CreateAsync(IEnumerable<Argument> arguments, DispatchState requi
 
             Job job = new Job(this.Context, this.Namespace, name: searchId);
 
-            await job.GetAsync().ConfigureAwait(false);
+            await job.GetAsync(requiredState).ConfigureAwait(false);
             await job.TransitionAsync(requiredState).ConfigureAwait(false);
 
             return job;
         }
 
+       async Task<Job> Create(IEnumerable<Argument> arguments) // this version doesn't wait
+        {
+            string searchId;
+
+            using (var response = await this.Context.PostAsync(this.Namespace, ClassResourceName, arguments).ConfigureAwait(false))
+            {
+                await response.EnsureStatusCodeAsync(HttpStatusCode.Created).ConfigureAwait(false);
+                searchId = await response.XmlReader.ReadResponseElementAsync("sid").ConfigureAwait(false);
+            }
+
+            Job job = new Job(this.Context, this.Namespace, name: searchId);
+
+            return job;
+        }
+
         #endregion
 
         #region Types
diff --git a/src/Splunk.Client/Splunk/Client/Service.cs b/src/Splunk.Client/Splunk/Client/Service.cs
@@ -13,7 +13,7 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-
+ 
 //// TODO:
 //// [ ] Consider schema validation from schemas stored as resources.
 ////     See [XmlReaderSettings.Schemas Property](http://goo.gl/Syvj4V)
diff --git a/src/Splunk.ModularInputs/Properties/AssemblyInfo.cs b/src/Splunk.ModularInputs/Properties/AssemblyInfo.cs
@@ -39,5 +39,5 @@
 
 //// Version information
 
-[assembly: AssemblyVersion("2.2.8.0")]
-[assembly: AssemblyFileVersion("2.2.8.0")]
+[assembly: AssemblyVersion("2.2.9.0")]
+[assembly: AssemblyFileVersion("2.2.9.0")]
diff --git a/test/acceptance-tests/TestSearchJob.cs b/test/acceptance-tests/TestSearchJob.cs
@@ -485,6 +485,94 @@ public async Task CanRefreshJob()
             }
         }
 
+        [Trait("acceptance-test", "Splunk.Client.QueuedSearchCreate")]
+        [MockContext]
+        [Fact]
+        public async Task QueuedSearchCreate()
+        {
+            const string searchPrefix = "search index=_internal ";
+            int i = 0;
+
+            using (var service = await SdkHelper.CreateService())
+            {
+                List<Job> jobs = new List<Job>();
+                Job job = null;
+                do
+                {
+                    JobArgs jobArgs = new JobArgs();
+                    jobArgs.SearchMode = SearchMode.RealTime;
+
+                    try
+                    {
+                        // Jobs should eventually be queued w/o waiting for them to get to running state
+                        job = await service.Jobs.Create(searchPrefix + i.ToString(), args: jobArgs);
+                        Assert.Equal(DispatchState.None, job.DispatchState);
+                        await job.GetAsync();
+                        jobs.Add(job);
+                        i++;
+                    } catch (Exception ex)
+                    {
+                        System.Diagnostics.Debug.WriteLine(ex.GetBaseException().ToString());
+                        break;
+                    }
+
+                } while (job.DispatchState != DispatchState.Queued);
+
+                Assert.NotNull(job);
+                Assert.Equal(DispatchState.Queued, job.DispatchState);
+
+                // Cleanup
+                foreach (Job j in jobs)
+                {
+                    await j.CancelAsync();
+                }
+            }
+            Assert.True(i > 0);
+        }
+
+        [Trait("acceptance-test", "Splunk.Client.QueuedSearchCreateAsync")]
+        [MockContext]
+        [Fact]
+        public async Task QueuedSearchCreateAsync()
+        {
+            const string searchPrefix = "search index=_internal ";
+            int i = 0;
+
+            using (var service = await SdkHelper.CreateService())
+            {
+                List<Job> jobs = new List<Job>();
+                Job job = null;
+                do
+                {
+                    JobArgs jobArgs = new JobArgs();
+                    jobArgs.SearchMode = SearchMode.RealTime;
+
+                    try
+                    {
+                        // Jobs should eventually be queued w/o waiting for them to get to running state
+                        job = await service.Jobs.CreateAsync(searchPrefix + i.ToString(), args: jobArgs);
+                        jobs.Add(job);
+                        i++;
+                    }
+                    catch (Exception ex)
+                    {
+                        break;
+                    }
+
+                } while (job.DispatchState != DispatchState.Queued);
+
+                Assert.NotNull(job);
+                Assert.Equal(DispatchState.Queued, job.DispatchState);
+
+                // Cleanup
+                foreach (Job j in jobs)
+                {
+                    await j.CancelAsync();
+                }
+            }
+            Assert.True(i > 0);
+        }
+
         #region Helpers
 
         /// <summary>
diff --git a/test/unit-tests/TestJobCollection.cs b/test/unit-tests/TestJobCollection.cs
@@ -135,7 +135,21 @@ void CanSpecifyFilter()
                 },
                 filter);
         }
-        
+
+        [Trait("unit-test", "TestJobCollection.DateTimeConverterTest")]
+        [Fact]
+        void DateTimeConverterTest()
+        {
+            object[] expected = { DateTime.MinValue, DateTime.MinValue, DateTime.MinValue };
+            object[] actual = {"", "   ", "\t"};
+            Assert.Equal(expected.Length, actual.Length);
+
+            for (var i = 0; i < expected.Length; i++)
+            {
+                Assert.Equal(expected[i], DateTimeConverter.Instance.Convert(actual[i]));
+            }
+        }
+
         void CheckCommonProperties<TResource>(string expectedName, BaseEntity<TResource> entity) where TResource : BaseResource, new()
         {
             Assert.Equal(expectedName, entity.Title);

Original file line number	Diff line number	Diff line change
`@@ -58,9 +58,14 @@ public override DateTime Convert(object input)`
`58`	`58`	`return x.Value;`
`59`	`59`	`}`
`60`	`60`
`61`		`- DateTime value;`
	`61`	`+ var dateString = input.ToString();`
	`62`	`+ if (dateString.Trim().Equals(""))`
	`63`	`+ {`
	`64`	`+ return DateTime.MinValue;`
	`65`	`+ }`
`62`	`66`
`63`		`- if (DateTime.TryParse(input.ToString(), result: out value))`
	`67`	`+ DateTime value;`
	`68`	`+ if (DateTime.TryParse(dateString, result: out value))`
`64`	`69`	`{`
`65`	`70`	`return value;`
`66`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -458,6 +458,7 @@ public virtual async Task GetAsync(DispatchState dispatchState, int delay = 3000`
`458`	`458`	`{`
`459`	`459`	`using (var cancellationTokenSource = new CancellationTokenSource())`
`460`	`460`	`{`
	`461`	`+ // Timeout if Job is never at least the requiredState`
`461`	`462`	`cancellationTokenSource.CancelAfter(delay);`
`462`	`463`	`var token = cancellationTokenSource.Token;`
`463`	`464`
`@@ -470,7 +471,8 @@ public virtual async Task GetAsync(DispatchState dispatchState, int delay = 3000`
`470`	`471`	`await response.EnsureStatusCodeAsync(HttpStatusCode.OK).ConfigureAwait(false);`
`471`	`472`	`await this.ReconstructSnapshotAsync(response).ConfigureAwait(false);`
`472`	`473`
`473`		`- if (this.DispatchState >= dispatchState)`
	`474`	`+ // None or Parsing are the only states to continue checking status for`
	`475`	`+ if (this.DispatchState >= dispatchState \|\| this.DispatchState == DispatchState.Queued)`
`474`	`476`	`{`
`475`	`477`	`break;`
`476`	`478`	`}`
`@@ -702,12 +704,12 @@ protected internal override async Task<bool> ReconstructSnapshotAsync(Response r`
`702`	`704`
`703`	`705`	`static readonly Argument[] DisablePreview = new Argument[]`
`704`	`706`	`{`
`705`		`- new Argument("action", "disable_preview")`
	`707`	`+ new Argument("action", "disablepreview")`
`706`	`708`	`};`
`707`	`709`
`708`	`710`	`static readonly Argument[] EnablePreview = new Argument[]`
`709`	`711`	`{`
`710`		`- new Argument("action", "enable_preview")`
	`712`	`+ new Argument("action", "enablepreview")`
`711`	`713`	`};`
`712`	`714`
`713`	`715`	`static readonly Argument[] Finalize = new Argument[]`