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.

Sign up for GitHub

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

Add Test Plan #47

Merged
merged 1 commit into from
May 16, 2024
Merged

Add Test Plan #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
![CI Status](https://github.com/ethanuppal/cs3110_compiler/actions/workflows/ci.yaml/badge.svg)

> "x86 is simple trust me bro"
> Last updated: 2024-05-16 14:06:38.529127
> Last updated: 2024-05-16 15:36:15.102847

```
$ ./main -h
Expand Down
12 changes: 1 addition & 11 deletions docs/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,4 @@ By permission (and interest) of Professor Clarkson, we are using the framework A

## Plan

TODO

## Snapshot Testing

> [!NOTE]
> This section is slightly outdated.

To ensure that internal workings are correct between edits, we have a system of snapshot testing.
Based on the version in [`Meta.get.version`](../lib/meta.ml), a different suite of input-output tests will be read from the [`test/snapshots`](../test/snapshots/).
The snapshot tester will run the interpreter on all the `*.in` files and compare the standard output resulting from the execution to the corresponding `.out` file.
If they do not match, a testing error is indicated.
The [test plan](../test_plan.pdf) is available in the root directory of the repository.
Binary file added test_plan.pdf
View file
Open in desktop
Binary file not shown.
Loading