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

Update workshop v3 // update link #398

Open
mefellows opened this issue May 31, 2022 · 6 comments
Open

Update workshop v3 // update link #398

mefellows opened this issue May 31, 2022 · 6 comments
Labels
documentation Indicates a need for improvements or additions to documentation help wanted Indicates that a maintainer wants help on an issue or pull request

Comments

@mefellows
Copy link
Member

The README still has a link to this old workshop, which is quite outdated relative to the current status of this project.

Ideally, this workshop is updated to reflect the latest/greatest things.

Should we (in the mean time) remove the link?

See also DiUS/pact-workshop-dotnet-core-v3#1 (comment).

@adamrodger
Copy link
Contributor

I don't think it's all that outdated (the general API usage is correct and the flow is right) but it definitely needs some work. Some problems I can see:

  • Using an alpha version of PactNet from an Artifactory instance instead of latest from nuget.org
  • The tests use async void instead of async Task
  • Using .GetAwaiter().GetResult() from a sync Main instead of making it async
  • The mock server uses a hard-coded port, which is not recommended, and then creates the HttpClient once using that port. It's recommended to create the HttpClient inside the VerifyAsync lambda using the URI from the verification context
  • The diagrams are SVGs with transparent backgrounds and black text, which can't be seen in dark mode
  • There are some typo/style problems, such as the Authorization section has one test embedded inside another because of a missed closing brace

@mefellows
Copy link
Member Author

Well, I agree with all that - which is why I'm raising it ;)

We get quite a few comments/issues on that workshop and it seems to be a cause of confusion. I'm finding myself pointing people back to your examples/docs because they are up to date.e I think we should bring the workshop into the foundation (especially now the awesome 4.x.x is live 🙌 ), what do you think?

cc: @YOU54F for visibility. I don't think there is much work to do to bring it up to speed, would be a great one to see if we can get some community contributors on.

@riezebosch
Copy link

riezebosch commented Mar 22, 2023

I don't think it's all that outdated (the general API usage is correct and the flow is right) but it definitely needs some work. Some problems I can see:

  • Using an alpha version of PactNet from an Artifactory instance instead of latest from nuget.org
  • The tests use async void instead of async Task
  • Using .GetAwaiter().GetResult() from a sync Main instead of making it async
  • The mock server uses a hard-coded port, which is not recommended, and then creates the HttpClient once using that port. It's recommended to create the HttpClient inside the VerifyAsync lambda using the URI from the verification context
  • The diagrams are SVGs with transparent backgrounds and black text, which can't be seen in dark mode
  • There are some typo/style problems, such as the Authorization section has one test embedded inside another because of a missed closing brace

DiUS/pact-workshop-dotnet-core-v3#7

also updated to net6.0 and changed to minimal api and removed all unused classes.

@YOU54F
Copy link
Member

YOU54F commented Mar 22, 2023

Awesome @riezebosch - thanks for casting your eyes over and even more thanks for your PR! Will bring it to attention of the team and take it for a spin 👍🏾

@mefellows
Copy link
Member Author

Amazing! Thanks.

I think with the SVGs, we could just save them and remove transparency - that would be the simplest thing.

@YOU54F
Copy link
Member

YOU54F commented Apr 26, 2023

Thanks @riezebosch for kicking this off

To all Pact-netizens, got some goodies for you, wouldn't mind some eyes across them :)

I think we may in the very near future, to consolidate all the things.

PS. I have to say, the DSL is pact-net 4.x is quite nice, and the delta between 3.x -> 4.x isn't bad at all, especially once you've got one test converted, the rest is relatively plain sailing.

@mefellows mefellows added help wanted Indicates that a maintainer wants help on an issue or pull request documentation Indicates a need for improvements or additions to documentation labels Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation help wanted Indicates that a maintainer wants help on an issue or pull request
Projects
Status: New Issue
Development

No branches or pull requests

4 participants