azdavis.netPostsRSS

Test the repository

We usually write tests that check that our code behaves a certain way when we run it. However, we can use tests to check not just the behavior of programs, but the “behavior” of the entire project and all of its code files.

I learned about this idea of “testing everything” from Alex Kladov, aka matklad, and his post How to Test. It’s a great post, and I’m focusing on just one part of it in this post of mine.

Examples

In my project Millet, a language server for Standard ML, I have some repository tests, which ensure the repository itself must be a certain way.

Statics rule references

For every rule in the statics for the Definition of Standard ML, there must be exactly one place in the code that references that rule.

Manual sync

Sometimes there are places in the code that must be kept “in sync” with some other place. In this case, there must be exactly two comments that name the thing that must be kept in sync, to link them together.

Test references

There are comments above interesting or unintuitive bits of the code that make reference to tests that specifically use that interesting or unintuitive bit. These comments must refer to actual tests.

Node version

All of the following Node versions must be the same:

Documentation

Changelog

Every git tag must have a corresponding entry in the changelog.

Conclusion

Writing tests for the repository itself is a nifty trick with a lot of possible benefits:

And so on.