KubeArmor icon indicating copy to clipboard operation
KubeArmor copied to clipboard

Unit Test Coverage Audit

Open rksharma95 opened this issue 8 months ago • 7 comments

Description

Analyze and improve unit test coverage for KubeArmor codebase.

ok  	github.com/kubearmor/KubeArmor/KubeArmor	0.029s
?   	github.com/kubearmor/KubeArmor/KubeArmor/buildinfo	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/cert	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/common	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/config	[no test files]
ok  	github.com/kubearmor/KubeArmor/KubeArmor/core	0.029s
ok  	github.com/kubearmor/KubeArmor/KubeArmor/enforcer	0.021s
?   	github.com/kubearmor/KubeArmor/KubeArmor/enforcer/bpflsm	[no test files]
ok  	github.com/kubearmor/KubeArmor/KubeArmor/feeder	1.016s
?   	github.com/kubearmor/KubeArmor/KubeArmor/kvmAgent	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/log	[no test files]
ok  	github.com/kubearmor/KubeArmor/KubeArmor/monitor	3.021s
?   	github.com/kubearmor/KubeArmor/KubeArmor/policy	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets/anonmapexec	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets/base	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets/exec	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets/filelessexec	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets/protectenv	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/presets/protectproc	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/state	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/types	[no test files]
?   	github.com/kubearmor/KubeArmor/KubeArmor/utils/bpflsmprobe	[no test files]

Goals

  • [ ] Measure code coverage for all go packages.
  • [ ] Propose and implement additional unit tests to improve coverage, prioritizing core modules (core, monitor, enforcer, log, feeder).
  • [ ] Identify untested major components and suggest relevant unit test scenarios.
  • [ ] PR(s) to add missing unit tests, aiming for measurable improvement.

Any other suggestions welcome...

Reference

rksharma95 avatar Jul 29 '25 07:07 rksharma95

hey @rksharma95 @Aryan-sharma11 as i am being familiar with kubearmor recently and have strengthen my knowledge through setting up the project, understanding the what project provides also watched your recent v1.6 release video https://www.youtube.com/watch?v=f1TzmmmF8P0 also making a pr i have improved my logs to fetch docker related logs for the pr as suggested by @Aryan-sharma11 will complete it in some moments talking about this project would love to know how to proceed taking as a pre task like implementing one of the test coverage by picking up from the description above or any test related issues you would suggest i am ready for implementation feel free to guide me further !

RayyanSeliya avatar Jul 29 '25 09:07 RayyanSeliya

Hey everyone,

Thanks for your interest in the mentorship! There are a few prerequisites we expect to be included in your application. Please provide details or a reference document for these prerequisites in one of the following ways:

  • Cover Letter
  • Email to the mentors
  • Issue thread submission
  • Direct message to mentors on CNCF Slack

The deadline for this task is Sunday, August 17, 2025.

Details:

CNCF - KubeArmor: Unit Test Coverage Audit (2025 Term 3) – Project Link

Prerequisite:

Identify and specify edge cases and critical coverage points for the feeder package in KubeArmor, aimed at validating robustness and handling of unusual scenarios described in code comments and logic.

Deliverables:

test descriptions for each case, ready for implementation in Go.

Brownie points -

provide test description for another core module (core, monitor, enforcer, log, etc.) that you like : )

Looking forward to your submissions! :rocket:

rksharma95 avatar Aug 11 '25 04:08 rksharma95

@rksharma95 Submitted the prerequisite task with feeder package test descriptions.

GAURAV-DEEP01 avatar Aug 16 '25 19:08 GAURAV-DEEP01

submitted the pre-requisite today via slack ,kindly check and count me in @rksharma95

RONAK-AI647 avatar Aug 17 '25 09:08 RONAK-AI647

@rksharma95 I noticed that several packages currently have no test coverage. I’d like to start adding unit tests for these areas to help improve the overall reliability and maintainability of the project. Can I work on this?

GauravDeshmukh0909 avatar Nov 05 '25 11:11 GauravDeshmukh0909

hi @GauravDeshmukh0909 thanks for your interest,

just FYI @GAURAV-DEEP01 is also dedicatedly working on this, if you can provide the details about the tests that you're planning to implement it would be helpful to avoid the overlap here.

rksharma95 avatar Nov 05 '25 12:11 rksharma95

Hi @rksharma95 I have also worked on this issue and I would like to continue contributing further. I have just sent you an email regarding the same please check it once. Thank you.

yuvraj-kolkar17 avatar Nov 06 '25 17:11 yuvraj-kolkar17