Lynx Portal | Improve this page

Testing your Lab

  1. Running automated tests on your system
  2. Push commits to Github and review results of automated testing via web

Running automated tests on your system

  • When you're done with a notebook, make sure it is saved (Ctrl+S) and close the tab.

  • Make sure all the packages needed to run your test code are installed. 

cd REPO_DIR
julia --project -e 'using Pkg; Pkg.instantiate(); Pkg.activate("test"); Pkg.instantiate(); '

  • Make sure all all the packages need to run the notebook you want to test are installed. For example, for a notebook named ex1.jl, you would do

cd REPO_DIR
julia -e 'using Pkg, Pluto; Pluto.activate_notebook_environment("ex1.jl"); Pkg.instantiate(); '

If there are multiple notebooks to test, then you can combine this for multiple notebook files in one command such as

cd REPO_DIR
julia -e 'using Pkg, Pluto; Pluto.activate_notebook_environment("ex1.jl"); Pkg.instantiate();   Pluto.activate_notebook_environment("ex2.jl"); Pkg.instantiate(); '

In many cases this step will be unnecessary because the packages will have been installed what you ran the Pluto notebook. But this can become important in some scenarios such as if you add or upgrade any packages. (This can happen implicitly if you do some work within a notebook on another computer that has a different version of Julia or Pluto installed).

  • Run the tests for first notebook

cd REPO_DIR
julia --project -e 'cd("test"); include("test1.jl")'

or run tets for all the notebooks like

cd REPO_DIR
julia --project -e 'cd("test"); include("runtests.jl")'

  • Inspect the test report results and identify any areas that you want to revisit before submitting.

  • Once you're happy with the results (or run out of time) commit your changes and submit.

Push commits to Github and review results of automated testing via web

  • Return to the terminal tab, make sure you're in your repo's directory.

  • Commit your changes to your local repository and submit by pushing to your GitHub repository.

  • For repositories that are configured to apply tests via continuous integration, you can navigate to your repository's webpage, click Actions, then look under "All Workflows" and choose "Test notebooks". There will be some tests of early versions that have red x's next to them. Hopefully, your latest submission (typically at the top of the list) will have a green checkbox next to it. If not, then you can click on that commit string, then click "test (...)" and see the results of the continuous integration tests.