toolsconfig:chore: create tests and rename public objects #764
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matheusalcantarazup
requested review from
iancardosozup,
lucasbrunozup,
nathanmartinszup and
wiliansilvazup
as code owners
matheusalcantarazup
force-pushed
the
tests-tools-config
branch
from
f116350
to
c5060d0
Compare
iancardosozup
suggested changes
Nov 11, 2021
matheusalcantarazup
force-pushed
the
tests-tools-config
branch
from
c5060d0
to
9bb7c0d
Compare
Previously the toolsconfig package does not have any unit tests and the
public functions and types was a bit confused, since two types was
exported to represents the same "thing".
This commit implements the tests to cover scenarios of toolsconfig
parsing.
This commit also rename ToolsConfigStruct to toolsConfig and also made
private, since this struct is only used as schema to parse the values
and only the Map type is used by other packages. The Map and Config
struct was also renamed to don't be repetitive on names.
The function ParseInterfaceToMapToolsConfig was also renamed to
MustParseToolsConfig to follow the Go standards of functions that can
cause errors that will be not returned. The signature was also changed
to avoid bugs when accepting an empty interface{}, since the viper will
always return a map[string]interface{} when we get the tools config from
config file, this function does not need to accept an empty interface.
A new function Default was also created to return the default values
from tools config.
Updates #718
Signed-off-by: Matheus Alcantara <[email protected]>
matheusalcantarazup
force-pushed
the
tests-tools-config
branch
from
9bb7c0d
to
b6ff11f
Compare
iancardosozup
approved these changes
Nov 11, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously the toolsconfig package does not have any unit tests and the
public functions and types was a bit confused, since two types was
exported to represents the same "thing".
This commit implements the tests to cover scenarios of toolsconfig
parsing.
This commit also rename ToolsConfigStruct to toolsConfig and also made
private, since this struct is only used as schema to parse the values
and only the Map type is used by other packages. The Map and Config
struct was also renamed to don't be repetitive on names.
The function ParseInterfaceToMapToolsConfig was also renamed to
MustParseToolsConfig to follow the Go standards of functions that can
cause errors that will be not returned. The signature was also changed
to avoid bugs when accepting an empty interface{}, since the viper will
always return a map[string]interface{} when we get the tools config from
config file, this function does not need to accept an empty interface.
A new function Default was also created to return the default values
from tools config.
Updates #718
Signed-off-by: Matheus Alcantara [email protected]
- What I did
- How to verify it
- Description for the changelog