epic: Testing

[mircea-pavel-anton]

After merging some renovate updates that passed the (extremely minimal) testing that was in place, the app has some issues when importing DNS entries from MTK API. As such, better testing is definitely required.

Goals and non-goals

• I only plan to test the code that is directly interacting with the Mikrotik API
• For unit tests, I will mock the mikrotik api with some dummy data
• I do NOT plan to test anything under pkg/webhook as it is simply copy pasted from other providers and I have absolutely 0 clue as to what that code does 😅
• There are some tests in place for internal/configuration and internal/logging. I do NOT plan to expand those
• I have no clue as to what I should test under internal/dnsprovider

TODO

• [x] Unit tests for internal/mikrotik/record.go
• [ ] Unit tests for internal/mikrotik/client.go where Mikrotik API is mocked
• [ ] Integration tests for internal/mikrotik/client.go using https://github.com/EvilFreelancer/docker-routeros ?

[mircea-pavel-anton]

Relevant: https://github.com/mirceanton/external-dns-provider-mikrotik/pull/88

[mircea-pavel-anton]

Questions

Client Connection Validation

Should I validate the connection between the API Client and the actual RouterOS API server as part of the Client creation, Provider creation or neither?

I think it is important to validate the client can connect properly (good credentials, good url etc.) sooner rather than later so that we can fail fast if something is wrong.

https://github.com/mirceanton/external-dns-provider-mikrotik/pull/91/commits/48c00db58fc664700c98560cb4ff60ee989b72d3