Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add postman collection and README for general workflow #782

Merged
merged 3 commits into from Mar 15, 2019

Conversation

Projects
None yet
5 participants
@mallek
Copy link
Contributor

mallek commented Feb 18, 2019

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

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Feb 19, 2019

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

@mswilkison

This comment has been minimized.

Copy link
Member

mswilkison commented Feb 20, 2019

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.

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

This comment has been minimized.

Copy link
@KPrasch

KPrasch Feb 21, 2019

Member

missing newline at EOF

@KPrasch

This comment has been minimized.

Copy link
Member

KPrasch commented Feb 21, 2019

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

@tuxxy
Copy link
Member

tuxxy left a comment

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
Copy link
Member

cygnusv left a comment

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

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

This comment has been minimized.

Copy link
Contributor Author

mallek commented Feb 22, 2019

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

This comment has been minimized.

Copy link
Member

KPrasch commented Feb 22, 2019

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

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 3, 2019

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

This comment has been minimized.

Copy link
Member

cygnusv commented Mar 3, 2019

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

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 3, 2019

@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

This comment has been minimized.

Copy link
Member

cygnusv commented Mar 3, 2019

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

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 3, 2019

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

@cygnusv

This comment has been minimized.

Copy link
Member

cygnusv commented Mar 3, 2019

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

heartbeat_demo:

"response": []
}
]
}

This comment has been minimized.

Copy link
@KPrasch

KPrasch Mar 6, 2019

Member

Missing Newline at OEF

@KPrasch
Copy link
Member

KPrasch left a comment

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

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 10, 2019

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

@KPrasch

This comment has been minimized.

Copy link
Member

KPrasch commented Mar 10, 2019

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

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 10, 2019

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

This comment has been minimized.

Copy link
Member

KPrasch commented Mar 10, 2019

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

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 10, 2019

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

@mallek mallek force-pushed the mallek:postmancollection branch from 85b8189 to 82a3815 Mar 10, 2019

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 10, 2019

This should be much better, sorry :|

@KPrasch

This comment has been minimized.

Copy link
Member

KPrasch commented Mar 10, 2019

No worries! :-)

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 10, 2019

something in my tooling keeps removing the new line..

Updates made

@KPrasch
Copy link
Member

KPrasch left a comment

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

@tuxxy

tuxxy approved these changes Mar 14, 2019

Copy link
Member

tuxxy left a comment

🐧

@KPrasch

This comment has been minimized.

Copy link
Member

KPrasch commented Mar 14, 2019

Issue #840

@mallek

This comment has been minimized.

Copy link
Contributor Author

mallek commented Mar 15, 2019

@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.

Update examples/postman/README.md
Co-Authored-By: mallek <travis@haleycomputersolutions.com>

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.