Gitlab CI variables

[Jabray5]

Introduced Gitlab provider

[paul-the-alien]

Greetings!
Thank you for contributing to this project!
If this is your first time contributing, please make
sure to read the Developer and Contributing Process guides.
Please also mind and follow our Code of Conduct.

[knelasevero]

Basically, unit tests and mocking missing, right? Need any specific help going over those?

[Jabray5]

Basically, unit tests and mocking missing, right? Need any specific help going over those?

Yeah I didn't manage to quite figure out what the mock providers were doing. Any tips would be great!

[knelasevero]

Basically, unit tests and mocking missing, right? Need any specific help going over those?

Yeah I didn't manage to quite figure out what the mock providers were doing. Any tips would be great!

So, we want a mock client struct that is similar to the real client struct that we imported in the real implementation.

If you look at GCP implementation, the line that actually gets a secret value is this:

external-secrets/pkg/provider/gcp/secretmanager/secretsmanager.go

Line 153 in 328cf88

result, err := sm.SecretManagerClient.AccessSecretVersion(ctx, req)

and there we see that the client struct needs a method named AccessSecretVersion (with the same signature and all that).

So in the fake client for gcp, we create a mock client struct that has a method like that.

external-secrets/pkg/provider/gcp/secretmanager/fake/fake.go

Line 31 in 328cf88

func (mc *MockSMClient) AccessSecretVersion(ctx context.Context, req *secretmanagerpb.AccessSecretVersionRequest, opts ...grpc.CallOption) (*secretmanagerpb.AccessSecretVersionResponse, error) {

same thing for IBM, here you can see that IBM gets a secret in this line:

external-secrets/pkg/provider/ibm/provider.go

Line 129 in 328cf88

response, _, err := ibm.IBMClient.GetSecret(

And therefore we need our mock client struct to be similar to the real struct and to have a method named GetSecret (with the same signature and everything).

external-secrets/pkg/provider/ibm/fake/fake.go

Line 29 in 328cf88

func (mc *IBMMockClient) GetSecret(getSecretOptions *sm.GetSecretOptions) (result *sm.GetSecret, response *core.DetailedResponse, err error) {

This is important, because when we call unit tests, we don't want the code to call the actual client, because we don't want to do real calls to the providers apis. Using IBM as an example, for unit testing, we want to test (normally run through real code) the provider going through lines 95 to just before 110, mock what is being returned from the client, and go normally until another call to the client, mock it, and so on, until the end of the method. We test the simple logic of the method, and not client API calls.

In the test setup we call

external-secrets/pkg/provider/ibm/provider_test.go

Line 56 in 328cf88

smtc.mockClient.WithValue(smtc.apiInput, smtc.apiOutput, smtc.apiErr)

the withValue method to overwrite the important method in the fake client to receive anything we want and return any arbritary data we want.

You can see the WithValue method overriding what getSecret does here WithValue. And GetSecret just calls getSecret.

And before looping over our testCases, we set the provider client to be the mock client instead of a real one. (In real life, the controller will know wich client to create and assign, if you wanna check that).

Here you can see the test setting the mock client before looping over tests:

external-secrets/pkg/provider/ibm/provider_test.go

Line 245 in 328cf88

sm.IBMClient = v.mockClient

In your case you will have to create a fake client struct that has a method named GetVariable (with same signature, same arguments and all that, similar to the client struct that you imported from the gilab official package). Then an indirection func (that you can call anything really) that your GetVariable just calls. And a WithValue that overrides this indirection func.

[knelasevero]

BTW, great work making it already pass all e2e tests and be functional already! 🎉

[knelasevero]

/ok-to-test sha=079e11d8a403b422d41115c37749dd7e090d843c

[knelasevero]

/approve

[knelasevero]

Docs missing, but we can add docs later if you want :)

LGTM!

[knelasevero]

/ok-to-test sha=ad966ea2efdd6c3bb5e87bd3709cbba7257f043f

[knelasevero]

/merge