-
Notifications
You must be signed in to change notification settings - Fork 129
Run compiletest on rmc documentation code #635
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
Conversation
adpaco-aws
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM modulo the comment below.
|
|
||
| # Standalone rmc tests, expected tests, and cargo tests | ||
| ./x.py test -i --stage 1 rmc firecracker prusti smack expected cargo-rmc | ||
| ./x.py test -i --stage 1 rmc firecracker prusti smack expected cargo-rmc rmc-docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought testing rmc-docs examples was going to be done by the build-docs.sh script (see the TODO comment there).
I'm okay with having it here but then we should remove the comment. Does the regression workflow need to change too? Please check.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah good point! I'll remove the comment and add another bit of documentation about how to run the tests for the docs.
The CI workflow runs the rmc-regression.sh script.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, but I recall having a discussion with you about the condition to execute build-docs.sh. Anyway, looks like it executes on Ubuntu 20.04 only - that is fine if we run them from rmc-regression.sh.
* Run compiletest on rmc documentation code * update readme and build script comments for testing documentation
* Run compiletest on rmc documentation code * update readme and build script comments for testing documentation
Description of changes:
A few findings:
src/test/so I created a symlink. (Github doesn't seem to indicate this very obviously, but that's thatsrc/test/rmc-docsis.)find . -name "*.rs"and compile each file separately, but that's fine for the doc tests, since we're only using theproptestdependency ifcfg(test)which we aren't here.rmc-verify-failbut that's fine I think since we mostly want to ensure they still build correctly. It'd be nice if we could be more precise about why they fail, but that's not easy to do, so oh wellResolved issues:
Resolves #254
Testing:
How is this change tested? it's new tests
Is this a refactor change?
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.