hello, reporter world!

Author: machow

.Rbuildignore

@@ -0,0 +1,4 @@
+^.*\.Rproj$
+^\.Rproj\.user$
+.*\.swp
+\.ipynb_checkpoints

.gitignore

@@ -0,0 +1,10 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+
+# vim swapfiles
+*.swp
+
+# ipython notebook checkpoints
+.ipynb_checkpoints

DESCRIPTION

@@ -0,0 +1,13 @@
+Package: IRkernel.testthat
+Title: What the Package Does (one line, title case)
+Version: 0.0.1
+Authors@R: person("Michael", "Chow", email = "michael@datacamp.com", role = c("aut", "cre"))
+Description: Implements reporter for communicating testthat results to a jupyter client.
+License: All Rights Reserved
+Depends: R (>= 3.3.1)
+Imports: 
+    testthat,
+    IRkernel
+Encoding: UTF-8
+LazyData: true
+RoxygenNote: 6.0.1

IRkernel.testthat.Rproj

@@ -0,0 +1,21 @@
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace

NAMESPACE

@@ -0,0 +1,4 @@
+# Generated by roxygen2: do not edit by hand
+
+export(ProjectReporter)
+export(run_tests)

R-projects-test-example.ipynb

@@ -0,0 +1,78 @@
+#' Project reporter: send test results to IRkernel, for use with DataCamp Projects.
+#'
+#' This reporter subclasses the ListReporter, to send detailed test information for
+#' use with jupyter notebooks.
+#'
+#' @export
+ProjectReporter <- R6::R6Class("ProjectReporter", inherit = testthat::ListReporter,
+  public = list(
+    all_tests = NULL,
+    comm = NULL,
+    initialize = function(..., comm) {
+      super$initialize(...)
+      self$comm <- comm
+      self$all_tests = testthat:::Stack$new()
+    },
+    end_reporter = function() {
+        test_res <- lapply(self$results$as_list(),
+                           self$dump_test)
+        test_df <- data.frame(do.call(rbind, test_res))
+
+        # summarize number of tests, etc..
+        summary <- list(
+                tests = length(test_res),
+                failures = sum(test_df$outcome == 'fail'),
+                errors = sum(test_df$outcome == 'error')
+                )
+
+        payload <- list(
+                success = all(as.logical(test_df$success)),
+                summary = summary,
+                tests = test_res
+                )
+
+        self$comm$send(payload)
+
+        payload
+    },
+    dump_test = function(test) {
+        message <- paste(
+            lapply(test$results, `[[`, 'message'),
+            collapse = '\n')
+
+        res <- testthat:::sumarize_one_test_results(test)
+        success <- !any(res$failed, res$error)
+        # figure out outcome, e.g. for counting errors later
+        if (!success) {
+            outcome <- if (res$failed) 'fail' else 'error'
+        } else outcome <- 'success'
+
+        list(name = test$test,
+             message = message,
+             success = !any(res$failed, res$error),
+             outcome = outcome)
+    }
+  ),
+  private = list(
+  )
+)
+
+#' Creates a project reporter and executes tests.
+#'
+#' @param test_expr testthat code to execute
+#'
+#' @export
+run_tests <- function(test_expr) {
+    comm <- IRkernel::comm_manager()$new_comm('dc_project')
+    comm$open()
+
+    reporter <- ProjectReporter$new(comm = comm)
+    reporter$start_file('some name')
+    env = testthat::test_env()
+    tests <- substitute(test_expr)
+    testthat::with_reporter(
+        reporter = reporter, start_end_reporter = TRUE,
+        eval(tests, envir = env)
+        )
+    reporter
+}

R/reporter-project.R

@@ -0,0 +1,71 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Checking Projects with testthat\n",
+    "-----------------------------\n",
+    "\n",
+    "In this notebook, a testthat reporter sends test output to the jupyter client.\n",
+    "To see this in action, paste this javascript into your console:\n",
+    "\n",
+    "```\n",
+    "Jupyter.notebook.kernel.comm_manager.register_target('dc_project',\n",
+    "    function(comm, msg) {\n",
+    "        // comm is the frontend comm instance\n",
+    "        // msg is the comm_open message, which can carry data\n",
+    "\n",
+    "        // Register handlers for later messages:\n",
+    "        comm.on_msg(function(msg) { console.log('msg:', msg)} );\n",
+    "        comm.on_close(function(msg) { console.log('close msg:', msg)});\n",
+    "        //comm.send({'foo': 0});\n",
+    "    })\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# TODO: load testthat funcs into an envir, or make parent?\n",
+    "library(testthat)\n",
+    "IRkernel.testthat::run_tests({\n",
+    "    test_that(\"a passing test\", {\n",
+    "        expect_equal(2, 2)\n",
+    "        expect_equal(3, 3)\n",
+    "    })\n",
+    "\n",
+    "    test_that(\"a failing test\", {\n",
+    "        expect_equal(2, 3)\n",
+    "        expect_equal(3, 4)\n",
+    "    })\n",
+    "    \n",
+    "    test_that(\"an erroring test\", {\n",
+    "        stopifnot(FALSE)\n",
+    "        expect_equat(2, 2)\n",
+    "    })\n",
+    "})"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "R",
+   "language": "R",
+   "name": "ir"
+  },
+  "language_info": {
+   "codemirror_mode": "r",
+   "file_extension": ".r",
+   "mimetype": "text/x-r-source",
+   "name": "R",
+   "pygments_lexer": "r",
+   "version": "3.3.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}