Add github_branch_protection

[eliecharra]

Q	A
🐛 Bug fix?	no
🚀 New feature?	yes
⚠ Deprecations?	no
❌ BC Break	no
🔗 Related issues	#249
❓ Documentation	yes

Description

⚠️ To be able to alert when use user github_branch_protection_v3, we should create a resource, a deserializer and a finally a middleware to check if there is any github_branch_protection_v3 resource in state just to send an alert and remove theses resources. Do we really want to do that ? Maybe a line in LIMITATIONS.md may be enough.

⚠️ It seems that the terraform provider is not returning the repository_id, so I've ignored it from the diff

Attentive review required please @moadibfr @wbeuil

[codecov]

Codecov Report

Merging #301 (1c34d86) into main (fcc17eb) will increase coverage by 0.11%.
The diff coverage is 71.79%.

@@            Coverage Diff             @@
##             main     #301      +/-   ##
==========================================
+ Coverage   68.92%   69.03%   +0.11%     
==========================================
  Files         269      273       +4     
  Lines        5724     5796      +72     
==========================================
+ Hits         3945     4001      +56     
- Misses       1436     1447      +11     
- Partials      343      348       +5     

Impacted Files	Coverage Δ
pkg/remote/github/init.go	0.00% <0.00%> (ø)
pkg/remote/github/provider.go	7.69% <40.00%> (+7.69%)	⬆️
...remote/github/github_branch_protection_supplier.go	42.85% <42.85%> (ø)
...erializer/github_branch_protection_deserializer.go	69.23% <69.23%> (ø)
...kg/resource/github/github_branch_protection_ext.go	87.50% <87.50%> (ø)
pkg/iac/deserializers.go	100.00% <100.00%> (ø)
pkg/remote/github/repository.go	90.82% <100.00%> (+1.93%)	⬆️
pkg/resource/github/github_branch_protection.go	100.00% <100.00%> (ø)
... and 2 more

[lotoussa]

~LGTM

[lotoussa]

Isn't missing parenthesis for RepoId ?

[eliecharra]

This is a good question, WDYT @moadibfr @wbeuil ? Should we display Branch: %s (RepoId: %s) to be more consistent with Branch: %s (Id: %s) ?

[wbeuil]

Let's be consistent then. But I'm fine with one or the other

[eliecharra]

Fixed

[moadibfr]

warning To be able to alert when use user github_branch_protection_v3, we should create a resource, a deserializer and a finally a middleware to check if there is any github_branch_protection_v3 resource in state just to send an alert and remove theses resources. Do we really want to do that ? Maybe a line in LIMITATIONS.md may be enough.

Maybe we could add a warning when we find unmanaged repository only ? Saying that this might be a false positive as we don't support v3 ?

[eliecharra]

Maybe we could add a warning when we find unmanaged repository only ? Saying that this might be a false positive as we don't support v3 ?

We cannot make the difference between a false positive drift and a real drift with this approach.
For me we the only way to handle this is to read v3 res from the state and try to match them to non-v3 unmanaged one and ignore them with a warning. So we'll end up with a v3 resource and deserializer without any supplier related.

WDYT @moadibfr @wbeuil ? Is it worth it ? I can totally do this in a couple of hours.

[wbeuil]

I'm not sure it's worth your time to do it. Are we sure that we can create a non-v3 resource with a v3 resource ? Can't we just warn the user if we find a v3 resource in its state ?