Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 1 | # Copyright 2017 Open Networking Foundation (ONF) |
| 2 | # |
| 3 | # Please refer questions to either the onos test mailing list at <onos-test@onosproject.org>, |
| 4 | # the System Testing Plans and Results wiki page at <https://wiki.onosproject.org/x/voMg>, |
| 5 | # or the System Testing Guide page at <https://wiki.onosproject.org/x/WYQg> |
| 6 | # |
| 7 | # TestON is free software: you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as published by |
| 9 | # the Free Software Foundation, either version 2 of the License, or |
| 10 | # (at your option) any later version. |
| 11 | # |
| 12 | # TestON is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with TestON. If not, see <http://www.gnu.org/licenses/>. |
| 19 | # |
| 20 | # If you have any questions, or if you don't understand R, |
Jeremy Ronquillo | b626884 | 2017-10-03 13:02:58 -0700 | [diff] [blame] | 21 | # please contact Jeremy Ronquillo: j_ronquillo@u.pacific.edu |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 22 | |
| 23 | # This is the R script that generates the SCPF front page graphs. |
| 24 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 25 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 26 | # ********************************************************** |
| 27 | # STEP 1: Data management. |
| 28 | # ********************************************************** |
| 29 | |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 30 | database_host = 1 |
| 31 | database_port = 2 |
| 32 | database_u_id = 3 |
| 33 | database_pw = 4 |
| 34 | graph_title = 5 |
| 35 | branch_name = 6 |
| 36 | num_dates = 7 |
| 37 | sql_commands = 8 |
| 38 | y_axis = 9 |
| 39 | old_flow = 10 |
| 40 | save_directory = 11 |
| 41 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 42 | print( "**********************************************************" ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 43 | print( "STEP 1: Data management." ) |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 44 | print( "**********************************************************" ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 45 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 46 | # ---------------- |
| 47 | # Import Libraries |
| 48 | # ---------------- |
| 49 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 50 | print( "Importing libraries." ) |
| 51 | library( ggplot2 ) |
| 52 | library( reshape2 ) |
| 53 | library( RPostgreSQL ) |
| 54 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 55 | # ------------------- |
| 56 | # Check CLI Arguments |
| 57 | # ------------------- |
| 58 | |
| 59 | print( "Verifying CLI args." ) |
| 60 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 61 | # Command line arguments are read. Args include the database credentials, test name, branch name, and the directory to output files. |
| 62 | print( "Reading commmand-line args." ) |
| 63 | args <- commandArgs( trailingOnly=TRUE ) |
| 64 | |
| 65 | # Check if sufficient args are provided. |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 66 | if ( is.na( args[ save_directory ] ) ){ |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 67 | |
| 68 | print( paste( "Usage: Rscript testresultgraph.R", |
| 69 | "<database-host>", |
| 70 | "<database-port>", |
| 71 | "<database-user-id>", |
| 72 | "<database-password>", |
| 73 | "<graph-title>", # part of the output filename as well |
| 74 | "<branch-name>", # part of the output filename |
| 75 | "<#-dates>", # part of the output filename |
| 76 | "<SQL-command>", |
| 77 | "<y-axis-title>", # y-axis may be different among other SCPF graphs (ie: batch size, latency, etc. ) |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 78 | "<using-old-flow>", |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 79 | "<directory-to-save-graph>", |
| 80 | sep = " " ) ) |
Jeremy Ronquillo | 9ea85d0 | 2017-11-27 10:21:03 -0800 | [diff] [blame] | 81 | quit( status = 1 ) # basically exit(), but in R |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 82 | } |
| 83 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 84 | # ------------------------------- |
| 85 | # Create Title and Graph Filename |
| 86 | # ------------------------------- |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 87 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 88 | print( "Creating title of graph" ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 89 | |
| 90 | # Title of graph based on command line args. |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 91 | |
| 92 | title <- args[ graph_title ] |
Devin Lim | 1bba762 | 2017-11-14 16:31:41 -0800 | [diff] [blame] | 93 | title <- paste( title, if( args[ old_flow ] == "y" ) "\nWith Eventually Consistent Flow Rule Store" else "" ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 94 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 95 | print( "Creating graph filename." ) |
| 96 | |
| 97 | # Filenames for the output graph include the testname, branch, and the graph type. |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 98 | outputFile <- paste( args[ save_directory ], |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 99 | "SCPF_Front_Page_", |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 100 | gsub( " ", "_", args[ graph_title ] ), |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 101 | "_", |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 102 | args[ branch_name ], |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 103 | "_", |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 104 | args[ num_dates ], |
| 105 | "-dates", |
| 106 | if( args[ old_flow ] == "y" ) "_OldFlow" else "", |
| 107 | "_graph.jpg", |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 108 | sep="" ) |
| 109 | |
| 110 | # ------------------ |
| 111 | # SQL Initialization |
| 112 | # ------------------ |
| 113 | |
| 114 | print( "Initializing SQL" ) |
| 115 | con <- dbConnect( dbDriver( "PostgreSQL" ), |
| 116 | dbname = "onostest", |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 117 | host = args[ database_host ], |
| 118 | port = strtoi( args[ database_port ] ), |
| 119 | user = args[ database_u_id ], |
| 120 | password = args[ database_pw ] ) |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 121 | |
| 122 | print( "Sending SQL command:" ) |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 123 | print( args[ sql_commands ] ) |
| 124 | fileData <- dbGetQuery( con, args[ sql_commands ] ) |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 125 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 126 | # ********************************************************** |
| 127 | # STEP 2: Organize data. |
| 128 | # ********************************************************** |
| 129 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 130 | print( "**********************************************************" ) |
| 131 | print( "STEP 2: Organize Data." ) |
| 132 | print( "**********************************************************" ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 133 | |
| 134 | # Create lists c() and organize data into their corresponding list. |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 135 | print( "Combine data retrieved from databases into a list." ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 136 | |
Jeremy Ronquillo | 9ea85d0 | 2017-11-27 10:21:03 -0800 | [diff] [blame] | 137 | tryCatch( if ( ncol( fileData ) > 1 ){ |
| 138 | for ( i in 2:ncol( fileData ) ){ |
| 139 | fileData[ i ] <- fileData[ i - 1 ] + fileData[ i ] |
| 140 | } |
| 141 | }, |
| 142 | error = function( e ) { |
| 143 | print( "[ERROR] One or more expected columns are missing or invalid. Please check that the SQL command is valid, then try again." ) |
| 144 | print( "Actual columns: " ) |
| 145 | print( names( fileData ) ) |
| 146 | print( "Error dump:" ) |
| 147 | print( e ) |
| 148 | quit( status = 1 ) |
| 149 | } |
| 150 | ) |
| 151 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 152 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 153 | # -------------------- |
| 154 | # Construct Data Frame |
| 155 | # -------------------- |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 156 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 157 | print( "Constructing data frame from combined data." ) |
| 158 | |
| 159 | dataFrame <- melt( fileData ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 160 | dataFrame$date <- fileData$date |
| 161 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 162 | colnames( dataFrame ) <- c( "Legend", |
| 163 | "Values" ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 164 | |
| 165 | # Format data frame so that the data is in the same order as it appeared in the file. |
| 166 | dataFrame$Legend <- as.character( dataFrame$Legend ) |
| 167 | dataFrame$Legend <- factor( dataFrame$Legend, levels=unique( dataFrame$Legend ) ) |
| 168 | |
Jeremy Ronquillo | 2d2649d | 2017-09-14 12:53:06 -0700 | [diff] [blame] | 169 | # Adding a temporary iterative list to the dataFrame so that there are no gaps in-between date numbers. |
| 170 | dataFrame$iterative <- rev( seq( 1, nrow( fileData ), by = 1 ) ) |
| 171 | |
| 172 | dataFrame <- na.omit( dataFrame ) # Omit any data that doesn't exist |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 173 | |
| 174 | print( "Data Frame Results:" ) |
| 175 | print( dataFrame ) |
| 176 | |
| 177 | # ********************************************************** |
| 178 | # STEP 3: Generate graphs. |
| 179 | # ********************************************************** |
| 180 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 181 | print( "**********************************************************" ) |
| 182 | print( "STEP 3: Generate Graph." ) |
| 183 | print( "**********************************************************" ) |
| 184 | |
| 185 | # ------------------- |
| 186 | # Main Plot Generated |
| 187 | # ------------------- |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 188 | |
| 189 | print( "Creating main plot." ) |
| 190 | # Create the primary plot here. |
| 191 | # ggplot contains the following arguments: |
| 192 | # - data: the data frame that the graph will be based off of |
| 193 | # - aes: the asthetics of the graph which require: |
| 194 | # - x: x-axis values (usually iterative, but it will become date # later) |
| 195 | # - y: y-axis values (usually tests) |
| 196 | # - color: the category of the colored lines (usually legend of test) |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 197 | |
| 198 | mainPlot <- ggplot( data = dataFrame, aes( x = iterative, |
| 199 | y = Values, |
| 200 | color = Legend ) ) |
| 201 | |
| 202 | # ------------------- |
| 203 | # Main Plot Formatted |
| 204 | # ------------------- |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 205 | |
| 206 | print( "Formatting main plot." ) |
| 207 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 208 | limitExpansion <- expand_limits( y = 0 ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 209 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 210 | maxYDisplay <- max( dataFrame$Values ) * 1.05 |
| 211 | yBreaks <- ceiling( max( dataFrame$Values ) / 10 ) |
| 212 | yScaleConfig <- scale_y_continuous( breaks = seq( 0, maxYDisplay, by = yBreaks ) ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 213 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 214 | # ------------------------------ |
| 215 | # Fundamental Variables Assigned |
| 216 | # ------------------------------ |
| 217 | |
| 218 | print( "Generating fundamental graph data." ) |
| 219 | |
| 220 | theme_set( theme_grey( base_size = 22 ) ) # set the default text size of the graph. |
| 221 | xLabel <- xlab( "Build" ) |
Devin Lim | 0e96716 | 2017-11-03 15:59:53 -0700 | [diff] [blame] | 222 | yLabel <- ylab( args[ y_axis ] ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 223 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 224 | imageWidth <- 15 |
| 225 | imageHeight <- 10 |
| 226 | imageDPI <- 200 |
| 227 | |
| 228 | # Set other graph configurations here. |
| 229 | theme <- theme( axis.text.x = element_blank(), |
| 230 | axis.ticks.x = element_blank(), |
| 231 | plot.title = element_text( size = 32, face='bold', hjust = 0.5 ), |
| 232 | legend.position = "bottom", |
| 233 | legend.text = element_text( size=22 ), |
| 234 | legend.title = element_blank(), |
| 235 | legend.key.size = unit( 1.5, 'lines' ), |
| 236 | legend.direction = 'horizontal' ) |
| 237 | |
| 238 | # Colors used for the lines. |
| 239 | # Note: graphs that have X lines will use the first X colors in this list. |
| 240 | colors <- scale_color_manual( values=c( "#111111", # black |
| 241 | "#008CFF", # blue |
| 242 | "#FF3700", # red |
| 243 | "#00E043", # green |
| 244 | "#EEB600", # yellow |
| 245 | "#E500FF") ) # purple (not used) |
| 246 | |
| 247 | wrapLegend <- guides( color = guide_legend( nrow = 2, byrow = TRUE ) ) |
| 248 | title <- ggtitle( title ) |
| 249 | |
| 250 | fundamentalGraphData <- mainPlot + |
| 251 | limitExpansion + |
| 252 | yScaleConfig + |
| 253 | xLabel + |
| 254 | yLabel + |
| 255 | theme + |
| 256 | colors + |
| 257 | wrapLegend + |
| 258 | title |
| 259 | |
| 260 | # ---------------------------- |
| 261 | # Generating Line Graph Format |
| 262 | # ---------------------------- |
| 263 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 264 | print( "Generating line graph." ) |
| 265 | |
Jeremy Ronquillo | e906376 | 2017-10-17 15:36:09 -0700 | [diff] [blame] | 266 | lineGraphFormat <- geom_line( size = 0.75 ) |
| 267 | pointFormat <- geom_point( size = 1.75 ) |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 268 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 269 | result <- fundamentalGraphData + |
| 270 | lineGraphFormat + |
| 271 | pointFormat |
Jeremy Ronquillo | 0e27b91 | 2017-10-21 14:34:24 -0700 | [diff] [blame] | 272 | |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 273 | # ----------------------- |
| 274 | # Exporting Graph to File |
| 275 | # ----------------------- |
| 276 | |
Jeremy Ronquillo | 6df8781 | 2017-08-28 16:17:36 +0000 | [diff] [blame] | 277 | print( paste( "Saving result graph to", outputFile ) ) |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 278 | |
Jeremy Ronquillo | 9ea85d0 | 2017-11-27 10:21:03 -0800 | [diff] [blame] | 279 | tryCatch( ggsave( outputFile, |
| 280 | width = imageWidth, |
| 281 | height = imageHeight, |
| 282 | dpi = imageDPI ), |
| 283 | error = function( e ){ |
| 284 | print( "[ERROR] There was a problem saving the graph due to a graph formatting exception. Error dump:" ) |
| 285 | print( e ) |
| 286 | quit( status = 1 ) |
| 287 | } |
| 288 | ) |
Jeremy Ronquillo | 7673f80 | 2017-10-30 09:42:44 -0700 | [diff] [blame] | 289 | |
| 290 | print( paste( "[SUCCESS] Successfully wrote result graph out to", outputFile ) ) |
Jeremy Ronquillo | 9ea85d0 | 2017-11-27 10:21:03 -0800 | [diff] [blame] | 291 | quit( status = 0 ) |