# coding=utf-8
# Copyright (c) 2015-2018, UT-BATTELLE, LLC
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors
# may be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
Module to hold LIVVkit specific functions
"""
import os
import sys
import errno
import shutil
import fnmatch
from datetime import datetime
import json_tricks
import livvkit
[docs]class TempSysPath(object):
"""Add a path to the PYTHONPATH temporarily"""
def __init__(self, path):
self.path = path
def __enter__(self):
sys.path.insert(0, self.path)
def __exit__(self, *args):
sys.path.remove(self.path)
[docs]def mkdir_p(path):
"""
Make parent directories as needed and no error if existing. Works like `mkdir -p`.
"""
try:
os.makedirs(path)
except OSError as exc: # Python >2.5
if exc.errno == errno.EEXIST and os.path.isdir(path):
pass
else:
raise
[docs]def merge_dicts(dict1, dict2):
""" Merge two dictionaries and return the result """
tmp = dict1.copy()
tmp.update(dict2)
return tmp
[docs]def parse_gptl(file_path, var_list):
"""
Read a GPTL timing file and extract some data.
Args:
file_path: the path to the GPTL timing file
var_list: a list of strings to look for in the file
Returns:
A dict containing key-value pairs of the livvkit
and the times associated with them
"""
timing_result = dict()
if os.path.isfile(file_path):
with open(file_path, 'r') as f:
for var in var_list:
for line in f:
if var in line:
timing_result[var] = float(line.split()[4])/int(line.split()[2])
break
return timing_result
[docs]def find_file(search_dir, file_pattern):
"""
Search for a file in a directory, and return the first match.
If the file is not found return an empty string
Args:
search_dir: The root directory to search in
file_pattern: A unix-style wildcard pattern representing
the file to find
Returns:
The path to the file if it was found, otherwise an empty string
"""
for root, _, fnames in os.walk(search_dir):
for fname in fnames:
if fnmatch.fnmatch(fname, file_pattern):
return os.path.join(root, fname)
return ""
[docs]def sort_processor_counts(p_string):
""" Simple wrapper to help sort processor counts """
return int(p_string.split('-')[0][1:])
[docs]def sort_scale(s_string):
""" Simple wrapper to help sort scale sizes """
return int(s_string[1:])
[docs]def create_page_from_template(template_file, output_path):
""" Copy the correct html template file to the output directory """
mkdir_p(os.path.dirname(output_path))
shutil.copy(os.path.join(livvkit.resource_dir, template_file), output_path)
[docs]def read_json(file_path):
""" Read in a json file and return a dictionary representation """
try:
with open(file_path, 'r') as f:
config = json_tricks.load(f)
except ValueError:
print(' '+'!'*58)
print(' Woops! Looks the JSON syntax is not valid in:')
print(' {}'.format(file_path))
print(' Note: commonly this is a result of having a trailing comma \n in the file')
print(' '+'!'*58)
raise
return config
[docs]def write_json(data, path, file_name):
"""
Write out data to a json file.
Args:
data: A dictionary representation of the data to write out
path: The directory to output the file in
file_name: The name of the file to write out
"""
if os.path.exists(path) and not os.path.isdir(path):
return
elif not os.path.exists(path):
mkdir_p(path)
with open(os.path.join(path, file_name), 'w') as f:
json_tricks.dump(data, f, indent=4, primitives=True, allow_nan=True)
[docs]def collect_cases(data_dir):
""" Find all cases and subcases of a particular run type """
cases = {}
for root, dirs, files in os.walk(data_dir):
if not dirs:
split_case = os.path.relpath(root, data_dir).split(os.path.sep)
if split_case[0] not in cases:
cases[split_case[0]] = []
cases[split_case[0]].append("-".join(split_case[1:]))
return cases
[docs]def setup_output(cssd=None, jsd=None, imgd=None):
"""
Set up the directory structure for the output. Copies old run
data into a timestamped directory and sets up the new directory
"""
# Check if we need to back up an old run
if os.path.isdir(livvkit.index_dir):
print("-------------------------------------------------------------------")
print(' Previous output data found in output directory!')
try:
f = open(os.path.join(livvkit.index_dir, "data.txt"), "r")
prev_time = f.readline().replace(":", "").replace("-", "").replace(" ", "_").rstrip()
f.close()
except IOError:
prev_time = "bkd_"+datetime.now().strftime("%Y%m%d_%H%M%S")
print(' Backing up data to:')
print(' ' + livvkit.index_dir + "_" + prev_time)
print("-------------------------------------------------------------------")
shutil.move(livvkit.index_dir, livvkit.index_dir + "_" + prev_time)
else:
print("-------------------------------------------------------------------")
# Copy over js, css, & imgs directories from source
if cssd:
shutil.copytree(cssd, os.path.join(livvkit.index_dir, "css"))
else:
shutil.copytree(os.path.join(livvkit.resource_dir, "css"),
os.path.join(livvkit.index_dir, "css"))
if jsd:
shutil.copytree(jsd, os.path.join(livvkit.index_dir, "js"))
else:
shutil.copytree(os.path.join(livvkit.resource_dir, "js"),
os.path.join(livvkit.index_dir, "js"))
if imgd:
shutil.copytree(imgd, os.path.join(livvkit.index_dir, "js"))
else:
shutil.copytree(os.path.join(livvkit.resource_dir, "imgs"),
os.path.join(livvkit.index_dir, "imgs"))
# Get the index template from the resource directory
shutil.copy(os.path.join(livvkit.resource_dir, "index.html"),
os.path.join(livvkit.index_dir, "index.html"))
shutil.copy(os.path.join(livvkit.resource_dir, "favicon.ico"),
os.path.join(livvkit.index_dir, "favicon.ico"))
# Record when this data was recorded so we can make nice backups
with open(os.path.join(livvkit.index_dir, "data.txt"), "w") as f:
f.write(livvkit.timestamp + '\n')
f.write('Call: livv ')
for arg in sys.argv[1:]:
f.write(arg)
f.write(' ')
f.write('\n')
f.write('Version: ' + livvkit.__version__ + '\n')
f.write("User: " + livvkit.user + '\n')
f.write("OS Type: " + livvkit.os_type + '\n')
f.write("Machine: " + livvkit.machine + '\n')
# Make a directory to keep log files
mkdir_p(os.path.join(livvkit.index_dir, 'logs'))
