smccarthy788 opened a new pull request, #86:
URL: https://github.com/apache/otava/pull/86
See #82.
Took a stab at this. I fear I've misunderstood the goal:
> use ConfigArgParse and support all options in the same library. (CLI
options, yaml file, [env vars])
I've pushed the entire creation of the config object through ConfigArgParse.
It feels a bit unwieldy, or... square peg through a round hole? So I'm not
super attached to this implementation. Still, putting it up for consideration /
reference.
Pros:
- all config options are available to be set in config file, env var, or CLI
(with precedence as desired)
- good looking documentation of the CLI arguments & env vars output via
`otava --help`:
<details>
<summary>Help Output</summary>
```
$ uv run otava --help
usage: otava [-h] [--config-file CONFIG_FILE] [--graphite-url GRAPHITE_URL]
[--grafana-url GRAFANA_URL] [--grafana-user GRAFANA_USER] [--grafana-password
GRAFANA_PASSWORD] [--slack-token SLACK_TOKEN] [--postgres-hostname
POSTGRES_HOSTNAME]
[--postgres-port POSTGRES_PORT] [--postgres-username
POSTGRES_USERNAME] [--postgres-password POSTGRES_PASSWORD] [--postgres-database
POSTGRES_DATABASE] [--bigquery-project BIGQUERY_PROJECT] [--bigquery-dataset
BIGQUERY_DATASET]
[--bigquery-credentials BIGQUERY_CREDENTIALS]
{list-tests,list-metrics,list-groups,analyze,regressions,remove-annotations,validate}
...
Hunts performance regressions in Fallout results
positional arguments:
{list-tests,list-metrics,list-groups,analyze,regressions,remove-annotations,validate}
list-tests list available tests
list-metrics list available metrics for a test
list-groups list available groups of tests
analyze analyze performance test results
regressions find performance regressions
validate validates the tests and metrics defined in the
configuration
optional arguments:
-h, --help show this help message and exit
--config-file CONFIG_FILE
Otava config file path [env var: OTAVA_CONFIG]
Graphite Options:
Options for Graphite configuration
--graphite-url GRAPHITE_URL
Graphite server URL [env var: GRAPHITE_ADDRESS]
Grafana Options:
Options for Grafana configuration
--grafana-url GRAFANA_URL
Grafana server URL [env var: GRAFANA_ADDRESS]
--grafana-user GRAFANA_USER
Grafana server user [env var: GRAFANA_USER]
--grafana-password GRAFANA_PASSWORD
Grafana server password [env var: GRAFANA_PASSWORD]
Slack Options:
Options for Slack configuration
--slack-token SLACK_TOKEN
Slack bot token to use for sending notifications
[env var: SLACK_BOT_TOKEN]
Postgres Options:
Options for Postgres configuration
--postgres-hostname POSTGRES_HOSTNAME
PostgreSQL server hostname [env var:
POSTGRES_HOSTNAME]
--postgres-port POSTGRES_PORT
PostgreSQL server port [env var: POSTGRES_PORT]
--postgres-username POSTGRES_USERNAME
PostgreSQL username [env var: POSTGRES_USERNAME]
--postgres-password POSTGRES_PASSWORD
PostgreSQL password [env var: POSTGRES_PASSWORD]
--postgres-database POSTGRES_DATABASE
PostgreSQL database name [env var: POSTGRES_DATABASE]
BigQuery Options:
Options for BigQuery configuration
--bigquery-project BIGQUERY_PROJECT
BigQuery project ID [env var: BIGQUERY_PROJECT_ID]
--bigquery-dataset BIGQUERY_DATASET
BigQuery dataset [env var: BIGQUERY_DATASET]
--bigquery-credentials BIGQUERY_CREDENTIALS
BigQuery credentials file [env var:
BIGQUERY_VAULT_SECRET]
Args that start with '--' can also be set in a config file (specified via
--config-file). Config file syntax allows: key=value, flag=true, stuff=[a,b,c]
(for details, see syntax at https://goo.gl/R74nmi). In general, command-line
values
override environment variables which override config file values which
override defaults.
```
</details>
Cons:
- custom parser to handle nested config objects
- abstraction leaking into the config objects; config objects now need to
know about configargparse.
- need to use `parse_known_args` to avoid exceptions from parts of the
config we don't want to include in the CLI (tests, templates, test_groups)
- creating a Config object programatically from a configuration file is...
_weird_ (although I avoided exposing people to this by adding a helper
function):
```python
config_file = Path("tests/resources/substitution_test_config.yaml")
parser = create_config_parser(config_file)
args, unknown_args = parser.parse_known_args(args=[])
config = load_config_from_parser_args(args, config_file)
```
If we do want to pursue this implementation, I'll flesh out the unit tests
more. So far I've only added enough to validate the basics.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
