<divrole="region"aria-label="Skip to main content"><aclass="skipToContent_fXgn"href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><navaria-label="Main"class="navbar navbar--fixed-top"><divclass="navbar__inner"><divclass="navbar__items"><buttonaria-label="Toggle navigation bar"aria-expanded="false"class="navbar__toggle clean-btn"type="button"><svgwidth="30"height="30"viewBox="0 0 30 30"aria-hidden="true"><pathstroke="currentColor"stroke-linecap="round"stroke-miterlimit="10"stroke-width="2"d="M4 7h22M4 15h22M4 23h22"></path></svg></button><aclass="navbar__brand"href="/"><bclass="navbar__title text--truncate">mf</b></a><divclass="navbar__item dropdown dropdown--hoverable"><ahref="#"aria-haspopup="true"aria-expanded="false"role="button"class="navbar__link">Additional FI MU materials</a><ulclass="dropdown__menu"><li><aclass="dropdown__link"href="/ib002/">IB002: Algorithms</a></li><li><aaria-current="page"class="dropdown__link dropdown__link--active"href="/pb071/">PB071: C</a></li><li><aclass="dropdown__link"href="/pb161/">PB161: C++</a></li></ul></div><aclass="navbar__item navbar__link"href="/contributions">Contributions</a><aclass="navbar__item navbar__link"href="/talks">Talks</a></div><divclass="navbar__items navbar__items--right"><aclass="navbar__item navbar__link"href="/blog">Blog</a><divclass="toggle_vylO colorModeToggle_DEke"><buttonclass="clean-btn toggleButton_gllP toggleButtonDisabled_aARS"type="button"disabled=""title="Switch between dark and light mode (currently light mode)"aria-label="Switch between dark and light mode (currently light mode)"aria-live="polite"><svgviewBox="0 0 24 24"width="24"height="24"class="lightToggleIcon_pyhR"><pathfill="currentColor"d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svgviewBox="0 0 24 24"width="24"height="24"class="darkToggleIcon_wfgR"><pathfill="currentColor"d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><divclass="searchBox_ZlJk"><buttontype="button"class="DocSearch DocSearch-Button"aria-label="Search"><spanclass="DocSearch-Button-Container"><svgwidth="20"height="20"class="DocSearch-Search-Icon"viewBox="0 0 20 20"><pathd="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z"stroke="currentColor"fill="none"fill-rule="evenodd"stroke-linecap="round"stroke-linejoin="round"></path></svg><spanclass="DocSearch-Button-Placeholder">Search</span></span><spanclass="DocSearch-Button-Keys"></span></button></div></div></div><divrole="presentation"class="navbar-sidebar__backdrop"></div></nav><divid="__docusaurus_skipToContent_fallback"class="main-wrappermainWrapper_
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><p>Ideally submit the assignment through the merge request. Step-by-step tutorial
is present <ahref="/pb071/mr">here</a>. For setting assignee my xlogin is <code>xfocko</code>.</p><p>In case you do not want to experiment on GitLab, send me the source code via
