<div dir="ltr"><div class="gmail_default" style="font-size:small">Hi All,<br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">A quick update on this - we've now added "good-first-issue" to the list of unit test issues. You can see the list of those issues here:</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"><a href="https://github.com/kata-containers/kata-containers/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue">https://github.com/kata-containers/kata-containers/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue</a><br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">A reminder that this is a *great* way to learn the codebase and will expand your skills in golang and/or rust! ;-)</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">If you'd like to help contribute either add a comment to the issue or just ping us.</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Cheers,</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">James</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, 5 Jun 2020 at 17:54, Hunt, James O <<a href="mailto:james.o.hunt@intel.com">james.o.hunt@intel.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div class="gmail_default" style="font-size:small">Hi All,<br clear="all"></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">- Want to learn more about the internals of Kata but don't know where to start?<br></div><div class="gmail_default" style="font-size:small">- Are you keen to contribute to Kata?</div><div class="gmail_default" style="font-size:small">- Can you code in golang or rust?<br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">If you answer yes to those questions, read on...! ;)</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"># Summary</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">We're looking to increase the unit test coverage for the development versions of the Kata 2.0 [1]. Specifically, we want to increase coverage levels for the following Kata 2.0 components:</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">- runtime (written in golang) [2]</div><div class="gmail_default" style="font-size:small">- the new agent (written in rust) [3]<br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">The unit test coverage levels have slipped for the runtime and the new agent is so new it still lacks tests in certain areas.</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">This is an important activity as you have the chance to find (and potentially fix!) bugs before they are unleashed into the wild.</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"># Details</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">There is a top-level issue for each component (runtime [4], agent [5]).</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Each of those top-level issues has a number of related issues that breaks the work down into smaller chunks (there is an issue per directory/module, or even per file in some cases).</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"># Tracking</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">I've added all those task issues into the Kata 2.0 GitHub project [6].</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"># Get involved<br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">If you'd like to be involved, please let us know by adding a comment to [4] or [5] and we can help you find an interesting area to work on with us. Conversely, please don't start writing tests without telling us to avoid disappointment when we discover multiple people are writing the same set of tests!</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"># Advice</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">You should definitely read [7] first and you may find [8] and [9] helpful (the latter for golang tests).<br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Before writing any new tests, please look at the existing tests for inspiration. Note also that some tests must run as root, whereas others must run as a non-privileged user. It's important to always consider which users your tests should run as (and we have infrastructure to ensure the tests DTRT).</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"># Team effort</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">If you want to volunteer to write some tests for a particular area and are happy to do that on your own, great! However, please don't think this is expected - if you volunteer, we're more than happy to help you out - remember that GitHub issues can be assigned to multiple users :-)</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Cheers,<br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">James</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">[1] - Although we're focussing on 2.0, these new tests will also be backported where possible.</div><div class="gmail_default" style="font-size:small">[2] - <a href="https://github.com/kata-containers/kata-containers/tree/2.0-dev/src/runtime" target="_blank">https://github.com/kata-containers/kata-containers/tree/2.0-dev/src/runtime</a></div><div class="gmail_default" style="font-size:small">[3] - <a href="https://github.com/kata-containers/kata-containers/tree/2.0-dev/src/agent" target="_blank">https://github.com/kata-containers/kata-containers/tree/2.0-dev/src/agent</a></div><div class="gmail_default" style="font-size:small">[4] - <a href="https://github.com/kata-containers/kata-containers/issues/237" target="_blank">https://github.com/kata-containers/kata-containers/issues/237</a></div><div class="gmail_default" style="font-size:small">[5] - <a href="https://github.com/kata-containers/kata-containers/issues/275" target="_blank">https://github.com/kata-containers/kata-containers/issues/275</a></div><div class="gmail_default" style="font-size:small">[6] - <a href="https://github.com/kata-containers/kata-containers/projects/2" target="_blank">https://github.com/kata-containers/kata-containers/projects/2</a></div><div class="gmail_default" style="font-size:small">[7] - <a href="https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md" target="_blank">https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md</a><br></div><div class="gmail_default" style="font-size:small">[8] - <a href="https://github.com/kata-containers/tests/blob/master/Unit-Test-Advice.md" target="_blank">https://github.com/kata-containers/tests/blob/master/Unit-Test-Advice.md</a><br></div><div class="gmail_default" style="font-size:small">[9] - <a href="https://github.com/kata-containers/kata-containers/tree/2.0-dev/src/runtime/pkg/katatestutils" target="_blank">https://github.com/kata-containers/kata-containers/tree/2.0-dev/src/runtime/pkg/katatestutils</a><br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"></div><div class="gmail_default" style="font-size:small"><span style="font-family:monospace,monospace;color:rgb(136,136,136)">---</span></div><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><a href="https://katacontainers.io/" style="color:rgb(17,85,204);font-family:monospace,monospace" target="_blank">https://katacontainers.io/</a><span style="color:rgb(136,136,136);font-family:monospace,monospace"> | <a href="https://github.com/clearcontainers" target="_blank">https://github.com/kata-containers</a></span><font color="#888888"><span style="font-family:monospace,monospace"><span style="font-family:monospace,monospace"><br></span></span></font></div><div dir="ltr"><font color="#888888"><font face="monospace, monospace">Open Source Technology Center</font><br><font face="monospace, monospace">Intel Corporation (UK) Ltd. - Co. Reg. #1134945 - Pipers Way, Swindon SN3 1RJ.</font></font><br></div></div></div></div></div></div></div></div></div></div>
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><font color="#888888"><span style="font-family:monospace,monospace"><span style="font-family:monospace,monospace">James<br>---</span></span></font></div><div dir="ltr"><a href="https://katacontainers.io/" style="color:rgb(17,85,204);font-family:monospace,monospace" target="_blank">https://katacontainers.io/</a><span style="color:rgb(136,136,136);font-family:monospace,monospace"> | <a href="https://github.com/clearcontainers" target="_blank">https://github.com/kata-containers</a></span><font color="#888888"><span style="font-family:monospace,monospace"><span style="font-family:monospace,monospace"><br></span></span></font></div><div dir="ltr"><font color="#888888"><font face="monospace, monospace">Open Source Technology Center</font><br><font face="monospace, monospace">Intel Corporation (UK) Ltd. - Co. Reg. #1134945 - Pipers Way, Swindon SN3 1RJ.</font></font><br></div></div></div></div></div></div></div></div></div></div></div>