task is to try the game, in case you find any bugs point them out and cover as
much of the game as possible with tests.</p><p>For this bonus you can get at maximum 2 K₡.</p><table><thead><tr><th>Item</th><th>Bonus</th></tr></thead><tbody><tr><td>Fixing bugs from failing tests</td><td>0.25</td></tr><tr><td><code>word_guessed</code></td><td>0.50</td></tr><tr><td>Hidden bug</td><td>0.50</td></tr><tr><td>Extending tests, undetectable bugs or evil bug</td><td>0.37</td></tr><tr><td>Refactor</td><td>0.38</td></tr></tbody></table><h2class="anchor anchorWithStickyNavbar_LWe7"id="project">Project<ahref="#project"class="hash-link"aria-label="Direct link to Project"title="Direct link to Project"></a></h2><p>Project consists of 2 source files - <code>hangman.c</code> and <code>main.c</code>.</p><p><code>main.c</code> is quite short and concise, there is nothing for you to do.</p><p><code>hangman.c</code> contains implementation of the game. In case you feel lost, consult
the documentation in <code>hangman.h</code> that represents an interface that can be used
for implementing the game.</p><p>Apart from those sources this project is a bit more complicated. <em>Game loop</em> is
realised via single encapsulated function that complicates the testing. Because
of that, there are 2 kinds of tests:</p><ul><li><p><em>Unit tests</em> - that are present in <code>test_hangman.c</code> and can be run via:</p><divclass="codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#000000;--prism-background-color:#ffffff"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-text codeBlock_bY9V thin-scrollbar"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#000000"><spanclass="token plain">$ make check-unit</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgviewBox="0 0 24 24"class="copyButtonIcon_y97N"><pathfill="currentColor"d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgviewBox="0 0 24 24"class="copyButtonSuccessIcon_LjdS"><pathfill="currentColor"d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>They cover majorly functions that can be tested easily via testing framework.</p></li><li><p><em>Functional tests</em> - same as in <code>seminar-08</code> and are focused on testing the
program as whole. Basic smoke test is already included in <code>usage</code> test case.</p><p>They can be run via:</p><divclass="codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#000000;--prism-background-color:#ffffff"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-text codeBlock_bY9V thin-scrollbar"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#000000"><spanclass="token plain">$ make check-functional</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgviewBox="0 0 24 24"class="copyButtonIcon_y97N"><pathfill="currentColor"d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgviewBox="0 0 24 24"class="copyButtonSuccessIcon_LjdS"><pathfill="currentColor"d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When testing <code>hangman</code> function (the game loop), it is suggested to create
functional tests.</p><p>When submitting the files for review, please leave out functional tests that
were given as a part of the assignment, so that it is easier to navigate, I
will drag the common files myself. :)</p></li></ul><blockquote><p>Whole test suite can be run via:</p><divclass="codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#000000;--prism-background-color:#ffffff"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-text codeBlock_bY9V thin-scrollbar"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#000000"><spanclass="token plain">$ make check</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgviewBox="0 0 24 24"class="copyButtonIcon_y97N"><pathfill="currentColor"d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgviewBox="0 0 24 24"class="copyButtonSuccessIcon_LjdS"><pathfill="currentColor"d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></blockquote><h3class="anchor anchorWithStickyNavbar_LWe7"id="summary-of-the-gameplay">Summary of the gameplay<ahref="#summary-of-the-gameplay"class="hash-link"aria-label="Direct link to Summary of the gameplay"title="Direct link to Summary of the gameplay"></a></h3><ol><li>Secret word gets chosen from the file that's path is given as an argument.</li><li>You get 8 guesses.</li><li>Invalid characters don't count.</li><li>Already guessed characters don't count, even if not included in the secret.</li><li>You can guess the whole word at once<ul><li>If you get it right, you won, game ends.</li><li>If you don't get it right, you get to see the secret, game ends.</li></ul></li><li>In case of end of input, game finishes via force.</li><li>In case of invalid input, no guesses are subtracted, game carries on.</li><li>Letters and words are not case sensitive.</li></ol><h2class="anchor anchorWithStickyNavbar_LWe7"id="suggested-workflow">Suggested workflow<ahref="#suggested-workflow"class="hash-link"aria-label="Direct link to Suggested workflow"title="Direct link to Suggested workflow"></a></h2><p>As we have talked about on the seminar, I suggest you to follow
<em>Test-Driven Development</em>
in this case.</p><p><imgloading="lazy"alt="TDD workflow"src="/assets/images/tdd_lifecycle-327ad9ee0ed8318ed11e19a28e02b2cc.png"width="2814"height="1652"class="img_ev3q"></p><p>In our current scenario we are already in the stage of refactoring and fixing the
bugs. Therefore try to follow this succession of steps:</p><ol><li>Try to reproduce the bug.</li><li>Create a test that proves the presence of the bug.</li><li>Fix the bug.</li></ol><p>In case you are submitting the bonus via GitLab, it is helpful to commit tests
before commiting the fixes, so that it is apparent that the bug is manifested.
Example of <code>git log</code> (notice that the first line represents latest commit):</p><divclass="codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#000000;--prism-background-color:#ffffff"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-text codeBlock_bY9V thin-scrollbar"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#000000"><spanclass="token plain">feat: Implement fizz_buzzer</span><br></span><spanclass="token-line"style="color:#000000"><spanclass="token plain">test: Add tests for fizz_buzzer</span><br></span><spanclass="token-line"style="color:#000000"><spanclass="token plain">fix: Fix NULL-check in print_name</span><br></span><spanclass="token-line"style="color:#000000"><spanclass="token plain">test: Add test for NULL in print_name</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgviewBox="0 0 24 24"class="copyButtonIcon_y97N"><pathfill="currentColor"d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgviewBox="0 0 24 24"class="copyButtonSuccessIcon_LjdS"><pathfill="currentColor"d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2class="anchor anchorWithStickyNavbar_LWe7"id="tasks">Tasks<ahref="#tasks"class="hash-link"aria-label="Direct link to Tasks"title="Direct link to Tasks"></a></h2><p>As to your tasks, there are multiple things wrong in this project.</p><ol><li><p>There are 2 "bugs" that cannot be detected via tests, i.e. they are not bugs
that affect functionality of the game.</p></li><li><p>There is one evil bug in <code>get_word</code>. It is not required to be fixed ;) Assign
it the lowest priority.</p></li><li><p>There are some tests failing. Please try to figure it out, so you have green
tests for the rest :)</p></li><li><p>We have gotten a bug report for <code>word_guessed</code>, all we got is</p><blockquote><p>doesn't work when there are too many <code>a</code>s</p></blockquote><p>Please try to replicate the bug and create a tests, so we don't get any
regression later on.</p></li><li><p>One hidden bug :) Closely non-specified, we cannot reproduce it and we were
drunk while playing the game, so we don't remember a thing. :/</p></li><li><p>Try to cover as much code via the tests as possible. We are not going to look
at the metrics, but DRY is violated a lot, so as a last task try to remove as
much of the duplicit code as possible.</p><p>Tests should help you a lot in case there are some regressions.</p></li></ol><hr><p>In case you wonder why there are always 3 same words in the file with words, it
is because of the <code>get_word</code> bug. It is not a bug that can be easily fixed, so
it is a not requirement at all and you can still get all points for the bonus ;)</p><h2class="anchor anchorWithStickyNavbar_LWe7"id="dictionary">Dictionary<ahref="#dictionary"class="hash-link"aria-label="Direct link to Dictionary"title="Direct link to Dictionary"></a></h2><ul><li><ahref="https://en.wikipedia.org/wiki/Functional_testing"target="_blank"rel="noopener noreferrer">Functional tests</a></li><li><ahref="https://en.wikipedia.org/wiki/Smoke_testing_%28software%29"target="_blank"rel="noopener noreferrer">Smoke test</a></li><li><ahref="https://en.wikipedia.org/wiki/Don%27t_repeat_yourself"target="_blank"rel="noopener noreferrer">DRY</a></li></ul><h2class="anchor anchorWithStickyNavbar_LWe7"id="submitting">Submitting<ahref="#submitting"class="hash-link"aria-label="Direct link to Submitting"title="Direct link to Submitting"></a></h2><p>In case you have any questions, feel free to reach out to me.</p><hr></div><footerclass="theme-doc-footer docusaurus-mt-lg"><divclass="theme-doc-footer-edit-meta-row row"><divclass="col"><ahref="https://github.com/mfocko/blog/tree/main/pb071/bonuses/10.md"target="_blank"rel="noreferrer noopener"class="theme-edit-this-page"><svgfill="currentColor"height="20"width="20"viewBox="0 0 40 40"class="iconEdit_Z9Sw"aria-hidden="true"><g><pathd="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><divclass="col lastUpdated_vwxv"><spanclass="theme-last-updated">Last updated<!----> on <b><timedatetime="2023-09-17T14:05:05.000Z">Sep 17, 2023</time></b></span></div></div></footer></article><navclass="pagination-nav docusaurus-mt-lg"aria-label="Docs pages"><aclass="pagination-nav__link pagination-nav__link--prev"href="/pb071/bonuses/seminar-08/"><divclass="pagination-nav__sublabel">Previous</div><divclass="pagination-nav__label">8th seminar</div></a><aclass="pagination-nav__link pagination-nav__link--next"href="/pb071/category/practice-exams/"><divclass="pagination-nav__sublabel">Next</div><divclass="pagination-nav__label">Practice Exams</div></a></nav></div></div><divclass="col col--3"><divclass="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ulclass="table-of-contents table-of-contents__left-border"><li><ahref="#introduction"class="table-of-contents__link toc-highlight">Introduction</a></li><li><ahref="#project"class="table-of-contents__link toc-highlight">Project</a><ul><li><ahref="#summary-of-the-gameplay"class="table-of-contents__link toc-highlight">Summary of the gameplay</a></li></ul></li><li><ahref="#suggested-workflow"class="table-of-contents__link toc-highlight">Suggested workflow</a></li><li><ahref="#tasks"class="table-of-contents__link toc-highlight">Tasks</a></li><li><ahref="#dictionary"class="table-of-contents__link toc-highlight">Dictionary</a></li><li><ahref="#submitting"class="table-of-contents__link toc-highlight">Submitting</a></li></ul></div></div></div></div></main></div></div><footerclass="footer footer--dark"><divclass="container container-fluid"><divclass="row footer__links"><divclass="col footer__col"><divclass="footer__title">Git</div><ulclass="footer__items clean-list"><liclass="footer__item"><ahref="https://github.com/mfocko"target="_blank"rel="noopener noreferrer"class="footer__link-item">GitHub<svgwidth="13.5"height="13.5"aria-hidden="true"viewBox="0 0 24 24"class="iconExternalLink_nPIU"><pathfill="currentColor"d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><liclass="footer__item"><ahref="https://gitlab.com/mfocko"target="_blank"rel="noopener noreferrer"class="footer__link-item">GitLab<svgwidth="13.5"height="13.5"aria-hidden="true"viewBox="0 0 24 24"class="iconExternalLink_nPIU"><pathfill="currentColor"d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><lic
