Add postman collection and README for general workflow #782

mallek · 2019-02-18T16:54:22Z

I added the postman collection we used at ETHDenver to the /examples/postman and added a quick readme to describe the workflow

mallek · 2019-02-19T20:58:24Z

I see a heartbeat_demo test is failing, would you like to fix that and I can merge it into this PR?

mswilkison · 2019-02-20T02:18:18Z

Hey @mallek and team - thanks for this! We're working on merging in some other pull requests but will try to give this our attention in the next several days.

KPrasch · 2019-02-21T14:34:07Z

examples/postman/dev.postman_environment.json

+	"_postman_variable_scope": "environment",
+	"_postman_exported_at": "2019-02-18T16:37:46.501Z",
+	"_postman_exported_using": "Postman/6.5.2"
+}


missing newline at EOF

KPrasch · 2019-02-21T14:34:55Z

Awesome! leaving this open for a bit as we investigate how to include the changeset in CI.

tuxxy

Everything looks good here, but my only concern is that endpoints get updated and the postman examples get left behind.

Currently, no one on the team actively uses postman. With that said, that's my only concern with this PR. If a member of the team decided to maintain this, then I think I could be +1 to this contribution. Due to the early stages of this API as well, I'm hesitant to agree to merge this in such a state. If the API was more frozen, then I can see merging this even if no one on the team was going to use postman.

cygnusv

Perhaps we can integrate in the CI workflow some command-line tool for postman, such as Newman.

examples/postman/README.md

mallek · 2019-02-22T20:31:31Z

I had also suggested a tool like newman to run the tests. I like making the calls because it allows the http context to be generated without any mocking. Because of that his will also be a good place to test things like CORS access or TLS if that is intended to be added to the product.

I also think having a postman collection may be easy for a first time user to pick up without having to read and understand the python tests.

I do want to make sure the documentation stays up to date. I think this would be done if it is truly used by the community where if it's not used it will be neglected.

KPrasch · 2019-02-22T21:23:39Z

I actually do use postman, and I think this is a nice step for lowering the bar to entry; However, our experience tells us that anything that is untested will eventually fail.

I'm looking forward to having this contribution merged if we can find a way to include in in CI.

mallek · 2019-03-03T15:18:33Z

We have identified that newman would be an appropriate way to run these tests. What additional work would you like to see done on this PR?

cygnusv · 2019-03-03T15:26:55Z

@mallek can you prepare a python script that runs it? We can use that as a basic for tests integrated in our CI

mallek · 2019-03-03T15:42:10Z

@cygnusv. Newman is a command line tool. You want me to use python to start the cli tool? The way I have done this is run it as a step in CI shelling out to run Newman.

cygnusv · 2019-03-03T15:44:56Z

No need to use python to run the CLI, I think. Just specify what are the newman commands we need to run, and we can integrate them in the CI workflow.

mallek · 2019-03-03T15:54:47Z

Is there a set of running actors available to hit via http during the CI process?

cygnusv · 2019-03-03T16:08:07Z

We prefer to deploy them locally in the test workflow. See this test as an example, which deploys a fleet or Ursulas to test the heartbeat demo

nucypher/.circleci/config.yml

Line 444 in ec6b754

heartbeat_demo:

KPrasch · 2019-03-06T16:05:34Z

examples/postman/NuCypher.postman_collection.json

+			"response": []
+		}
+	]
+}


Missing Newline at OEF

KPrasch

The HTTP Character Control API has been updated. For example "signing_key" is now "verifying_key" in all cases.

mallek · 2019-03-10T16:56:02Z

I rebased this PR from #820 and made the changes requested

KPrasch · 2019-03-10T17:14:46Z

Heh - looks like you picked up an extra 172 commits there! (perhaps due to diverged history.)

mallek · 2019-03-10T17:20:18Z

Interesting I show a clean rebase from master. I haven't worked much with upstream only origin so i'll play around with it and see if i can get it. If not since it's just documentation I can just create a new PR from master

KPrasch · 2019-03-10T17:21:45Z

Be sure to add nucypher/nucypher as an upstream remote, and rebase over upstream/master after a fresh git remote update

mallek · 2019-03-10T17:22:40Z

that was it, I rebased over origin/master I'll try it... thanks

mallek · 2019-03-10T17:40:57Z

This should be much better, sorry :|

KPrasch · 2019-03-10T17:41:28Z

No worries! :-)

mallek · 2019-03-10T17:44:43Z

something in my tooling keeps removing the new line..

Updates made

KPrasch

This will need automated testing - so we'll follow up with an Issue. Approved - Thanks for the contribution!

tuxxy

🐧

KPrasch · 2019-03-14T21:17:13Z

Issue #840

mallek · 2019-03-15T18:56:44Z

@tuxxy @KPrasch I understand that the automated tests need to be integrated to accept this PR, I however do not feel comfortable coding this into the CI. If someone wants to take the ball and do that great if not I can close this PR.

Co-Authored-By: mallek <travis@haleycomputersolutions.com>

KPrasch self-requested a review February 21, 2019 14:09

KPrasch added Enhancement New or improved features documentation Effects the official documentation Automation General automation concerns labels Feb 21, 2019

KPrasch reviewed Feb 21, 2019

View reviewed changes

tuxxy reviewed Feb 22, 2019

View reviewed changes

cygnusv reviewed Feb 22, 2019

View reviewed changes

examples/postman/README.md Outdated Show resolved Hide resolved

KPrasch reviewed Mar 6, 2019

View reviewed changes

examples/postman/NuCypher.postman_collection.json Outdated

"response": []

}

]

}

Copy link

Member

KPrasch Mar 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing Newline at OEF

KPrasch previously requested changes Mar 6, 2019

View reviewed changes

mallek and others added 2 commits March 10, 2019 11:34

Add postman collection and README for general workflow

ee4e4a5

Updated to use verifying_key also added EOF as requested

82a3815

mallek force-pushed the postmancollection branch from 85b8189 to 82a3815 Compare March 10, 2019 17:39

KPrasch approved these changes Mar 14, 2019

View reviewed changes

tuxxy approved these changes Mar 14, 2019

View reviewed changes

Update examples/postman/README.md

6a40e8d

Co-Authored-By: mallek <travis@haleycomputersolutions.com>

tuxxy merged commit eb13d35 into nucypher:master Mar 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add postman collection and README for general workflow #782

Add postman collection and README for general workflow #782

mallek commented Feb 18, 2019

mallek commented Feb 19, 2019

mswilkison commented Feb 20, 2019

KPrasch Feb 21, 2019

KPrasch commented Feb 21, 2019

tuxxy left a comment •

edited

Loading

cygnusv left a comment

mallek commented Feb 22, 2019

KPrasch commented Feb 22, 2019

mallek commented Mar 3, 2019

cygnusv commented Mar 3, 2019

mallek commented Mar 3, 2019

cygnusv commented Mar 3, 2019

mallek commented Mar 3, 2019

cygnusv commented Mar 3, 2019

KPrasch Mar 6, 2019

KPrasch left a comment •

edited

Loading

mallek commented Mar 10, 2019

KPrasch commented Mar 10, 2019

mallek commented Mar 10, 2019

KPrasch commented Mar 10, 2019

mallek commented Mar 10, 2019

mallek commented Mar 10, 2019

KPrasch commented Mar 10, 2019

mallek commented Mar 10, 2019

KPrasch left a comment

tuxxy left a comment

KPrasch commented Mar 14, 2019

mallek commented Mar 15, 2019

Add postman collection and README for general workflow #782

Add postman collection and README for general workflow #782

Conversation

mallek commented Feb 18, 2019

mallek commented Feb 19, 2019

mswilkison commented Feb 20, 2019

KPrasch Feb 21, 2019

Choose a reason for hiding this comment

KPrasch commented Feb 21, 2019

tuxxy left a comment • edited Loading

Choose a reason for hiding this comment

cygnusv left a comment

Choose a reason for hiding this comment

mallek commented Feb 22, 2019

KPrasch commented Feb 22, 2019

mallek commented Mar 3, 2019

cygnusv commented Mar 3, 2019

mallek commented Mar 3, 2019

cygnusv commented Mar 3, 2019

mallek commented Mar 3, 2019

cygnusv commented Mar 3, 2019

KPrasch Mar 6, 2019

Choose a reason for hiding this comment

KPrasch left a comment • edited Loading

Choose a reason for hiding this comment

mallek commented Mar 10, 2019

KPrasch commented Mar 10, 2019

mallek commented Mar 10, 2019

KPrasch commented Mar 10, 2019

mallek commented Mar 10, 2019

mallek commented Mar 10, 2019

KPrasch commented Mar 10, 2019

mallek commented Mar 10, 2019

KPrasch left a comment

Choose a reason for hiding this comment

tuxxy left a comment

Choose a reason for hiding this comment

KPrasch commented Mar 14, 2019

mallek commented Mar 15, 2019

tuxxy left a comment •

edited

Loading

KPrasch left a comment •

edited

Loading