gozeloglu / cache Goto Github PK

Makefile can be added to the project. It can have some commands that are used commonly.

• test: Runs go test command.
• race: Runs go test with -race command.
• cover: Runs go test with -cover option.
• cover-out: Runs cover command and produce report.
  • go test -coverprofile=coverage.out ./... go tool cover -html=coverage.out command can be used.

Keys and values(as an object) can be stored in a map to access in O(1) time complexity. Also, updates can be done faster.

cache_test.go should be refactored to follow Go-style table-driven test.

Why was it written like that?

I was a newbie in Go while I was implementing this package.

Why is it important?

• In the current version, test files are not maintainable and readable. It is really hard to make changes or add new test cases.
• Go has some conventions like writing tests in a table-driven style. It will be better if the test functions are refactored for welcoming new contributors. Go developers are familiar with test style and it makes the project understandable for them.
• It is hard to detect bugs now.

TODOs

• Convert test functions to table-driven tests.
• Keep test coverage rate.

Resources

• https://dave.cheney.net/2019/05/07/prefer-table-driven-tests
• https://go.dev/blog/subtests
• https://semaphoreci.com/blog/table-driven-unit-tests-go
• https://dev.to/boncheff/table-driven-unit-tests-in-go-407b

The current Go version is 1.18 but the pipeline version is 1.17. It causes the pipeline failure. It should be updated and synced with the Go version we use in the project.

Acceptance criteria

• We need to update the Go version in .github/workflows/go.yml.