Skip to content

Commit

Permalink
ci_build/: Re-design build-logs webpage
Browse files Browse the repository at this point in the history
The newly created webpage combines the previous
two webpages- info.txt and log/index.html. This
web-page combines the results of both the pages
and shows them in a better UI/UX with additional
features of filtering and searching within the
existing logs. The logs are fetched from a JSON
file which is created from the logs stored in
the log file _site/community.log

Closes #256
  • Loading branch information
KVGarg committed Aug 4, 2019
1 parent ae718af commit 2eb9a35
Show file tree
Hide file tree
Showing 11 changed files with 402 additions and 51 deletions.
2 changes: 1 addition & 1 deletion .moban.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ packages:
- gci
- gsoc
- gamification
- log
- ci_build
- meta_review
- model
- unassigned_issues
Expand Down
2 changes: 1 addition & 1 deletion .nocover.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nocover_file_globs:
- community/git.py
- gci/*.py
- gsoc/*.py
- log/*.py
- ci_build/*.py
- meta_review/handler.py
- model/*.py
- openhub/*.py
Expand Down
131 changes: 131 additions & 0 deletions ci_build/view_log.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
import re
import json
import os
import sys

from django.views.generic import TemplateView

from community.views import get_header_and_footer
from community.git import (
get_org_name,
get_owner,
get_deploy_url,
get_upstream_deploy_url
)


class BuildLogsView(TemplateView):
template_name = 'build_logs.html'

def copy_build_logs_json(self, ci_build_jsons):
"""
:param ci_build_jsons: A dict of directories path
:return: A boolean, whether the build file is copied
"""
if os.path.isfile(ci_build_jsons['public_path']):
if sys.platform == 'linux':
os.popen('cp {} {}'.format(
ci_build_jsons['site_path'],
ci_build_jsons['public_path']))
os.popen('cp {} {}'.format(
ci_build_jsons['site_path'],
ci_build_jsons['static_path']))
else:
os.popen('copy {} {}'.format(
ci_build_jsons['site_path'],
ci_build_jsons['public_path']))
os.popen('copy {} {}'.format(
ci_build_jsons['site_path'],
ci_build_jsons['static_path']))
return True
return False

def create_and_copy_build_logs_json(self, logs, level_specific_logs):
"""
Create a build logs detailed json file in ./_site directory and copy
that file in the ./static and ./public/static directories
:param logs: A list of all lines in build log file
:param level_specific_logs: A dict containing logs divided in their
respective categories
:return: A boolean, whether the files were copied or not
"""
ci_build_jsons = {
'site_path': './_site/ci-build-detailed-logs.json',
'public_path': './public/static/ci-build-detailed-logs.json',
'static_path': './static/ci-build-detailed-logs.json'
}
with open(ci_build_jsons['site_path'], 'w+') as build_logs_file:
data = {
'logs': logs,
'logs_level_Specific': level_specific_logs
}
json.dump(data, build_logs_file, indent=4)
return self.copy_build_logs_json(ci_build_jsons)

def get_build_logs(self, log_file_path):
"""
:param log_file_path: build logs file path
:return: a tuple of two where the first element in tuple refers to
a list of build logs in the file, and the second element is a dict
which categorizes the build logs into 5 categories - INFO, DEBUG,
WARNING, ERROR nad CRITICAL
"""
log_lines = []
log_level_specific_lines = {
'INFO': [],
'DEBUG': [],
'WARNING': [],
'ERROR': [],
'CRITICAL': []
}
with open(log_file_path) as log_file:
previous_found_level = None
for line in log_file:
log_lines.append(line)
levels = re.findall(r'\[[A-Z]+]', line)
if levels:
level = levels[0]
level = previous_found_level = level[1:-1]
log_level_specific_lines[level].append(line)
elif previous_found_level:
log_level_specific_lines[previous_found_level].append(
line)
return log_lines, log_level_specific_lines

def check_build_logs_stored(self):
"""
Check whether the build logs json file is copied to _site and public
directories or not
:return: A Boolean
"""
log_file_path = './_site/community.log'
log_file_exists = os.path.isfile(log_file_path)
if log_file_exists:
logs, level_specific_logs = self.get_build_logs(log_file_path)
return self.create_and_copy_build_logs_json(logs,
level_specific_logs)
return False

def get_build_info(self):
"""
Get the information about build, like who deployed the website i.e.
owner, name of the organization or user etc.
:return: A dict having information about build related details
"""
data = {
'Org name': get_org_name(),
'Owner': get_owner(),
'Deploy URL': get_deploy_url(),
}
try:
data['Upstream deploy URL'] = get_upstream_deploy_url()
except RuntimeError:
data['Upstream deploy URL'] = 'Not found'
return data

def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context = get_header_and_footer(context)
context['build_info'] = self.get_build_info()
context['logs_stored'] = self.check_build_logs_stored()
return context
16 changes: 5 additions & 11 deletions community/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
from django.conf.urls.static import static
from django.conf import settings

from community.views import HomePageView, info
from community.views import HomePageView
from gci.views import index as gci_index
from gci.feeds import LatestTasksFeed as gci_tasks_rss
from log.view_log import index as log_index
from ci_build.view_log import BuildLogsView
from data.views import index as contributors_index
from gamification.views import index as gamification_index
from meta_review.views import index as meta_review_index
Expand Down Expand Up @@ -78,12 +78,6 @@ def get_organization():
distill_func=get_index,
distill_file='index.html',
),
distill_url(
'info.txt', info,
name='index',
distill_func=get_index,
distill_file='info.txt',
),
distill_url(
r'gci/tasks/rss.xml', gci_tasks_rss(),
name='gci-tasks-rss',
Expand All @@ -97,10 +91,10 @@ def get_organization():
distill_file='gci/index.html',
),
distill_url(
r'log/', log_index,
name='log',
r'ci/build/', BuildLogsView.as_view(),
name='ci_build',
distill_func=get_index,
distill_file='log/index.html',
distill_file='ci/build/index.html',
),
distill_url(
r'contributors/$', contributors_index,
Expand Down
21 changes: 0 additions & 21 deletions community/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,10 @@

from trav import Travis

from django.http import HttpResponse
from django.views.generic.base import TemplateView

from .git import (
get_deploy_url,
get_org_name,
get_owner,
get_upstream_deploy_url,
get_remote_url
)
from data.models import Team
Expand Down Expand Up @@ -114,20 +110,3 @@ def get_context_data(self, **kwargs):
context['top_gamification_users'] = self.get_top_gamification_users(
count=5)
return context


def info(request):
data = {
'Org name': get_org_name(),
'Owner': get_owner(),
'Deploy URL': get_deploy_url(),
}
try:
upstream_deploy_url = get_upstream_deploy_url()
data['Upstream deploy URL'] = upstream_deploy_url
except RuntimeError:
data['Upstream deploy URL'] = 'Not found'

s = '\n'.join(name + ': ' + value
for name, value in data.items())
return HttpResponse(s)
12 changes: 0 additions & 12 deletions log/view_log.py

This file was deleted.

6 changes: 3 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ testpaths =
gci
gsoc
gamification
log
ci_build
meta_review
model
unassigned_issues
Expand Down Expand Up @@ -69,7 +69,7 @@ source =
gci
gsoc
gamification
log
ci_build
meta_review
model
unassigned_issues
Expand All @@ -80,7 +80,7 @@ omit =
community/git.py
gci/*.py
gsoc/*.py
log/*.py
ci_build/*.py
meta_review/handler.py
model/*.py
openhub/*.py
Expand Down
84 changes: 84 additions & 0 deletions static/css/build_logs.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
.build-info-section section,
.build-logs-section section {
min-width: 300px;
width: 80%;
}

.build-information,
.build-logs {
background-color: black;
padding-left: 10px;
font-weight: bold;
color: white;
}

.build-information p {
font-size: 1.5em;
margin: 0;
}

.build-logs {
max-height: 900px;
overflow: scroll;
overflow-x: hidden;
overflow-y: auto;
}

.build-logs p {
margin: 0;
}

.build-logs-section .log-chooser {
width: 25%;
min-width: 150px;
border-radius: 100px;
box-shadow: 0 0 25px 2px black;
color: #454343;
background-color: #c7da99;
padding-left: 10px;
margin: auto 0 auto auto;
}

.build-logs-section .log-chooser input,
.build-logs-section .log-chooser input:focus:not(.browser-default) {
border-bottom: none;
margin-bottom: 0;
}

.build-logs-section .small-screen,
.build-logs-section .fa-close {
display: none;
}

.form-fields {
margin: auto 0 auto auto;
width: 60%;
padding-top: 10px;
}

.search-field {
width: 60%;
min-width: 180px;
}

.section-header {
display: flex;
align-items: center;
}

.section-header form {
display: flex;
}

@media only screen and (max-width: 660px) {
.build-logs-section .search-field {
display: none;
}
.build-logs-section .small-screen {
display: flex;
align-items: center;
margin: auto;
margin-right: 3px;
font-size: 2em;
}
}
Loading

0 comments on commit 2eb9a35

Please sign in to comment.