diff --git a/_reports/chay2199.md b/_reports/chay2199.md new file mode 100644 index 00000000..f1e9ffe7 --- /dev/null +++ b/_reports/chay2199.md @@ -0,0 +1,343 @@ +--- +categories: + - GSoC + - 2019 + - StatusReport +date: 2019-08-24 +title: chay2199 +student: Chaitanya Tyagi +organisation: coala +organisation_link : https://coala.io +project: Result Reporter Tool +project_link: https://summerofcode.withgoogle.com/projects/?sp-search=chaitanya#6527640138153984 +tarball: https://github.com/chay2199/GSoCReport/raw/master/chay2199_coala.tar.xz +sha256sum: df723efc31d178ecc3ea7e35ed854829e599fbd6c6fd7fc67559a53d2b14e69c +mentors: > + [Boxuan Li](https://github.com/li-boxuan) +phase: + - Bonding : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/6?title=BONDING_RESULT_REPORTER_TOOL + - Phase 1 : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/7?title=PHASE_1_RESULT_REPORTER_TOOL + - Phase 2 : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/8?title=PHASE_2_RESULT_REPORTER_TOOL + - Phase 3 : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/9?title=PHASE_3_RESULT_REPORTER_TOOL +bio: > + I'm a third year student (expected graduation date: May 2021) of Computer Science at Birla Institute of Technology, Mesra. I participated in GSoC and worked with [coala](https://coala.io) on building a Result Reporter Tool, which loads data from coala-json output and converts it to test result report formats like JUnit, TAP and Checkstyle. [coala-json](https://pypi.org/project/coala-json/) is a python package now, and thus it can be extended to any other project. To generate test reports using a particular json output you simply have to create a custom loader file. +social: + - GitHub: + - username: chay2199 + - link: https://github.com/chay2199 + - GitLab: + - username: chay2199 + - link: https://gitlab.com/chay2199 + - Gitter: + - username: chay2199 + - link: https://gitter.im/chay2199 + - LinkedIn: + - username: chaitanya tyagi + - link: https://www.linkedin.com/in/chaitanya-tyagi-03a560174/ +email: chay2199@gmail.com +blog: https://medium.com/@chay2199 +activity: + - 0: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/1865bad5ffe09dad1ed3ba43ebfdde5d1647ef9e + - details: > + Add .travis.yml + - 1: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/8a1d57f286ec5faff64e02482edec9b61b52b0a2 + - details: > + Sync Templates + + - 2: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/25a8353b959b410a4f00bafcc5650fd30410ad38 + - details: > + Add Junit output + + - 3: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/06b063aeea49c84a034333247b66d5a61a711f64 + - details: > + Remove .idea/vcs.xml + + - 4: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/0766a58cf05c8de3fa67d304477758af26fced8b + - details: > + test_diagnostic.py: Fix Pycodestyle W504 problem + + - 5: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/ffc50fad5e3f74664690de27627791c36c369b8f + - details: > + Add config for circleci + + - 6: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/6d1673b243d79004a5e3e5cf9035de203ad9de02 + - details: > + Add config for appveyor + + - 7: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/1a5a804867e456da6939b14d2896f891acf43338 + - details: > + Sync Templates + + - 8: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/2f13419d3f3d10724ee2f3503aad89ec3901064e + - details: > + Add documentation for JUnit + + - 9: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/d1efaf7ec0168fdf7d95db7d2e599bdafc87e54e + - details: > + Add netlify.toml file + + - 10: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/553c7222d00c5192f433892b2c3b4e9b15200948 + - details: > + Sync Templates + + - 11: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/7c57e24675d6df3c3988bd258b66e98063c19948 + - details: > + Add config for circleci + + - 12: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/48aed5a796f6052298cf39fa43eb92795a01b01c + - details: > + Add config for appveyor + + - 13: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/1c2bcbb8093e1bb4912e44eabb2810ea589847cd + - details: > + Add CLI for JUnit + + - 14: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/df013818f11e66c7cd763c21ae38fa25f66e9a34 + - details: > + Sync Templates + + - 15: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/b285295203d66a81760121732084793b785f736f + - details: > + Remove reports folder + + - 16: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/d52162d1b5220ac8a5f5966c9b1d41f3cc3dc200 + - details: > + Add pytest to CircleCI + + - 17: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/7bbb66e6653700595ec6ad9cf9f43ce9f7f6931c + - details: > + Sync Templates + + - 18: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/ccf5c3065553d01e90bdaf3d6e3401989a179821 + - details: > + Upload JUnit to gitlab-ci + + - 19: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/ce019bd7fb5adb91aabfb7f9e8df198a548083c5 + - details: > + Add Loader and coalaJsonLoader class + + - 20: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/b9c9a2a16970451b3f6a2f2a93f620312ef118ea + - details: > + Add checkstyle output + + - 21: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/3a90034f34590e9392c62c91524845b1397b7447 + - details: > + Add TAP output + + - 22: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/c2ce17f6d1366441a869562e2a5591a2dd49db65 + - details: > + fix extract_error_code message + + - 23: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/ca8a4e93e2b5d6605d1f749483c424807db0493a + - details: > + Fix redundancy in TAP error messages + + - 24: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/8834c1873b25335a9b882b6bffa2eff71adacd3e + - details: > + add severity to checkstyle reporter + + - 25: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/23c89ae012de2af50b2fa5b6d0938d54d2697b2f + - details: > + coalaJsonLoader.py: Edit sanitize method + + - 26: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/4a5fa88a766c042f7a40fa982400da4e3785d3c6 + - details: > + Sync Templates + + - 27: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/fd55822de4f1d9d0256cb3d4b7a85c338fbb5bfd + - details: > + Documentation of test result reports + + - 28: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/1b29998f1f7b922485d0fd03ed1cfe08cbab8d82 + - details: > + Sync Templates + + - 29: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/e38dd3c35f4a6d17f6149da8e46ff6b35fcc555c + - details: > + Set documentation version + + - 30: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/4d2ccc569692b11b1fcfd2ea9077ae1f2d032882 + - details: > + Publish coala-json version 0.1.0 + + - 31: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/2a61b8a7c087ffa764326ba8a53f5f5c9a8a957f + - details: > + Remove redundant main_call function + + - 32: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/a4e8b25b62ab27c20b90a1a69533ba755f0fe977 + - details: > + export PYTHONPATH to coala-json + + - 33: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/f1574f59e4d5c4a94123dd676c29ba95f7b873fd + - details: > + Add html-table output format + + - 34: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/1f4fbf07f668c557a1d032c3be2acd44293bfe28 + - details: > + Add stdout output + + - 35: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/c4cb4dd598a7dfc867bc5a5e8906acc3bf242d3b + - details: > + JunitReporter.py: Change error tag to failure tag + + - 36: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/df856e5a7aa91ff126eff1f38c6c2b30338433d5 + - details: > + coala-json version update 0.1.1 + + - 37: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/6cc6ec867d7d77171cbf78884e173e6cc34abeb8 + - details: > + Add coala-json to docs/requirements.txt + + - 38: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/2036499136abf87a72e34f108a302b2b9b5d2352 + - details: > + Temporary fix for ruamel error + + - 39: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/e9dd53ccf602e57379ed6e270c52df6f74d62f0c + - details: > + Add badges + + - 40: + - repo: coala-json + - link: https://gitlab.com/coala/coala-json/commit/249dfc598a29cc6aab197a1ebafe2f82098e3498 + - details: > + README.rst: Update description + + - 41: + - repo: mobans + - link: https://gitlab.com/coala/mobans/commit/a0205fd1da8ad3c147036fd7ee9a5218b9af6203 + - details: > + coala-setup.py.jj2: Add missing commas + + - 42: + - repo: mobans + - link: https://gitlab.com/coala/mobans/commit/aabd1098888e4983c92928c070b3bb8663adee58 + - details: > + Sync Templates + + - 43: + - repo: pyflakes + - link: https://github.com/PyCQA/pyflakes/pull/463 + - details: > + Add coala-json support to pyflakes (unmerged) + +--- + +### Result Reporter Tool + + +#### Work Done + +[coala-json](https://gitlab.com/coala/coala-json) has many test report formats as outputs. + +[Documentation](https://coala-json.readthedocs.io/en/latest/) at ReadTheDocs + +[Website](https://coala-json.netlify.com) hosted at netlify. + +coala-json can be used to load data from coala-json output and produce various +test result report formats that can be used to visualise test report artifacts +at a glance across various CI/CD tools. +coala-json is now a python package and can be extended to any project with a +json output simply by changing the loader file. I also contribute to +coala/mobans so that the whole coala community can take advantage of the work +done in coala-json. I do some other contributions to the community, including +doing reviews, and fixing several issues around coala & coala-bears repo. + +#### Challenges + +Most things went smoothly. I used to get uncomfortable while deciding on the structure +of coala-json as I was building the whole project almost from scratch. Some of my OOPs +concepts were not upto the task but with the help of my mentor I learned many new concepts +along the way. My mentor used to review my code almost on the same day whenever I requested +him and that really helped me. coala community always expects a high quality of code and +I am happy that I was able to succeed. + +#### Work to be done + +As a project coala-json has a lot of scope to be extended and improved. Currently the +whole coala community is not using coala-json. All CIs should include coala-json +section in their templates. More test reports can be generated in the future. The mapping +of coala-json can be improved to provide more information to the test reports. Moreover +currently the loader file needs to be changed to if some other project needs to use +coala-json for their json output, this process can be made more simpler or should vanish +in the future. +