Adding documentations for the Jenkins file
Change-Id: I2ff71c4a787901b80401bb53117572f9c58ef6d0
diff --git a/TestON/JenkinsFile/dependencies/JenkinsPathAndFiles.groovy b/TestON/JenkinsFile/dependencies/JenkinsPathAndFiles.groovy
index fc89730..b2c30c5 100644
--- a/TestON/JenkinsFile/dependencies/JenkinsPathAndFiles.groovy
+++ b/TestON/JenkinsFile/dependencies/JenkinsPathAndFiles.groovy
@@ -1,5 +1,28 @@
+// Copyright 2017 Open Networking Foundation (ONF)
+//
+// Please refer questions to either the onos test mailing list at <onos-test@onosproject.org>,
+// the System Testing Plans and Results wiki page at <https://wiki.onosproject.org/x/voMg>,
+// or the System Testing Guide page at <https://wiki.onosproject.org/x/WYQg>
+//
+// TestON is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 2 of the License, or
+// (at your option) any later version.
+//
+// TestON 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with TestON. If not, see <http://www.gnu.org/licenses/>.
+
+// This is the dependency Jenkins script.
+// This will initialize the paths of the jenkins file and paths.
+
#!groovy
+// init the paths for the directory
def initLocation(){
jenkinsFolder = "~/OnosSystemTest/TestON/JenkinsFile/"
rScriptLocation = jenkinsFolder + "wikiGraphRScripts/"
@@ -7,6 +30,8 @@
SCPFSpecificLocation = rScriptLocation + "SCPFspecificGraphRScripts/"
CHOScriptDir = "~/CHO_Jenkins_Scripts/"
}
+
+// init the paths for the files.
def initFiles(){
trendIndividual = rScriptLocation + "trendIndividualTest.R"
trendMultiple = rScriptLocation + "trendMultipleTests.R"
@@ -15,6 +40,8 @@
histogramMultiple = rScriptLocation + "histogramMultipleTestGroups.R"
pieMultiple = rScriptLocation + "pieMultipleTests.R"
}
+
+// init both directory and file paths.
def init(){
initLocation()
initFiles()