Adding machine output to component create #2532

mohammedzee1000 · 2020-01-27T13:04:56Z

Cleaning machine output
Changing as needed to affected packages
Adding machine output to component create

What type of PR is this?

/kind bug

Which issue(s) this PR fixes:

How to test changes / Special notes to the reviewer:

❯ odo create -o json nodejs
{
    "kind": "Component",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "name": "nodejs-nodejs-ex-2-quxc",
        "namespace": "myproject",
        "creationTimestamp": null
    },
    "spec": {
        "app": "app",
        "type": "nodejs",
        "source": "file://./",
        "ports": [
            "8080/TCP"
        ]
    },
    "status": {
        "state": "Not Pushed"
    }
}

❯ odo create python --now -o json
{
    "kind": "Component",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "name": "python-python-bveb",
        "namespace": "myproject",
        "creationTimestamp": null
    },
    "spec": {
        "app": "app",
        "type": "python",
        "source": "file://./",
        "env": [
            {
                "name": "DEBUG_PORT",
                "value": "5858"
            }
        ]
    },
    "status": {
        "state": "Pushed"
    }
}

kadel · 2020-01-29T10:58:12Z

pkg/odo/cli/component/push.go

+		return err
+	}
+	if log.IsJSON() {
+		componentDesc, err := component.GetComponent(po.Context.Client, po.Context.Component(), po.Context.Application, po.Context.Project)


Not sure if outputting component description is what we want for odo push -o json output.
I would skip JSON output for the push for now as we are not sure how it should look like. This PR was supposed to just about create command.

Sorry, skipped

kadel

The output was supposed to be for odo create command, not odo push :-(

▶ odo component create java -o json
 ✗  Machine readable output is not yet implemented for this command

mohammedzee1000 · 2020-01-30T06:33:13Z

@kadel fixed

kadel · 2020-01-30T13:02:24Z

@mohammedzee1000 :-(
you are not checking error, and odo list is panicking :-(

golangci-lint run ./... --timeout 5m
pkg/odo/cli/component/create.go:502:35: SA4006: this value of `err` is never used (staticcheck)
		co.Context, co.localConfigInfo, err = genericclioptions.UpdatedContext(co.Context)

odo component list --app app --project hfksemmieq]

[odo] panic: runtime error: invalid memory address or nil pointer dereference
[odo] [signal SIGSEGV: segmentation violation code=0x1 addr=0x20 pc=0x13c71d5]
[odo] 
[odo] goroutine 1 [running]:
[odo] github.com/openshift/odo/pkg/component.List(0xc00072f040, 0x7ffd6a39e598, 0x3, 0xc000a22cd0, 0xc000946e60, 0x18f55a8, 0x14, 0x18e43e7, 0x2, 0x1516b11)
[odo] 	/go/src/github.com/openshift/odo/pkg/component/component.go:907 +0x4f5
[odo] github.com/openshift/odo/pkg/odo/cli/component.(*ListOptions).Run(0xc000841aa0, 0x0, 0x0)
[odo] 	/go/src/github.com/openshift/odo/pkg/odo/cli/component/list.go:113 +0xc7d
[odo] github.com/openshift/odo/pkg/odo/genericclioptions.GenericRun(0x1b205e0, 0xc000841aa0, 0xc0007bb8c0, 0xc0004d93c0, 0x0, 0x4)
[odo] 	/go/src/github.com/openshift/odo/pkg/odo/genericclioptions/runnable.go:31 +0x13c
[odo] github.com/openshift/odo/pkg/odo/cli/component.NewCmdList.func1(0xc0007bb8c0, 0xc0004d93c0, 0x0, 0x4)
[odo] 	/go/src/github.com/openshift/odo/pkg/odo/cli/component/list.go:149 +0x5e
[odo] github.com/openshift/odo/vendor/github.com/spf13/cobra.(*Command).execute(0xc0007bb8c0, 0xc0004d9380, 0x4, 0x4, 0xc0007bb8c0, 0xc0004d9380)
[odo] 	/go/src/github.com/openshift/odo/vendor/github.com/spf13/cobra/command.go:702 +0x2d3
[odo] github.com/openshift/odo/vendor/github.com/spf13/cobra.(*Command).ExecuteC(0xc000817b00, 0x8, 0xc000000300, 0x15012d0)
[odo] 	/go/src/github.com/openshift/odo/vendor/github.com/spf13/cobra/command.go:783 +0x2dc
[odo] github.com/openshift/odo/vendor/github.com/spf13/cobra.(*Command).Execute(0xc000817b00, 0x19e8e78, 0xc0007a2420)
[odo] 	/go/src/github.com/openshift/odo/vendor/github.com/spf13/cobra/command.go:736 +0x2b
[odo] main.main()
[odo] 	/go/src/github.com/openshift/odo/cmd/odo/odo.go:72 +0x3fe

girishramnani · 2020-02-04T09:02:09Z

any update on this PR @mohammedzee1000

mohammedzee1000 · 2020-02-04T09:09:04Z

I am looking at what broke

girishramnani · 2020-02-04T09:10:14Z

@mohammedzee1000 :-(
you are not checking error, and odo list is panicking :-(

golangci-lint run ./... --timeout 5m
pkg/odo/cli/component/create.go:502:35: SA4006: this value of `err` is never used (staticcheck)
		co.Context, co.localConfigInfo, err = genericclioptions.UpdatedContext(co.Context)

odo component list --app app --project hfksemmieq]

[odo] panic: runtime error: invalid memory address or nil pointer dereference
[odo] [signal SIGSEGV: segmentation violation code=0x1 addr=0x20 pc=0x13c71d5]
[odo] 
[odo] goroutine 1 [running]:
[odo] github.com/openshift/odo/pkg/component.List(0xc00072f040, 0x7ffd6a39e598, 0x3, 0xc000a22cd0, 0xc000946e60, 0x18f55a8, 0x14, 0x18e43e7, 0x2, 0x1516b11)
[odo] 	/go/src/github.com/openshift/odo/pkg/component/component.go:907 +0x4f5
[odo] github.com/openshift/odo/pkg/odo/cli/component.(*ListOptions).Run(0xc000841aa0, 0x0, 0x0)
[odo] 	/go/src/github.com/openshift/odo/pkg/odo/cli/component/list.go:113 +0xc7d
[odo] github.com/openshift/odo/pkg/odo/genericclioptions.GenericRun(0x1b205e0, 0xc000841aa0, 0xc0007bb8c0, 0xc0004d93c0, 0x0, 0x4)
[odo] 	/go/src/github.com/openshift/odo/pkg/odo/genericclioptions/runnable.go:31 +0x13c
[odo] github.com/openshift/odo/pkg/odo/cli/component.NewCmdList.func1(0xc0007bb8c0, 0xc0004d93c0, 0x0, 0x4)
[odo] 	/go/src/github.com/openshift/odo/pkg/odo/cli/component/list.go:149 +0x5e
[odo] github.com/openshift/odo/vendor/github.com/spf13/cobra.(*Command).execute(0xc0007bb8c0, 0xc0004d9380, 0x4, 0x4, 0xc0007bb8c0, 0xc0004d9380)
[odo] 	/go/src/github.com/openshift/odo/vendor/github.com/spf13/cobra/command.go:702 +0x2d3
[odo] github.com/openshift/odo/vendor/github.com/spf13/cobra.(*Command).ExecuteC(0xc000817b00, 0x8, 0xc000000300, 0x15012d0)
[odo] 	/go/src/github.com/openshift/odo/vendor/github.com/spf13/cobra/command.go:783 +0x2dc
[odo] github.com/openshift/odo/vendor/github.com/spf13/cobra.(*Command).Execute(0xc000817b00, 0x19e8e78, 0xc0007a2420)
[odo] 	/go/src/github.com/openshift/odo/vendor/github.com/spf13/cobra/command.go:736 +0x2b
[odo] main.main()
[odo] 	/go/src/github.com/openshift/odo/cmd/odo/odo.go:72 +0x3fe

please address @kadel comments too

codecov · 2020-02-05T11:18:54Z

Codecov Report

Merging #2532 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2532   +/-   ##
=======================================
  Coverage   43.39%   43.39%           
=======================================
  Files          91       91           
  Lines        8312     8312           
=======================================
  Hits         3607     3607           
  Misses       4352     4352           
  Partials      353      353

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 791be7f...2f56a8b. Read the comment docs.

mohammedzee1000 · 2020-02-06T11:37:42Z

Due to less amount of time, I am removing the changes i had implemented to json output itself. I am recording it #2573.

I will push smaller PR with only machine-readable output for component creation shortly.

cdrage · 2020-02-12T16:40:15Z

Looks like only this is currently implemented:

~/nodejs-ex  master ✔                                                                                                                                                          16d  ⍉
▶ odo create nodejs -o json
{
    "metadata": {
        "creationTimestamp": null
    },
    "spec": {},
    "status": {
        "state": ""
    }
}

However.. this should match odo describe..

{
    "kind": "Component",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "name": "nodejs-nodejs-ex-wila",
        "namespace": "default",
        "creationTimestamp": null
    },
    "spec": {
        "app": "app",
        "type": "nodejs",
        "source": "file://./",
        "ports": [
            "8080/TCP"
        ]
    },
    "status": {
        "state": "Not Pushed"
    }
}

So I'm going to fix that 👍

kadel · 2020-03-10T11:38:10Z

@mohammedzee1000 How is this progressing? Any blockers?

amitkrout · 2020-04-01T11:37:55Z

tests/integration/component.go

@@ -236,6 +236,24 @@ func componentTests(args ...string) {
 			helper.CmdShouldPass("odo", append(args, "delete", "-f", "--all", "--context", context)...)
 		})

+		It("should describe not pushed component when it is created with json output", func() {
+			cmpDescribeJSON, err := helper.Unindented(helper.CmdShouldPass("odo", append(args, "create", "nodejs", "cmp-git", "--project", project, "--git", "https://github.com/openshift/nodejs-ex", "--context", context, "--app", "testing", "-o", "json")...))


Can you use nodejs local source (less time consuming) instead of git source.

amitkrout · 2020-04-01T11:39:45Z

tests/integration/component.go

+		})
+
+		It("should describe pushed component when it is created with json output", func() {
+			cmpDescribeJSON, err := helper.Unindented(helper.CmdShouldPass("odo", append(args, "create", "nodejs", "cmp-git", "--project", project, "--git", "https://github.com/openshift/nodejs-ex", "--context", context, "--app", "testing", "-o", "json", "--now")...))


Use local nodejs source to save few minutes of CI time

Signed-off-by: Mohammed Zeeshan Ahmed <mohammed.zee1000@gmail.com>

mohammedzee1000 · 2020-04-01T12:06:11Z

@amitkrout done

mohammedzee1000 · 2020-04-02T05:13:12Z

now flag flake https://prow.svc.ci.openshift.org/view/gcs/origin-ci-test/pr-logs/pull/openshift_odo/2532/pull-ci-openshift-odo-master-v4.3-integration-e2e-benchmark/1522

/retest

mohammedzee1000 · 2020-04-02T07:22:03Z

/retest

mohammedzee1000 · 2020-04-02T10:04:31Z

/retest

amitkrout · 2020-04-02T12:52:26Z

/lgtm

girishramnani · 2020-04-07T08:38:12Z

pkg/odo/cli/component/create.go

+				return err
+			}
+		}
+		componentDesc.Spec.Ports = co.LocalConfigInfo.GetPorts()


Why is this needed to be done, shouldn’t the port be populated in the spec?

I took what is there in odo describe logic. Must be a reason why its there

cdrage

Changes look great!

/approve

openshift-ci-robot · 2020-04-07T15:49:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cdrage

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [cdrage]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci-robot added the size/L label Jan 27, 2020

openshift-ci-robot requested review from amitkrout and prietyc123 January 27, 2020 13:05

mohammedzee1000 force-pushed the cmp_create_json branch from f6d94b2 to 5eae7db Compare January 28, 2020 10:07

kadel reviewed Jan 29, 2020

View reviewed changes

kadel requested changes Jan 29, 2020

View reviewed changes

openshift-ci-robot assigned kadel Jan 29, 2020

mohammedzee1000 force-pushed the cmp_create_json branch from 5eae7db to 42d92b7 Compare January 30, 2020 06:32

mohammedzee1000 force-pushed the cmp_create_json branch 2 times, most recently from 64ca790 to e773574 Compare February 5, 2020 11:18

mohammedzee1000 force-pushed the cmp_create_json branch from fc3cc1a to a660515 Compare February 6, 2020 12:13

openshift-ci-robot added size/M and removed size/L labels Feb 6, 2020

mohammedzee1000 force-pushed the cmp_create_json branch 2 times, most recently from 1517fec to 3cadb5a Compare February 7, 2020 09:24

cdrage mentioned this pull request Feb 13, 2020

Issues with localConfigInfo in common_push.go #2602

Closed

mohammedzee1000 force-pushed the cmp_create_json branch 2 times, most recently from 983b696 to 15fa4c1 Compare March 2, 2020 06:53

mohammedzee1000 force-pushed the cmp_create_json branch 3 times, most recently from 0b937be to 43a7275 Compare March 9, 2020 13:08

openshift-ci-robot requested a review from kadel April 1, 2020 08:40

mohammedzee1000 mentioned this pull request Apr 1, 2020

No message is generated for component create command with -o json flag #2309

Closed

amitkrout suggested changes Apr 1, 2020

View reviewed changes

openshift-ci-robot assigned amitkrout Apr 1, 2020

mohammedzee1000 added 9 commits April 1, 2020 17:35

Adding json output to component create

683f079

Signed-off-by: Mohammed Zeeshan Ahmed <mohammed.zee1000@gmail.com>

Fixing function parameter change after rebase

b12dd6d

Updating context in case of non pushed component

e8865f4

Fixing up unhandled error while updating context

6f86644

Adding missing }

35a7f9c

Adding misssing ports

f9e9dd1

Fixing expected output

8ab8a24

Fixing expected json output

dc03e7f

Updating tests to use local context

3b9e7c7

mohammedzee1000 force-pushed the cmp_create_json branch from 7f664da to 3b9e7c7 Compare April 1, 2020 12:05

Removing source from expected output for pushed cmp

2f56a8b

openshift-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Apr 2, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Apr 2, 2020

girishramnani reviewed Apr 7, 2020

View reviewed changes

cdrage approved these changes Apr 7, 2020

View reviewed changes

openshift-ci-robot assigned cdrage Apr 7, 2020

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Apr 7, 2020

openshift-merge-robot merged commit 2995990 into redhat-developer:master Apr 7, 2020

mohammedzee1000 deleted the cmp_create_json branch April 8, 2020 05:49

rm3l added the estimated-size/M (10-20) Rough sizing for Epics. About 1 sprint of work for one person label Jun 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding machine output to component create #2532

Adding machine output to component create #2532

mohammedzee1000 commented Jan 27, 2020 •

edited by amitkrout

kadel Jan 29, 2020

mohammedzee1000 Feb 5, 2020

kadel left a comment •

edited

mohammedzee1000 commented Jan 30, 2020

kadel commented Jan 30, 2020

girishramnani commented Feb 4, 2020

mohammedzee1000 commented Feb 4, 2020

girishramnani commented Feb 4, 2020

codecov bot commented Feb 5, 2020 •

edited

mohammedzee1000 commented Feb 6, 2020

cdrage commented Feb 12, 2020

kadel commented Mar 10, 2020

amitkrout Apr 1, 2020

mohammedzee1000 Apr 1, 2020

amitkrout Apr 1, 2020

mohammedzee1000 Apr 1, 2020

mohammedzee1000 commented Apr 1, 2020

mohammedzee1000 commented Apr 2, 2020

mohammedzee1000 commented Apr 2, 2020

mohammedzee1000 commented Apr 2, 2020

amitkrout commented Apr 2, 2020

girishramnani Apr 7, 2020

mohammedzee1000 Apr 7, 2020

cdrage left a comment

openshift-ci-robot commented Apr 7, 2020

Adding machine output to component create #2532

Adding machine output to component create #2532

Conversation

mohammedzee1000 commented Jan 27, 2020 • edited by amitkrout

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kadel left a comment • edited

Choose a reason for hiding this comment

mohammedzee1000 commented Jan 30, 2020

kadel commented Jan 30, 2020

girishramnani commented Feb 4, 2020

mohammedzee1000 commented Feb 4, 2020

girishramnani commented Feb 4, 2020

codecov bot commented Feb 5, 2020 • edited

Codecov Report

mohammedzee1000 commented Feb 6, 2020

cdrage commented Feb 12, 2020

kadel commented Mar 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohammedzee1000 commented Apr 1, 2020

mohammedzee1000 commented Apr 2, 2020

mohammedzee1000 commented Apr 2, 2020

mohammedzee1000 commented Apr 2, 2020

amitkrout commented Apr 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdrage left a comment

Choose a reason for hiding this comment

openshift-ci-robot commented Apr 7, 2020

mohammedzee1000 commented Jan 27, 2020 •

edited by amitkrout

kadel left a comment •

edited

codecov bot commented Feb 5, 2020 •

edited