bcgov/gwa-cli

Add config validation subcommand

Open

#98 opened on Dec 15, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (1 fork)auto 404
enhancementgood first issue

Repository metrics

Stars
 (7 stars)
PR merge metrics
 (PR metrics pending)

Description

As a user I want to ensure my config is setup correctly. As an APS team dev I want to ensure my user's config set up correctly during troubleshooting or bug reports.

Acceptance Criteria

Add a gwa config validate subcommand. This command will exit the program and print nothing if the application doesn't find any issues or potential warnings. An example output could be:

gwa config validate
[WARN] namespace not set
[ERROR] scheme set to ws, which is invalid. Must only be http or https.

Not required, but output flags of  --json could be added, which would write the output to a JSON file.

Rules

  • host: required, must be a valid hostname
  • api_key: warning if empty (some operations could be executed without it)
  • namespace: warning if empty
  • scheme: required, http and https only accepted values
  • token_endpoint: required, must be valid URL

Notes

Recommend merging #95 before starting work on this ticket, as that PR introduces a logging pattern that would be useful for this work.

Contributor guide

Research direction
Study the existing CLI command structure in the repository, likely using a library like cobra. Look at how other subcommands are defined, and add a new 'config validate' command. Implement validation logic for the config fields as specified in the issue (host, api key, namespace, scheme, token endpoint). Use the logging pattern from PR #95 to output warnings and errors.
Tech stack
go
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoCLI development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70