refactor(main): extract helper functions and add comprehensive tests (#45) #53
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
…med helper functions with proper error handling: - `validateConfigFlags()` handles command-line flag validation - `createCacheDirectory()` checks and creates cache directory if missing - `downloadGTFSBundles()` handles initial GTFS bundle downloading - `refreshGTFSBundles()` manages periodic GTFS updates - `refreshConfig()` manages periodic remote configuration refresh - Added `updateConfig()` method to Application struct for thread-safe config updates
cmd/watchdog/main_test.go
Outdated
| } | ||
| }) | ||
|
|
||
| t.Run("Fails : if path is a file", func(t *testing.T) { |
There was a problem hiding this comment.
[nitpick] Consider removing the extra space before the colon in the subtest name for consistency, e.g. change "Fails : if path is a file" to "Fails: if path is a file".
Suggested change
| t.Run("Fails : if path is a file", func(t *testing.T) { | |
| t.Run("Fails: if path is a file", func(t *testing.T) { |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
cmd/watchdog/main.go
Outdated
| logger.Error("Failed to create cache directory", "error", err) | ||
| os.Exit(1) | ||
| } | ||
| if err = createCacheDirectory(cacheDir , logger) ; err != nil { |
There was a problem hiding this comment.
[nitpick] Remove the extra space before the comma in the function call arguments and after the closing parenthesis, e.g. change 'cacheDir , logger' to 'cacheDir, logger'.
Suggested change
| if err = createCacheDirectory(cacheDir , logger) ; err != nil { | |
| if err = createCacheDirectory(cacheDir, logger); err != nil { |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
- `TestValidateConfigFlags`: tests multiple flag combinations for validation - `TestCreateCacheDirectory`: covers directory creation, existing paths, and error handling - `TestDownloadGTFSBundles`: validates GTFS bundle downloading logic - `TestRefreshGTFSBundles`: tests periodic bundle refresh functionality - `TestRefreshConfig`: uses a mock server to test remote config refresh - `TestUpdateConfig`: verifies thread-safe config updates
Abo-Omar-74
force-pushed
the
feat/increase-test-coverage-2
branch
from
295f3fc to
f322208
Compare
…d add unit test for collectMetricsForServer - Extract metrics collection into collectMetricsForServer. - Add a basic unit test to verify the function collects metrics for a server and registers them with Prometheus, using a fresh registry to avoid conflicts.
Follow-upRefactored |
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.
Summary
This PR refactors the main function in
main.gointo named helper functions with proper error handling and adds comprehensive unit tests for each function to enhance test coverage, as outlined in issue #45 .Changes
Refactoring:
validateConfigFlags()to handle command-line flag validationcreateCacheDirectory()with proper directory existence checkingdownloadGTFSBundles()for GTFS bundle downloadingrefreshGTFSBundles()for periodic GTFS updatesrefreshConfig()for periodic remote configuration updatesupdateConfig()method to the application struct for thread-safe updatesTesting:
TestValidateConfigFlagsTestCreateCacheDirectoryTestDownloadGTFSBundlesTestRefreshGTFSBundlesTestRefreshConfigTestUpdateConfigTestLoadConfigFromFileTestLoadConfigFromURLTest coverage after these changes: