Azure / aks-app-routing-operator

Kubernetes operator that implements AKS Application Routing

https://learn.microsoft.com/en-us/azure/aks/app-routing

MIT License

30 stars 20 forks source link

Add Prometheus controller name validation #80

Closed Marcus-Hines closed 1 year ago

Marcus-Hines commented 1 year ago

…in line with prometheus best practices

Description

Match prometheus controller labels to controller name - Adding the function to check for snakeCase and its unit test first. Next step is documenting that the controller name needs to be snake case, and updating the the loggers to use the correct controller name / label

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue) Feature # (details)

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Is it a breaking change which will impact consuming tool(s)?

[x] Test to endure that obvious incorrect snake case fails and that the inverse results in true

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 5870825211

6 of 6 (100.0%) changed or added relevant lines in 1 file are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-1.4%) to 86.057%

Totals
Change from base Build 5868959243:	-1.4%
Covered Lines:	1796
Relevant Lines:	2087

💛 - Coveralls

OliverMKing commented 1 year ago

/ok-to-test sha=2842e2b

OliverMKing commented 1 year ago

/ok-to-test sha=e22bbc0