Menu
Home
People
Places
Arts
History
Plants & Animals
Science
Life & Culture
Technology
Reference.org
Cucumber (software)
open-in-new
<h2 id="gherkin-language">Gherkin language</h2> <p>Gherkin is the language that Cucumber uses to define test cases. It is designed to be non-technical and human readable, and collectively describes use cases relating to a software system.<a class="footnote-ref" id="fnref:23" href="#fn:23"><sup>23</sup></a><a class="footnote-ref" id="fnref:24" href="#fn:24"><sup>24</sup></a><a class="footnote-ref" id="fnref:25" href="#fn:25"><sup>25</sup></a><a class="footnote-ref" id="fnref:26" href="#fn:26"><sup>26</sup></a> The purpose behind Gherkin's syntax is to promote behavior-driven development practices across an entire development team, including business analysts and managers. It seeks to enforce firm, unambiguous requirements starting in the initial phases of requirements definition by business management and in other stages of the development lifecycle. </p><p>In addition to providing a script for automated testing, Gherkin's natural language syntax is designed to provide simple documentation of the code under test.<a class="footnote-ref" id="fnref:27" href="#fn:27"><sup>27</sup></a> Gherkin currently supports keywords in dozens of languages.<a class="footnote-ref" id="fnref:28" href="#fn:28"><sup>28</sup></a><a class="footnote-ref" id="fnref:29" href="#fn:29"><sup>29</sup></a><a class="footnote-ref" id="fnref:30" href="#fn:30"><sup>30</sup></a><a class="footnote-ref" id="fnref:31" href="#fn:31"><sup>31</sup></a> </p> <h3>Syntax</h3> <p>Syntax is centered around a <a href="/facts/Off-side_rule/LmengNTS">line-oriented design</a>, similar to that of <a href="/facts/Python_(programming_language)/YbuGqofa">Python</a>. The structure of a file is defined using whitespace and other control characters.<a class="footnote-ref" id="fnref:32" href="#fn:32"><sup>32</sup></a> Lines starting with # are considered comments, and can be placed anywhere in a file.<a class="footnote-ref" id="fnref:33" href="#fn:33"><sup>33</sup></a> Instructions are any non-empty and non-comment line. They consist of a recognized Gherkin keyword followed by a string.<a class="footnote-ref" id="fnref:34" href="#fn:34"><sup>34</sup></a> </p><p>All Gherkin files have the .feature file extension. They contain a single Feature definition for the system under test and are an executable test script.<a class="footnote-ref" id="fnref:35" href="#fn:35"><sup>35</sup></a> </p><p>Here is an example of the syntax:<a class="footnote-ref" id="fnref:36" href="#fn:36"><sup>36</sup></a> </p> Feature: Guess the word # The first example has two steps Scenario: Maker starts a game When the Maker starts a game Then the Maker waits for a Breaker to join # The second example has three steps Scenario: Breaker joins a game Given the Maker has started a game with the word "silky" When the Breaker joins the Maker's game Then the Breaker must guess a word with 5 characters <h2 id="command-line">Command line</h2> <p>Cucumber comes with a built-in command line interface that covers a comprehensive list of instructions. Like most command line tools, cucumber provides the --help option that provides a summary of arguments the command accepts.<a class="footnote-ref" id="fnref:37" href="#fn:37"><sup>37</sup></a> </p> $ cucumber --help -r, --require LIBRARY|DIR Require files before executing the features. --i18n LANG List keywords for in a particular language. Run with "--i18n help" to see all languages. -f, --format FORMAT How to format features (Default: pretty). -o, --out [FILE|DIR] Write output to a file/directory instead of ... <p>Cucumber command line can be used to quickly run defined tests. It also supports running a subset of scenarios by filtering tags. </p> $ cucumber --tags @tag-name <p>The above command helps in executing only those scenarios that have the specified @tag-name.<a class="footnote-ref" id="fnref:38" href="#fn:38"><sup>38</sup></a> Arguments can be provided as a logical OR or AND operation of tags. Apart from tags, scenarios can be filtered on scenario names.<a class="footnote-ref" id="fnref:39" href="#fn:39"><sup>39</sup></a> </p> $ cucumber --name logout <p>The above command will run only those scenarios that contain the word 'logout'. </p><p>It is also useful to be able to know what went wrong when a test fails. Cucumber makes it easy to catch bugs in the code with the --backtrace option.<a class="footnote-ref" id="fnref:40" href="#fn:40"><sup>40</sup></a> </p> <h2 id="external-links">External links</h2> <ul> <li>Free and open-source software portal</li></ul> <ul><li><a href="https://cucumber.io">Cucumber project</a></li> <li><a href="https://cucumber.io/docs">Cucumber project documentation</a></li></ul> <h2 id="references">References</h2> <ol> <li id="fn:1"><p>"The Pragmatic Bookshelf | The Cucumber Book". Pragprog.com. Archived from the original on 2012-01-21. Retrieved 2012-01-24. <a href="https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book" target="_blank">https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li> <li id="fn:2"><p>Rose, Seb; Wynne, Matt; Hellesøy, Aslak (15 February 2015). The Pragmatic Bookshelf | The Cucumber For Java Book. Pragprog.com. Retrieved 2019-04-28. <a href="https://pragprog.com/book/srjcuc/the-cucumber-for-java-book" target="_blank">https://pragprog.com/book/srjcuc/the-cucumber-for-java-book</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li> <li id="fn:3"><p>"What is Cucumber?". cucumber. Retrieved 2019-06-08. <a href="https://cucumber.io/docs/guides/overview/" target="_blank">https://cucumber.io/docs/guides/overview/</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li> <li id="fn:4"><p>Aslak Hellesøy. "The world's most misunderstood collaboration tool". cucumber. <a href="https://cucumber.io/blog/the-worlds-most-misunderstood-collaboration-tool/" target="_blank">https://cucumber.io/blog/the-worlds-most-misunderstood-collaboration-tool/</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li> <li id="fn:5"><p>Nagy, Gáspár; Rose, Seb (2017-03-07). The BDD Books - Discovery. Leanpub. ISBN 978-1983591259.{{cite book}}: CS1 maint: date and year (link) <a href="978-1983591259" target="_blank">978-1983591259</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li> <li id="fn:6"><p>Rose, Seb; Nagy, Gáspár (2021-04-27). The BDD Books – Formulation. Leanpub. ISBN 979-8723395015.{{cite book}}: CS1 maint: date and year (link) <a href="979-8723395015" target="_blank">979-8723395015</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li> <li id="fn:7"><p>Fox, Armando; Patterson, David (2016). Engineering Software as a Service. Strawberry Canyon. pp. 218–255. ISBN 978-0-9848812-4-6. <a href="978-0-9848812-4-6" target="_blank">978-0-9848812-4-6</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li> <li id="fn:8"><p>"The Pragmatic Bookshelf | The Cucumber Book". Pragprog.com. Archived from the original on 2012-01-21. Retrieved 2012-01-24. <a href="https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book" target="_blank">https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li> <li id="fn:9"><p>Rose, Seb; Wynne, Matt; Hellesøy, Aslak (15 February 2015). The Pragmatic Bookshelf | The Cucumber For Java Book. Pragprog.com. Retrieved 2019-04-28. <a href="https://pragprog.com/book/srjcuc/the-cucumber-for-java-book" target="_blank">https://pragprog.com/book/srjcuc/the-cucumber-for-java-book</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></p></li> <li id="fn:10"><p>"Automated testing with Selenium and Cucumber". www.ibm.com. 2013-08-06. Retrieved 2017-02-09. <a href="https://www.ibm.com/developerworks/library/a-automating-ria/" target="_blank">https://www.ibm.com/developerworks/library/a-automating-ria/</a> <a href="#fnref:10" class="footnote-back-ref">↩</a></p></li> <li id="fn:11"><p>Soeken, Mathias; Wille, Robert; Drechsler, Rolf (2012-05-29). Furia, Carlo A.; Nanz, Sebastian (eds.). Objects, Models, Components, Patterns. Lecture Notes in Computer Science. Springer Berlin Heidelberg. pp. 269–287. doi:10.1007/978-3-642-30561-0_19. ISBN 9783642305603. <a href="9783642305603" target="_blank">9783642305603</a> <a href="#fnref:11" class="footnote-back-ref">↩</a></p></li> <li id="fn:12"><p>"The Pragmatic Bookshelf | The Cucumber Book". Pragprog.com. Archived from the original on 2012-01-21. Retrieved 2012-01-24. <a href="https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book" target="_blank">https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book</a> <a href="#fnref:12" class="footnote-back-ref">↩</a></p></li> <li id="fn:13"><p>"The Pragmatic Bookshelf | The RSpec Book". Pragprog.com. 2010-12-02. Archived from the original on 2012-01-21. Retrieved 2012-01-24. <a href="https://web.archive.org/web/20120121003856/http://pragprog.com/book/achbd/the-rspec-book" target="_blank">https://web.archive.org/web/20120121003856/http://pragprog.com/book/achbd/the-rspec-book</a> <a href="#fnref:13" class="footnote-back-ref">↩</a></p></li> <li id="fn:14"><p>Rose, Seb; Wynne, Matt; Hellesøy, Aslak (15 February 2015). The Pragmatic Bookshelf | The Cucumber For Java Book. Pragprog.com. Retrieved 2019-04-28. <a href="https://pragprog.com/book/srjcuc/the-cucumber-for-java-book" target="_blank">https://pragprog.com/book/srjcuc/the-cucumber-for-java-book</a> <a href="#fnref:14" class="footnote-back-ref">↩</a></p></li> <li id="fn:15"><p>"Cucumber-jvm". cucumber. Retrieved 2018-03-08. <a href="https://github.com/cucumber/cucumber-jvm" target="_blank">https://github.com/cucumber/cucumber-jvm</a> <a href="#fnref:15" class="footnote-back-ref">↩</a></p></li> <li id="fn:16"><p>Rose, Seb; Wynne, Matt; Hellesøy, Aslak (15 February 2015). The Pragmatic Bookshelf | The Cucumber For Java Book. Pragprog.com. Retrieved 2019-04-28. <a href="https://pragprog.com/book/srjcuc/the-cucumber-for-java-book" target="_blank">https://pragprog.com/book/srjcuc/the-cucumber-for-java-book</a> <a href="#fnref:16" class="footnote-back-ref">↩</a></p></li> <li id="fn:17"><p>"Cucumber-js". cucumber. Retrieved 2018-03-08. <a href="https://github.com/cucumber/cucumber-js" target="_blank">https://github.com/cucumber/cucumber-js</a> <a href="#fnref:17" class="footnote-back-ref">↩</a></p></li> <li id="fn:18"><p>Naidele Manjunath; Olivier de Meulder (2019-02-01). "No Code? No Problem — Writing Tests in Plain English". Times Open. Retrieved 2019-04-29. <a href="https://open.nytimes.com/no-code-no-problem-writing-tests-in-plain-english-537827eaaa6e" target="_blank">https://open.nytimes.com/no-code-no-problem-writing-tests-in-plain-english-537827eaaa6e</a> <a href="#fnref:18" class="footnote-back-ref">↩</a></p></li> <li id="fn:19"><p>"Binding Business Requirements to .NET Code". SpecFlow. Retrieved 2019-04-29. <a href="https://specflow.org/" target="_blank">https://specflow.org/</a> <a href="#fnref:19" class="footnote-back-ref">↩</a></p></li> <li id="fn:20"><p>"SpecFlow". GitHub. Retrieved 2019-04-29. <a href="https://github.com/techtalk/SpecFlow" target="_blank">https://github.com/techtalk/SpecFlow</a> <a href="#fnref:20" class="footnote-back-ref">↩</a></p></li> <li id="fn:21"><p>Richard Lawrence; Paul Rayner (2018). Behavior-Driven Development with Cucumber. Addison Wesley. <a href="#fnref:21" class="footnote-back-ref">↩</a></p></li> <li id="fn:22"><p>Nagy, Gáspár (8 February 2024). "From SpecFlow to Reqnroll: Why and How". reqnroll.net. Reqnroll. Retrieved 18 April 2024. <a href="https://reqnroll.net/news/2024/02/from-specflow-to-reqnroll-why-and-how/" target="_blank">https://reqnroll.net/news/2024/02/from-specflow-to-reqnroll-why-and-how/</a> <a href="#fnref:22" class="footnote-back-ref">↩</a></p></li> <li id="fn:23"><p>"The Pragmatic Bookshelf | The Cucumber Book". Pragprog.com. Archived from the original on 2012-01-21. Retrieved 2012-01-24. <a href="https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book" target="_blank">https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book</a> <a href="#fnref:23" class="footnote-back-ref">↩</a></p></li> <li id="fn:24"><p>Rose, Seb; Wynne, Matt; Hellesøy, Aslak (15 February 2015). The Pragmatic Bookshelf | The Cucumber For Java Book. Pragprog.com. Retrieved 2019-04-28. <a href="https://pragprog.com/book/srjcuc/the-cucumber-for-java-book" target="_blank">https://pragprog.com/book/srjcuc/the-cucumber-for-java-book</a> <a href="#fnref:24" class="footnote-back-ref">↩</a></p></li> <li id="fn:25"><p>"cucumber/gherkin". GitHub. Retrieved 2017-02-09. <a href="https://github.com/cucumber/cucumber/tree/master/gherkin" target="_blank">https://github.com/cucumber/cucumber/tree/master/gherkin</a> <a href="#fnref:25" class="footnote-back-ref">↩</a></p></li> <li id="fn:26"><p>"Gherkin Syntax". cucumber. Retrieved 2019-07-09. <a href="https://cucumber.io/docs/gherkin/" target="_blank">https://cucumber.io/docs/gherkin/</a> <a href="#fnref:26" class="footnote-back-ref">↩</a></p></li> <li id="fn:27"><p>"Gherkin Syntax". cucumber. Retrieved 2019-07-09. <a href="https://cucumber.io/docs/gherkin/" target="_blank">https://cucumber.io/docs/gherkin/</a> <a href="#fnref:27" class="footnote-back-ref">↩</a></p></li> <li id="fn:28"><p>"Gherkin Syntax". cucumber. Retrieved 2019-07-09. <a href="https://cucumber.io/docs/gherkin/" target="_blank">https://cucumber.io/docs/gherkin/</a> <a href="#fnref:28" class="footnote-back-ref">↩</a></p></li> <li id="fn:29"><p>"Gherkin Supported Languages". Gherkin. cucumber/cucumber: Cucumber monorepo - building blocks for Cucumber in various languages. Retrieved 2021-03-21 – via GitHub. <a href="https://github.com/cucumber/gherkin/blob/main/gherkin-languages.json" target="_blank">https://github.com/cucumber/gherkin/blob/main/gherkin-languages.json</a> <a href="#fnref:29" class="footnote-back-ref">↩</a></p></li> <li id="fn:30"><p>"The Pragmatic Bookshelf | The Cucumber Book". Pragprog.com. Archived from the original on 2012-01-21. Retrieved 2012-01-24. <a href="https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book" target="_blank">https://web.archive.org/web/20120121022646/http://pragprog.com/book/hwcuc/the-cucumber-book</a> <a href="#fnref:30" class="footnote-back-ref">↩</a></p></li> <li id="fn:31"><p>Rose, Seb; Wynne, Matt; Hellesøy, Aslak (15 February 2015). The Pragmatic Bookshelf | The Cucumber For Java Book. Pragprog.com. Retrieved 2019-04-28. <a href="https://pragprog.com/book/srjcuc/the-cucumber-for-java-book" target="_blank">https://pragprog.com/book/srjcuc/the-cucumber-for-java-book</a> <a href="#fnref:31" class="footnote-back-ref">↩</a></p></li> <li id="fn:32"><p>"Gherkin Syntax". cucumber. Retrieved 2019-07-09. <a href="https://cucumber.io/docs/gherkin/" target="_blank">https://cucumber.io/docs/gherkin/</a> <a href="#fnref:32" class="footnote-back-ref">↩</a></p></li> <li id="fn:33"><p>"Gherkin Syntax". cucumber. Retrieved 2019-07-09. <a href="https://cucumber.io/docs/gherkin/" target="_blank">https://cucumber.io/docs/gherkin/</a> <a href="#fnref:33" class="footnote-back-ref">↩</a></p></li> <li id="fn:34"><p>"Reference". cucumber. Archived from the original on 2015-10-25. Retrieved 2016-01-17. <a href="https://web.archive.org/web/20151025214933/https://cucumber.io/docs/reference" target="_blank">https://web.archive.org/web/20151025214933/https://cucumber.io/docs/reference</a> <a href="#fnref:34" class="footnote-back-ref">↩</a></p></li> <li id="fn:35"><p>"Reference". cucumber. Archived from the original on 2015-10-25. Retrieved 2016-01-17. <a href="https://web.archive.org/web/20151025214933/https://cucumber.io/docs/reference" target="_blank">https://web.archive.org/web/20151025214933/https://cucumber.io/docs/reference</a> <a href="#fnref:35" class="footnote-back-ref">↩</a></p></li> <li id="fn:36"><p>"Gherkin Reference". cucumber. Archived from the original on 2024-01-13. Retrieved 2024-02-11. <a href="https://web.archive.org/web/20240113160832/https://cucumber.io/docs/gherkin/reference/" target="_blank">https://web.archive.org/web/20240113160832/https://cucumber.io/docs/gherkin/reference/</a> <a href="#fnref:36" class="footnote-back-ref">↩</a></p></li> <li id="fn:37"><p>Wynne, Matt; Hellesoy, Aslak. "The Cucumber Book". SafariBooksOnline. Retrieved 22 January 2016. <a href="https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html" target="_blank">https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html</a> <a href="#fnref:37" class="footnote-back-ref">↩</a></p></li> <li id="fn:38"><p>Wynne, Matt; Hellesoy, Aslak. "The Cucumber Book". SafariBooksOnline. Retrieved 22 January 2016. <a href="https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html" target="_blank">https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html</a> <a href="#fnref:38" class="footnote-back-ref">↩</a></p></li> <li id="fn:39"><p>Wynne, Matt; Hellesoy, Aslak. "The Cucumber Book". SafariBooksOnline. Retrieved 22 January 2016. <a href="https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html" target="_blank">https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html</a> <a href="#fnref:39" class="footnote-back-ref">↩</a></p></li> <li id="fn:40"><p>Wynne, Matt; Hellesoy, Aslak. "The Cucumber Book". SafariBooksOnline. Retrieved 22 January 2016. <a href="https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html" target="_blank">https://www.safaribooksonline.com/library/view/the-cucumber-book/9781941222911/f_0090.html</a> <a href="#fnref:40" class="footnote-back-ref">↩</a></p></li> </ol>