Purpose of this section

This section documents the concepts, ideas and structure of the DataSHIELD testing framework.  It is aimed to develop the skills and provide the necessary information to understand how the DataSHIELD Newcastle team has designed a framework to inspire confidence with a simple design. The testing of dataSHIELD includes a continuous integration, that checks every element of DataSHIELD continues working suitably after any upgrades of operating systems, version of R and also other technologies.  A testing framework has been integrated into the continuous integration, to empower DataSHIELD developers to be part of the continuous integration and development of DataSHIELD. 

Useful example of testthat as a vignette: https://cran.r-project.org/web/packages/testthat/vignettes/custom-expectation.html

• Testing Framework
  • "Testers" documentation
    • Test-driven development and unit testing
    • Installing the testing framework
    • Writing some tests
    • Running tests locally
  • Technical documentation
    • The testing environment
    • Dataset for testing
    • Connecting to the Testing dataset
    • Definition of tests
    • Classes of tests and naming convention
• Continuous integration
  • Setting up CI using your own Azure account
  • How to use and interpret results from Azure Pipelines (Continuous Integration)
• Checking Test Coverage
• Test status
• Classification of types of test