vmware-tanzu / tanzu-framework

Tanzu Framework provides a set of building blocks to build atop of the Tanzu platform and leverages Carvel packaging and plugins to provide users with a much stronger, more integrated experience than the loose coupling and stand-alone commands of the previous generation of tools.
Apache License 2.0
195 stars 192 forks source link

Readiness Framework changes #4604

Closed sathyanarays closed 1 year ago

sathyanarays commented 1 year ago

What this PR does / why we need it

This PR adds readiness framework to the runtime core. This PR contains the following changes:

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

Unit tests are added with 90+ percentage coverage

Release note

Additional information

Special notes for your reviewer

rajathagasthya commented 1 year ago

I'll add ok-to-merge once @yharish991 reviews this.

avi-08 commented 1 year ago

added a few comments and questions. Also, I would like to see

  1. Env tests
  2. Some guide on how to use the Readiness and ReadinessProvider API
  3. Design doc in the docs directory( can be done in a follow up pr)
  1. Env tests are defined in readiness/suite_test.go and readiness_provider/suite_test.go
  2. Added docs/runtime-core/readiness-framework.md
  3. @yharish991 Please help me with the format for the design doc. I'll add it in a follow-up PR.
codecov[bot] commented 1 year ago

Codecov Report

Merging #4604 (400244e) into main (bb07e03) will increase coverage by 24.94%. The diff coverage is n/a.

:exclamation: Current head 400244e differs from pull request most recent head d772f37. Consider uploading reports for the commit d772f37 to get more accurate results

@@             Coverage Diff             @@
##             main    #4604       +/-   ##
===========================================
+ Coverage   49.77%   74.72%   +24.94%     
===========================================
  Files         453       21      -432     
  Lines       45424     1199    -44225     
===========================================
- Hits        22612      896    -21716     
+ Misses      20652      252    -20400     
+ Partials     2160       51     -2109     

see 408 files with indirect coverage changes