[full-ci] Revamp Config Parsing

[refs]

TODO

• add changelog
• remove all flagsets
• move all flagset default values into structs
• use gookit/config to aid with config and env vars parsing
• remove any dependencies on viper
• remove the docs pipeline on CI
• provide with a config docs section
• action: how do we want to generate docs for the new structs? We can reuse the old Description field in the flags and have a go:generate do the work see Generate config docs #2806
• ...

This is an implementation of the proposed configuration proposal on #2704

• it adds a new dependency that does roughly what I started to do on a side project. Not reinventing the wheel. MIT license.
• remove cli flags on subcommands, not on ocis root command
• makes easy to do a config dump
• support for environment variables
• support for merging config values
• support for defaults
• and most important thread safe, as I can create as many config.Config structs as I wish.

This is also in preparation for the upcoming "restart a service if a config changes" story.

ENV Variables and Templates

We have 2 options. Let the ENV parsing to the config file, which looks like:

proxy.yaml:

log:
  level: info
  color: true
  pretty: true
http:
  addr: "${PROXY_HTTP_ADDR|localhost:2222}"

There clearly PROXY_HTTP_ADDR will take precedence over the default specified in the config file localhost:2222.

The other alternative is to parse a set of predefined ENV variables, get the config environment and overwrite the config values, trimming down the config a bit.

I personally prefer the first approach, since it allows more flexibility for the end user as they are in control of the environment, and we only need to provide with a default in-memory config file that reads from the default environment values, in the case there is no extension.[*] config file on the user's machine, this way we don't break config parsing in the case the user wants to use only environment variables.

[update-docs]

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

[kobergj]

@refs I'm not sure about approach No1. Would that work with any configuration type? (yml? json? xml?)

[refs]

@refs I'm not sure about approach No1. Would that work with any configuration type? (yml? json? xml?)

yes, supports many encoders: https://github.com/gookit/config/blob/8a7c1f28b5b0e9abecffc94d0d865e17a531eb0d/config.go#L87

[ownclouders]

💥 Acceptance test Core-API-Tests-ocis-storage-10 failed. Further test are cancelled...

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
13 Code Smells

6.8% Coverage
24.9% Duplication

[wkloucek]

Let's see that out in the wild 🚀

[micbar]

Let it fly ✈️