Health check on CLI on first start #256

gabrielbussolo · 2022-11-30T14:39:00Z

Summary of this proposal

Depends on #300 to be aprovved

Notes for the reviewer

This runs on first execution of any CLI command.
We can also run it explicitly as calyptia config check.

Issue(s) number(s)

Disclaimer: Please do not create a Pull Request without creating an issue first.

Checklist for submitter

Checklist for reviewer

The proposal fixes a bug/issue or implements a new feature that is well described.
The proposal has sufficient test cases that covers the changes.
- If changes an API, it does not break backwards compatibility (-1 major version).
If integration is required, the proposal has integration tests.
The proposal does not break coverage stats
The proposal has the required documentation changes.

Backport

Backport to the latest stable release.

cmd/calyptia/main.go

cmd/calyptia/config_check.go

patrick-stephens

Add option to remove colours and emojis as it causes issues sometimes

cmd/config/config_check.go

jasmingacic

The code looks good. There is a single typo that Pat already pointed out

Otherwise, let's merge it.

Signed-off-by: Gabriel Bussolo <gabriel@calyptia.com>

gabrielbussolo · 2023-03-06T13:12:28Z

Add option to remove colours and emojis as it causes issues sometimes

the workaround to keep both was too big just for this pr, so I decided to just remove the emojis and colors.

patrick-stephens

Typo again
@vigneshcommits or @jasmingacic any good option for spell checking debug statements in Go?

cmd/config/config_check.go

cmd/root.go

gabrielbussolo · 2023-03-06T14:04:29Z

Typo again @vigneshcommits or @jasmingacic any good option for spell checking debug statements in Go?

in theory, I have it on my IDE, I just don't know why dint worked 😅

jasmingacic · 2023-03-06T15:44:30Z

I've never used any of those tools

patrick-stephens

I'm reasonably happy with this, it needs follow on updates as we add more checks.
Plus @gabrielbussolo can you raise an issue to update the calyptia/core-images vm/install-core.sh script to invoke it as well?
@jasmingacic please approve if you're happy to he can merge

nicolasparada · 2023-03-07T17:12:14Z

cmd/config/config_check.go

+func checkUrl(c *cfg.Config) bool {
+	ctx := context.Background()
+	_, err := c.Cloud.Environments(ctx, c.ProjectID, types.EnvironmentsParams{})
+	if err != nil {


This simple error check is not good enough. If the token is incorrect, or cloud is down for some reason, you will get the "internet connection issues" anyway. Which is not fair.

We should check if errors.Is(err, syscall.ECONNREFUSED) to detect if the URL is wrong.
And hit the /healthz endpoint to check if the server is up.

Ensure the cloud API endpoint is reachable with the given token (this can be performed with any simple get/listing operation). (issue#229)

The idea is literally to test if we can do a GET with the given token, but I improved the message now including more causes of the connection not working.

@gabrielbussolo after this URL check just do quick connect to it with the token just to check validity of the token. You can do that in checkToken() fn.

I don't think that checkUrl is acutally going to help us at all because chances are that by doing calyptia create core_instance k8s core will be installed in a remote cluster. What do you think?

nicolasparada · 2023-03-07T17:13:46Z

cmd/root.go

@@ -75,6 +75,14 @@ func NewRootCmd(ctx context.Context) *cobra.Command {
 		Short:         "Calyptia Cloud CLI",
 		SilenceErrors: true,
 		SilenceUsage:  true,
+		PreRun: func(cmd *cobra.Command, args []string) {
+			if _, err = config.LocalData.Get(cnfg.KeyCliHealth); errors.Is(err, localdata.ErrNotFound) {


If we store the health indicator, this code won't run ever again. And health is something that changes over time, or if the user passes different arguments.

according to the original issue, the idea it's run once after a fresh install, after this, if the client wants to check the status he should run the proper command for it.

After brew install or installing the binary directly, a quick set of checks has to be performed
in the local machine to ensure further operations will work (issue#229)

put it on the PreRun was a suggestion but can be moved to the main func again after the token and URL setup if you guys find it pertinent @jasmingacic @nicolasparada (i don't have a strong opinion about it)

PreRun was something else. This is rather preflight check.
So don't worry about it

nicolasparada

Left some comments...

But I don't know what we are trying to accomplish here...

Having a global pre-run hook is an overkill, since it checks too many things. And have it to run only once, and then save that it's ok, and not run it ever again it's not good either 🤷‍♂️

Maybe reduce he scope and on the pre-run only check that that token is set, and /healthz. Checking kubernetes might be too much, besides not all commands of the CLI require k8s. Maybe you just want to get some info about your pipelines, this will block you if you don't have access to the cluster.

cmd/config/config_check.go

Signed-off-by: Gabriel Bussolo <gabriel@calyptia.com>

sonarcloud · 2023-03-13T10:43:50Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

patrick-stephens · 2023-03-14T14:37:03Z

@gabrielbussolo I'm going to park this for now I'm afraid, good work so far but I think we need to reconsider.

gabrielbussolo self-assigned this Nov 30, 2022

gabrielbussolo linked an issue Nov 30, 2022 that may be closed by this pull request

CLI: Installation check report. #229

Closed

2 tasks

gabrielbussolo marked this pull request as draft November 30, 2022 14:39

gabrielbussolo force-pushed the 229-cli-installation-check-report branch 3 times, most recently from bae5260 to 3d4acbe Compare February 2, 2023 08:34

gabrielbussolo mentioned this pull request Feb 2, 2023

Moves keyring stuffs to a package to save data locally #300

Merged

17 tasks

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from 3d4acbe to cffac69 Compare February 2, 2023 15:13

gabrielbussolo requested a review from nicolasparada February 2, 2023 15:15

gabrielbussolo changed the title ~~[wip] Health check on CLI on first start~~ Health check on CLI on first start Feb 2, 2023

gabrielbussolo requested a review from pwhelan February 2, 2023 15:16

gabrielbussolo marked this pull request as ready for review February 2, 2023 15:16

gabrielbussolo added enhancement go Pull requests that update Go code cli labels Feb 2, 2023

gabrielbussolo marked this pull request as draft February 2, 2023 15:17

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from cffac69 to d9ebf45 Compare February 21, 2023 11:52

gabrielbussolo marked this pull request as ready for review February 21, 2023 11:53

gabrielbussolo requested a review from jasmingacic February 22, 2023 11:29

jasmingacic reviewed Feb 22, 2023

View reviewed changes

cmd/calyptia/main.go Outdated Show resolved Hide resolved

jasmingacic reviewed Feb 23, 2023

View reviewed changes

cmd/calyptia/config_check.go Outdated Show resolved Hide resolved

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from d9ebf45 to 496e809 Compare March 1, 2023 08:48

gabrielbussolo requested a review from jasmingacic March 1, 2023 08:48

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from 496e809 to 52f71b9 Compare March 1, 2023 08:52

patrick-stephens requested changes Mar 1, 2023

View reviewed changes

patrick-stephens reviewed Mar 1, 2023

View reviewed changes

cmd/config/config_check.go Outdated Show resolved Hide resolved

jasmingacic previously approved these changes Mar 2, 2023

View reviewed changes

gabrielbussolo dismissed jasmingacic’s stale review via 8cf7cbe March 6, 2023 13:10

Create a package to save data locally

e5e341d

Signed-off-by: Gabriel Bussolo <gabriel@calyptia.com>

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from 8cf7cbe to 7d8e47c Compare March 6, 2023 13:11

gabrielbussolo requested review from patrick-stephens and jasmingacic March 6, 2023 13:11

patrick-stephens requested changes Mar 6, 2023

View reviewed changes

cmd/config/config_check.go Outdated Show resolved Hide resolved

cmd/root.go Outdated Show resolved Hide resolved

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from 7d8e47c to 9019b34 Compare March 6, 2023 14:00

gabrielbussolo requested a review from patrick-stephens March 6, 2023 14:01

patrick-stephens previously approved these changes Mar 6, 2023

View reviewed changes

nicolasparada reviewed Mar 7, 2023

View reviewed changes

nicolasparada suggested changes Mar 7, 2023

View reviewed changes

gabrielbussolo dismissed patrick-stephens’s stale review via 475588f March 13, 2023 10:26

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from 9019b34 to 475588f Compare March 13, 2023 10:26

jasmingacic reviewed Mar 13, 2023

View reviewed changes

cmd/config/config_check.go Show resolved Hide resolved

Add config check command to understand the health status of the CLI

3112adb

Signed-off-by: Gabriel Bussolo <gabriel@calyptia.com>

gabrielbussolo force-pushed the 229-cli-installation-check-report branch from 475588f to 3112adb Compare March 13, 2023 10:43

gabrielbussolo requested review from jasmingacic and nicolasparada March 13, 2023 10:45

patrick-stephens closed this Mar 14, 2023

nicolasparada deleted the 229-cli-installation-check-report branch March 9, 2024 00:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Health check on CLI on first start #256

Health check on CLI on first start #256

gabrielbussolo commented Nov 30, 2022 •

edited by patrick-stephens

Loading

patrick-stephens left a comment

jasmingacic left a comment

gabrielbussolo commented Mar 6, 2023

patrick-stephens left a comment

gabrielbussolo commented Mar 6, 2023 •

edited

Loading

jasmingacic commented Mar 6, 2023

patrick-stephens left a comment

nicolasparada Mar 7, 2023

gabrielbussolo Mar 13, 2023 •

edited

Loading

jasmingacic Mar 13, 2023

nicolasparada Mar 7, 2023

gabrielbussolo Mar 13, 2023

gabrielbussolo Mar 13, 2023 •

edited

Loading

jasmingacic Mar 13, 2023

nicolasparada left a comment •

edited

Loading

sonarcloud bot commented Mar 13, 2023

patrick-stephens commented Mar 14, 2023

Health check on CLI on first start #256

Health check on CLI on first start #256

Conversation

gabrielbussolo commented Nov 30, 2022 • edited by patrick-stephens Loading

Summary of this proposal

Notes for the reviewer

Issue(s) number(s)

Checklist for submitter

Checklist for reviewer

Backport

patrick-stephens left a comment

Choose a reason for hiding this comment

jasmingacic left a comment

Choose a reason for hiding this comment

gabrielbussolo commented Mar 6, 2023

patrick-stephens left a comment

Choose a reason for hiding this comment

gabrielbussolo commented Mar 6, 2023 • edited Loading

jasmingacic commented Mar 6, 2023

patrick-stephens left a comment

Choose a reason for hiding this comment

nicolasparada Mar 7, 2023

Choose a reason for hiding this comment

gabrielbussolo Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

jasmingacic Mar 13, 2023

Choose a reason for hiding this comment

nicolasparada Mar 7, 2023

Choose a reason for hiding this comment

gabrielbussolo Mar 13, 2023

Choose a reason for hiding this comment

gabrielbussolo Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

jasmingacic Mar 13, 2023

Choose a reason for hiding this comment

nicolasparada left a comment • edited Loading

Choose a reason for hiding this comment

sonarcloud bot commented Mar 13, 2023

patrick-stephens commented Mar 14, 2023

gabrielbussolo commented Nov 30, 2022 •

edited by patrick-stephens

Loading

gabrielbussolo commented Mar 6, 2023 •

edited

Loading

gabrielbussolo Mar 13, 2023 •

edited

Loading

gabrielbussolo Mar 13, 2023 •

edited

Loading

nicolasparada left a comment •

edited

Loading