Merge pull request #4 from AshleyPoole/just-automatic-analyzer

Adding automatic analyzer

Author: AshleyPoole

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 AshleyPoole - www.ashleypoole.co.uk
+Copyright (c) 2015 AshleyPoole - www.ashleypoole.co.uk
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -47,6 +47,20 @@ The wrapper also contains an overloaded Analyze method which only requires the h
 public Analyze Analyze(string host)
 ```
 
+##### AutomaticAnalyze()
+
+The Analyze method is used to initiate and wait for an assessment to complete before retrieving results. Compared to the normal Analyze() method this method keeps checking the Api and only when a scan has finished does it return. This saves the comsumer from having to write their own logic for handling an assessment in progress.
+Another call to GetEndpointDetails() may be needed to view the whole result set for a given endpoint.
+
+```C#
+public Analyze AutomaticAnalyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all)
+```
+
+The wrapper also contains an overloaded AutomaticAnalyze method which only requires the host parameter. Internal is uses the following parameter options - Publish.Off, ClearCache.On, FromCache.Ignore, All.On.
+```C#
+public Analyze AutomaticAnalyze(string host)
+```
+
 ##### GetEndpointData()
 
 The GetEndpointData method is used to retrieve a fully results set.

SSLLWrapper.IntegrationTests/AnalyzeTests.cs

@@ -52,7 +52,7 @@ public void then_should_not_trigger_an_api_invocation_error()
 		}
 
 		[TestMethod]
-		public void then_should_analyze_status_should_not_be_null()
+		public void then_analyze_status_should_not_be_null()
 		{
 			_analyze.status.Should().NotBeNullOrEmpty();
 		}

SSLLWrapper.IntegrationTests/AutomaticAnalyzeTests.cs

@@ -0,0 +1,72 @@
+using System.Configuration;
+using FluentAssertions;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using SSLLWrapper;
+using SSLLWrapper.Models.Response;
+
+namespace given_that_I_make_a_automaticanalyze_request
+{
+	[TestClass]
+	public class when_i_expect_a_successful_result
+	{
+		private static SSLLService _ssllService;
+		private static Analyze _analyze;
+		private static string _host;
+
+		[ClassInitialize]
+		public static void Setup(TestContext testContext)
+		{
+			_host = ConfigurationManager.AppSettings.Get("EndpointHost");
+			_ssllService = new SSLLService(ConfigurationManager.AppSettings.Get("ApiUrl"));
+			_analyze = _ssllService.AutomaticAnalyze(_host);
+		}
+
+		[TestMethod]
+		public void then_the_error_count_should_be_zero()
+		{
+			_analyze.Errors.Count.Should().Be(0);
+		}
+
+		[TestMethod]
+		public void then_HasErrorOccurred_should_be_false()
+		{
+			_analyze.HasErrorOccurred.Should().BeFalse();
+		}
+
+		[TestMethod]
+		public void then_status_code_header_should_be_greater_than_zero()
+		{
+			_analyze.Header.statusCode.Should().BeGreaterThan(0);
+		}
+
+		[TestMethod]
+		public void then_status_code_header_should_not_be_404()
+		{
+			_analyze.Header.statusCode.Should().NotBe(404);
+		}
+
+		[TestMethod]
+		public void then_should_not_trigger_an_api_invocation_error()
+		{
+			_analyze.Header.statusCode.Should().NotBe(400);
+		}
+
+		[TestMethod]
+		public void then_should_analyze_status_should_not_be_null()
+		{
+			_analyze.status.Should().NotBeNullOrEmpty();
+		}
+
+		[TestMethod]
+		public void then_start_time_should_be_greater_than_zero()
+		{
+			_analyze.startTime.Should().BeGreaterThan(0);
+		}
+
+		[TestMethod]
+		public void then_the_host_in_the_response_should_match_the_request()
+		{
+			_analyze.host.Should().Match(_host);
+		}
+	}
+}

SSLLWrapper.IntegrationTests/SSLLWrapper.IntegrationTests.csproj

@@ -64,6 +64,7 @@
     </Otherwise>
   </Choose>
   <ItemGroup>
+    <Compile Include="AutomaticAnalyzeTests.cs" />
     <Compile Include="AnalyzeTests.cs" />
     <Compile Include="GetEndpointDetails.cs" />
     <Compile Include="GetStatusCodesTests.cs" />

SSLLWrapper/SSLLService.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Threading;
 using SSLLWrapper.Domain;
 using SSLLWrapper.External;
 using SSLLWrapper.Interfaces;
@@ -124,6 +125,35 @@ public Analyze Analyze(string host, Publish publish, ClearCache clearCache, From
 			return analyzeModel;
 		}
 
+	    public Analyze AutomaticAnalyze(string host)
+	    {
+			return AutomaticAnalyze(host, 300, 15);
+	    }
+
+	    public Analyze AutomaticAnalyze(string host, int maxWaitInterval, int sleepInterval)
+	    {
+			return AutomaticAnalyze(host, Publish.Off, ClearCache.On, FromCache.Ignore, All.On, maxWaitInterval, sleepInterval);
+	    }
+
+		public Analyze AutomaticAnalyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all, int maxWaitInterval, int sleepInterval)
+	    {
+		    var startTime = DateTime.Now;
+			var sleepIntervalMilliseconds = sleepInterval * 1000;
+			var analyzeModel = Analyze(host, publish, clearCache, fromCache, all);
+
+			// Ignoring cache settings after first request to prevent loop
+			clearCache = ClearCache.Ignore;
+
+			// Shouldn't have to check status header as HasErrorOccurred should be enough
+			while (analyzeModel.HasErrorOccurred == false && analyzeModel.status != "READY" && (DateTime.Now - startTime).TotalSeconds < maxWaitInterval)
+			{
+				Thread.Sleep(sleepIntervalMilliseconds);
+				analyzeModel = Analyze(host, publish, clearCache, fromCache, all);
+		    }
+
+			return analyzeModel;
+	    }
+
 		public Endpoint GetEndpointData(string host, string s)
 		{
 			return GetEndpointData(host, s, FromCache.Off);