Refactor machine output code #4948

feloy · 2021-07-27T08:02:29Z

What type of PR is this?

/kind feature

What does this PR do / why we need it:

Refactored the code for the JSON output of the following commands:

odo debug info
odo env view
odo project create
odo project delete
odo project get
odo project list
odo storage create
odo storage delete
odo url create
odo url list
odo component list

Main changes:

project.GetMachineReadableFormat function renamed to project.NewProject (and similar for other kinds)
project.getMachineReadableFormatForList renamed to project.NewProjectList (and similar for other kinds)
(o Project) HumanReadableOutput created (and similar for other kinds)

Kinds are capitalized:

url -> URL
storage -> Storage

Messages are not included in the returned value:

There are no message fields in the odo objects (Project, Storage, etc).

$ odo project create test1 -o json
{
"kind": "Project",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "test1",
"namespace": "test1",
"creationTimestamp": null
},
~~"message": "Project 'test1' is ready for use"~~
}

Delete commands return a `Status` object:

APIs generally does not return the deleted object. If we want to try to be compatible with other Kubernetes CLIs/APIs, we could use the Status kind returned by calls to the Kubernetes API DELETE endpoints (example: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#delete-delete-a-deployment).

$ odo project delete prj2 -o json
{
	"kind": "Status",
	"apiVersion": "v1",
	"metadata": {},
	"status": "Success",
	"message": "Deleted project : prj2",
	"details": {
		"name": "prj2",
		"kind": "Project"
	}
}

Which issue(s) this PR fixes:

Related to #2784

PR acceptance criteria:

How to test changes / Special notes to the reviewer:

netlify · 2021-07-27T08:03:18Z

✔️ Deploy Preview for odo-docusaurus-preview ready!

🔨 Explore the source changes: 48e1261

🔍 Inspect the deploy log: https://app.netlify.com/sites/odo-docusaurus-preview/deploys/612de797c21e620008441c67

😎 Browse the preview: https://deploy-preview-4948--odo-docusaurus-preview.netlify.app

prietyc123 · 2021-07-28T13:02:04Z

/test v4.8-integration-e2e

pkg/component/types.go

pkg/storage/storage_test.go

pkg/component/types.go

feloy · 2021-08-17T17:59:08Z

/test v4.8-integration-e2e

[skipping gathering secrets/support due to error: secrets "support" not found, skipping gathering EgressFirewall.k8s.ovn.org due to error: the server doesn't have a resource type "EgressFirewall", skipping gathering EgressIP.k8s.ovn.org due to error: the server doesn't have a resource type "EgressIP", skipping gathering endpoints/host-etcd-2 due to error: endpoints "host-etcd-2" not found, skipping gathering namespaces/openshift-manila-csi-driver due to error: namespaces "openshift-manila-csi-driver" not found]error: gather did not start for pod must-gather-99rhq: unable to pull image: ImagePullBackOff:

feloy · 2021-08-18T08:20:25Z

/test v4.8-integration-e2e

[Fail] odo devfile registry command tests When executing registry commands with the registry is not present [It] Should successfully add the registry

feloy · 2021-08-18T11:31:30Z

/test v4.8-integration-e2e

(passes locally)

[Fail] odo project command tests [It] should list current empty project in json format 
/go/src/github.com/openshift/odo/tests/integration/project/cmd_project_test.go:68

dharmit

Only reviewed the documentation changes.

dharmit · 2021-08-19T04:36:43Z

website/docs/using-odo/json-output.md

@@ -0,0 +1,43 @@
+---
+title: JSON Output
+sidebar_position: 2


We're planning to put Spring Boot + Postgres in the "Using odo" section such that it'll show the complete flow starting from creating a component to creating URL, storage, services, and linking with services, components, etc. In that context, putting JSON Output doc under "Using odo" seems out of place to me.

For a few guides that we're importing from old website which don't make sense to be put in "Using odo" section, we are putting them under "Tutorials". A PR is open for it #4934.

I'm inclined to put this under "Tutorials" as well. What do you feel?

I would prefer to place this page under a "Reference" section

Yes, that makes a lot of sense. Where do you think we could put up that section? Current sections:

Introduction (no sub-sections)

Getting Started

Using odo

Command Reference

Tutorials

Architecture

Contributing to odo

This page could appear at the end of the Command Reference section

Ack. 👍🏾

@feloy can you create a new page and move this to the Command Reference section, or do you intend to do this in another PR?

dharmit · 2021-08-19T04:38:06Z

website/docs/using-odo/json-output.md

+| odo application list           | List (odo.dev/v1alpha1)                 | Application (odo.dev/v1alpha1)                               | ?                         |
+| odo catalog list components    | List (odo.dev/v1alpha1)                 | ComponentType (odo.dev/v1alpha1) (s2i) / *missing* (devfile) | yes (s2i) / yes (devfile) |
+| odo catalog list services      | List (odo.dev/v1alpha1)                 | ClusterServiceVersion (operators.coreos.com/v1alpha1)        | ?                         |
+| odo catalog describe component | *missing*                               | *n/a*                                                        | yes                       |


How's "missing" different from "n/a"?

"missing" indicates that the output does not contain the kind/version information, but should contain it.

dharmit · 2021-08-19T04:38:42Z

website/docs/using-odo/json-output.md

+| commands                       | Kind (version)                          | Kind (version) of list items                                 | Complete content?         | 
+|--------------------------------|-----------------------------------------|--------------------------------------------------------------|---------------------------|
+| odo application describe       | Application (odo.dev/v1alpha1)          | *n/a*                                                        |no                         |
+| odo application list           | List (odo.dev/v1alpha1)                 | Application (odo.dev/v1alpha1)                               | ?                         |


What's the difference between "n/a" and "?" ?

n/a (not applicable) indicates that this information (Kind (version) of list items) if not applicable, because the discussed resource is not a list

"?" is a request for comment from the team, to discuss if the content is useful and complete, or if we should work on it

website/docs/using-odo/json-output.md

dharmit · 2021-08-19T04:41:45Z

website/docs/using-odo/json-output.md

+
+The exhaustive list of commands accepting the `-o json` flag is currently:
+
+| commands                       | Kind (version)                          | Kind (version) of list items                                 | Complete content?         | 


What does "Complete content" mean? Are there any commands where it's incomplete? I'd expect this to be binary - either JSON output is present or not present. But "Complete" makes me think it's about something else.

Does the content contains all the data present in the human readale output (or more), and is equivalent to it.

openshift-bot · 2021-08-31T13:12:53Z

/retest-required