{"id":126,"date":"2019-07-16T15:01:43","date_gmt":"2019-07-16T14:01:43","guid":{"rendered":"https:\/\/wissing.me\/?p=126"},"modified":"2019-07-16T15:01:43","modified_gmt":"2019-07-16T14:01:43","slug":"unit-test-snippets","status":"publish","type":"post","link":"https:\/\/daan.wsng.eu\/index.php\/2019\/07\/16\/unit-test-snippets\/","title":{"rendered":"Unit test snippets"},"content":{"rendered":"\n

I am a big fan of making things easy for myself. When preparing the TDD Workshop<\/a> for another round I found it increasingly tedious to type out every unit test function. Luckily, Visual Studio lets you create your own snippets, so I created one that would immediately generate something like this:<\/p>\n\n\n

\n[Test]\npublic void GivenContext_WhenAction_ThenResult()\n{\n    \/\/ Arrange\n\n    \/\/ Act\n\n    \/\/ Assert\n}\n<\/pre><\/div>\n\n\n\n\n\n\n
How does it work I hear you say? It’s simpler than I expected:<\/p>\n\n\n\n
  1. Create a .snippet file in <documents>\/Visual Studio 2017\/Code Snippets\/Visual C#\/My Code Snippets<\/code> (e.g. TDD.snippet)<\/li>
  2. Put the following XML content in the file:<\/li><\/ol>\n\n\n
    \n<?xml version="1.0" encoding="utf-8"?>\n<CodeSnippets xmlns="http:\/\/schemas.microsoft.com\/VisualStudio\/2005\/CodeSnippet">\n  <CodeSnippet Format="1.0.0">\n    <Header>\n      <Title>Unit test template<\/Title>\n      <Author>Daan Wissing<\/Author>\n      <Description>Insert Arrange\/Act\/Assert groups in unit test function<\/Description>\n      <Shortcut>unittest<\/Shortcut>\n    <\/Header>\n    <Snippet>\n      <Code Language="CSharp">\n        <![CDATA[[Test]\n        public void Given$context$_When$action$_Then$result$()\n        {\n          \/\/ Arrange\n        \n          \/\/ Act\n        \n          \/\/ Assert\n        }]]>\n      <\/Code>\n      <Declarations>\n        <Literal>\n          <ID>context<\/ID>\n          <Default>Context<\/Default>\n          <ToolTip>The context of this unit test<\/ToolTip>\n        <\/Literal>\n        <Literal>\n          <ID>action<\/ID>\n          <Default>Action<\/Default>\n          <ToolTip>The action that is tested<\/ToolTip>\n        <\/Literal>\n        <Literal>\n          <ID>result<\/ID>\n          <Default>Result<\/Default>\n          <ToolTip>The resulting state that will be asserted<\/ToolTip>\n        <\/Literal>\n      <\/Declarations>\n    <\/Snippet>\n  <\/CodeSnippet>\n<\/CodeSnippets>\n<\/pre><\/div>\n\n\n
    Done! Visual Studio will automatically pick up the new snippet file (maybe you need to restart). You can use the snippet by invoking IntelliSense (usually CTRL + SPACE), typing unittest<\/code> and hitting TAB. <\/p>\n\n\n\n
    The highlighted lines are the meat of this snippet: the Code<\/code> node contains what to actually insert in the editor. Most of the rest is some administration, but some extra fun is the Declarations<\/code> node. In this snippet I have to fill in three important pieces of information of the unit test (the context, the action tested and the expectation) because these will change for every unit test.<\/p>\n\n\n\n
    Try it out yourself!<\/p>\n","protected":false},"excerpt":{"rendered":"
    I am a big fan of making things easy for myself. When preparing the TDD Workshop for another round I found it increasingly tedious to type out every unit test function. Luckily, Visual Studio lets you create your own snippets, so I created one that would immediately generate something like this:<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"twitterCardType":"","cardImageID":0,"cardImage":"","cardTitle":"","cardDesc":"","cardImageAlt":"","cardPlayer":"","cardPlayerWidth":0,"cardPlayerHeight":0,"cardPlayerStream":"","cardPlayerCodec":""},"categories":[10],"tags":[],"_links":{"self":[{"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/posts\/126"}],"collection":[{"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/comments?post=126"}],"version-history":[{"count":6,"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/posts\/126\/revisions"}],"predecessor-version":[{"id":132,"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/posts\/126\/revisions\/132"}],"wp:attachment":[{"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/media?parent=126"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/categories?post=126"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/daan.wsng.eu\/index.php\/wp-json\/wp\/v2\/tags?post=126"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}