tests.qmd

# Tests {#sec-tests .unnumbered}

```{r}
#| eval: true 
#| echo: false 
#| include: false
source("_common.R")
library(shinypak)
```

Expand the callout boxes below to review what we've covered in the previous chapters on debugging:

::: {.callout-note collapse='true'}

## [Exploring Code (Chapter 10)]{style='font-size: 1.35em;'}

In the [Exploring code](debug_explore.qmd) chapter we covered: 

1. 

2. 

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 10 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 10 (Exploring code) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 10 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^10')
```

::: 

::::

:::

::: {.callout-note collapse='true'}

## [Debugging apps (Chapter 11)]{style='font-size: 1.35em;'}

In the [Debugging apps](debug_apps.qmd) chapter we covered: 

1. 

2. 

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 11 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 11 (Debugging apps) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 11 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^11')
```

::: 

::::

:::

::: {.callout-note collapse='true'}

## [Print debugging (Chapter 12)]{style='font-size: 1.35em;'}

In the [Print debugging](debug_print.qmd) chapter we covered: 

1. 

2. 

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 12 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 11 (Print debugging) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 12 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^12')
```

::: 

::::

:::

::: {.callout-note collapse='true'}

## [Utility functions (Chapter 13)]{style='font-size: 1.35em;'}

In the [Exploring code](debug_util_funs.qmd) chapter we covered: 

1. 

2. 

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 13 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 13 (Utility functions) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 13 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^13')
```

::: 

::::

:::

<!--



::: {.callout-note collapse='true'}

## [Dependencies (Chapter 6)]{style='font-size: 1.35em;'}

In [Dependencies](dependencies.qmd), we walked through:

1. How to give users of our app-package access to it's functions (i.e., exports (@sec-depends-exports)), and

2. What to do with the functions we use from other packages in the `R/` folder (i.e., imports (@sec-depends-imports))

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 6 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 6 (Dependencies) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 6 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^06')
```

::: 

::::

:::

::: {.callout-note collapse='true'}

## [Data (Chapter 7)]{style='font-size: 1.35em;'}

[Data](data.qmd) covered the three common locations for data in R packages: 

1. `data/` (@sec-data-data), 

2. `data-raw/` (@sec-data-data-raw), and

3. `inst/extdata/` (@sec-data-inst-extdata)

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 7 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 7 (Data) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 7 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^07')
```

::: 

::::

:::

::: {.callout-note collapse='true'}

## [Launch (Chapter 8)]{style='font-size: 1.35em;'}

[Launch](launch.qmd) described the differences between

1. `shinyApp()` (@sec-launch-shiny-app),

2. `runApp()` (@sec-launch-run-app), and

3. `shinyAppDir()` (@sec-launch-shiny-app-dir)

This chapter also provided some options to include in `app.R` (@sec-launch-app-dot-r) and the standalone app function (@sec-launch-standalone-app-function).

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 8 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 8 (Launch) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 8 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^08')
```

::: 

::::

:::

::: {.callout-note collapse='true'}

## [External files (Chapter 9)]{style='font-size: 1.35em;'}

[External files](external.qmd) covered how to include external files and/or resources in your app (i.e., those previously stored in `www/`): 

1. Combining `system.file()` (@sec-external-system-file) and `addResourcePath()` (@sec-external-add-resource-path), and  

2. The various uses of the `inst/` folder (@sec-inst)
<br>
    a. Alternative images and layout options (@sec-external-system-file)
<br><br>
    b. Development versions of your application using alternative data and modules (@sec-external-inst-dev)
<br><br>
    c. A production version of your application (@sec-external-inst-prod)

:::: {.callout-tip collapse='true' appearance='default'}

### [Chapter 9 Applications]{style='font-weight: bold; font-size: 1.15em;'}

::: {style='font-size: 0.95em; color: #282b2d;'}

The applications in Chapter 9 (External files) can be accessed with the `launch()` or `get()` functions from the [`shinypak` R package](https://mjfrigaard.github.io/shinypak/):

```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| eval: false
# install.packages('pak')
pak::pak('mjfrigaard/shinypak')
library(shinypak)
```

Chapter 9 applications:
  
```{r}
#| code-fold: false 
#| message: false
#| warning: false
#| collapse: true
list_apps(regex = '^09')
```

::: 

::::

:::
-->

# Testing your app

We're now ready to test the code and features in our app-package. The next section covers the following topics:

## Test suite 

[Test suite](test_suite.qmd) starts by showing how to create the `testthat` infrastructure then, dives into creating test files, the mechanics unit tests and expectations, and running tests during development

+   @sec-tests-suite-use-testthat

+   @sec-tests-suite-use-test

+   @sec-tests-suite-test-that

+   @sec-tests-suite-expectations

+   @sec-tests-suite-running-tests

This chapter also introduces keyboard shortcuts for testing and `testthat`'s behavior-driven development functions:

+   @sec-tests-suite-keyboard-shortcuts

+   @sec-tests-suite-bdd-intro

## Specifications

[Specifications](test_specs.qmd) discusses how to collect and organize information to write tests for your application: 

+   @sec-tests-specs-app-reqs 

+   @sec-tests-specs-user-specs 

+   @sec-tests-specs-features, and 

+   @sec-tests-specs-func-reqs 

This chapter also gives examples of behavior-driven development tests features and how to track specifications and tests together:

+   @sec-tests-specs-bdd-testthat 

+   @sec-tests-specs-traceability-matrix

## Test tools 

[This chapter](test_tools.qmd) introduces:

-   @sec-test-fixtures

-   @sec-test-helpers

-   @sec-test-coverage-active-file, and 

-   @sec-test-snaps-review

Each tool can contribute to testing your Shiny app-package in a unique way (they're also relatively recent additions to the `testthat` framework)


## Testing modules 

Shiny's `testServer()` function can be useful for performing integration tests with module server functions. [Testing modules](test_modules.qmd) gives examples of using `testServer()` to verify module communication (i.e., passing data between modules):

-   @sec-tests-mods-returned

-   @sec-tests-mods-args-list

-   @sec-tests-mods-coverage 

-   @sec-tests-mods-outputs

## System tests 

The [final chapter](test_system.qmd) in this section covers setting up and running system (or end-to-end tests with `shinytest2`):

-   @sec-tests-system-shinytest2

-   @sec-tests-system-recording-tests

-   @sec-tests-system-shinytest2-bdd

-   @sec-tests-system-test-mode

```{r}
#| label: git_contrib_box
#| echo: false
#| results: asis
#| eval: true
git_contrib_box()
```