"wsk property get" should return raw output when provided with specific property. by neerajmangal · Pull Request #430 · apache/openwhisk-cli

neerajmangal · 2019-03-26T04:18:46Z

This PR attempts to address issues explained in #407.

With this PR, wsk CLI will provide a raw output when a specific property is provided in "wsk property get" command.

"wsk property get"

Neerajs-MacBook-Pro:incubator-openwhisk-cli mangal$ ./wsk property get
client cert
Client key
whisk auth		2eafce54-d08e-4128-a109-#####
whisk API host		https://wsk-edge#####.com
whisk API version	v1
whisk namespace		mangal
whisk CLI version	not set
whisk API build		2018-01-29T18:32:59Z
whisk API build number	latest
Neerajs-MacBook-Pro:incubator-openwhisk-cli mangal$

wsk property get --namespace
mangal

# There is no need to parsing the output now. 

export NAMESPACE=`wsk property get --namespace`
echo $NAMESPACE
mangal

wsk property get --apihost
https://wsk-edge.#####.com

wsk property get --auth
2eafce54-d08e-4128-a109-####

If Option "--all" is present with other options then --all takes precedence.

Neerajs-MacBook-Pro:incubator-openwhisk-cli mangal$ ./wsk property get --namespace --all
client cert
Client key
whisk auth		2eafce54-d08e-4128-a109-######
whisk API host		https://wsk-edge.#####.com
whisk API version	v1
whisk namespace		mangal
whisk CLI version	not set
whisk API build		2018-01-29T18:32:59Z
whisk API build number	latest
Neerajs-MacBook-Pro:incubator-openwhisk-cli mangal$

neerajmangal · 2019-03-26T05:05:39Z

Fixing integration tests as they depend on output "text" of 'wsk property get' command.

mdeuser · 2019-03-26T11:59:53Z

@neerajmangal - currently, this appears to be a breaking change.. that is, existing scripts will fail when this is merged as-is. what about adding a new flag - that could be used by all commands - to specify the format of the output (i.e. json, raw, etc)

rabbah

This is awesome! Thank you for implementing this.

neerajmangal · 2019-03-26T15:57:53Z

@neerajmangal - currently, this appears to be a breaking change.. that is, existing scripts will fail when this is merged as-is. what about adding a new flag - that could be used by all commands - to specify the format of the output (i.e. json, raw, etc)

Hi @mdeuser , Yes this will possibly break existing scripts if they are using "property get" and then parsing the output.

I initially thought of adding a "--raw" option but let me know what should be the best option in this case. But I believe "-- propertyname" can be think of raw input to the command "wsk property get".

Modify existing scripts to cater to this change and add documentation about it.
Adding a new flag like "--raw" into existing commands.

mdeuser · 2019-03-26T16:44:28Z

what about a --output | -o flag that takes a single value specifying the desired output type?

./wsk property get --namespace -o json   // for future pr :-)
./wsk property get --namespace -o raw
./wsk property get --namespace -o std    // today's formatting
./wsk property get --namespace           // defaults to "std" formatting

additional output formats can be added without requiring new option flags.

neerajmangal · 2019-03-27T15:42:56Z

what about a --output | -o flag that takes a single value specifying the desired output type?
./wsk property get --namespace -o json   // for future pr :-)
./wsk property get --namespace -o raw
./wsk property get --namespace -o std    // today's formatting
./wsk property get --namespace           // defaults to "std" formatting
additional output formats can be added without requiring new option flags.

@mdeuser , I attempted an implementation as suggested.

New option --output|-o is added to property get command for now with std|raw.

./wsk property get --help
get property
Usage:
  wsk property get [flags]

Flags:
      --all             all properties
      --apibuild        whisk API build version
      --apibuildno      whisk API build number
      --apihost         whisk API host
      --apiversion      whisk API version
      --auth            authorization key
      --cert            client cert
      --cliversion      whisk CLI version
      --key             client key
      --namespace       whisk namespace
  -o, --output string   Output format in std|raw (default "std")

Global Flags:
  -d, --debug      debug level output
  -i, --insecure   bypass certificate checking
  -v, --verbose    verbose output

default behavior is "std" if no --output|-o option is provided

./wsk property get
client cert
Client key
whisk auth		23bc46b1-71f6-4ed5-8c54-xxxx
whisk API host		https://wsk-edge.xxx.com
whisk API version	v1
whisk namespace		_
whisk CLI version	2019-03-27T20:19:17.662+0530
whisk API build		2018-01-29T18:32:59Z
whisk API build number	latest

./wsk property get --all
client cert
Client key
whisk auth		23bc46b1-71f6-4ed5-8c54-xxxx
whisk API host		https://wsk-edge.xxx.com
whisk API version	v1
whisk namespace		_
whisk CLI version	2019-03-27T20:19:17.662+0530
whisk API build		2018-01-29T18:32:59Z
whisk API build number	latest

./wsk property get --namespace
whisk namespace		_

./wsk property get --apihost
whisk API host		https://wsk-edge.xxxxxx.com

With raw Option

./wsk property get --apihost --output raw
https://wsk-edge.corp.adobe.com

./wsk property get --namespace -o raw
_

If "raw" is provided with --all or without property it will return an error.

./wsk property get --output raw
error: --output|-o raw only supported with specific property type

./wsk property get --all --output raw
error: --output|-o raw only supported with specific property type

check for bugus output type.

./wsk property get --namespace -o jalskkfla
error: Supported output format are std|raw

if "std" provided with --all or without a specific property, cmd will treat it as default behavior.

/wsk property get --all -o std
client cert
Client key
whisk auth		23bc46b1-71f6-4ed5-8c54-xxxxx
whisk API host		https://wsk-edge.xxxx.com
whisk API version	v1
whisk namespace		_
whisk CLI version	2019-03-27T20:19:17.662+0530
whisk API build		2018-01-29T18:32:59Z
whisk API build number	latest

I am writing test cases for new output flag and also will update the documentation.
Let me know your feedback.

rabbah · 2019-03-27T16:15:30Z

fantastic work 👏 @neerajmangal - thanks for these contributions.

dubee

Looking good!

mdeuser · 2019-03-27T18:54:01Z

this behavior is perfect @neerajmangal ! 💯 🥇 thanks!!

mdeuser · 2019-03-27T18:55:38Z

only item for discussion could be the use of std.. i was thinking off-the-cuff on that one. would default or def be better?

neerajmangal · 2019-03-31T08:44:29Z

only item for discussion could be the use of std.. i was thinking off-the-cuff on that one. would default or def be better?

Hi @mdeuser, I think we should get cut-off default|std output type itself. I mean, if --ouput|-o is provided then it will be a formatted output as raw|json|yaml otherwise it will throw an error. If --output|-o not provided then cmd will display as of today.

Let me know your suggestions.

neerajmangal · 2019-04-05T06:38:08Z

only item for discussion could be the use of std.. i was thinking off-the-cuff on that one. would default or def be better?

Hi @mdeuser, I think we should get cut-off default|std output type itself. I mean, if --ouput|-o is provided then it will be a formatted output as raw|json|yaml otherwise it will throw an error. If --output|-o not provided then cmd will display as of today.

Let me know your suggestions.

Hi @mdeuser, please let me know your thoughts on above. I should modify "std" flag further or it should be good for now?

Thanks,
Neeraj

mdeuser · 2019-04-05T13:24:37Z

@neerajmangal - i'm not sure i entirely understand the following

I think we should get cut-off default|std output type itself.

imho, all supported output format types should be able to be specified via the --output|-o flag, including the default format used when none are specified.

rabbah · 2019-04-10T15:17:09Z

Is this ready to merge now?

neerajmangal · 2019-04-10T19:03:45Z

Hi @rabbah, I think we can merge it unless we want to rename "std" to "default" or "def".
I can take it up first thing in the morning tomorrow if this change is required.

cc @mdeuser

rabbah · 2019-04-10T19:08:39Z

std is ok with me - will wait for Mark in case he feels strongly.

rabbah · 2019-04-10T19:10:02Z

@neerajmangal do you mind sending an email to the Apache dev list about this PR - just a short description of what you've done and a link to the PR.

mdeuser · 2019-04-10T19:28:31Z

using --output|-o raw|std works for me

rabbah · 2019-04-17T15:41:09Z

Thanks @neerajmangal for this contribution.

Neeraj Mangal added 2 commits March 25, 2019 21:05

Add a raw output option to a property queried with "wsk property get"

1a2cb49

Check for option all, if given with raw options

ba42e60

Neeraj Mangal added 2 commits March 26, 2019 13:52

Fix integration and native tests

bc77aeb

Fix Travis scala tests

c7124db

rabbah reviewed Mar 26, 2019

View reviewed changes

Neeraj Mangal added 2 commits March 26, 2019 18:33

Fix format issues

0a0ee3a

Fix regex to 20.* from 201.*

293097e

Adding --output|-o raw|std options to property get command

0ec0e32

dubee reviewed Mar 27, 2019

View reviewed changes

Fix: Failed Tests cases

6567887

rabbah approved these changes Apr 17, 2019

View reviewed changes

rabbah merged commit 23de5a3 into apache:master Apr 17, 2019

Conversation

neerajmangal commented Mar 26, 2019

Uh oh!

neerajmangal commented Mar 26, 2019

Uh oh!

mdeuser commented Mar 26, 2019

Uh oh!

rabbah left a comment

Choose a reason for hiding this comment

Uh oh!

neerajmangal commented Mar 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mdeuser commented Mar 26, 2019

Uh oh!

neerajmangal commented Mar 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rabbah commented Mar 27, 2019

Uh oh!

dubee left a comment

Choose a reason for hiding this comment

Uh oh!

mdeuser commented Mar 27, 2019

Uh oh!

mdeuser commented Mar 27, 2019

Uh oh!

neerajmangal commented Mar 31, 2019

Uh oh!

neerajmangal commented Apr 5, 2019

Uh oh!

mdeuser commented Apr 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rabbah commented Apr 10, 2019

Uh oh!

neerajmangal commented Apr 10, 2019

Uh oh!

rabbah commented Apr 10, 2019

Uh oh!

rabbah commented Apr 10, 2019

Uh oh!

mdeuser commented Apr 10, 2019

Uh oh!

rabbah commented Apr 17, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

neerajmangal commented Mar 26, 2019 •

edited

Loading

neerajmangal commented Mar 27, 2019 •

edited

Loading

mdeuser commented Apr 5, 2019 •

edited

Loading