Documenting webapi with Swagger

October 26, 2015 by boro

If you’ve ever worked with webservices, chances are you’ve run into WSDL (http://www.w3.org/TR/wsdl). In the webapi world you don’t get so much out the box – this is where swagger can help expose test methods, documentation and a lot more.

For asp.net projects you can make use of a library: https://github.com/domaindrivendev/Swashbuckle. Install via nuget and you get a UI allowing a configurable interaction with all the webapi methods in your solution:

The swagger UI:

The test controller and methods:

All pretty simple stuff – how about if you want to secure things?
An example scenario might be you only want swagger accessible if you are visiting via http://localhost (or a loopback url).

It’s straight forwards if you implement a custom webapi DelegatingHandler.

using System.Net.Http;
using System.Security;
using System.Threading;
using System.Threading.Tasks;

namespace SwaggerDemo.Controllers.Api
{
    public class SwaggerAccessHandler : DelegatingHandler
    {
        protected override async Task<HttpResponseMessage> SendAsync(
            HttpRequestMessage request, CancellationToken cancellationToken)
        {
            if (request.RequestUri.ToString().ToLower().Contains("/swagger/"))
            {
                if (IsTrustedRequest(request))
                {
                    return await base.SendAsync(request, cancellationToken);
                }
                else
                {
                    throw new SecurityException();
                }
            }

            return await base.SendAsync(request, cancellationToken);
        }

        private bool IsTrustedRequest(HttpRequestMessage request)
        {
            //concoct the logic you require here to determine if the request is trusted or not
            // an example could be: if request.IsLocal()
            return true;
        }
    }
}

using System.Net.Http;

using System.Security;

using System.Threading;

using System.Threading.Tasks;

namespace SwaggerDemo.Controllers.Api

{

public class SwaggerAccessHandler : DelegatingHandler

{

protected override async Task<HttpResponseMessage> SendAsync(

HttpRequestMessage request, CancellationToken cancellationToken)

{

if (request.RequestUri.ToString().ToLower().Contains("/swagger/"))

{

if (IsTrustedRequest(request))

{

return await base.SendAsync(request, cancellationToken);

}

else

{

throw new SecurityException();

}

return await base.SendAsync(request, cancellationToken);

}

private bool IsTrustedRequest(HttpRequestMessage request)

{

//concoct the logic you require here to determine if the request is trusted or not

// an example could be: if request.IsLocal()

return true;

}

This then needs wiring into the webapi request pipelines. In your WebApiConfig file (OTB in your solution in the folder: App_Start) add:

config.MessageHandlers.Add(new SwaggerAccessHandler());

1	config.MessageHandlers.Add(new SwaggerAccessHandler());

In the TestController example above we had several httpPost methods available – to enable this functionality you need to allow the routes to include the {action} url chunk.

config.Routes.MapHttpRoute(
    name: "DefaultApiWithAction",
    routeTemplate: "api/{controller}/{action}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

config.Routes.MapHttpRoute(

name: "DefaultApiWithAction",

routeTemplate: "api/{controller}/{action}/{id}",

defaults: new { id = RouteParameter.Optional }

);

Azure webapi’s are now compatible with swagger – see https://azure.microsoft.com/en-gb/documentation/articles/app-service-dotnet-create-api-app/ for more info.

Grunt and gulp tasks in visual studio 2015 – libsass error

July 21, 2015 by boro

One of the neat features baked into the new Visual Studio is the ability to run grunt and gulp tasks. This can be done on demand via the Task Runner Explorer or tied into build events.

Some simple steps for getting started with Grunt are: http://www.iambacon.co.uk/blog/getting-started-with-grunt-sass-and-task-runner-explorer-visual-studio

All pretty cool, if it works! If you’ve got a version of node installed be aware that Visual Studio also ships with its own. It took me a while to track down so thought it worth sharing. If you receive errors when trying to run these tasks eg:

cmd.exe /c gulp --tasks-simple
Error: `libsass` bindings not found in C:\Users\###

1 2	cmd.exe /c gulp --tasks-simple Error: `libsass` bindings not found in C:\Users\###

Then try swapping the options so that $(PATH) is higher priority than the MS Web tools option:

This was found with some help from:

http://blogs.msdn.com/b/webdev/archive/2015/03/19/customize-external-web-tools-in-visual-studio-2015.aspx

No Sitecore logs, no Event log entries and no working site?

July 16, 2015 by boro

It’s not a nice place to be I’m sure you’ll agree!

Before we go on, I can’t guarantee one size will fix all!! This worked (well, fixed) our setup – it’s by no means the only way to solve the scary place of no working site.

In our setup we make use of the IIS URL Rewrite module. Under the hood this maps some xml within the web.config to the rules it applies. If for any reason you’ve goofed up this config, easily done with rogue config transforms or general typo’s, then you may have broken this IIS feature. The giveaway, when you double click the feature in IIS you receive an error message.

The reason for posting – this took me a while to track down the first time, now it’s my go-to verification if we don’t get any Sitecore logs or Event log entries.

The issue here isn’t really related to Sitecore, the lack of Sitecore logs is simply another symptom of the problem.

Moq – the basics

April 4, 2012 by boro

During a recent XP programming course we made use of the Moq’ing framework. I’d not used this before so tried to come up with some example moq basic tests. There are several tutorials on the internet which offer up the basics so do hunt around. Hopefully the following provides some simple examples for people to get started with.

The following code relies on the following assemblies:

nunit.framework – available from http://www.nunit.org/
moq – available from http://code.google.com/p/moq/

The real crux of TDD is that you program your functionality to interfaces – here we have a simple interface and dto:

public interface IMyInterface
{
    int IntMethod(int value);

    int HarderIntMethod(int value, int anotherValue);

    MyObject MyObjectMethod(int value);
}

public class MyObject
{
    public virtual string MyVirtualProperty { get; set; }
    public string MyProperty { get; set; }
}

public interface IMyInterface

{

int IntMethod(int value);

int HarderIntMethod(int value, int anotherValue);

MyObject MyObjectMethod(int value);

}

public class MyObject

{

public virtual string MyVirtualProperty { get; set; }

public string MyProperty { get; set; }

}

Note the importance of the virtual property in MyObject will be highlighted in the tests. In the following examples not all the tests pass – this is intentional! Failing tests are included to demonstrate specific features of Moq. Apologies for the long dump of test code – the idea is really to copy it into a test class and let NUnit do the work.

[TestFixture]
public class MyTests
{
    [Test]
    [TestCase(1, TestName = "1")]
    public void A_TestMockBehaviourDefault(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>();

        int result = myInterface.Object.IntMethod(value);

        //we havent setup mock for value = 1
        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    public void B_TestMockBehaviourStrict(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        int result = myInterface.Object.IntMethod(value);

        //now in strict mode
        //again, we havent setup mock for value = 1
        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void C_TestMockBehaviourStrictWithSpecificValue(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        myInterface.Setup(a => a.IntMethod(1)).Returns(1);

        int result = myInterface.Object.IntMethod(value);

        //we have setup the mock for value = 1 but not value = 2
        Assert.AreEqual(value, result);

        myInterface.Verify();
    }       

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void D_TestMockBehaviourStrictWithTypedValue(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a);

        int result = myInterface.Object.IntMethod(value);

        //any int will pass
        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    private int _count = 0;

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void E_TestMockBehaviourStrictWithTypedValueAndCallback(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);            

        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a).Callback(() => _count++);

        int result = myInterface.Object.IntMethod(value);

        //we can log callbacks before or after the Returns call
        Console.WriteLine(String.Format("Called E_TestMockBehaviourStrictWithTypedValueAndCallback {0} times", _count));

        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void E1_TestMockBehaviourStrictWithTypedValueAndCallbackBefore(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //callbacks can happen before and after the Returns call
        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Callback(() => Console.WriteLine("before")).Returns((int a) => a).Callback(() => Console.WriteLine("after"));

        int result = myInterface.Object.IntMethod(value);

        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    [ExpectedException(typeof(Exception))]
    public void F_TestMockBehaviourStrictWithException(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //this can throw specific exceptions if we want
        //catching at a test level is a bit loose since other code could exception - see F1 for alternative
        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Throws<Exception>();

        int result = myInterface.Object.IntMethod(value);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void F1_TestMockBehaviourStrictWithException(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //this can throw specific exceptions if we want
        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Throws<Exception>();

        //here we can catch specific exceptions
        Assert.Throws<Exception>(() => myInterface.Object.IntMethod(value));

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void G_TestMockBehaviourStrictVerify(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a).Verifiable();
        myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), (It.IsAny<int>()))).Returns((int a, int b) => a).Verifiable();

        int result = myInterface.Object.IntMethod(value);

        //we havent called HarderIntMethod
        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void H_TestMockBehaviourStrictVerifySuccess(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a).Verifiable();
        myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), It.IsAny<int>())).Returns((int a, int b) => a).Verifiable();

        int result = myInterface.Object.IntMethod(value);

        int anotherResult = myInterface.Object.HarderIntMethod(value, value);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void I_TestMockBehaviourStrictWithTypedValueAndLogicOnInput(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //setup can perform logic based on input to determine return value(s)
        myInterface.Setup(a => a.IntMethod(It.Is<int>(b => b % 2 == 0))).Returns((int a) => a);
        myInterface.Setup(a => a.IntMethod(It.Is<int>(b => b % 2 != 0))).Returns((int a) => -a);

        int result = myInterface.Object.IntMethod(value);

        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    [TestCase(4, TestName = "4")]
    public void J_TestMockBehaviourStrictWithTypedValueAndRangeLogicOnInput(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //rather than specific logic, instead we can make use of Ranges
        myInterface.Setup(a => a.IntMethod(It.IsInRange<int>(0,3, Range.Inclusive))).Returns((int a) => a);

        int result = myInterface.Object.IntMethod(value);

        Assert.AreEqual(value, result);

        //we haven't setup a return value for 4
        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void K_TestMockBehaviourStrictWithProperties(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //we can manipulate objects being returned
        myInterface.Setup(a => a.MyObjectMethod(value)).Returns((int a) => new MyObject() { MyProperty = a.ToString() });

        MyObject result = myInterface.Object.MyObjectMethod(value);

        Assert.AreEqual(value.ToString(), result.MyProperty);

        myInterface.Verify();
    }

    [Test]
    public void L_TestMockBehaviourStrictWithPropertiesVerifyGet()
    {
        Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

        //this is where you need virtual properties
        myObject.Setup(a => a.MyProperty).Returns("blah");

        myObject.Verify();

        myObject.VerifyGet(a => a.MyProperty);
    }

    [Test]
    public void L1_TestMockBehaviourStrictWithPropertiesVerifyGet()
    {
        Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

        myObject.Setup(a => a.MyVirtualProperty).Returns("blah");

        myObject.Verify();

        //we have never accessed MyVirtualProperty hence the VerifyGet fails
        myObject.VerifyGet(a => a.MyVirtualProperty);
    }

    [Test]
    public void L2_TestMockBehaviourStrictWithPropertiesVerifyGet()
    {
        Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

        myObject.Setup(a => a.MyVirtualProperty).Returns("blah");

        Assert.IsNotEmpty(myObject.Object.MyVirtualProperty);

        myObject.Verify();

        //we have accessed both properties
        myObject.VerifyGet(a => a.MyVirtualProperty);
    }

    [Test]
    public void L3_TestMockBehaviourStrictWithPropertiesSetupProperty()
    {
        Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

        //rather than setup and then adding Returns method, SetupProperty achieves the same thing
        myObject.SetupProperty(a => a.MyVirtualProperty, "blah");

        Assert.IsNotEmpty(myObject.Object.MyVirtualProperty);

        myObject.Verify();

        myObject.VerifyGet(a => a.MyVirtualProperty);
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void M_TestMockBehaviourStrictWithTypedValueAndDetailedCallback(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //Callback and Returns can both deal with multiple parameters via Generics or parameters.
        // M1 shows the opposite of each
        myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), It.IsAny<int>()))
            .Returns((int a, int b) => a)
            .Callback<int, int>((a, b) => Console.WriteLine("A is " + a + " B is " + b));

        int result = myInterface.Object.HarderIntMethod(value, value + 1);

        Assert.AreEqual(value, result);

        myInterface.Verify();
    }

    [Test]
    [TestCase(1, TestName = "1")]
    [TestCase(2, TestName = "2")]
    public void M1_TestMockBehaviourStrictWithTypedValueAndDetailedCallbackAlternativeSyntax(int value)
    {
        Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

        //demonstrates the opposite of M in terms of the syntax required into Callback and Returns
        myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), It.IsAny<int>()))
            .Returns<int , int>((a, b) => a)
            .Callback((int a, int b) => Console.WriteLine("A is " + a + " B is " + b));

        int result = myInterface.Object.HarderIntMethod(value, value + 1);

        Assert.AreEqual(value, result);

        myInterface.Verify();
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

[TestFixture]

public class MyTests

{

[Test]

[TestCase(1, TestName = "1")]

public void A_TestMockBehaviourDefault(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>();

int result = myInterface.Object.IntMethod(value);

//we havent setup mock for value = 1

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

public void B_TestMockBehaviourStrict(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

int result = myInterface.Object.IntMethod(value);

//now in strict mode

//again, we havent setup mock for value = 1

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void C_TestMockBehaviourStrictWithSpecificValue(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

myInterface.Setup(a => a.IntMethod(1)).Returns(1);

int result = myInterface.Object.IntMethod(value);

//we have setup the mock for value = 1 but not value = 2

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void D_TestMockBehaviourStrictWithTypedValue(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a);

int result = myInterface.Object.IntMethod(value);

//any int will pass

Assert.AreEqual(value, result);

myInterface.Verify();

}

private int _count = 0;

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void E_TestMockBehaviourStrictWithTypedValueAndCallback(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a).Callback(() => _count++);

int result = myInterface.Object.IntMethod(value);

//we can log callbacks before or after the Returns call

Console.WriteLine(String.Format("Called E_TestMockBehaviourStrictWithTypedValueAndCallback {0} times", _count));

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void E1_TestMockBehaviourStrictWithTypedValueAndCallbackBefore(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//callbacks can happen before and after the Returns call

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Callback(() => Console.WriteLine("before")).Returns((int a) => a).Callback(() => Console.WriteLine("after"));

int result = myInterface.Object.IntMethod(value);

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

[ExpectedException(typeof(Exception))]

public void F_TestMockBehaviourStrictWithException(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//this can throw specific exceptions if we want

//catching at a test level is a bit loose since other code could exception - see F1 for alternative

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Throws<Exception>();

int result = myInterface.Object.IntMethod(value);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void F1_TestMockBehaviourStrictWithException(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//this can throw specific exceptions if we want

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Throws<Exception>();

//here we can catch specific exceptions

Assert.Throws<Exception>(() => myInterface.Object.IntMethod(value));

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void G_TestMockBehaviourStrictVerify(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a).Verifiable();

myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), (It.IsAny<int>()))).Returns((int a, int b) => a).Verifiable();

int result = myInterface.Object.IntMethod(value);

//we havent called HarderIntMethod

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void H_TestMockBehaviourStrictVerifySuccess(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

myInterface.Setup(a => a.IntMethod(It.IsAny<int>())).Returns((int a) => a).Verifiable();

myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), It.IsAny<int>())).Returns((int a, int b) => a).Verifiable();

int result = myInterface.Object.IntMethod(value);

int anotherResult = myInterface.Object.HarderIntMethod(value, value);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void I_TestMockBehaviourStrictWithTypedValueAndLogicOnInput(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//setup can perform logic based on input to determine return value(s)

myInterface.Setup(a => a.IntMethod(It.Is<int>(b => b % 2 == 0))).Returns((int a) => a);

myInterface.Setup(a => a.IntMethod(It.Is<int>(b => b % 2 != 0))).Returns((int a) => -a);

int result = myInterface.Object.IntMethod(value);

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

[TestCase(4, TestName = "4")]

public void J_TestMockBehaviourStrictWithTypedValueAndRangeLogicOnInput(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//rather than specific logic, instead we can make use of Ranges

myInterface.Setup(a => a.IntMethod(It.IsInRange<int>(0,3, Range.Inclusive))).Returns((int a) => a);

int result = myInterface.Object.IntMethod(value);

Assert.AreEqual(value, result);

//we haven't setup a return value for 4

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void K_TestMockBehaviourStrictWithProperties(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//we can manipulate objects being returned

myInterface.Setup(a => a.MyObjectMethod(value)).Returns((int a) => new MyObject() { MyProperty = a.ToString() });

MyObject result = myInterface.Object.MyObjectMethod(value);

Assert.AreEqual(value.ToString(), result.MyProperty);

myInterface.Verify();

}

[Test]

public void L_TestMockBehaviourStrictWithPropertiesVerifyGet()

{

Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

//this is where you need virtual properties

myObject.Setup(a => a.MyProperty).Returns("blah");

myObject.Verify();

myObject.VerifyGet(a => a.MyProperty);

}

[Test]

public void L1_TestMockBehaviourStrictWithPropertiesVerifyGet()

{

Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

myObject.Setup(a => a.MyVirtualProperty).Returns("blah");

myObject.Verify();

//we have never accessed MyVirtualProperty hence the VerifyGet fails

myObject.VerifyGet(a => a.MyVirtualProperty);

}

[Test]

public void L2_TestMockBehaviourStrictWithPropertiesVerifyGet()

{

Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

myObject.Setup(a => a.MyVirtualProperty).Returns("blah");

Assert.IsNotEmpty(myObject.Object.MyVirtualProperty);

myObject.Verify();

//we have accessed both properties

myObject.VerifyGet(a => a.MyVirtualProperty);

}

[Test]

public void L3_TestMockBehaviourStrictWithPropertiesSetupProperty()

{

Mock<MyObject> myObject = new Mock<MyObject>(MockBehavior.Strict);

//rather than setup and then adding Returns method, SetupProperty achieves the same thing

myObject.SetupProperty(a => a.MyVirtualProperty, "blah");

Assert.IsNotEmpty(myObject.Object.MyVirtualProperty);

myObject.Verify();

myObject.VerifyGet(a => a.MyVirtualProperty);

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void M_TestMockBehaviourStrictWithTypedValueAndDetailedCallback(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//Callback and Returns can both deal with multiple parameters via Generics or parameters.

// M1 shows the opposite of each

myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), It.IsAny<int>()))

.Returns((int a, int b) => a)

.Callback<int, int>((a, b) => Console.WriteLine("A is " + a + " B is " + b));

int result = myInterface.Object.HarderIntMethod(value, value + 1);

Assert.AreEqual(value, result);

myInterface.Verify();

}

[Test]

[TestCase(1, TestName = "1")]

[TestCase(2, TestName = "2")]

public void M1_TestMockBehaviourStrictWithTypedValueAndDetailedCallbackAlternativeSyntax(int value)

{

Mock<IMyInterface> myInterface = new Mock<IMyInterface>(MockBehavior.Strict);

//demonstrates the opposite of M in terms of the syntax required into Callback and Returns

myInterface.Setup(a => a.HarderIntMethod(It.IsAny<int>(), It.IsAny<int>()))

.Returns<int , int>((a, b) => a)

.Callback((int a, int b) => Console.WriteLine("A is " + a + " B is " + b));

int result = myInterface.Object.HarderIntMethod(value, value + 1);

Assert.AreEqual(value, result);

myInterface.Verify();

}

Here is the expected results when evaluated in NUnit:

Adding functionality to interfaces with extension methods

July 8, 2011 by boro

When building large scale applications a very useful design pattern to adopt is dependency injection. An example of this is programming to interfaces such that the implementation of each interface can be interchanged.

In this post I will demonstrate some examples of how you can go about adding functionality to interfaces with extension methods.

Consider the following example with some demo interfaces and classes:

//Incident is a simple dto which could include things like category, severity, message, date etc
public class Incident
{
    public string Message { get; set; }
    public Severity IncidentSeverity { get; set; }
}

//Incident severity
public enum Severity
{
    Info,
    Warn,
    Fatal
}

//Interface for our logging
public interface ILog
{
    //Write incident to log
    void Write(Incident incident);
}

//Implementation of our log - behind the scenes this could log to any format
public class Log : ILog
{        
    public void Write(Incident incident)
    {
        //write to required log eg sql / xml
    }        
}

public class MyProgram
{
    public void DoSomething()
    {
        //perform tasks

        //access instance of log
        //note: DependencyInjectionLogic.Instantiate is 
        //pseudo code for this, libraries are available to perform this kind of operation
        //the idea being that Log is the selected implementation
        ILog log = DependencyInjectionLogic.Instantiate&lt;ILog&gt;();

        log.Write(new Incident() { IncidentSeverity = Severity.Info, Message = &quot;Message&quot; });
    }
}

//Incident is a simple dto which could include things like category, severity, message, date etc

public class Incident

{

public string Message { get; set; }

public Severity IncidentSeverity { get; set; }

}

//Incident severity

public enum Severity

{

Info,

Warn,

Fatal

}

//Interface for our logging

public interface ILog

{

//Write incident to log

void Write(Incident incident);

}

//Implementation of our log - behind the scenes this could log to any format

public class Log : ILog

{

public void Write(Incident incident)

{

//write to required log eg sql / xml

}

public class MyProgram

{

public void DoSomething()

{

//perform tasks

//access instance of log

//note: DependencyInjectionLogic.Instantiate is

//pseudo code for this, libraries are available to perform this kind of operation

//the idea being that Log is the selected implementation

ILog log = DependencyInjectionLogic.Instantiate<ILog>();

log.Write(new Incident() { IncidentSeverity = Severity.Info, Message = "Message" });

}

This is all well and good – the user can write log entries with the following line:

log.Write(new Incident() { IncidentSeverity = Severity.Info, Message = &quot;Message&quot; });

1	log.Write(new Incident() { IncidentSeverity = Severity.Info, Message = "Message" });

So, how can we achieve:

ILog.Warn(&quot;message&quot;);

1	ILog.Warn("message");

The interface cannot contain any implementation. One solution would be to use abstract classes for the base class however that goes against the principal of programming to interfaces.

How about extension methods? Using the following examples we can add these shorthand methods to our ILog hiding some of the complexity / repeated code:

public static class ILogExtensions
{
    public static void Warn(this ILog log, string message)
    {
        Incident incident = new Incident()
        {
            IncidentSeverity = Severity.Warn,
            Message = message
        };

        log.Write(incident);
    }
}

public static class ILogExtensions

{

public static void Warn(this ILog log, string message)

{

Incident incident = new Incident()

{

IncidentSeverity = Severity.Warn,

Message = message

};

log.Write(incident);

}

If you setup the extension methods in the same namespace as your interface, you will now have available:

ILog.Warn(&quot;message&quot;);

1	ILog.Warn("message");

Add ITemplate content to a controls markup

June 14, 2011 by boro

When building web controls, a common scenario is how to cascade control parameters to the control from the markup (or code-behind). Within Sitecore controls this is typically the Field you want to render.

&lt;tc:SText runat="server" Field="Title" HideIfEmpty="true" /&gt;

1	<tc:SText runat="server" Field="Title" HideIfEmpty="true" />

This approach to programming controls works very well until the set of parameters becomes very long or the control doesnt need to know about each parameter. Consider embedding a flash movie, the number of parameters to code could be huge.

In the flash example, often the parameters aren’t needed by your c# code, instead they just to be rendered to the markup.

&lt;pf:SFlash runat="server" Field="Flash Item" Width="384" Height="380"&gt;
    &lt;ParametersTemplate&gt;
        &lt;param name="quality" value="high" /&gt;
        &lt;param name="bgcolor" value="#006699" /&gt;
        ...
        &lt;param name="salign" value="" /&gt;
        &lt;param name="allowScriptAccess" value="sameDomain" /&gt;
        &lt;param name="flashVars" value='dataURL=&lt;%= FeedUrl() %&gt;' /&gt;
    &lt;/ParametersTemplate&gt;
&lt;/pf:SFlash&gt;

<pf:SFlash runat="server" Field="Flash Item" Width="384" Height="380">

...

</ParametersTemplate>

</pf:SFlash>

One useful tip is that you can get information from your code behind into the template markup eg

&lt;%= FeedUrl() %&gt;

1	<%= FeedUrl() %>

To build the control you need to add the following attribute:

[ParseChildren(true)]
public class SFlash : Control

1 2	[ParseChildren(true)] public class SFlash : Control

And then the template you want to use:

[Browsable(false), DefaultValue(null), PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ITemplate ParametersTemplate
{
    get { return _parametersTemplate; }
    set { _parametersTemplate = value; }
}

private ITemplate _parametersTemplate;

[Browsable(false), DefaultValue(null), PersistenceMode(PersistenceMode.InnerProperty)]

public virtual ITemplate ParametersTemplate

{

get { return _parametersTemplate; }

set { _parametersTemplate = value; }

}

private ITemplate _parametersTemplate;

The content of the template can be extracted as a string with the following:

PlaceHolder placeholder = new PlaceHolder();

if (ParametersTemplate != null)
{
    ParametersTemplate.InstantiateIn(placeholder);
}   

StringWriter stringWriter = new StringWriter();
HtmlTextWriter writer = new HtmlTextWriter(stringWriter);

placeholder.RenderControl(writer);

PlaceHolder placeholder = new PlaceHolder();

if (ParametersTemplate != null)

{

ParametersTemplate.InstantiateIn(placeholder);

}

StringWriter stringWriter = new StringWriter();

HtmlTextWriter writer = new HtmlTextWriter(stringWriter);

placeholder.RenderControl(writer);

Note, based on the chosen implementation, you may not need the content of the template as a string. Instead you could simply instantiate to the control’s child controls

blog.boro2g .co.uk

Some ideas about coding, dev and all things online.

Category Archives: asp.net

Documenting webapi with Swagger

Grunt and gulp tasks in visual studio 2015 – libsass error

No Sitecore logs, no Event log entries and no working site?

Moq – the basics

Adding functionality to interfaces with extension methods

Add ITemplate content to a controls markup