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

Adding spin test documentation #1274

Merged
merged 11 commits into from
May 8, 2024
Merged

Conversation

tpmccallum
Copy link
Contributor

@tpmccallum tpmccallum commented May 7, 2024

Content must go through a pre-merge checklist.

Pre-Merge Content Checklist

This documentation has been checked to ensure that:

  • The title, template, and date are all set
  • Does this PR have a new menu item (anywhere in templates/*.hbs files) that points to a document .md that is set to publish in the future? If so please only publish the .md and .hbs changes in real-time (otherwise there will be a menu item pointing to a .md file that does not exist)
  • File does not use CRLF, but uses plain LF (hint: use cat -ve <filename> | grep '^M' | wc -l and expect 0 as a result)
  • Has passed bart check
$ bart check content/spin/v2/testing-apps.md 
✅ content/spin/v2/testing-apps.md
  • Has been manually tested by running in Spin/Bartholomew (hint: use PREVIEW_MODE=1 and run npm run styles to update styling)

image

  • Headings are using Title Case
  • Code blocks have the programming language set to properly highlight syntax and the proper copy directive
  • Have tested with npm run test and resolved all errors
  • Relates to an existing (potentially outdated) blog article? If so please add URL in blog to point to this content.

content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
running 1 test
test cache-hit ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.46s
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd actually really like to see a failure so I know how to read it.

content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
content/spin/v2/testing-apps.md Outdated Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
@rylev
Copy link
Contributor

rylev commented May 7, 2024

This seems to be the post that I wrote. I had originally meant that as a blog post and not as documentation. I'm more than happy to let this live as documentation (since that's generally longer lived anyway), but then I'm not quite sure if we want to also have a blog post, and if so what that blog post should say.

tpmccallum and others added 7 commits May 8, 2024 08:45
Signed-off-by: tpmccallum [email protected]

Co-authored-by: itowlson <[email protected]>
Signed-off-by: Timothy McCallum <[email protected]>
Signed-off-by: tpmccallum [email protected]

Co-authored-by: itowlson <[email protected]>
Signed-off-by: Timothy McCallum <[email protected]>
Signed-off-by: tpmccallum [email protected]

Co-authored-by: itowlson <[email protected]>
Signed-off-by: Timothy McCallum <[email protected]>
Signed-off-by: tpmccallum [email protected]

Co-authored-by: itowlson <[email protected]>
Signed-off-by: Timothy McCallum <[email protected]>
Signed-off-by: tpmccallum <[email protected]>
@tpmccallum tpmccallum requested a review from itowlson May 8, 2024 10:49

---

The `spin-test` plugin allows you to run tests, written in WebAssembly, against a Spin application (where all Spin and WASI APIs are configurable mocks).
Copy link
Contributor

Choose a reason for hiding this comment

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

suggest throughout:

Suggested change
The `spin-test` plugin allows you to run tests, written in WebAssembly, against a Spin application (where all Spin and WASI APIs are configurable mocks).
The `spin test` plugin allows you to run tests, written in WebAssembly, against a Spin application (where all Spin and WASI APIs are configurable mocks).

because spin-test exists only as a repo name, not as an actual command, and using this form seems to have caused a bit of confusion in the repo docs!

content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
content/spin/v2/testing-apps.md Show resolved Hide resolved
templates/spin_sidebar_v2.hbs Show resolved Hide resolved
@tpmccallum tpmccallum requested a review from itowlson May 8, 2024 21:33
Copy link
Contributor

@itowlson itowlson left a comment

Choose a reason for hiding this comment

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

As discussed, let's get this in so the blog link works, and we can keep iterating on it!

@tpmccallum tpmccallum merged commit a57d6a3 into fermyon:main May 8, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants