test(init): cover cz without descriptions #1829
Conversation
bearomorphism
requested review from
Lee-W,
noirbizarre and
woile
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next-release #1829 +/- ##
=============================================
Coverage 97.98% 97.98%
=============================================
Files 60 60
Lines 2682 2682
=============================================
Hits 2628 2628
Misses 54 54 ☔ View full report in Codecov by Sentry. |
| try: | ||
| # TODO(bearomorphism): can we get the description from the cz class without initiating an instance? | ||
| cz_obj = cz_class(self.config) | ||
| except MissingCzCustomizeConfigError: |
There was a problem hiding this comment.
Actually, I'm not sure whether this is compatible with plugins. Should we use general exception?
wdyt @Lee-W
There was a problem hiding this comment.
why do you think it might not be compatible
There was a problem hiding this comment.
I thought other plugins throw other exceptions when they initialize with empty config, but we actually always initialize that with a BaseConfig object.
commitizen/commands/init.py
Outdated
| choices = [] | ||
| for cz_name, cz_class in registry.items(): | ||
| try: | ||
| # TODO(bearomorphism): can we get the description from the cz class without initiating an instance? |
There was a problem hiding this comment.
need to make it a class of static method, as we need to take config as an argument, it's not likely.
| try: | ||
| # TODO(bearomorphism): can we get the description from the cz class without initiating an instance? | ||
| cz_obj = cz_class(self.config) | ||
| except MissingCzCustomizeConfigError: |
There was a problem hiding this comment.
why do you think it might not be compatible
commitizen/commands/init.py
Outdated
| # TODO(bearomorphism): can we get the description from the cz class without initiating an instance? | ||
| cz_obj = cz_class(self.config) | ||
| except MissingCzCustomizeConfigError: | ||
| # workaround for cz_customize |
There was a problem hiding this comment.
why is it a workaround for cz_customize? I thought it's for non-core czs
There was a problem hiding this comment.
do non-core czs throw MissingCzCustomizeConfigError? I am not familiar with it
There was a problem hiding this comment.
If I understood it correctly, only CzCustomize throws the error
| continue | ||
| first_example = cz_obj.schema().partition("\n")[0] | ||
|
|
||
| # Get the first line of the schema as the description |
There was a problem hiding this comment.
we'd better add a description in v5. schema looks like a workaround for me
There was a problem hiding this comment.
I think it does not have to be a v5 feature. We can make description optional.
bearomorphism
force-pushed
the
test-init-nit
branch
from
84635c9 to
ac05276
Compare
Follow up of #1825
Better test coverage for the change and renamed some variables and methods.