+
Skip to content

Urbit Testing Procedures #70

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Urbit Testing Procedures #70

wants to merge 7 commits into from

Conversation

hanfel-dovned
Copy link

Consider this a pre-draft UIP ready for criticism and potential revisions.

A couple key points to resolve before moving to Review:

  • where should the doc be located?
  • is the governance process by which the doc gets updated extrajudicial to the UIP process?

@hanfel-dovned
Copy link
Author

The governance process for Living UIPs encompasses what we need for updating the doc; the doc can be updated and hosted wherever, and then the proposer proposes a change to the pointer (along with any other changes to the Living UIP).

@hanfel-dovned
Copy link
Author

I divided the doc that this UIP previously linked to in two. The "Arvo Testing Standards" section is now contained in the body of the UIP as the formal proposal, and the "Vere" and "Evolving Practices" sections are a single Google doc centered around evolving practices.

@mopfel-winrux
Copy link
Collaborator

Some thoughts on this:

  • in each example you should state where the test will be saved and its name
  • You're missing an example for the Vane directory, even a link to the Eyre test would be useful

@hanfel-dovned hanfel-dovned marked this pull request as ready for review April 9, 2025 22:51
Copy link
Contributor

@Fang- Fang- left a comment

Choose a reason for hiding this comment

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

• where should the doc be located?

/tests/readme.md could be good as long for arvo testing instructions/expectations/discipline.

• is the governance process by which the doc gets updated extrajudicial to the UIP process?

If the doc lives in the repo it's gonna have to pass PR review at the very least. In that light, too, seems appropriate to put the doc alongside the tests in the repo where they belong. Local codeowners should generally be responsible for it, but the UIP Shadow Government would do good to keep an eye on things to make sure that's not falling out of line.

- Catching regressions that may reintroduce known vulnerabilities
- Identifying memory and runtime issues earlier in development
- Ensuring correctness of serialization, cryptographic operations, and system boundaries
- Providing a foundation for automated verification in CI
Copy link
Contributor

Choose a reason for hiding this comment

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

CI is its own whole situation. It's not obvious to me that any of the recommendations made in this doc do anything to improve that. At most it will give you more tests to potentially run during CI.

Copy link
Author

Choose a reason for hiding this comment

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

Which provides a foundation, right? :)

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean, we already have that foundation. "Having tests" doesn't answer anything about:

  • How to run the tests automatically,
  • Deciding which tests to run automatically,
  • Parsing or otherwise retrieving test output for status reports,

and maybe other things I'm not thinking of. I guess my beef here is just that CI seems very out of scope for this document, and so it shouldn't try to talk about it.

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
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载