Jenkinsfile-poll-gNB-UE 17.4 KB
Newer Older
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
#!/bin/groovy
/*
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
* contributor license agreements.  See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The OpenAirInterface Software Alliance licenses this file to You under
* the OAI Public License, Version 1.1  (the "License"); you may not use this file
* except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.openairinterface.org/?page_id=698
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*-------------------------------------------------------------------------------
* For more information about the OpenAirInterface (OAI) Software Alliance:
*      contact@openairinterface.org
*/


// Abstraction function to send social media messages:
// like on Slack or Mattermost
def sendSocialMediaMessage(pipeChannel, pipeColor, pipeMessage) {
    if (params.pipelineUsesSlack != null) {
        if (params.pipelineUsesSlack) {
            slackSend channel: pipeChannel, color: pipeColor, message: pipeMessage
        }
    }
}

// Location of the test XML file to be run
def testXMLFile = params.pythonTestXmlFile
def mainPythonAllXmlFiles = ""
37
def buildStageStatus = true
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

// Name of the phone resource
def ciUSRPsResource = params.USRPsResource

// Terminate Status
def termUE = 0
def termENB = 1
def termStatusArray = new Boolean[2]
termStatusArray[termUE] = false
termStatusArray[termENB] = false

// Global Parameters.
def eNB_Repository
def eNB_Branch
def eNB_CommitID
def eNB_AllowMergeRequestProcess = false
def eNB_TargetBranch
def PROJECT_NAME = "test-boris"
def GIT_COMMIT_AUTHORi
def GIT_COMMIT_EMAIL
Boris Djalal's avatar
Fix    
Boris Djalal committed
58
def testStageName
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
// Reversing list because pop() will take the last (right-most) element
//def modeList = ['TesteNB', 'TestUE', 'TesteNB'].reverse()

// Global Parameters not to break the main.py command line and code.
def ADB_IPAddress = "none"
def ADB_Username = "none"
def ADB_Password = "none"
def EPC_IPAddress = "none"
def EPC_Username = "none"
def EPC_Password = "none"



pipeline {
    agent {
        label pythonExecutor 
    }
    options {
        disableConcurrentBuilds()
        gitLabConnection('OAI GitLab')
        ansiColor('xterm')
	lock (ciUSRPsResource)
    }

    stages {
        stage ('Retrieve latest from branch') {
            steps {
	        script {
	            checkout([$class: 'GitSCM', branches: [[name: "${params.Branch}"]], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[url: 'https://gitlab.eurecom.fr/oai/openairinterface5g.git']]])
	            sh "git clean -x -d -ff"
	            sh "git log -n1"
	        }
            }
        }
        stage ("print latest commit info") {
            steps {
        	    script {
        	        echo "Building on: "
        	        echo "  Repository -- ${GIT_URL}"
        	        echo "  Branch -- ${GIT_BRANCH}"
        	        echo "  Commit -- ${GIT_COMMIT}"
        	    }
            }
        }
        stage ("Verify Parameters") {
            steps {
                script {
                    JOB_TIMESTAMP = sh returnStdout: true, script: 'date --utc --rfc-3339=seconds | sed -e "s#+00:00##"'
                    JOB_TIMESTAMP = JOB_TIMESTAMP.trim()

                    echo '\u2705 \u001B[32mVerify Parameters\u001B[0m'
                    def allParametersPresent = true

                    // It is already too late to check it
                    if (params.pythonExecutor != null) {
                       echo "eNB CI executor node  :   ${pythonExecutor}"
                    }
                    if (params.eNB_Repository == null) {
                        eNB_Repository = GIT_URL 
                    } else {
                        eNB_Repository = params.eNB_Repository
                    }
                    echo "eNB_Repository = ${eNB_Repository}"
                    if (params.eNB_Branch== null) {
                        eNB_Branch = GIT_BRANCH
                    } else {
                        eNB_Branch = params.eNB_Branch
                    }
                    echo "eNB_Branch = ${eNB_Branch}"
                    if (params.eNB_CommitID == null) {
                        eNB_CommitID = GIT_COMMIT 
                    } else {
                        eNB_CommitID = params.eNB_CommitID
                    }
                    echo "eNB_CommitID = ${eNB_CommitID}"
                    // If not present picking a default Stage Name
                    if (params.pipelineTestStageName == null) {
                        // picking default
                        testStageName = 'Template Test Stage'
Boris Djalal's avatar
Fix    
Boris Djalal committed
138
139
140
                    } else {
			testStageName = params.pipelineTestStageName
	            }
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
183
184

                    if (params.USRPsResource == null) {
                        allParametersPresent = false
                    }
	
                    if (params.eNB_IPAddress == null) {
                        allParametersPresent = false
                    }
                    if (params.UE_IPAddress == null) {
                        allParametersPresent = false
                    }
                    if (params.eNB_SourceCodePath == null) {
                        allParametersPresent = false
                    }
                    if (params.eNB_Credentials == null) {
                        allParametersPresent = false
                    }
                    if (params.UE_Credentials == null) {
                        allParametersPresent = false
                    }
                    GIT_COMMIT_AUTHOR = sh (
                        script: 'git show -s --pretty=%an',
                        returnStdout: true
                    ).trim()
                    echo "The author of the commit is: ${GIT_COMMIT_AUTHOR}"
                    GIT_COMMIT_EMAIL = sh (
                        script: 'git show -s --pretty=%ae',
                        returnStdout: true
                    ).trim()
                    echo "The email of the author is: ${GIT_COMMIT_EMAIL}"
                    if (allParametersPresent) {
                        echo "All parameters are present"
                    } else {
                        echo "Some parameters are missing"
                        sh "./ci-scripts/fail.sh"
                    }
                }
            }
        }

        stage ("Build and Test") {
            steps {
        	    script {
        	        dir ('ci-scripts') {
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
                        // If not present picking a default XML file
                        if (params.pythonTestXmlFile == null) {
                            // picking default
                            testXMLFile = 'xml_files/gnb_usrp_build.xml'
                            echo "Test XML file(default):   ${testXMLFile}"
                            mainPythonAllXmlFiles += "--XMLTestFile=" + testXMLFile + " "
                        } else {
                            String[] myXmlTestSuite = testXMLFile.split("\\r?\\n")
                            for (xmlFile in myXmlTestSuite) {
                                if (fileExists(xmlFile)) {
                            	mainPythonAllXmlFiles += "--XMLTestFile=" + xmlFile + " "
                            	echo "Test XML file         :   ${xmlFile}"
                                }
                            }
                        }
200
201
202
203
204
205
206
207
208
209
210
211
        	    	withCredentials([
        	    	    [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'eNB_Username', passwordVariable: 'eNB_Password'],
        	    	    [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.UE_Credentials}", usernameVariable: 'UE_Username', passwordVariable: 'UE_Password']
        	    	]) {
        	    	    sh "python3 main.py --mode=InitiateHtml --eNBRepository=${eNB_Repository} --eNBBranch=${eNB_Branch} --eNBCommitID=${eNB_CommitID} --eNB_AllowMerge=${eNB_AllowMergeRequestProcess} --ADBIPAddress=${ADB_IPAddress} --ADBUserName=${ADB_Username} --ADBPassword=${ADB_Password} --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password} ${mainPythonAllXmlFiles}"
        	    	    String[] myXmlTestSuite = testXMLFile.split("\\r?\\n")
        	    	    for (xmlFile in myXmlTestSuite) {
        	    	    if (fileExists(xmlFile)) {
        	    	        try {
        	    	            sh "python3 main.py --mode=TesteNB --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password} --UEIPAddress=${params.eNB_IPAddress} --UEUserName=${eNB_Username} --UEPassword=${eNB_Password} --eNBBranch=${eNB_Branch} --eNBSourceCodePath=${params.eNB_SourceCodePath} --UESourceCodePath=${params.eNB_SourceCodePath} --eNBRepository=${eNB_Repository} --eNBCommitID=${eNB_CommitID} --ADBIPAddress=${ADB_IPAddress} --EPCIPAddress=${EPC_IPAddress} --XMLTestFile=${xmlFile}"
        	    	        } catch (Exception e) {
        	    	            currentBuild.result = 'FAILURE'
212
        	    	            buildStageStatus = false
213
214
215
        	    	        }
        	    	    }
        	    	    }
216
                            sh "python3 main.py --mode=FinalizeHtml --finalStatus=${buildStageStatus} --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password}"
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
        	        }
        	    }
                }
            }
	}	
	
        stage ("Terminate") {
            parallel {
        	stage('Terminate NR UE') {
        	    steps {
        		echo '\u2705 \u001B[32mTerminate NR UE\u001B[0m'
                        withCredentials([
                            [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'UE_Username', passwordVariable: 'UE_Password']
                        ]) {
                            sh "python3 ci-scripts/main.py --mode=TerminateOAIUE --UEIPAddress=${params.eNB_IPAddress} --UEUserName=${UE_Username} --UEPassword=${UE_Password}"
                        }
        	    }
        	    post {
        		success {
        		    script {
        			termStatusArray[termUE] = true
        		    }
        		}
        	    }
        	}
       	    stage('Terminate NR eNB') {
       	        steps {
		    echo '\u2705 \u001B[32mTerminate NR eNB\u001B[0m'
                        withCredentials([
                            [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'eNB_Username', passwordVariable: 'eNB_Password']
                        ]) {
                            sh "python3 ci-scripts/main.py --mode=TerminateeNB --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password}"
                        }
        	      }
                    post {
        	        success {
                            script {
        		        termStatusArray[termENB] = true
        		    }
                        }
        	    }
                }
            }
        }

        stage('Log Collection') {
            parallel {
        	stage('Log Collection (gNB and NR UE - Build)') {
        	    steps {
        		withCredentials([
        		     [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'eNB_Username', passwordVariable: 'eNB_Password']
        		]) {
        		    echo '\u2705 \u001B[32mLog Collection (gNB and NR UE - Build)\u001B[0m'
        		    sh "python3 ci-scripts/main.py --mode=LogCollectBuild --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password} --eNBSourceCodePath=${params.eNB_SourceCodePath}"
        
        		    echo '\u2705 \u001B[32mLog Transfer (gNB and NR UE - Build)\u001B[0m'
        		    sh "sshpass -p \'${eNB_Password}\' scp -o 'StrictHostKeyChecking no' -o 'ConnectTimeout 10' ${eNB_Username}@${params.eNB_IPAddress}:${eNB_SourceCodePath}/cmake_targets/build.log.zip ./build.log.${env.BUILD_ID}.zip || true"
        		}
        		script {
        		    if(fileExists("build.log.${env.BUILD_ID}.zip")) {
        			archiveArtifacts "build.log.${env.BUILD_ID}.zip"
        		    }
        		}
        	    }
        	}
        	stage('Log Collection (gNB - Run)') {
        	    steps {
        		withCredentials([
        		     [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'eNB_Username', passwordVariable: 'eNB_Password']
        		]) {
        		    echo '\u2705 \u001B[32mLog Collection (gNB - Run)\u001B[0m'
        		    sh "python3 ci-scripts/main.py --mode=LogCollecteNB --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password} --eNBSourceCodePath=${params.eNB_SourceCodePath}"
        
        		    echo '\u2705 \u001B[32mLog Transfer (gNB - Run)\u001B[0m'
        		    sh "sshpass -p \'${eNB_Password}\' scp -o 'StrictHostKeyChecking no' -o 'ConnectTimeout 10' ${eNB_Username}@${params.eNB_IPAddress}:${eNB_SourceCodePath}/cmake_targets/enb.log.zip ./enb.log.${env.BUILD_ID}.zip || true"
        		}
        		script {
        		    if(fileExists("enb.log.${env.BUILD_ID}.zip")) {
        			archiveArtifacts "enb.log.${env.BUILD_ID}.zip"
        		    }
        		    if(fileExists("ci-scripts/test_results.html")) {
        			sh "mv ci-scripts/test_results.html test_results-${JOB_NAME}.html"
        			sh "sed -i -e 's#TEMPLATE_JOB_NAME#${JOB_NAME}#' -e 's@build #TEMPLATE_BUILD_ID@build #${BUILD_ID}@' -e 's#Build-ID: TEMPLATE_BUILD_ID#Build-ID: <a href=\"${BUILD_URL}\">${BUILD_ID}</a>#' -e 's#TEMPLATE_STAGE_NAME#${testStageName}#' test_results-${JOB_NAME}.html"
        			archiveArtifacts "test_results-${JOB_NAME}.html"
        		    }
        		}
        	    }
        	}
        	stage('Log Collection (NR UE - Run)') {
        	    steps {
        		withCredentials([
        		     [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'eNB_Username', passwordVariable: 'eNB_Password']
        		]) {
        		    echo '\u2705 \u001B[32mLog Collection (gNB - Run)\u001B[0m'
        		    sh "python3 ci-scripts/main.py --mode=LogCollectOAIUE --UEIPAddress=${params.eNB_IPAddress} --UEUserName=${eNB_Username} --UEPassword=${eNB_Password} --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password} --UESourceCodePath=${params.eNB_SourceCodePath}"
        
        		    echo '\u2705 \u001B[32mLog Transfer (gNB - Run)\u001B[0m'
        		    sh "sshpass -p \'${eNB_Password}\' scp -o 'StrictHostKeyChecking no' -o 'ConnectTimeout 10' ${eNB_Username}@${params.eNB_IPAddress}:${eNB_SourceCodePath}/cmake_targets/ue.log.zip ./ue.log.${env.BUILD_ID}.zip || true"
        		}
        		script {
        		    if(fileExists("ue.log.${env.BUILD_ID}.zip")) {
        			archiveArtifacts "ue.log.${env.BUILD_ID}.zip"
        		    }
        		}
        	    }
        	}
            }
        }
    }

    post {
        always {
            script {
                if ("MERGE".equals(env.gitlabActionType)) {
                    echo "This is a MERGE event"
                } else {
                    gitlabCommitStatus(name: "Test-gNB-nrUE") {
                        if ((currentBuild.result == null) || (currentBuild.result == 'SUCCESS')) {
                            echo "Setting the gitlab commit status to pass"
                        } else {
                            sh "./ci-scripts/fail.sh"
                        }
                    }
                }
                emailext attachmentsPattern: '*results*.html',
                     body: '''Hi,
Here are attached HTML report files for $PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!

Regards,
OAI CI Team''',
                     replyTo: 'no-reply@openairinterface.org',
                     subject: '$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!',
                     to: GIT_COMMIT_EMAIL
	    }
        }
        success {
            script {
                def message = "OAI " + JOB_NAME + " build (" + BUILD_ID + "): passed (" + BUILD_URL + ")"
                if ("MERGE".equals(env.gitlabActionType)) {
                    echo "This is a MERGE event"
                    //addGitLabMRComment comment: message
                    def message2 = "OAI " + JOB_NAME + " build (" + BUILD_ID + "): passed (" + BUILD_URL + ") -- MergeRequest #" + env.gitlabMergeRequestIid + " (" + env.gitlabMergeRequestTitle + ")"
                    sendSocialMediaMessage('ci-test', 'good', message2)
                } else {
                    sendSocialMediaMessage('ci-test', 'good', message)
                }
            }
        }
        failure {
            script {
                def message = "OAI " + JOB_NAME + " build (" + BUILD_ID + "): failed (" + BUILD_URL + ")"
                if ("MERGE".equals(env.gitlabActionType)) {
                    echo "This is a MERGE event"
                    //addGitLabMRComment comment: message
                    def message2 = "OAI " + JOB_NAME + " build (" + BUILD_ID + "): failed (" + BUILD_URL + ") -- MergeRequest #" + env.gitlabMergeRequestIid + " (" + env.gitlabMergeRequestTitle + ")"
                    sendSocialMediaMessage('ci-test', 'danger', message2)
                } else {
                    sendSocialMediaMessage('ci-test', 'danger', message)
                }
            }
        }
    }
}