Add option to get content from all directories recursively

[nikimanoledaki]

The current implementation to GET a repository's content that was added in #80 does not get a directory tree recursively - it only returns a single, end subdirectory and its files. This is ok for now, but returning all directories recursively could be enabled easily by passing an option with RepositoryContentGetOptions, specifically here.

See documentation:

• github api https://docs.github.com/en/rest/reference/git#trees
• go-gitlab https://pkg.go.dev/github.com/xanzy/go-gitlab#ListTreeOptions

Alternatively, it would be nice to have the option to pass any RepositoryContentGetOptions :)

[foot]

Current prototype looks like this:

https://github.com/fluxcd/go-git-providers/blob/main/gitprovider/client.go#L244

type FileClient interface {
	// GetFiles fetch files content from specific path and branch
	Get(ctx context.Context, path, branch string) ([]*CommitFile, error)
}

So we could either add another method GetFileRecursively / GetWithOptions or add an extra arg ...Options to keep things backwards compatible?

[souleb]

I would prefer having a functional option... if I'm being asked 😄

[foot]

if I'm being asked 😄

'course you are :D,

Oh yeah an options thingy ay. Maybe

type Options struct {
	Recursive bool
}

type Option func(*Options)

func WithRecursive(bool value) Option {
	return func(o *Options) {
		o.Recursive = value
	}
}

Get(ctx context.Context, path, branch string, optFns ...Option) ([]*CommitFile, error)

And call it?

Get(ctx, "./clusters/my-cluster", "main", gitprovider.WithRecursive(true))

I'm not soo familiar w/ this pattern so if you have a good idea what the interfaces could look like please feel free to scribble something else!

[foot]

https://golang.cafe/blog/golang-functional-options-pattern.html

[foot]

On tackling:

• Just run the github tests GIT_PROVIDER_ORGANIZATION=foo-org GIT_PROVIDER_USER=foo go test -v ./github/...
• This looks like a good test case we could adapt

  go-git-providers/github/integration_test.go

  Lines 518 to 519 in 20f8d12

  	It("should be possible to download files from path and branch specified", func() {

  to check for files flat and recursive.