diff --git a/.gitignore b/.gitignore index b8865cc..8336bde 100644 --- a/.gitignore +++ b/.gitignore @@ -1,56 +1,341 @@ -#OS junk files -[Tt]humbs.db -*.DS_Store +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore -#Visual Studio files -*.[Oo]bj +# User-specific files +*.rsuser +*.suo *.user -*.aps -*.pch -*.vspscc -*.vssscc +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio *_i.c *_p.c -*.ncb -*.suo +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr *.tlb +*.tli *.tlh -*.bak -*.[Cc]ache -*.ilk +*.tmp +*.tmp_proj +*_wpftmp.csproj *.log -*.lib -*.sbr -*.sdf -*.suo -*.opensdf -*.unsuccessfulbuild -*.user +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files ipch/ -obj/ -log4net/ -logging/ -packages/ -[Bb]in -[Dd]ebug*/ -[Rr]elease*/ -Ankh.NoLoad - -#Tooling +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in _ReSharper*/ -*.resharper -[Tt]est[Rr]esult* +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* -#Project files -[Bb]uild/ +# DotCover is a Code Coverage Tool +*.dotCover -#Subversion files -.svn +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json -# Office Temp Files +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ ~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ +# ASP.NET Core default setup: bower directory is configured as wwwroot/lib/ and bower restore is true +**/wwwroot/lib/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ -#runtime files -*.compile.css -*.compile.js -uploads/ +# BeatPulse healthcheck temp database +healthchecksdb diff --git a/src/RA.Tests/MockExecutionContextWithMulitipleQueries.cs b/src/RA.Tests/MockExecutionContextWithMulitipleQueries.cs new file mode 100644 index 0000000..89c649b --- /dev/null +++ b/src/RA.Tests/MockExecutionContextWithMulitipleQueries.cs @@ -0,0 +1,73 @@ +using System; +using System.Collections.Generic; +using System.Collections.Specialized; +using System.IO; +using NUnit.Framework; + +namespace RA.Tests +{ + [TestFixture] + public class MockExecutionContextWithMulitipleQueries + { + private SetupContext _setupContext; + private ExecutionContext _executionContext; + + [SetUp] + public void Setup() + { + _setupContext = new SetupContext(); + _executionContext = new HttpActionContext(_setupContext) + .Get("http://test.com"); + } + + [Test] + [TestCaseSource(nameof(GenerateTestData))] + public void UrlContainsAllQueries(NameValueCollection queryStrings, string expectedQuery) + { + _setupContext.Queries(queryStrings); + + var stdOut = Console.Out; + try + { + using (StringWriter sw = new StringWriter()) + { + Console.SetOut(sw); + + _executionContext.Debug(); + StringAssert.Contains(expectedQuery, sw.ToString()); + } + } + finally + { + Console.SetOut(stdOut); + } + } + + private static IEnumerable GenerateTestData() + { + yield return new TestCaseData( + new NameValueCollection + { + { "a", "x" }, + { "b", "y" } + }, + "a=x&b=y"); + + yield return new TestCaseData( + new NameValueCollection + { + { "foo", "bar" }, + { "foo", "baz" } + }, + "foo=bar&foo=baz"); + + yield return new TestCaseData( + new NameValueCollection + { + { null, "foo" }, + { "bar", "baz" } + }, + "foo&bar=baz"); + } + } +} \ No newline at end of file diff --git a/src/RA/ExecutionContext.cs b/src/RA/ExecutionContext.cs index d5c97d0..8330140 100644 --- a/src/RA/ExecutionContext.cs +++ b/src/RA/ExecutionContext.cs @@ -149,12 +149,9 @@ private Uri BuildUri() var builder = new UriBuilder(_httpActionContext.Url()); var query = HttpUtility.ParseQueryString(builder.Query); - foreach (var queryString in _setupContext.Queries()) - { - query.Add(queryString.Key, queryString.Value); - } + query.Add(_setupContext.Queries()); - builder.Query = query.ToString(); + builder.Query = query.ToQueryString(); return new Uri(builder.ToString()); } @@ -164,12 +161,32 @@ private void AppendHeaders(HttpRequestMessage request) _setupContext.HeaderAccept().ForEach(x => _httpClient.DefaultRequestHeaders.Add(HeaderType.Accept.Value, x)); _setupContext.HeaderAcceptEncoding().ForEach(x => request.Headers.AcceptEncoding.Add(new StringWithQualityHeaderValue(x))); _setupContext.HeaderAcceptCharset().ForEach(x => request.Headers.AcceptCharset.Add(new StringWithQualityHeaderValue(x))); - _setupContext.HeaderForEverythingElse().ForEach(x => request.Headers.Add(x.Key, x.Value)); + + var headersForEverythingElse = _setupContext.HeaderForEverythingElse(); + foreach (string header in headersForEverythingElse) + { + request.Headers.Add(header, headersForEverythingElse.GetValues(header)); + } } private void AppendCookies(HttpRequestMessage request) { - request.Headers.Add("Cookie", string.Join(";", _setupContext.Cookies().Select(x => x.Key + "=" + x.Value))); + var cookies = _setupContext.Cookies(); + if (cookies.Count == 0) + { + return; + } + + var pairs = new List(); + foreach (string cookie in cookies) + { + foreach (var value in cookies.GetValues(cookie)) + { + pairs.Add($"{cookie}={value}"); + } + } + + request.Headers.Add("Cookie", string.Join("; ", pairs)); } private void SetTimeout() diff --git a/src/RA/Extensions/NameValueCollectionExtensions.cs b/src/RA/Extensions/NameValueCollectionExtensions.cs new file mode 100644 index 0000000..11006c1 --- /dev/null +++ b/src/RA/Extensions/NameValueCollectionExtensions.cs @@ -0,0 +1,42 @@ +using System.Collections.Specialized; +using System.Text; +using System.Web; + +namespace RA.Extensions +{ + public static class NameValueCollectionExtensions + { + public static string ToQueryString(this NameValueCollection nvc) + { + if (nvc == null || nvc.Count == 0) + { + return string.Empty; + } + + var sb = new StringBuilder(); + + string[] keys = nvc.AllKeys; + for (int i = 0; i < nvc.Count; i++) + { + string[] values = nvc.GetValues(keys[i]); + if (values != null) + { + foreach (string value in values) + { + if (string.IsNullOrEmpty(keys[i])) + { + sb.AppendFormat("{0}&", HttpUtility.UrlEncode(value)); + } + else + { + sb.AppendFormat("{0}={1}&", keys[i], HttpUtility.UrlEncode(value)); + } + } + } + } + + // trim trailing `&` + return sb.ToString(0, sb.Length - 1); + } + } +} diff --git a/src/RA/SetupContext.cs b/src/RA/SetupContext.cs index 82783b5..9b4e66c 100644 --- a/src/RA/SetupContext.cs +++ b/src/RA/SetupContext.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using System.Collections.Specialized; using System.Linq; using System.Net; using System.Net.Http; @@ -18,26 +19,26 @@ public class SetupContext private string _body; private HttpClient _httpClient; private bool _useHttps; - private readonly Dictionary _headers = new Dictionary(); private readonly Dictionary _parameters = new Dictionary(); - private readonly Dictionary _queryStrings = new Dictionary(); - private readonly Dictionary _cookies = new Dictionary(); + private readonly NameValueCollection _headers = new NameValueCollection(); + private readonly NameValueCollection _queryStrings = new NameValueCollection(); + private readonly NameValueCollection _cookies = new NameValueCollection(); private readonly List _files = new List(); private TimeSpan? _timeout = null; - private Func, List> GetHeaderFor = (filter, headers) => + private Func> GetHeaderFor = (filter, headers) => { - var value = - headers.Where(x => x.Key.Equals(filter, StringComparison.InvariantCultureIgnoreCase)) - .Select(x => x.Value) - .DefaultIfEmpty(string.Empty) - .First(); + var values = headers + .GetValues(filter) + ?.First() + .Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries) + .Select(v => v.Trim()); - return !string.IsNullOrEmpty(value) ? value.Split(new[] { ',' }).Select(x => x.Trim()).ToList() : new List(); + return values != null + ? values.ToList() + : new List(0); }; - - /// /// Setup the name of the test suite. /// @@ -206,8 +207,7 @@ public List Files() /// public SetupContext Cookie(string name, string value) { - if(!_cookies.ContainsKey(name)) - _cookies.Add(name, value); + _cookies.Add(name, value); return this; } @@ -221,19 +221,31 @@ public SetupContext Cookies(Dictionary cookies) { foreach (var cookie in cookies) { - if (!_cookies.ContainsKey(cookie.Key)) - _cookies.Add(cookie.Key, cookie.Value); + _cookies.Add(cookie.Key, cookie.Value); } + return this; } + /// + /// Set cookie value pair. + /// eg: name : X-XSRF-TOKEN and value : 123456789 + /// + /// + /// + public SetupContext Cookies(NameValueCollection cookies) + { + _cookies.Add(cookies); + return this; + } + /// /// Return all cookies. /// /// - public Dictionary Cookies() + public NameValueCollection Cookies() { - return _cookies.Select(x => new KeyValuePair(x.Key, x.Value)).ToDictionary(x => x.Key, x => x.Value); + return new NameValueCollection(_cookies); } /// @@ -245,8 +257,7 @@ public Dictionary Cookies() /// public SetupContext Header(string key, string value) { - if (!_headers.ContainsKey(key)) - _headers.Add(key, value); + _headers.Add(key, value); return this; } @@ -259,20 +270,30 @@ public SetupContext Headers(Dictionary headers) { foreach (var header in headers) { - if (!_headers.ContainsKey(header.Key)) - _headers.Add(header.Key, header.Value); + _headers.Add(header.Key, header.Value); } return this; } - /// - /// Return all headers. - /// - /// - public Dictionary Headers() + /// + /// Sets multiple Http request header value pairs. + /// + /// + /// + public SetupContext Headers(NameValueCollection headers) + { + _headers.Add(headers); + return this; + } + + /// + /// Return all headers. + /// + /// + public NameValueCollection Headers() { - return _headers.Select(x => new KeyValuePair(x.Key, x.Value)).ToDictionary(x => x.Key, x => x.Value); + return new NameValueCollection(_headers); } /// @@ -315,14 +336,20 @@ public List HeaderAcceptCharset() /// Return all headers except for content-type, accept, accept-encoding and accept-charset /// /// - public Dictionary HeaderForEverythingElse() + public NameValueCollection HeaderForEverythingElse() { - return - _headers.Where( - x => - !HeaderType.GetAll() - .Any(y => y.Value.Equals(x.Key, StringComparison.InvariantCultureIgnoreCase))) - .ToDictionary(x => x.Key, x => x.Value); + var keepHeaders = _headers.AllKeys.Except(HeaderType.GetAll().Select(t => t.Value)); + + var headers = new NameValueCollection(); + foreach (var header in keepHeaders) + { + foreach (var value in _headers.GetValues(header)) + { + headers.Add(header, value); + } + } + + return headers; } /// @@ -373,13 +400,12 @@ public Dictionary Params() /// public SetupContext Query(string key, string value) { - if (!_queryStrings.ContainsKey(key)) - _queryStrings.Add(key, value); + _queryStrings.Add(key, value); return this; } /// - /// Set multiple Querystring value pairs. This is any key/value pairs that needs to go into the Url. This will be emitted with all Http verbs. + /// Set multiple Querystring value pairs. This is any key/value pairs that needs to go into the Url. This will be emitted with all Http verbs. /// /// /// @@ -388,19 +414,31 @@ public SetupContext Queries(Dictionary queries) { foreach (var query in queries) { - if (!_queryStrings.ContainsKey(query.Key)) - _queryStrings.Add(query.Key, query.Value); + _queryStrings.Add(query.Key, query.Value); } + return this; } + /// + /// Set multiple Querystring value pairs. This is any key/value pairs that needs to go into the Url. This will be emitted with all Http verbs. + /// + /// + /// + /// + public SetupContext Queries(NameValueCollection queries) + { + _queryStrings.Add(queries); + return this; + } + /// /// Return Querystring value pairs. /// /// - public Dictionary Queries() + public NameValueCollection Queries() { - return _queryStrings.Select(x => new KeyValuePair(x.Key, x.Value)).ToDictionary(x => x.Key, x => x.Value); + return new NameValueCollection(_queryStrings); } public SetupContext HttpClient(HttpClient client) @@ -490,15 +528,21 @@ public SetupContext Debug() "{0}\n".Write(_body); "request headers".WriteHeader(); - foreach (var header in _headers) + foreach (string key in _headers) { - "{0} : {1}".WriteLine(header.Key, header.Value); + "{0} : {1}".WriteLine(key, _headers[key].ToString()); } "querystrings".WriteHeader(); - foreach (var queryString in _queryStrings) + foreach (string queryString in _queryStrings) + { + "{0} : {1}".WriteLine(queryString, _queryStrings[queryString]); + } + + "cookies".WriteHeader(); + foreach (string cookie in _cookies) { - "{0} : {1}".WriteLine(queryString.Key, queryString.Value); + "{0} : {1}".WriteLine(cookie, _cookies[cookie]); } "parameters".WriteHeader();