File: unitTest.R

package info (click to toggle)
futilities 270.73-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 804 kB
  • ctags: 5
  • sloc: makefile: 13
file content (182 lines) | stat: -rw-r--r-- 5,042 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Library General Public License for more details.
#
# You should have received A copy of the GNU Library General
# Public License along with this library; if not, write to the
# Free Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA  02111-1307  USA

# Copyrights (C)
# for this R-port:
#   1999 - 2008, Diethelm Wuertz, Rmetrics Foundation, GPL
#   Diethelm Wuertz <wuertz@itp.phys.ethz.ch>
#   www.rmetrics.org
# for the code accessed (or partly included) from other R-ports:
#   see R's copyright and license files
# for the code accessed (or partly included) from contributed R-ports
# and other sources
#   see Rmetrics's copyright file


################################################################################
# FUNCTION:                 DESCRIPTION:
#  .runitTest                Perorms RUnit Tests
#  .rmetricsPackages         Lists all Rmetrics packages
#  .rmetricsUnitTest         Performs RUnit tests for all Rmetrics packages
################################################################################


.runitTest <-
    function(package = "Rmetrics")
{
    # A function implemented by Diethelm Wuertz

    # Description:
    #   Performs RUnit tests

    # Example:
    #   .runitTest"fCalendar")

    # FUNCTION:

    if (!require(RUnit, quietly = TRUE))
        stop("\n -- Package RUnit not available -- \n\n")

    pkg = package
    library(package = pkg, character.only = TRUE)
    # if(!(exists("path") && file.exists(path)))
        path <- system.file("unitTests", package = pkg)

    # --- Testing ---

    # Define tests
    testSuite <- defineTestSuite(name = paste(pkg, "unit testing"), dirs = path)

    cat("Now have RUnit Test Suite 'testSuite' for package '",
        pkg, "' :\n", sep='')
    str(testSuite)
    cat('', "Consider doing",
        "\t  tests <- runTestSuite(testSuite)", "\nand later",
        "\t  printTextProtocol(tests)", '', sep = "\n")
    tests <- runTestSuite(testSuite)

    if(file.access(path, 02) != 0) {
        # cannot write to path -> use writable one
        tdir <- tempfile(paste(pkg, "unitTests", sep="_"))
        dir.create(tdir)
        pathReport <- file.path(tdir, "report")
        cat("RUnit reports are written into ", tdir, "/report.(txt|html)",
            sep = "")
    } else {
        pathReport <- file.path(path, "report")
    }

    # Print TXT Report to File:
    printTextProtocol(tests)
    printTextProtocol(tests,
        fileName = paste(pathReport, ".txt", sep = ""))

    # Print HTML Report to File:
    fileName = paste(pathReport, ".html", sep = "")
    printHTMLProtocol(tests, fileName = fileName)

    # Repair href Links:
    protocol.html = scan(file = fileName, what = character(0))
    protocol.html = gsub('href=\"', 'href=\"file://', protocol.html)
    write(protocol.html, fileName)

    # stop() if there are any failures i.e. FALSE to unit test.
    # This will cause R CMD check to return error and stop
    if(getErrors(tests)$nFail > 0) {
        stop("one of the unit tests failed")
    }

    # Check for RUnit:
    # ... do we need this ?
    cat("R package 'RUnit' cannot be loaded -- no unit tests run\n",
        "for package", pkg,"\n")

    # Where you can find me ...
    cat("\nHTML Report saved to", fileName, "\n\n")

    # Return Value:
    invisible()
}


# ------------------------------------------------------------------------------


.rmetricsPackages <-
    function()
{
    # A function implemented by Diethelm Wuertz

    # Description:
    #   Lists all Rmetrics packages

    # FUNCTION:

    # All Rmetrics Packages:
    ans = c(
        "fUtilities",
        "fEcofin",
        "fCalendar",
        "fSeries",
        "fImport",
        "fBasics",
        "fArma",
        "fGarch",
        "fNonlinear",
        "fUnitRoots",
        "fTrading",
        "fMultivar",
        "fRegression",
        "fExtremes",
        "fCopulae",
        "fOptions",
        "fExoticOptions",
        "fAsianOptions",
        "fAssets",
        "fPortfolio")

    # Return Value:
    ans
}


# ------------------------------------------------------------------------------


.rmetricsUnitTest =
    function()
{
    # A function implemented by Diethelm Wuertz

    # Description:
    #   Performs RUnit tests for all Rmetrics packages

    # FUNCTION:

    # Do Unit Tests:
    Packages = .rmetricsPackages()
    for (package in Packages) {
        cat("\n\nPackage:", package, "\n")
        .runitTest(package)
    }

    # Return Value:
    invisible()
}


################################################################################