|
| 1 | +--- |
| 2 | +categories: |
| 3 | + - GSoC |
| 4 | + - 2019 |
| 5 | + - StatusReport |
| 6 | +date: 2019-08-24 |
| 7 | +title: chay2199 |
| 8 | +student: Chaitanya Tyagi |
| 9 | +organisation: coala |
| 10 | +organisation_link : https://coala.io |
| 11 | +project: Result Reporter Tool |
| 12 | +project_link: https://summerofcode.withgoogle.com/projects/?sp-search=chaitanya#6527640138153984 |
| 13 | +tarball: https://github.com/chay2199/GSoCReport/raw/master/chay2199_coala.tar.xz |
| 14 | +sha256sum: df723efc31d178ecc3ea7e35ed854829e599fbd6c6fd7fc67559a53d2b14e69c |
| 15 | +mentors: > |
| 16 | + [Boxuan Li](https://github.com/li-boxuan) |
| 17 | +phase: |
| 18 | + - Bonding : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/6?title=BONDING_RESULT_REPORTER_TOOL |
| 19 | + - Phase 1 : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/7?title=PHASE_1_RESULT_REPORTER_TOOL |
| 20 | + - Phase 2 : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/8?title=PHASE_2_RESULT_REPORTER_TOOL |
| 21 | + - Phase 3 : https://gitlab.com/coala/GSoC/gsoc-2019/-/milestones/9?title=PHASE_3_RESULT_REPORTER_TOOL |
| 22 | +bio: > |
| 23 | + 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. |
| 24 | +social: |
| 25 | + - GitHub: |
| 26 | + - username: chay2199 |
| 27 | + - link: https://github.com/chay2199 |
| 28 | + - GitLab: |
| 29 | + - username: chay2199 |
| 30 | + - link: https://gitlab.com/chay2199 |
| 31 | + - Gitter: |
| 32 | + - username: chay2199 |
| 33 | + - link: https://gitter.im/chay2199 |
| 34 | + - LinkedIn: |
| 35 | + - username: chaitanya tyagi |
| 36 | + - link: https://www.linkedin.com/in/chaitanya-tyagi-03a560174/ |
| 37 | +email: chay2199@gmail.com |
| 38 | +blog: https://medium.com/@chay2199 |
| 39 | +activity: |
| 40 | + - 0: |
| 41 | + - repo: coala-json |
| 42 | + - link: https://gitlab.com/coala/coala-json/commit/1865bad5ffe09dad1ed3ba43ebfdde5d1647ef9e |
| 43 | + - details: > |
| 44 | + Add .travis.yml |
| 45 | + - 1: |
| 46 | + - repo: coala-json |
| 47 | + - link: https://gitlab.com/coala/coala-json/commit/8a1d57f286ec5faff64e02482edec9b61b52b0a2 |
| 48 | + - details: > |
| 49 | + Sync Templates |
| 50 | +
|
| 51 | + - 2: |
| 52 | + - repo: coala-json |
| 53 | + - link: https://gitlab.com/coala/coala-json/commit/25a8353b959b410a4f00bafcc5650fd30410ad38 |
| 54 | + - details: > |
| 55 | + Add Junit output |
| 56 | +
|
| 57 | + - 3: |
| 58 | + - repo: coala-json |
| 59 | + - link: https://gitlab.com/coala/coala-json/commit/06b063aeea49c84a034333247b66d5a61a711f64 |
| 60 | + - details: > |
| 61 | + Remove .idea/vcs.xml |
| 62 | +
|
| 63 | + - 4: |
| 64 | + - repo: coala-json |
| 65 | + - link: https://gitlab.com/coala/coala-json/commit/0766a58cf05c8de3fa67d304477758af26fced8b |
| 66 | + - details: > |
| 67 | + test_diagnostic.py: Fix Pycodestyle W504 problem |
| 68 | +
|
| 69 | + - 5: |
| 70 | + - repo: coala-json |
| 71 | + - link: https://gitlab.com/coala/coala-json/commit/ffc50fad5e3f74664690de27627791c36c369b8f |
| 72 | + - details: > |
| 73 | + Add config for circleci |
| 74 | +
|
| 75 | + - 6: |
| 76 | + - repo: coala-json |
| 77 | + - link: https://gitlab.com/coala/coala-json/commit/6d1673b243d79004a5e3e5cf9035de203ad9de02 |
| 78 | + - details: > |
| 79 | + Add config for appveyor |
| 80 | +
|
| 81 | + - 7: |
| 82 | + - repo: coala-json |
| 83 | + - link: https://gitlab.com/coala/coala-json/commit/1a5a804867e456da6939b14d2896f891acf43338 |
| 84 | + - details: > |
| 85 | + Sync Templates |
| 86 | +
|
| 87 | + - 8: |
| 88 | + - repo: coala-json |
| 89 | + - link: https://gitlab.com/coala/coala-json/commit/2f13419d3f3d10724ee2f3503aad89ec3901064e |
| 90 | + - details: > |
| 91 | + Add documentation for JUnit |
| 92 | +
|
| 93 | + - 9: |
| 94 | + - repo: coala-json |
| 95 | + - link: https://gitlab.com/coala/coala-json/commit/d1efaf7ec0168fdf7d95db7d2e599bdafc87e54e |
| 96 | + - details: > |
| 97 | + Add netlify.toml file |
| 98 | +
|
| 99 | + - 10: |
| 100 | + - repo: coala-json |
| 101 | + - link: https://gitlab.com/coala/coala-json/commit/553c7222d00c5192f433892b2c3b4e9b15200948 |
| 102 | + - details: > |
| 103 | + Sync Templates |
| 104 | +
|
| 105 | + - 11: |
| 106 | + - repo: coala-json |
| 107 | + - link: https://gitlab.com/coala/coala-json/commit/7c57e24675d6df3c3988bd258b66e98063c19948 |
| 108 | + - details: > |
| 109 | + Add config for circleci |
| 110 | +
|
| 111 | + - 12: |
| 112 | + - repo: coala-json |
| 113 | + - link: https://gitlab.com/coala/coala-json/commit/48aed5a796f6052298cf39fa43eb92795a01b01c |
| 114 | + - details: > |
| 115 | + Add config for appveyor |
| 116 | +
|
| 117 | + - 13: |
| 118 | + - repo: coala-json |
| 119 | + - link: https://gitlab.com/coala/coala-json/commit/1c2bcbb8093e1bb4912e44eabb2810ea589847cd |
| 120 | + - details: > |
| 121 | + Add CLI for JUnit |
| 122 | +
|
| 123 | + - 14: |
| 124 | + - repo: coala-json |
| 125 | + - link: https://gitlab.com/coala/coala-json/commit/df013818f11e66c7cd763c21ae38fa25f66e9a34 |
| 126 | + - details: > |
| 127 | + Sync Templates |
| 128 | +
|
| 129 | + - 15: |
| 130 | + - repo: coala-json |
| 131 | + - link: https://gitlab.com/coala/coala-json/commit/b285295203d66a81760121732084793b785f736f |
| 132 | + - details: > |
| 133 | + Remove reports folder |
| 134 | +
|
| 135 | + - 16: |
| 136 | + - repo: coala-json |
| 137 | + - link: https://gitlab.com/coala/coala-json/commit/d52162d1b5220ac8a5f5966c9b1d41f3cc3dc200 |
| 138 | + - details: > |
| 139 | + Add pytest to CircleCI |
| 140 | +
|
| 141 | + - 17: |
| 142 | + - repo: coala-json |
| 143 | + - link: https://gitlab.com/coala/coala-json/commit/7bbb66e6653700595ec6ad9cf9f43ce9f7f6931c |
| 144 | + - details: > |
| 145 | + Sync Templates |
| 146 | +
|
| 147 | + - 18: |
| 148 | + - repo: coala-json |
| 149 | + - link: https://gitlab.com/coala/coala-json/commit/ccf5c3065553d01e90bdaf3d6e3401989a179821 |
| 150 | + - details: > |
| 151 | + Upload JUnit to gitlab-ci |
| 152 | +
|
| 153 | + - 19: |
| 154 | + - repo: coala-json |
| 155 | + - link: https://gitlab.com/coala/coala-json/commit/ce019bd7fb5adb91aabfb7f9e8df198a548083c5 |
| 156 | + - details: > |
| 157 | + Add Loader and coalaJsonLoader class |
| 158 | +
|
| 159 | + - 20: |
| 160 | + - repo: coala-json |
| 161 | + - link: https://gitlab.com/coala/coala-json/commit/b9c9a2a16970451b3f6a2f2a93f620312ef118ea |
| 162 | + - details: > |
| 163 | + Add checkstyle output |
| 164 | +
|
| 165 | + - 21: |
| 166 | + - repo: coala-json |
| 167 | + - link: https://gitlab.com/coala/coala-json/commit/3a90034f34590e9392c62c91524845b1397b7447 |
| 168 | + - details: > |
| 169 | + Add TAP output |
| 170 | +
|
| 171 | + - 22: |
| 172 | + - repo: coala-json |
| 173 | + - link: https://gitlab.com/coala/coala-json/commit/c2ce17f6d1366441a869562e2a5591a2dd49db65 |
| 174 | + - details: > |
| 175 | + fix extract_error_code message |
| 176 | +
|
| 177 | + - 23: |
| 178 | + - repo: coala-json |
| 179 | + - link: https://gitlab.com/coala/coala-json/commit/ca8a4e93e2b5d6605d1f749483c424807db0493a |
| 180 | + - details: > |
| 181 | + Fix redundancy in TAP error messages |
| 182 | +
|
| 183 | + - 24: |
| 184 | + - repo: coala-json |
| 185 | + - link: https://gitlab.com/coala/coala-json/commit/8834c1873b25335a9b882b6bffa2eff71adacd3e |
| 186 | + - details: > |
| 187 | + add severity to checkstyle reporter |
| 188 | +
|
| 189 | + - 25: |
| 190 | + - repo: coala-json |
| 191 | + - link: https://gitlab.com/coala/coala-json/commit/23c89ae012de2af50b2fa5b6d0938d54d2697b2f |
| 192 | + - details: > |
| 193 | + coalaJsonLoader.py: Edit sanitize method |
| 194 | +
|
| 195 | + - 26: |
| 196 | + - repo: coala-json |
| 197 | + - link: https://gitlab.com/coala/coala-json/commit/4a5fa88a766c042f7a40fa982400da4e3785d3c6 |
| 198 | + - details: > |
| 199 | + Sync Templates |
| 200 | +
|
| 201 | + - 27: |
| 202 | + - repo: coala-json |
| 203 | + - link: https://gitlab.com/coala/coala-json/commit/fd55822de4f1d9d0256cb3d4b7a85c338fbb5bfd |
| 204 | + - details: > |
| 205 | + Documentation of test result reports |
| 206 | +
|
| 207 | + - 28: |
| 208 | + - repo: coala-json |
| 209 | + - link: https://gitlab.com/coala/coala-json/commit/1b29998f1f7b922485d0fd03ed1cfe08cbab8d82 |
| 210 | + - details: > |
| 211 | + Sync Templates |
| 212 | +
|
| 213 | + - 29: |
| 214 | + - repo: coala-json |
| 215 | + - link: https://gitlab.com/coala/coala-json/commit/e38dd3c35f4a6d17f6149da8e46ff6b35fcc555c |
| 216 | + - details: > |
| 217 | + Set documentation version |
| 218 | +
|
| 219 | + - 30: |
| 220 | + - repo: coala-json |
| 221 | + - link: https://gitlab.com/coala/coala-json/commit/4d2ccc569692b11b1fcfd2ea9077ae1f2d032882 |
| 222 | + - details: > |
| 223 | + Publish coala-json version 0.1.0 |
| 224 | +
|
| 225 | + - 31: |
| 226 | + - repo: coala-json |
| 227 | + - link: https://gitlab.com/coala/coala-json/commit/2a61b8a7c087ffa764326ba8a53f5f5c9a8a957f |
| 228 | + - details: > |
| 229 | + Remove redundant main_call function |
| 230 | +
|
| 231 | + - 32: |
| 232 | + - repo: coala-json |
| 233 | + - link: https://gitlab.com/coala/coala-json/commit/a4e8b25b62ab27c20b90a1a69533ba755f0fe977 |
| 234 | + - details: > |
| 235 | + export PYTHONPATH to coala-json |
| 236 | +
|
| 237 | + - 33: |
| 238 | + - repo: coala-json |
| 239 | + - link: https://gitlab.com/coala/coala-json/commit/f1574f59e4d5c4a94123dd676c29ba95f7b873fd |
| 240 | + - details: > |
| 241 | + Add html-table output format |
| 242 | +
|
| 243 | + - 34: |
| 244 | + - repo: coala-json |
| 245 | + - link: https://gitlab.com/coala/coala-json/commit/1f4fbf07f668c557a1d032c3be2acd44293bfe28 |
| 246 | + - details: > |
| 247 | + Add stdout output |
| 248 | +
|
| 249 | + - 35: |
| 250 | + - repo: coala-json |
| 251 | + - link: https://gitlab.com/coala/coala-json/commit/c4cb4dd598a7dfc867bc5a5e8906acc3bf242d3b |
| 252 | + - details: > |
| 253 | + JunitReporter.py: Change error tag to failure tag |
| 254 | +
|
| 255 | + - 36: |
| 256 | + - repo: coala-json |
| 257 | + - link: https://gitlab.com/coala/coala-json/commit/df856e5a7aa91ff126eff1f38c6c2b30338433d5 |
| 258 | + - details: > |
| 259 | + coala-json version update 0.1.1 |
| 260 | +
|
| 261 | + - 37: |
| 262 | + - repo: coala-json |
| 263 | + - link: https://gitlab.com/coala/coala-json/commit/6cc6ec867d7d77171cbf78884e173e6cc34abeb8 |
| 264 | + - details: > |
| 265 | + Add coala-json to docs/requirements.txt |
| 266 | +
|
| 267 | + - 38: |
| 268 | + - repo: coala-json |
| 269 | + - link: https://gitlab.com/coala/coala-json/commit/2036499136abf87a72e34f108a302b2b9b5d2352 |
| 270 | + - details: > |
| 271 | + Temporary fix for ruamel error |
| 272 | +
|
| 273 | + - 39: |
| 274 | + - repo: coala-json |
| 275 | + - link: https://gitlab.com/coala/coala-json/commit/e9dd53ccf602e57379ed6e270c52df6f74d62f0c |
| 276 | + - details: > |
| 277 | + Add badges |
| 278 | +
|
| 279 | + - 40: |
| 280 | + - repo: coala-json |
| 281 | + - link: https://gitlab.com/coala/coala-json/commit/249dfc598a29cc6aab197a1ebafe2f82098e3498 |
| 282 | + - details: > |
| 283 | + README.rst: Update description |
| 284 | +
|
| 285 | + - 41: |
| 286 | + - repo: mobans |
| 287 | + - link: https://gitlab.com/coala/mobans/commit/a0205fd1da8ad3c147036fd7ee9a5218b9af6203 |
| 288 | + - details: > |
| 289 | + coala-setup.py.jj2: Add missing commas |
| 290 | +
|
| 291 | + - 42: |
| 292 | + - repo: mobans |
| 293 | + - link: https://gitlab.com/coala/mobans/commit/aabd1098888e4983c92928c070b3bb8663adee58 |
| 294 | + - details: > |
| 295 | + Sync Templates |
| 296 | +
|
| 297 | + - 43: |
| 298 | + - repo: pyflakes |
| 299 | + - link: https://github.com/PyCQA/pyflakes/pull/463 |
| 300 | + - details: > |
| 301 | + Add coala-json support to pyflakes (unmerged) |
| 302 | +
|
| 303 | +--- |
| 304 | + |
| 305 | +### Result Reporter Tool |
| 306 | + |
| 307 | + |
| 308 | +#### Work Done |
| 309 | + |
| 310 | +[coala-json](https://gitlab.com/coala/coala-json) has many test report formats as outputs. |
| 311 | + |
| 312 | +[Documentation](https://coala-json.readthedocs.io/en/latest/) at ReadTheDocs |
| 313 | + |
| 314 | +[Website](https://coala-json.netlify.com) hosted at netlify. |
| 315 | + |
| 316 | +coala-json can be used to load data from coala-json output and produce various |
| 317 | +test result report formats that can be used to visualise test report artifacts |
| 318 | +at a glance across various CI/CD tools. |
| 319 | +coala-json is now a python package and can be extended to any project with a |
| 320 | +json output simply by changing the loader file. I also contribute to |
| 321 | +coala/mobans so that the whole coala community can take advantage of the work |
| 322 | +done in coala-json. I do some other contributions to the community, including |
| 323 | +doing reviews, and fixing several issues around coala & coala-bears repo. |
| 324 | + |
| 325 | +#### Challenges |
| 326 | + |
| 327 | +Most things went smoothly. I used to get uncomfortable while deciding on the structure |
| 328 | +of coala-json as I was building the whole project almost from scratch. Some of my OOPs |
| 329 | +concepts were not upto the task but with the help of my mentor I learned many new concepts |
| 330 | +along the way. My mentor used to review my code almost on the same day whenever I requested |
| 331 | +him and that really helped me. coala community always expects a high quality of code and |
| 332 | +I am happy that I was able to succeed. |
| 333 | + |
| 334 | +#### Work to be done |
| 335 | + |
| 336 | +As a project coala-json has a lot of scope to be extended and improved. Currently the |
| 337 | +whole coala community is not using coala-json. All CIs should include coala-json |
| 338 | +section in their templates. More test reports can be generated in the future. The mapping |
| 339 | +of coala-json can be improved to provide more information to the test reports. Moreover |
| 340 | +currently the loader file needs to be changed to if some other project needs to use |
| 341 | +coala-json for their json output, this process can be made more simpler or should vanish |
| 342 | +in the future. |
| 343 | + |
0 commit comments