Add github action cache for redis-server binary #372
Merged
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
wszaranski
added a commit
to wszaranski/miniredis
that referenced
this pull request
Apr 9, 2024
${MAKE} -C integration redis_src/redis-server that is part of ci target
takes around 2 minutes to execute. With addition of cache preventing
rebuild of redis-server tests run time drops from ~2m50s to ~50s.
Currently github actions are free for public repositories[1] but I think
that shorter execution time will improve developer experience :)
Due to matrix build for go versions, when redis is upgraded, build will be
run multiple times in parallel. Unnecessary parallel builds can be
avoided but since we don't upgrade redis too often I feel it would be
unnecessary complication.
Perhaps even better solution might be usage of testcontainers[2].
Integration tests would basically download and run official redis docker
image and spin it up for tests. There would be no need for cache or building
binary but docker dependency would be introduced. I have decided to
introduce cache because docker dependency has pros and cons that need to
be discussed while cache is clear and easy win ;)
PR: alicebob#372
[1]: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration
[2]: https://golang.testcontainers.org/
Signed-off-by: Wojciech Szarański <[email protected]>
wszaranski
force-pushed
the
miniredis-add-redis-server-binary-cache
branch
from
34d6185 to
11f666b
Compare
${MAKE} -C integration redis_src/redis-server that is part of ci target
takes around 2 minutes to execute. With addition of cache preventing
rebuild of redis-server tests run time drops from ~2m50s to ~50s.
Currently github actions are free for public repositories[1] but I think
that shorter execution time will improve developer experience :)
Due to matrix build for go versions, when redis is upgraded, build will be
run multiple times in parallel. Unnecessary parallel builds can be
avoided but since we don't upgrade redis too often I feel it would be
unnecessary complication.
Perhaps even better solution might be usage of testcontainers[2].
Integration tests would basically download and run official redis docker
image and spin it up for tests. There would be no need for cache or building
binary but docker dependency would be introduced. I have decided to
introduce cache because docker dependency has pros and cons that need to
be discussed while cache is clear and easy win ;)
PR: alicebob#372
[1]: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration
[2]: https://golang.testcontainers.org/
Signed-off-by: Wojciech Szarański <[email protected]>
wszaranski
force-pushed
the
miniredis-add-redis-server-binary-cache
branch
from
11f666b to
be85aa3
Compare
|
Difference can be observed between run when cache wasn't available (2m44s) and when it was available (49s). |
|
I think that it would be funny to use competing solution (testcontainers) to run miniredis integration tests. Miniredis is smaller, way faster and doesn't require external dependency (docker) which is great ❤️ but maybe we can mention testcontainers in README for people that require features not implemented in miniredis? |
|
Fun, thanks! Testcontainers look fun, but there are similar things which also work well (for example https://devenv.sh/ ), so I think it's a bit out of scope to pick something. But then again a short "Other options" (or whatever) section in the readme is fine with me :) |
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.
${MAKE} -C integration redis_src/redis-serverthat is part ofcitarget takes around 2 minutes to execute. With addition of cache preventing rebuild ofredis-servertests run time drops from ~2m50s to ~50s.Currently github actions are free for public repositories but I think that shorter execution time will improve developer experience :)
Due to matrix build for go versions, when redis is upgraded, build will be run multiple times in parallel. Unnecessary parallel builds can be avoided but since we don't upgrade redis too often I feel it would be unnecessary complication.
Perhaps even better solution might be usage of testcontainers. Integration tests would basically download and run official redis docker image and spin it up for tests. There would be no need for cache or building binary but docker dependency would be introduced. I have decided to introduce cache because docker dependency has pros and cons that need to be discussed while cache is clear and easy win ;)