Add initial tests for the support_panel function

.Rbuildignore

@@ -1,2 +1,4 @@
 ^dfeshiny\.Rproj$
 ^\.Rproj\.user$
+^\.github$
+^codecov\.yml$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,49 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true

.github/workflows/test-coverage.yaml

@@ -0,0 +1,50 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: test-coverage
+
+jobs:
+  test-coverage:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::covr
+          needs: coverage
+
+      - name: Test coverage
+        run: |
+          covr::codecov(
+            quiet = FALSE,
+            clean = FALSE,
+            install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
+          )
+        shell: Rscript {0}
+
+      - name: Show testthat output
+        if: always()
+        run: |
+          ## --------------------------------------------------------------------
+          find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-test-failures
+          path: ${{ runner.temp }}/package

DESCRIPTION

@@ -1,9 +1,11 @@
 Package: dfeshiny
 Title: DfE R-Shiny Standards
 Version: 0.1.1
-Authors@R: 
+Authors@R: c(
     person("Rich", "Bielby", , "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "0000-0001-9070-9969"))
+    comment = c(ORCID = "0000-0001-9070-9969")),
+    person("Cameron", "Race", , "[email protected]", role = c("aut"))
+    )
 Description: R package containing preferred methods for creating official DfE R-Shiny dashboards.
 License: `use_gpl3_license()`
 Encoding: UTF-8
@@ -13,3 +15,6 @@ Imports:
     styler
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
+Suggests: 
+    testthat (>= 3.0.0)
+Config/testthat/edition: 3

R/standard_panels.R

@@ -6,7 +6,7 @@
 #' @description
 #' Create the standard DfE R-Shiny support and feedback dashboard panel.
 #'
-#' @param team_email Your team e-mail address as a string
+#' @param team_email Your team e-mail address as a string, this must be a education.gov.uk email
 #' @param repo_name The repository name as listed on GitHub
 #' @param ees_publication Whether the parent publication is hosted on Explore Education Statistics
 #' @param publication_name The parent publication name
@@ -26,80 +26,105 @@
     publication_stub = "",
     alt_href = NULL,
     form_url = NULL) {
-  tabPanel(
+
+  # Check that the team_email is a valid email
+  is_valid_dfe_email <- function(email) {
+    grepl(
+      "\\<[A-Z0-9._%+-][email protected]\\>",
+      as.character(email),
+      ignore.case = TRUE
+    )
+  }
+
+  if (is_valid_dfe_email(team_email) == FALSE) {
+    stop(
+      "You have entered an invalid email in the team_email argument.
+      Please enter a @education.gov.uk email.")
+  }
+
+
+  shiny::tabPanel(
     "Support and feedback",
-    gov_main_layout(
-      gov_row(
-        column(
+    shinyGovstyle::gov_main_layout(
+      shinyGovstyle::gov_row(
+        shiny::column(
           width = 12,
-          h1("Support and feedback"),
-          h2("Give us feedback"),
+          shiny::tags$h1("Support and feedback"),
+          shiny::tags$h2("Give us feedback"),
           if (!is.null(form_url)) {
-            p(
-              "This dashboard is a new service that we are developing. If you have any feedback or suggestions for improvements, please submit them using our ",
-              a(href = form_url, "feedback form", .noWS = c("after"))
+            shiny::tags$p(
+              "This dashboard is a new service that we are developing.
+              If you have any feedback or suggestions for improvements,
+              please submit them using our ",
+              shiny::tags$a(href = form_url, "feedback form", .noWS = c("after"))
             )
           } else {
-            p("This dashboard is a new service that we are developing.")
+            shiny::tags$p("This dashboard is a new service that we are developing.")
           },
-          p(
+          shiny::tags$p(
             paste0(
               ifelse(
                 !is.null(form_url),
                 "Alternatively, i",
                 "I"
               ),
-              "f you spot any errors or bugs while using this dashboard, please screenshot and email them to "
+              "f you spot any errors or bugs while using this dashboard,
+              please screenshot and email them to "
             ),
-            tags$a(href = paste0("mailto:", team_email), team_email, .noWS = c("after")), "."
+            shiny::tags$a(
+              href = paste0("mailto:", team_email),
+              team_email,
+              .noWS = c("after")),
+            "."
           ),
-          h2("Find more information on the data"),
-            if (ees_publication) {
-              p(
-                "The parent statistical release of this dashboard, along with methodological information, is available at the following link: ",
-                tags$a(
-                  href = paste0("https://explore-education-statistics.service.gov.uk/find-statistics/", publication_stub),
-                  ifelse(!is.null(publication_name), publication_name, "Explore Education Statistics"),
-                  .noWS = c("after")
-                ),
-                ". The statistical release provides additional ",
-                tags$a(
-                  href = paste0("https://explore-education-statistics.service.gov.uk/find-statistics/", publication_stub, "/data guidance"),
-                  "data guidance",
-                  .noWS = c("after")
-                ),
-                " and ",
-                tags$a(
-                  href = paste0("https://explore-education-statistics.service.gov.uk/find-statistics/", publication_stub,'#explore-data-and-files'),
-                  "tools to access and interogate the underling data",
-                  .noWS = c("after")
-                ),
+          shiny::tags$h2("Find more information on the data"),
+          if (ees_publication) {
+            shiny::tags$p(
+              "The parent statistical release of this dashboard,
+              along with methodological information, is available at the following link: ",
+              shiny::tags$a(
+                href = paste0("https://explore-education-statistics.service.gov.uk/find-statistics/", publication_stub),
+                ifelse(!is.null(publication_name), publication_name, "Explore Education Statistics"),
+                .noWS = c("after")
+              ),
+              ". The statistical release provides additional ",
+              shiny::tags$a(
+                href = paste0("https://explore-education-statistics.service.gov.uk/find-statistics/", publication_stub, "/data guidance"),
+                "data guidance",
+                .noWS = c("after")
+              ),
+              " and ",
+              shiny::tags$a(
+                href = paste0("https://explore-education-statistics.service.gov.uk/find-statistics/", publication_stub, "#explore-data-and-files"),
+                "tools to access and interogate the underling data",
+                .noWS = c("after")
+              ),
               " contained in this dashboard."
-              )
-            } else {
-              p(
-                "The parent statistical release of this dashboard, along with methodological information, is available at the following link: ",
-                a(
+            )
+          } else {
+            shiny::tags$p(
+              "The parent statistical release of this dashboard, along with methodological information, is available at the following link: ",
+              shiny::tags$a(
                 href = alt_href,
                 publication_name,
                 .noWS = c("after")
               )
-              )
-            },
-          h2("Contact us"),
-          p(
+            )
+          },
+          shiny::tags$h2("Contact us"),
+          shiny::tags$p(
             "If you have questions about the dashboard or data within it, please contact us at ",
-            a(href = paste0("mailto:", team_email), team_email, .noWS = c("after"))
+            shiny::tags$a(href = paste0("mailto:", team_email), team_email, .noWS = c("after"))
           ),
-          h2("See the source code"),
-          p(
+          shiny::tags$h2("See the source code"),
+          shiny::tags$p(
             "The source code for this dashboard is available in our ",
-            a(href = paste0("https://github.com/dfe-analytical-services/", repo_name), "GitHub repository", .noWS = c("after")),
+            shiny::tags$a(href = paste0("https://github.com/dfe-analytical-services/", repo_name), "GitHub repository", .noWS = c("after")),
             "."
           ),
-          h2("Use of cookies"),
-          textOutput("cookie_status"),
-          actionButton("remove", "Reset cookie consent"),
+          shiny::tags$h2("Use of cookies"),
+          shiny::textOutput("cookie_status"),
+          shiny::actionButton("remove", "Reset cookie consent"),
         )
       )
     )

README.md

@@ -1,9 +1,33 @@
+ <!-- badges: start -->
+  [![R-CMD-check](https://github.com/dfe-analytical-services/dfeshiny/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dfe-analytical-services/dfeshiny/actions/workflows/R-CMD-check.yaml)
+[![Codecov test coverage](https://codecov.io/gh/dfe-analytical-services/dfeshiny/branch/main/graph/badge.svg)](https://app.codecov.io/gh/dfe-analytical-services/dfeshiny?branch=main)
+
+  <!-- badges: end -->
+
 # dfeshiny
 R package containing preferred methods for creating official DfE R-Shiny dashboards 
 
 # Contributing
 
-Try and make use of the [usethis](https://usethis.r-lib.org/) package wherever possible.
+Try and make use of the `usethis` package wherever relevant: [https://usethis.r-lib.org/](https://usethis.r-lib.org/)
+
+When you initially clone the package, the first thing you'll need to do is install `devtools`:
+
+`install.packages("devtools")`
+
+Then to load in the package in its current form:
+
+`devtools::load_all()`
+
+## Run the unit tests
+
+Once the package is loaded in you can run the tests locally in a couple of ways:
+
+`Ctrl-Shft-T`
+
+or via the function that triggers
+
+`devtools::test()`
 
 ## Adding a package/dependency
 
@@ -17,6 +41,7 @@ This will create a new script within the package R/ folder.
 
 This will create a new script within the package R/ folder.
 
+
 ## Updating the package version
 
 Once changes have been completed, reviewed and are ready for use in the wild, you

codecov.yml

@@ -0,0 +1,14 @@
+comment: false
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        informational: true
+    patch:
+      default:
+        target: auto
+        threshold: 1%
+        informational: true

tests/testthat.R

@@ -0,0 +1,12 @@
+# This file is part of the standard setup for testthat.
+# It is recommended that you do not modify it.
+#
+# Where should you do additional test configuration?
+# Learn more about the roles of various files in:
+# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview
+# * https://testthat.r-lib.org/articles/special-files.html
+
+library(testthat)
+library(dfeshiny)
+
+test_check("dfeshiny")

tests/testthat/test-support-panel.R

@@ -0,0 +1,18 @@
+test_that("email needs to follow standard pattern", {
+  # Test that a @education.gov.uk passes
+  expect_no_error(support_panel(team_email = "[email protected]"))
+  expect_no_error(support_panel(team_email = "[email protected]"))
+
+  # Testing that it will fail if it follows the [email protected] pattern
+  expect_error(support_panel(team_email = "[email protected]"))
+  expect_error(support_panel(team_email = "[email protected]"))
+
+  # Testing that it will fail if there is no final dot and section
+  expect_error(support_panel(team_email = "thisshoulfail@something"))
+
+  # Test Wales will fail
+  expect_error(support_panel(team_email = "[email protected]"))
+
+  # Test that it fails if there is no @ symbol
+  expect_error(support_panel(team_email = "team.team"))
+})