blob: 3f78953e44f3fad2015fa1eae3f741a8137e7fb6 [file] [log] [blame]
Jeremy Ronquillo6df87812017-08-28 16:17:36 +00001# 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 Ronquillob6268842017-10-03 13:02:58 -070021# please contact Jeremy Ronquillo: j_ronquillo@u.pacific.edu
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000022
23# This is the R script that generates the SCPF front page graphs.
24
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070025
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000026# **********************************************************
27# STEP 1: Data management.
28# **********************************************************
29
Devin Lim0e967162017-11-03 15:59:53 -070030database_host = 1
31database_port = 2
32database_u_id = 3
33database_pw = 4
34graph_title = 5
35branch_name = 6
36num_dates = 7
37sql_commands = 8
38y_axis = 9
39old_flow = 10
40save_directory = 11
41
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070042print( "**********************************************************" )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000043print( "STEP 1: Data management." )
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070044print( "**********************************************************" )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000045
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070046# ----------------
47# Import Libraries
48# ----------------
49
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000050print( "Importing libraries." )
51library( ggplot2 )
52library( reshape2 )
53library( RPostgreSQL )
54
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070055# -------------------
56# Check CLI Arguments
57# -------------------
58
59print( "Verifying CLI args." )
60
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000061# Command line arguments are read. Args include the database credentials, test name, branch name, and the directory to output files.
62print( "Reading commmand-line args." )
63args <- commandArgs( trailingOnly=TRUE )
64
65# Check if sufficient args are provided.
Devin Lim0e967162017-11-03 15:59:53 -070066if ( is.na( args[ save_directory ] ) ){
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070067
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 Lim0e967162017-11-03 15:59:53 -070078 "<using-old-flow>",
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070079 "<directory-to-save-graph>",
80 sep = " " ) )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000081 q() # basically exit(), but in R
82}
83
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070084# -------------------------------
85# Create Title and Graph Filename
86# -------------------------------
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000087
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070088print( "Creating title of graph" )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000089
90# Title of graph based on command line args.
Devin Lim0e967162017-11-03 15:59:53 -070091
92title <- args[ graph_title ]
Devin Lim1bba7622017-11-14 16:31:41 -080093title <- paste( title, if( args[ old_flow ] == "y" ) "\nWith Eventually Consistent Flow Rule Store" else "" )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +000094
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070095print( "Creating graph filename." )
96
97# Filenames for the output graph include the testname, branch, and the graph type.
Devin Lim0e967162017-11-03 15:59:53 -070098outputFile <- paste( args[ save_directory ],
Jeremy Ronquillo7673f802017-10-30 09:42:44 -070099 "SCPF_Front_Page_",
Devin Lim0e967162017-11-03 15:59:53 -0700100 gsub( " ", "_", args[ graph_title ] ),
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700101 "_",
Devin Lim0e967162017-11-03 15:59:53 -0700102 args[ branch_name ],
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700103 "_",
Devin Lim0e967162017-11-03 15:59:53 -0700104 args[ num_dates ],
105 "-dates",
106 if( args[ old_flow ] == "y" ) "_OldFlow" else "",
107 "_graph.jpg",
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700108 sep="" )
109
110# ------------------
111# SQL Initialization
112# ------------------
113
114print( "Initializing SQL" )
115con <- dbConnect( dbDriver( "PostgreSQL" ),
116 dbname = "onostest",
Devin Lim0e967162017-11-03 15:59:53 -0700117 host = args[ database_host ],
118 port = strtoi( args[ database_port ] ),
119 user = args[ database_u_id ],
120 password = args[ database_pw ] )
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700121
122print( "Sending SQL command:" )
Devin Lim0e967162017-11-03 15:59:53 -0700123print( args[ sql_commands ] )
124fileData <- dbGetQuery( con, args[ sql_commands ] )
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700125
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000126# **********************************************************
127# STEP 2: Organize data.
128# **********************************************************
129
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700130print( "**********************************************************" )
131print( "STEP 2: Organize Data." )
132print( "**********************************************************" )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000133
134# Create lists c() and organize data into their corresponding list.
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700135print( "Combine data retrieved from databases into a list." )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000136
137if ( ncol( fileData ) > 1 ){
138 for ( i in 2:ncol( fileData ) ){
139 fileData[ i ] <- fileData[ i - 1 ] + fileData[ i ]
140 }
141}
142
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700143# --------------------
144# Construct Data Frame
145# --------------------
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000146
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700147print( "Constructing data frame from combined data." )
148
149dataFrame <- melt( fileData )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000150dataFrame$date <- fileData$date
151
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700152colnames( dataFrame ) <- c( "Legend",
153 "Values" )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000154
155# Format data frame so that the data is in the same order as it appeared in the file.
156dataFrame$Legend <- as.character( dataFrame$Legend )
157dataFrame$Legend <- factor( dataFrame$Legend, levels=unique( dataFrame$Legend ) )
158
Jeremy Ronquillo2d2649d2017-09-14 12:53:06 -0700159# Adding a temporary iterative list to the dataFrame so that there are no gaps in-between date numbers.
160dataFrame$iterative <- rev( seq( 1, nrow( fileData ), by = 1 ) )
161
162dataFrame <- na.omit( dataFrame ) # Omit any data that doesn't exist
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000163
164print( "Data Frame Results:" )
165print( dataFrame )
166
167# **********************************************************
168# STEP 3: Generate graphs.
169# **********************************************************
170
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700171print( "**********************************************************" )
172print( "STEP 3: Generate Graph." )
173print( "**********************************************************" )
174
175# -------------------
176# Main Plot Generated
177# -------------------
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000178
179print( "Creating main plot." )
180# Create the primary plot here.
181# ggplot contains the following arguments:
182# - data: the data frame that the graph will be based off of
183# - aes: the asthetics of the graph which require:
184# - x: x-axis values (usually iterative, but it will become date # later)
185# - y: y-axis values (usually tests)
186# - color: the category of the colored lines (usually legend of test)
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700187
188mainPlot <- ggplot( data = dataFrame, aes( x = iterative,
189 y = Values,
190 color = Legend ) )
191
192# -------------------
193# Main Plot Formatted
194# -------------------
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000195
196print( "Formatting main plot." )
197
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700198limitExpansion <- expand_limits( y = 0 )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000199
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700200maxYDisplay <- max( dataFrame$Values ) * 1.05
201yBreaks <- ceiling( max( dataFrame$Values ) / 10 )
202yScaleConfig <- scale_y_continuous( breaks = seq( 0, maxYDisplay, by = yBreaks ) )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000203
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700204# ------------------------------
205# Fundamental Variables Assigned
206# ------------------------------
207
208print( "Generating fundamental graph data." )
209
210theme_set( theme_grey( base_size = 22 ) ) # set the default text size of the graph.
211xLabel <- xlab( "Build" )
Devin Lim0e967162017-11-03 15:59:53 -0700212yLabel <- ylab( args[ y_axis ] )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000213
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700214imageWidth <- 15
215imageHeight <- 10
216imageDPI <- 200
217
218# Set other graph configurations here.
219theme <- theme( axis.text.x = element_blank(),
220 axis.ticks.x = element_blank(),
221 plot.title = element_text( size = 32, face='bold', hjust = 0.5 ),
222 legend.position = "bottom",
223 legend.text = element_text( size=22 ),
224 legend.title = element_blank(),
225 legend.key.size = unit( 1.5, 'lines' ),
226 legend.direction = 'horizontal' )
227
228# Colors used for the lines.
229# Note: graphs that have X lines will use the first X colors in this list.
230colors <- scale_color_manual( values=c( "#111111", # black
231 "#008CFF", # blue
232 "#FF3700", # red
233 "#00E043", # green
234 "#EEB600", # yellow
235 "#E500FF") ) # purple (not used)
236
237wrapLegend <- guides( color = guide_legend( nrow = 2, byrow = TRUE ) )
238title <- ggtitle( title )
239
240fundamentalGraphData <- mainPlot +
241 limitExpansion +
242 yScaleConfig +
243 xLabel +
244 yLabel +
245 theme +
246 colors +
247 wrapLegend +
248 title
249
250# ----------------------------
251# Generating Line Graph Format
252# ----------------------------
253
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000254print( "Generating line graph." )
255
Jeremy Ronquilloe9063762017-10-17 15:36:09 -0700256lineGraphFormat <- geom_line( size = 0.75 )
257pointFormat <- geom_point( size = 1.75 )
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000258
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700259result <- fundamentalGraphData +
260 lineGraphFormat +
261 pointFormat
Jeremy Ronquillo0e27b912017-10-21 14:34:24 -0700262
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700263# -----------------------
264# Exporting Graph to File
265# -----------------------
266
Jeremy Ronquillo6df87812017-08-28 16:17:36 +0000267print( paste( "Saving result graph to", outputFile ) )
Jeremy Ronquillo7673f802017-10-30 09:42:44 -0700268
269ggsave( outputFile,
270 width = imageWidth,
271 height = imageHeight,
272 dpi = imageDPI )
273
274print( paste( "[SUCCESS] Successfully wrote result graph out to", outputFile ) )