major update / refactoring for ran dashboard, including mysql db and test results table
This commit is contained in:
hardy
@@ -0,0 +1,393 @@
|
||||
#/*
|
||||
# * 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
|
||||
# */
|
||||
#---------------------------------------------------------------------
|
||||
# Merge Requests Dashboard for RAN on googleSheet
|
||||
#
|
||||
# Required Python Version
|
||||
# Python 3.x
|
||||
#
|
||||
#---------------------------------------------------------------------
|
||||
|
||||
#-----------------------------------------------------------
|
||||
# Import
|
||||
#-----------------------------------------------------------
|
||||
|
||||
#import google spreadsheet API
|
||||
import gspread
|
||||
from oauth2client.service_account import ServiceAccountCredentials
|
||||
|
||||
|
||||
import subprocess
|
||||
import shlex #lexical analysis
|
||||
import json #json structures
|
||||
import datetime #now() and date formating
|
||||
from datetime import datetime
|
||||
import re
|
||||
import gitlab
|
||||
import yaml
|
||||
import os
|
||||
import pickle
|
||||
|
||||
from sqlconnect import SQLConnect
|
||||
|
||||
#-----------------------------------------------------------
|
||||
# Class Declaration
|
||||
#-----------------------------------------------------------
|
||||
|
||||
class gDashboard:
|
||||
def __init__(self, creds_file, spreadsheet, worksheet): #"creds.json", 'OAI RAN Dashboard', 'MR Status'
|
||||
self.scope = ["https://spreadsheets.google.com/feeds",'https://www.googleapis.com/auth/spreadsheets',"https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]
|
||||
self.creds = ServiceAccountCredentials.from_json_keyfile_name(creds_file, self.scope)
|
||||
self.client = gspread.authorize(self.creds)
|
||||
#spreadsheet
|
||||
self.ss = self.client.open(spreadsheet)
|
||||
#worksheet
|
||||
self.sheet = self.ss.worksheet(worksheet)
|
||||
self.ss.del_worksheet(self.sheet) #start by deleting the old sheet
|
||||
self.sheet = self.ss.add_worksheet(title=worksheet, rows="100", cols="30") #create a new one
|
||||
|
||||
#init with data sources : git, yaml config file, test results databases
|
||||
cmd="""curl --silent "https://gitlab.eurecom.fr/api/v4/projects/oai%2Fopenairinterface5g/merge_requests?state=opened&per_page=100" """
|
||||
self.git = self.__getGitData(cmd) #git data from Gitlab
|
||||
self.tests = self.__loadCfg('ran_dashboard_cfg.yaml') #tests table setup from yaml
|
||||
self.db = self.__loadFromDB() #test results from database
|
||||
|
||||
|
||||
def __loadCfg(self,yaml_file):
|
||||
with open(yaml_file,'r') as f:
|
||||
tests = yaml.load(f)
|
||||
return tests
|
||||
|
||||
def __getGitData(self,cmd):
|
||||
#cmd="""curl --silent "https://gitlab.eurecom.fr/api/v4/projects/oai%2Fopenairinterface5g/merge_requests?state=opened&per_page=100" """
|
||||
process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE)
|
||||
output = process.stdout.readline()
|
||||
tmp=output.decode("utf-8")
|
||||
d = json.loads(tmp)
|
||||
return d
|
||||
|
||||
def __loadFromDB(self):
|
||||
mr_list=[]
|
||||
for x in range(len(self.git)):
|
||||
mr_list.append(str(self.git[x]['iid']))
|
||||
mydb=SQLConnect()
|
||||
for MR in mr_list:
|
||||
mydb.get(MR)
|
||||
mydb.close_connection()
|
||||
return mydb.data
|
||||
|
||||
|
||||
|
||||
def gBuild(self, destinationSheetName):
|
||||
|
||||
###line 1 : update date/time, format dd/mm/YY H:M:S
|
||||
now = datetime.now()
|
||||
dt_string = "Update : " + now.strftime("%d/%m/%Y %H:%M")
|
||||
row =[dt_string]
|
||||
self.sheet.insert_row(row, index=1, value_input_option='RAW')
|
||||
|
||||
###line 2 is for the test short names (links to jenkins pipeline), updated at the end
|
||||
|
||||
###line 3 is for the column names
|
||||
i=3
|
||||
row =["MR","Created_at","Author","Title","Assignee", "Reviewer", "CAN START","IN PROGRESS","COMPLETED","Review Form","OK MERGE","Merge conflicts"]
|
||||
|
||||
#tests
|
||||
for t in range(0,len(self.tests)):
|
||||
row.append("# PASS")
|
||||
row.append("# FAIL")
|
||||
row.append("Last Fail")
|
||||
|
||||
self.sheet.insert_row(row, index=i, value_input_option='RAW')
|
||||
|
||||
###line 4 onward, MR data lines
|
||||
for x in range(len(self.git)):
|
||||
i=i+1
|
||||
date_time_str = self.git[x]['created_at']
|
||||
date_time_obj = datetime.strptime(date_time_str, '%Y-%m-%dT%H:%M:%S.%fZ')
|
||||
|
||||
milestone1=milestone2=milestone3=milestone4=""
|
||||
if self.git[x]['milestone']!=None:
|
||||
if self.git[x]['milestone']['title']=="REVIEW_CAN_START":
|
||||
milestone1="X"
|
||||
elif self.git[x]['milestone']['title']=="REVIEW_IN_PROGRESS":
|
||||
milestone2="X"
|
||||
elif self.git[x]['milestone']['title']=="REVIEW_COMPLETED_AND_APPROVED":
|
||||
milestone3="X"
|
||||
elif self.git[x]['milestone']['title']=="OK_TO_BE_MERGED":
|
||||
milestone4="X"
|
||||
else:
|
||||
pass
|
||||
else:
|
||||
pass
|
||||
|
||||
#check if empty or not
|
||||
if self.git[x]['assignee']!=None:
|
||||
assignee = str(self.git[x]['assignee']['name'])
|
||||
else:
|
||||
assignee = ""
|
||||
|
||||
#check if empty or not
|
||||
if len(self.git[x]['reviewers'])!=0:
|
||||
reviewer = str(self.git[x]['reviewers'][0]['name'])
|
||||
else:
|
||||
reviewer = ""
|
||||
|
||||
if self.git[x]['has_conflicts']==True:
|
||||
conflicts = "YES"
|
||||
else:
|
||||
conflicts = ""
|
||||
|
||||
|
||||
#add a column flagging that the review form is present
|
||||
#we use gitlab API to parse the MR notes
|
||||
gl = gitlab.Gitlab.from_config('OAI')
|
||||
project_id = 223
|
||||
project = gl.projects.get(project_id)
|
||||
#get the opened MR in the project
|
||||
mrs = project.mergerequests.list(state='opened')
|
||||
review_form=''
|
||||
for m in range (0,len(mrs)):
|
||||
if mrs[m].iid==self.git[x]['iid']:#check the iid is the one we are on
|
||||
mr_notes = mrs[m].notes.list(all=True)
|
||||
n=0
|
||||
found=False
|
||||
while found==False and n<len(mr_notes):
|
||||
res=re.search('Code Review by',mr_notes[n].body)#this is the marker we are looking for in all notes
|
||||
if res!=None:
|
||||
review_form = "X"
|
||||
found=True
|
||||
n+=1
|
||||
|
||||
#build final row to be inserted, the first column is left empty for now, will be filled afterward with hyperlinks to gitlab MR
|
||||
row =["", str(date_time_obj.date()),str(self.git[x]['author']['name']), str(self.git[x]['title']),\
|
||||
assignee, reviewer,\
|
||||
milestone1,milestone2,milestone3,review_form,milestone4,conflicts]
|
||||
#and append the test results coming from self.db
|
||||
mr=str(self.git[x]['iid'])
|
||||
for t in self.tests:
|
||||
if mr in self.db:
|
||||
job=self.tests[t]['job']
|
||||
if job in self.db[mr]:
|
||||
if 'PASS' in self.db[mr][job]:
|
||||
row.append(self.db[mr][job]['PASS'])
|
||||
else:
|
||||
row.append('')
|
||||
if 'FAIL' in self.db[mr][job]:
|
||||
row.append(self.db[mr][job]['FAIL'])
|
||||
else:
|
||||
row.append('')
|
||||
row.append('')
|
||||
else:
|
||||
row.append('')
|
||||
row.append('')
|
||||
row.append('')
|
||||
|
||||
#insert the final row to worksheet
|
||||
self.sheet.insert_row(row, index=i, value_input_option='RAW')
|
||||
|
||||
|
||||
#add MR hyperlinks in a list of requests to be sent as one update batch; this to save API calls (quotas)
|
||||
i=3
|
||||
requests=[]
|
||||
for x in range(len(self.git)):
|
||||
rowIndex=i
|
||||
colIndex=0
|
||||
hyperlink= '\"'+"https://gitlab.eurecom.fr/oai/openairinterface5g/-/merge_requests/"+ str(self.git[x]['iid']) +'\"'
|
||||
text= '\"'+str(self.git[x]['iid'])+'"'
|
||||
requests.append(self.addHyperlink(hyperlink, text, destinationSheetName, rowIndex, colIndex))
|
||||
|
||||
mr=str(self.git[x]['iid'])
|
||||
colIndex=14
|
||||
for t in self.tests:
|
||||
job=self.tests[t]['job']
|
||||
if job in self.db[mr]:
|
||||
if len(self.db[mr][job]['last_fail'])>0:
|
||||
hyperlink= '\"'+ self.db[mr][job]['last_fail'][1] +'\"'
|
||||
text= '\"'+self.db[mr][job]['last_fail'][0]+'"'
|
||||
requests.append(self.addHyperlink(hyperlink, text, destinationSheetName, rowIndex, colIndex))
|
||||
colIndex+=3
|
||||
i=i+1 #increment row index for next MR
|
||||
|
||||
|
||||
|
||||
body = {"requests": requests}
|
||||
self.ss.batch_update(body)
|
||||
|
||||
###line 2 is for the test names
|
||||
#add MR hyperlinks in a list of requests to be sent as one update batch; this to save API calls (quotas)
|
||||
requests=[]
|
||||
rowIndex=1
|
||||
colIndex=12
|
||||
for t in self.tests :
|
||||
hyperlink= '\"'+self.tests[t]['link']+'\"'
|
||||
short_name= '\"'+ t +'\"'
|
||||
requests.append(self.addHyperlink(hyperlink, short_name, destinationSheetName, rowIndex, colIndex))
|
||||
colIndex+=3
|
||||
|
||||
body = {"requests": requests}
|
||||
self.ss.batch_update(body)
|
||||
|
||||
|
||||
def addHyperlink(self, hyperlink, text, destinationSheetName, rowIndex, colIndex):
|
||||
sheetId = self.ss.worksheet(destinationSheetName)._properties['sheetId']
|
||||
request =\
|
||||
{
|
||||
"updateCells": {
|
||||
"rows": [
|
||||
{
|
||||
"values": [
|
||||
{
|
||||
"userEnteredValue": {
|
||||
"formulaValue":"=HYPERLINK({},{})".format(hyperlink, text)
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"fields": "userEnteredValue",
|
||||
"start": {
|
||||
"sheetId": sheetId,
|
||||
"rowIndex": rowIndex,
|
||||
"columnIndex": colIndex
|
||||
}
|
||||
}
|
||||
}
|
||||
return request
|
||||
|
||||
|
||||
|
||||
def gFormat(self,sourceSheetName,destinationSheetName): # "Formating" , "MR Status"
|
||||
#the requests are appended in a list of requests to be sent as one update batch; this to save API calls (quotas)
|
||||
#copy formating template
|
||||
sourceSheetId = self.ss.worksheet(sourceSheetName)._properties['sheetId']
|
||||
destinationSheetId = self.ss.worksheet(destinationSheetName)._properties['sheetId']
|
||||
requests=[]
|
||||
requests.append(
|
||||
{
|
||||
"copyPaste": {
|
||||
"source": {
|
||||
"sheetId": sourceSheetId,
|
||||
"startRowIndex": 1,
|
||||
"endRowIndex": 40,
|
||||
"startColumnIndex": 0,
|
||||
"endColumnIndex": 26
|
||||
},
|
||||
"destination": {
|
||||
"sheetId": destinationSheetId,
|
||||
"startRowIndex": 1,
|
||||
"endRowIndex": 40,
|
||||
"startColumnIndex": 0,
|
||||
"endColumnIndex": 26
|
||||
},
|
||||
"pasteType": "PASTE_FORMAT"
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
#resize columns fit to data, except col 0
|
||||
sheetId = self.ss.worksheet(destinationSheetName)._properties['sheetId']
|
||||
requests.append(
|
||||
{
|
||||
'autoResizeDimensions': {
|
||||
'dimensions': {
|
||||
'sheetId': sheetId,
|
||||
'dimension': 'COLUMNS',
|
||||
'startIndex': 1,
|
||||
'endIndex': 12
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
#resize col 0
|
||||
sheetId = self.ss.worksheet(destinationSheetName)._properties['sheetId']
|
||||
requests.append(
|
||||
{
|
||||
"updateDimensionProperties": {
|
||||
"range": {
|
||||
"sheetId": sheetId,
|
||||
"dimension": "COLUMNS",
|
||||
"startIndex": 0,
|
||||
"endIndex": 1
|
||||
},
|
||||
"properties": {
|
||||
"pixelSize": 100
|
||||
},
|
||||
"fields": "pixelSize"
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
#resize milestones to be cleaner
|
||||
sheetId = self.ss.worksheet(destinationSheetName)._properties['sheetId']
|
||||
requests.append(
|
||||
{
|
||||
"updateDimensionProperties": {
|
||||
"range": {
|
||||
"sheetId": sheetId,
|
||||
"dimension": "COLUMNS",
|
||||
"startIndex": 6,
|
||||
"endIndex": 11
|
||||
},
|
||||
"properties": {
|
||||
"pixelSize": 120
|
||||
},
|
||||
"fields": "pixelSize"
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
#group MR related columns
|
||||
# sheetId = self.ss.worksheet(destinationSheetName)._properties['sheetId']
|
||||
# requests.append(
|
||||
# {
|
||||
# "addDimensionGroup": {
|
||||
# "range": {
|
||||
# "dimension": "COLUMNS",
|
||||
# "sheetId": sheetId,
|
||||
# "startIndex": 3,
|
||||
# "endIndex": 12
|
||||
# },
|
||||
# }
|
||||
# }
|
||||
# )
|
||||
#
|
||||
body = {"requests": requests}
|
||||
self.ss.batch_update(body)
|
||||
|
||||
|
||||
|
||||
|
||||
def main():
|
||||
my_gDashboard=gDashboard("/opt/dashboard/g_creds.json", 'OAI RAN Dashboard', 'MR Status')
|
||||
my_gDashboard.gBuild("MR Status")
|
||||
my_gDashboard.gFormat("Formating" , "MR Status")
|
||||
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# execute only if run as a script
|
||||
main()
|
||||
@@ -0,0 +1,12 @@
|
||||
LTE-2x2 : #short name used in the dashboard
|
||||
job : 'RAN-LTE-2x2-Module-OAIEPC' #job name from Jenkins, used in the database
|
||||
link : 'https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-LTE-2x2-Module-OAIEPC'
|
||||
NSA-B200 :
|
||||
job : 'RAN-NSA-B200-Module-LTEBOX'
|
||||
link : 'https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-NSA-B200-Module-LTEBOX'
|
||||
NSA-2x2 :
|
||||
job : 'RAN-NSA-2x2-Module-OAIEPC'
|
||||
link : 'https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-NSA-2x2-Module-OAIEPC'
|
||||
SA-N310 :
|
||||
job : 'RAN-SA-Module-CN5G'
|
||||
link : 'https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-SA-Module-CN5G'
|
||||
@@ -0,0 +1,64 @@
|
||||
import pymysql
|
||||
import sys
|
||||
from datetime import datetime
|
||||
import pickle
|
||||
|
||||
|
||||
#This is the script/package used by the dashboard to retrieve the MR test results from the database
|
||||
|
||||
class SQLConnect:
|
||||
def __init__(self):
|
||||
self.connection = pymysql.connect(
|
||||
host='172.22.0.2',
|
||||
user='root',
|
||||
password = 'ucZBc2XRYdvEm59F',
|
||||
db='oaicicd_tests',
|
||||
port=3306
|
||||
)
|
||||
self.data={}
|
||||
|
||||
|
||||
#retrieve data from mysql database and organize it in a dictionary (per MR passed as argument)
|
||||
def get(self,MR):
|
||||
self.data[MR]={}
|
||||
cur=self.connection.cursor()
|
||||
|
||||
#get counters per test
|
||||
sql = "select TEST,STATUS, count(*) AS COUNT from test_results where MR=(%s) group by TEST, STATUS;"
|
||||
cur.execute(sql,MR)
|
||||
response=cur.fetchall()
|
||||
if len(response)==0:#no test results yet
|
||||
self.data[MR]['PASS']=''
|
||||
self.data[MR]['FAIL']=''
|
||||
else:
|
||||
for i in range(0,len(response)):
|
||||
test=response[i][0]
|
||||
status=response[i][1]
|
||||
count=response[i][2]
|
||||
if test in self.data[MR]:
|
||||
self.data[MR][test][status]=count
|
||||
else:
|
||||
self.data[MR][test]={}
|
||||
self.data[MR][test][status]=count
|
||||
|
||||
#get last failing build and link
|
||||
sql = "select TEST,BUILD, BUILD_LINK from test_results where MR=(%s) and STATUS='FAIL' order by DATE DESC;"
|
||||
cur.execute(sql,MR)
|
||||
response=cur.fetchall()
|
||||
if len(response)!=0:
|
||||
for i in range(0,len(response)):
|
||||
test=response[i][0]
|
||||
build=response[i][1]
|
||||
link=response[i][2]
|
||||
if 'last_fail' not in self.data[MR][test]:
|
||||
self.data[MR][test]['last_fail']=[]
|
||||
self.data[MR][test]['last_fail'].append(build)
|
||||
self.data[MR][test]['last_fail'].append(link)
|
||||
|
||||
|
||||
|
||||
#close database connection
|
||||
def close_connection(self):
|
||||
self.connection.close()
|
||||
|
||||
|
||||
Reference in New Issue
Block a user