Aether icon indicating copy to clipboard operation
Aether copied to clipboard

[FEAT] Expand compilation tests

Open aburrell opened this issue 2 years ago • 4 comments

Is your feature request related to a problem? Please describe. Current CI only tests compilation on linux

Describe the solution you'd like Tests for

  • [ ] Latest Mac OS
  • [ ] Latest Windows OS

Describe alternatives you've considered Not covering all recent OS

Additional context These tests will also reduce the start up time for new users

aburrell avatar May 31 '23 18:05 aburrell

There are now a lot of tests in the test directory. Some of these could be run as standard tests that are run when pull requests happen. I don't know how to do this on github, though.

We would need to decide which tests are "important" and should be maintained long-term, and which were good for testing a feature and may not be critical.

aaronjridley avatar Aug 15 '23 11:08 aaronjridley

Can you tell me how to run the tests from the command line? If so, I can add that to the yaml. The best way is if there's a script that provides a success/failure and we just run that. At the moment we should just run all of them. Later we can prune down.

aburrell avatar Aug 15 '23 13:08 aburrell

In the tests directory, there are a bunch of sub-directories, each one has a test in it. Inside each of these directories is a shell script called something like "run_test.sh". You just have to run that. The PROBLEM is that there is no success or failure criteria at this point. All of the tests just make plots (assuming that aetherpy is installed in a given directory, even!), so they are not incredibly useful for automated testing - although the automated tests could just see if the code crashes or not (which is something..... just not much...)

So, I think that maybe one of the students could write something that maybe reads in the log file and does a comparison with another given log file and reports the difference between the two.

The problem with that is that we then have a ton of reference log files that will all need to be updated when something fundamental changes in the code.

aaronjridley avatar Aug 15 '23 14:08 aaronjridley

That's still a start. We definitely need something at the top level that runs the tests in each directory, though.

aburrell avatar Aug 15 '23 15:08 aburrell