[ONOS-7175]: Refractor R Scripts that generate wiki result graphs in TestON.
- Code is "chunked"; blocks of code are sectioned into sub-steps.
- Many comments have been added and updated.
- Many console messages have been added and updated.
Change-Id: I86853b4a3917d807e634311b672ab6d6d57b1194
diff --git a/TestON/JenkinsFile/scripts/SCPFintentEventTp.R b/TestON/JenkinsFile/scripts/SCPFintentEventTp.R
index 471fc7a..53fe2d4 100644
--- a/TestON/JenkinsFile/scripts/SCPFintentEventTp.R
+++ b/TestON/JenkinsFile/scripts/SCPFintentEventTp.R
@@ -21,88 +21,151 @@
# please contact Jeremy Ronquillo: j_ronquillo@u.pacific.edu
# **********************************************************
-# STEP 1: File management.
+# STEP 1: Data management.
# **********************************************************
-print( "STEP 1: File management." )
+print( "**********************************************************" )
+print( "STEP 1: Data management." )
+print( "**********************************************************" )
-# Command line arguments are read. Args usually include the database filename and the output
-# directory for the graphs to save to.
+# Command line arguments are read.
print( "Reading commmand-line args." )
args <- commandArgs( trailingOnly=TRUE )
-# Import libraries to be used for graphing and organizing data, respectively.
-# Find out more about ggplot2: https://github.com/tidyverse/ggplot2
-# reshape2: https://github.com/hadley/reshape
+# ----------------
+# Import Libraries
+# ----------------
+
print( "Importing libraries." )
library( ggplot2 )
library( reshape2 )
library( RPostgreSQL ) # For databases
-# Normal usage
-# Check if sufficient args are provided.
+# -------------------
+# Check CLI Arguments
+# -------------------
+
+print( "Verifying CLI args." )
+
if ( is.na( args[ 9 ] ) ){
- print( "Usage: Rscript SCPFIntentEventTp.R <has-flow-obj> <database-host> <database-port> <database-user-id> <database-password> <test-name> <branch-name> <has-neighbors> <directory-to-save-graphs>" )
+
+ print( paste( "Usage: Rscript SCPFIntentEventTp.R",
+ "<has-flow-obj>",
+ "<database-host>",
+ "<database-port>",
+ "<database-user-id>",
+ "<database-password>",
+ "<test-name>",
+ "<branch-name>",
+ "<has-neighbors>",
+ "<directory-to-save-graphs>",
+ sep=" " ) )
+
q() # basically exit(), but in R
}
-# paste() is used to concatenate strings.
-errBarOutputFile <- paste( args[ 9 ], args[ 6 ], sep="" )
-errBarOutputFile <- paste( errBarOutputFile, args[ 7 ], sep="_" )
-if ( args[ 8 ] == 'y' ){
- errBarOutputFile <- paste( errBarOutputFile, "all-neighbors", sep="_" )
-} else {
- errBarOutputFile <- paste( errBarOutputFile, "no-neighbors", sep="_" )
-}
-if ( args[ 1 ] == 'y' ){
- errBarOutputFile <- paste( errBarOutputFile, "flowObj", sep="_")
-}
-errBarOutputFile <- paste( errBarOutputFile, "_graph.jpg", sep="" )
+# -----------------
+# Create File Names
+# -----------------
-print( "Reading from databases." )
-con <- dbConnect( dbDriver( "PostgreSQL" ), dbname="onostest", host=args[ 2 ], port=strtoi( args[ 3 ] ), user=args[ 4 ],password=args[ 5 ] )
+print( "Creating filenames and title of graph." )
+chartTitle <- "Intent Event Throughput"
+fileNeighborsModifier <- "no"
commandNeighborModifier <- ""
-flowObjModifier <- ""
+fileFlowObjModifier <- ""
+sqlFlowObjModifier <- ""
+
if ( args[ 1 ] == 'y' ){
- flowObjModifier <- "_fobj"
+ fileFlowObjModifier <- "_flowObj"
+ sqlFlowObjModifier <- "_fobj"
+ chartTitle <- paste( chartTitle, " with Flow Objectives", sep="" )
}
+
+chartTitle <- paste( chartTitle, "\nevents/second with Neighbors =", sep="" )
+
if ( args[ 8 ] == 'y' ){
+ fileNeighborsModifier <- "all"
commandNeighborModifier <- "scale=1 OR NOT "
+ chartTitle <- paste( chartTitle, "all" )
+} else {
+ chartTitle <- paste( chartTitle, "0" )
}
-command <- paste( "SELECT scale, SUM( avg ) as avg FROM intent_tp", flowObjModifier, sep="" )
-command <- paste( command, "_tests WHERE (", sep="" )
-command <- paste( command, commandNeighborModifier, sep="" )
-command <- paste( command, "neighbors = 0 ) AND branch = '", sep="")
-command <- paste( command, args[ 7 ], sep="" )
-command <- paste( command, "' AND date IN ( SELECT max( date ) FROM intent_tp", sep="" )
-command <- paste( command, flowObjModifier, sep="" )
-command <- paste( command, "_tests WHERE branch='", sep="" )
-command <- paste( command, args[ 7 ], sep="" )
-command <- paste( command, "' ) GROUP BY scale ORDER BY scale", sep="" )
+errBarOutputFile <- paste( args[ 9 ],
+ args[ 6 ],
+ "_",
+ args[ 7 ],
+ "_",
+ fileNeighborsModifier,
+ "-neighbors",
+ fileFlowObjModifier,
+ "_graph.jpg",
+ sep="" )
-print( paste( "Sending SQL command:", command ) )
+# ------------------
+# SQL Initialization
+# ------------------
+
+print( "Initializing SQL" )
+
+con <- dbConnect( dbDriver( "PostgreSQL" ),
+ dbname = "onostest",
+ host = args[ 2 ],
+ port = strtoi( args[ 3 ] ),
+ user = args[ 4 ],
+ password = args[ 5 ] )
+
+# -----------------------------------
+# Intent Event Throughput SQL Command
+# -----------------------------------
+
+print( "Generating Intent Event Throughput SQL command." )
+
+command <- paste( "SELECT scale, SUM( avg ) as avg FROM intent_tp",
+ sqlFlowObjModifier,
+ "_tests WHERE (",
+ commandNeighborModifier,
+ "neighbors = 0 ) AND branch = '",
+ args[ 7 ],
+ "' AND date IN ( SELECT max( date ) FROM intent_tp",
+ sqlFlowObjModifier,
+ "_tests WHERE branch='",
+ args[ 7 ],
+ "' ) GROUP BY scale ORDER BY scale",
+ sep="" )
+
+print( "Sending SQL command:" )
+print( command )
fileData <- dbGetQuery( con, command )
-title <- paste( args[ 6 ], args[ 7 ], sep="_" )
-
# **********************************************************
# STEP 2: Organize data.
# **********************************************************
-print( "STEP 2: Organize data." )
+print( "**********************************************************" )
+print( "STEP 2: Organize Data." )
+print( "**********************************************************" )
-# Create lists c() and organize data into their corresponding list.
+# ------------
+# Data Sorting
+# ------------
+
print( "Sorting data." )
avgs <- c( fileData[ 'avg' ] )
-# Parse lists into data frames.
+# --------------------
+# Construct Data Frame
+# --------------------
+
+print( "Constructing data frame." )
dataFrame <- melt( avgs ) # This is where reshape2 comes in. Avgs list is converted to data frame
dataFrame$scale <- fileData$scale # Add node scaling to the data frame.
-colnames( dataFrame ) <- c( "throughput", "type", "scale" )
+colnames( dataFrame ) <- c( "throughput",
+ "type",
+ "scale" )
dataFrame <- na.omit( dataFrame ) # Omit any data that doesn't exist
@@ -114,18 +177,15 @@
# STEP 3: Generate graphs.
# **********************************************************
-print( "STEP 3: Generate graphs." )
+print( "**********************************************************" )
+print( "STEP 3: Generate Graph." )
+print( "**********************************************************" )
-# 1. Graph fundamental data is generated first.
-# These are variables that apply to all of the graphs being generated, regardless of type.
-#
-# 2. Type specific graph data is generated.
-#
-# 3. Generate and save the graphs.
-# Graphs are saved to the filename above, in the directory provided in command line args
+# ------------------
+# Generate Main Plot
+# ------------------
-print( "Generating fundamental graph data." )
-
+print( "Generating main plot." )
# Create the primary plot here.
# ggplot contains the following arguments:
# - data: the data frame that the graph will be based off of
@@ -133,41 +193,74 @@
# - x: x-axis values (usually node scaling)
# - y: y-axis values (usually time in milliseconds)
# - fill: the category of the colored side-by-side bars (usually type)
-theme_set( theme_grey( base_size = 22 ) ) # set the default text size of the graph.
-mainPlot <- ggplot( data = dataFrame, aes( x = scale, y = throughput, fill = type ) )
+mainPlot <- ggplot( data = dataFrame, aes( x = scale,
+ y = throughput,
+ fill = type ) )
+# ------------------------------
+# Fundamental Variables Assigned
+# ------------------------------
+
+print( "Generating fundamental graph data." )
# Formatting the plot
+theme_set( theme_grey( base_size = 22 ) ) # set the default text size of the graph.
width <- 0.7 # Width of the bars.
xScaleConfig <- scale_x_continuous( breaks = dataFrame$scale, label = dataFrame$scale )
xLabel <- xlab( "Scale" )
yLabel <- ylab( "Throughput (events/second)" )
fillLabel <- labs( fill="Type" )
-chartTitle <- "Intent Event Throughput"
-if ( args[ 1 ] == 'y' ){
- chartTitle <- paste( chartTitle, " With Flow Objectives", sep="" )
-}
-chartTitle <- paste( chartTitle, "\nevents/second with Neighbors =", sep="" )
-if ( args[ 8 ] == 'y' ){
- chartTitle <- paste( chartTitle, "all" )
-} else {
- chartTitle <- paste( chartTitle, "0" )
-}
+imageWidth <- 15
+imageHeight <- 10
+imageDPI <- 200
-theme <- theme( plot.title=element_text( hjust = 0.5, size = 32, face='bold' ), legend.position="bottom", legend.text=element_text( size=18, face="bold" ), legend.title = element_blank() )
-values <- geom_text( aes( x=dataFrame$scale, y=dataFrame$throughput + 0.03 * max( dataFrame$throughput ), label = format( dataFrame$throughput, digits=3, big.mark = ",", scientific = FALSE ) ), size = 7, fontface = "bold" )
+theme <- theme( plot.title = element_text( hjust = 0.5, size = 32, face = 'bold' ),
+ legend.position = "bottom",
+ legend.text = element_text( size = 18, face = "bold" ),
+ legend.title = element_blank() )
+
+values <- geom_text( aes( x = dataFrame$scale,
+ y = dataFrame$throughput + 0.03 * max( dataFrame$throughput ),
+ label = format( dataFrame$throughput,
+ digits=3,
+ big.mark = ",",
+ scientific = FALSE ) ),
+ size = 7,
+ fontface = "bold" )
# Store plot configurations as 1 variable
-fundamentalGraphData <- mainPlot + xScaleConfig + xLabel + yLabel + fillLabel + theme + values
+fundamentalGraphData <- mainPlot +
+ xScaleConfig +
+ xLabel +
+ yLabel +
+ fillLabel +
+ theme +
+ values
+# ---------------------------
+# Generating Bar Graph Format
+# ---------------------------
print( "Generating bar graph." )
-barGraphFormat <- geom_bar( stat = "identity", width = width, fill="#169EFF" )
-title <- ggtitle( paste( chartTitle, "" ) )
-result <- fundamentalGraphData + barGraphFormat + title
+barGraphFormat <- geom_bar( stat = "identity",
+ width = width,
+ fill = "#169EFF" )
-# Save graph to file
+title <- ggtitle( chartTitle )
+
+result <- fundamentalGraphData +
+ barGraphFormat +
+ title
+
+# -----------------------
+# Exporting Graph to File
+# -----------------------
+
print( paste( "Saving bar chart to", errBarOutputFile ) )
-ggsave( errBarOutputFile, width = 15, height = 10, dpi = 200 )
-print( paste( "Successfully wrote bar chart out to", errBarOutputFile ) )
+ggsave( errBarOutputFile,
+ width = imageWidth,
+ height = imageHeight,
+ dpi = imageDPI )
+
+print( paste( "[SUCCESS] Successfully wrote bar chart out to", errBarOutputFile ) )