aboutsummaryrefslogtreecommitdiffstats
path: root/ice_validator/vvp.py
diff options
context:
space:
mode:
Diffstat (limited to 'ice_validator/vvp.py')
-rw-r--r--ice_validator/vvp.py781
1 files changed, 781 insertions, 0 deletions
diff --git a/ice_validator/vvp.py b/ice_validator/vvp.py
new file mode 100644
index 0000000..9c63168
--- /dev/null
+++ b/ice_validator/vvp.py
@@ -0,0 +1,781 @@
+# -*- coding: utf8 -*-
+# ============LICENSE_START====================================================
+# org.onap.vvp/validation-scripts
+# ===================================================================
+# Copyright © 2019 AT&T Intellectual Property. All rights reserved.
+# ===================================================================
+#
+# Unless otherwise specified, all software contained herein is licensed
+# under the Apache License, Version 2.0 (the "License");
+# you may not use this software except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+#
+#
+# Unless otherwise specified, all documentation contained herein is licensed
+# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
+# you may not use this documentation except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://creativecommons.org/licenses/by/4.0/
+#
+# Unless required by applicable law or agreed to in writing, documentation
+# 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.
+#
+# ============LICENSE_END============================================
+#
+# ECOMP is a trademark and service mark of AT&T Intellectual Property.
+#
+
+"""
+A GUI that wraps the pytest validations scripts.
+
+To make an executable for windows execute the ``make_exe.bat`` to generate the
+.exe and its associated files. The the necessary files will be written to the
+``dist/vvp/`` directory. This entire directory must be copied to the target machine.
+
+NOTE: This script does require Python 3.6+
+"""
+import appdirs
+import os
+import pytest
+import sys
+import version
+import yaml
+import contextlib
+import multiprocessing
+import queue
+import tempfile
+import webbrowser
+import zipfile
+
+from collections import MutableMapping
+from configparser import ConfigParser
+from multiprocessing import Queue
+from pathlib import Path
+from shutil import rmtree
+from tkinter import (
+ filedialog,
+ font,
+ messagebox,
+ Tk,
+ PanedWindow,
+ BOTH,
+ HORIZONTAL,
+ RAISED,
+ Frame,
+ Label,
+ W,
+ StringVar,
+ OptionMenu,
+ LabelFrame,
+ E,
+ BooleanVar,
+ Entry,
+ Button,
+ WORD,
+ END,
+ Checkbutton,
+ IntVar,
+ Toplevel,
+)
+from tkinter.scrolledtext import ScrolledText
+from typing import Optional, List, Dict, TextIO, Callable, Iterator
+
+VERSION = version.VERSION
+PATH = os.path.dirname(os.path.realpath(__file__))
+OUT_DIR = "output"
+
+
+class ToolTip(object):
+ """
+ create a tooltip for a given widget
+ """
+
+ def __init__(self, widget, text="widget info"):
+ self.waittime = 750 # miliseconds
+ self.wraplength = 180 # pixels
+ self.widget = widget
+ self.text = text
+ self.widget.bind("<Enter>", self.enter)
+ self.widget.bind("<Leave>", self.leave)
+ self.widget.bind("<ButtonPress>", self.leave)
+ self.id = None
+ self.tw = None
+
+ def enter(self, event=None):
+ self.schedule()
+
+ def leave(self, event=None):
+ self.unschedule()
+ self.hidetip()
+
+ def schedule(self):
+ self.unschedule()
+ self.id = self.widget.after(self.waittime, self.showtip)
+
+ def unschedule(self):
+ id = self.id
+ self.id = None
+ if id:
+ self.widget.after_cancel(id)
+
+ def showtip(self, event=None):
+ x = y = 0
+ x, y, cx, cy = self.widget.bbox("insert")
+ x += self.widget.winfo_rootx() + 25
+ y += self.widget.winfo_rooty() + 20
+ # creates a toplevel window
+ self.tw = Toplevel(self.widget)
+ # Leaves only the label and removes the app window
+ self.tw.wm_overrideredirect(True)
+ self.tw.wm_geometry("+%d+%d" % (x, y))
+ label = Label(
+ self.tw,
+ text=self.text,
+ justify="left",
+ background="#ffffff",
+ relief="solid",
+ borderwidth=1,
+ wraplength=self.wraplength,
+ )
+ label.pack(ipadx=1)
+
+ def hidetip(self):
+ tw = self.tw
+ self.tw = None
+ if tw:
+ tw.destroy()
+
+
+class QueueWriter:
+ """``stdout`` and ``stderr`` will be written to this queue by pytest, and
+ pulled into the main GUI application"""
+
+ def __init__(self, log_queue: queue.Queue):
+ """Writes data to the provided queue.
+
+ :param log_queue: the queue instance to write to.
+ """
+ self.queue = log_queue
+
+ def write(self, data: str):
+ """Writes ``data`` to the queue """
+ self.queue.put(data)
+
+ # noinspection PyMethodMayBeStatic
+ def isatty(self) -> bool:
+ """Always returns ``False``"""
+ return False
+
+ def flush(self):
+ """No operation method to satisfy file-like behavior"""
+ pass
+
+
+def get_plugins() -> Optional[List]:
+ """When running in a frozen bundle, plugins need to be registered
+ explicitly. This method will return the required plugins to register
+ based on the run mode"""
+ if hasattr(sys, "frozen"):
+ import pytest_tap.plugin
+
+ return [pytest_tap.plugin]
+ else:
+ return None
+
+
+def run_pytest(
+ template_dir: str,
+ log: TextIO,
+ result_queue: Queue,
+ categories: Optional[list],
+ verbosity: str,
+ report_format: str,
+ halt_on_failure: bool,
+ template_source: str,
+):
+ """Runs pytest using the given ``profile`` in a background process. All
+ ``stdout`` and ``stderr`` are redirected to ``log``. The result of the job
+ will be put on the ``completion_queue``
+
+ :param template_dir: The directory containing the files to be validated.
+ :param log: ` `stderr`` and ``stdout`` of the pytest job will be
+ directed here
+ :param result_queue: Completion status posted here. See :class:`Config`
+ for more information.
+ :param categories: list of optional categories. When provided, pytest
+ will collect and execute all tests that are
+ decorated with any of the passed categories, as
+ well as tests not decorated with a category.
+ :param verbosity: Flag to be passed to pytest to control verbosity.
+ Options are '' (empty string), '-v' (verbose),
+ '-vv' (more verbose).
+ :param report_format: Determines the style of report written. Options are
+ csv, html, or excel
+ :param halt_on_failure: Determines if validation will halt when basic failures
+ are encountered in the input files. This can help
+ prevent a large number of errors from flooding the
+ report.
+ """
+ out_path = "{}/{}".format(PATH, OUT_DIR)
+ if os.path.exists(out_path):
+ rmtree(out_path, ignore_errors=True)
+ with contextlib.redirect_stderr(log), contextlib.redirect_stdout(log):
+ try:
+ args = [
+ "--ignore=app_tests",
+ "--capture=sys",
+ verbosity,
+ "--template-directory={}".format(template_dir),
+ "--report-format={}".format(report_format),
+ "--template-source={}".format(template_source),
+ ]
+ if categories:
+ for category in categories:
+ args.extend(("--category", category))
+ if not halt_on_failure:
+ args.append("--continue-on-failure")
+ pytest.main(args=args, plugins=get_plugins())
+ result_queue.put((True, None))
+ except Exception as e:
+ result_queue.put((False, e))
+
+
+class UserSettings(MutableMapping):
+ FILE_NAME = "UserSettings.ini"
+
+ def __init__(self):
+ user_config_dir = appdirs.AppDirs("org.onap.vvp", "ONAP").user_config_dir
+ if not os.path.exists(user_config_dir):
+ os.makedirs(user_config_dir, exist_ok=True)
+ self._settings_path = os.path.join(user_config_dir, self.FILE_NAME)
+ self._config = ConfigParser()
+ self._config.read(self._settings_path)
+
+ def __getitem__(self, k):
+ return self._config["DEFAULT"][k]
+
+ def __setitem__(self, k, v) -> None:
+ self._config["DEFAULT"][k] = v
+
+ def __delitem__(self, v) -> None:
+ del self._config["DEFAULT"][v]
+
+ def __len__(self) -> int:
+ return len(self._config["DEFAULT"])
+
+ def __iter__(self) -> Iterator:
+ return iter(self._config["DEFAULT"])
+
+ def save(self):
+ with open(self._settings_path, "w") as f:
+ self._config.write(f)
+
+
+class Config:
+ """
+ Configuration for the Validation GUI Application
+
+ Attributes
+ ----------
+ ``log_queue`` Queue for the ``stdout`` and ``stderr` of
+ the background job
+ ``log_file`` File-like object (write only!) that writes to
+ the ``log_queue``
+ ``status_queue`` Job completion status of the background job is
+ posted here as a tuple of (bool, Exception).
+ The first parameter is True if the job completed
+ successfully, and False otherwise. If the job
+ failed, then an Exception will be provided as the
+ second element.
+ ``command_queue`` Used to send commands to the GUI. Currently only
+ used to send shutdown commands in tests.
+ """
+
+ DEFAULT_FILENAME = "vvp-config.yaml"
+ DEFAULT_POLLING_FREQUENCY = "1000"
+
+ def __init__(self, config: dict = None):
+ """Creates instance of application configuration.
+
+ :param config: override default configuration if provided."""
+ if config:
+ self._config = config
+ else:
+ with open(self.DEFAULT_FILENAME, "r") as f:
+ self._config = yaml.load(f)
+ self._user_settings = UserSettings()
+ self._watched_variables = []
+ self._validate()
+ self._manager = multiprocessing.Manager()
+ self.log_queue = self._manager.Queue()
+ self.status_queue = self._manager.Queue()
+ self.log_file = QueueWriter(self.log_queue)
+ self.command_queue = self._manager.Queue()
+
+ def watch(self, *variables):
+ """Traces the variables and saves their settings for the user. The
+ last settings will be used where available"""
+ self._watched_variables = variables
+ for var in self._watched_variables:
+ var.trace_add("write", self.save_settings)
+
+ def save_settings(self, *args):
+ """Save the value of all watched variables to user settings"""
+ for var in self._watched_variables:
+ self._user_settings[var._name] = str(var.get())
+ self._user_settings.save()
+
+ @property
+ def app_name(self) -> str:
+ """Name of the application (displayed in title bar)"""
+ app_name = self._config["ui"].get("app-name", "VNF Validation Tool")
+ return "{} - {}".format(app_name, VERSION)
+
+ @property
+ def category_names(self) -> List[str]:
+ """List of validation profile names for display in the UI"""
+ return [category["name"] for category in self._config["categories"]]
+
+ @property
+ def polling_frequency(self) -> int:
+ """Returns the frequency (in ms) the UI polls the queue communicating
+ with any background job"""
+ return int(
+ self._config["settings"].get(
+ "polling-frequency", self.DEFAULT_POLLING_FREQUENCY
+ )
+ )
+
+ def default_verbosity(self, levels: Dict[str, str]) -> str:
+ requested_level = self._user_settings.get("verbosity") or self._config[
+ "settings"
+ ].get("default-verbosity", "Standard")
+ keys = [key for key in levels]
+ for key in levels:
+ if key.lower().startswith(requested_level.lower()):
+ return key
+ raise RuntimeError(
+ "Invalid default-verbosity level {}. Valid"
+ "values are {}".format(requested_level, ", ".join(keys))
+ )
+
+ def get_description(self, category_name: str) -> str:
+ """Returns the description associated with the category name"""
+ return self._get_category(category_name)["description"]
+
+ def get_category(self, category_name: str) -> str:
+ """Returns the category associated with the category name"""
+ return self._get_category(category_name).get("category", "")
+
+ def get_category_value(self, category_name: str) -> str:
+ """Returns the saved value for a category name"""
+ return self._user_settings.get(category_name, 0)
+
+ def _get_category(self, category_name: str) -> Dict[str, str]:
+ """Returns the profile definition"""
+ for category in self._config["categories"]:
+ if category["name"] == category_name:
+ return category
+ raise RuntimeError(
+ "Unexpected error: No category found in vvp-config.yaml "
+ "with a name of " + category_name
+ )
+
+ @property
+ def default_report_format(self):
+ return self._user_settings.get("report_format", "HTML")
+
+ @property
+ def report_formats(self):
+ return ["CSV", "Excel", "HTML"]
+
+ @property
+ def default_input_format(self):
+ requested_default = self._user_settings.get("input_format") or self._config[
+ "settings"
+ ].get("default-input-format")
+ if requested_default in self.input_formats:
+ return requested_default
+ else:
+ return self.input_formats[0]
+
+ @property
+ def input_formats(self):
+ return ["Directory (Uncompressed)", "ZIP File"]
+
+ @property
+ def default_halt_on_failure(self):
+ setting = self._user_settings.get("halt_on_failure", "True")
+ return setting.lower() == "true"
+
+ def _validate(self):
+ """Ensures the config file is properly formatted"""
+ categories = self._config["categories"]
+
+ # All profiles have required keys
+ expected_keys = {"name", "description"}
+ for category in categories:
+ actual_keys = set(category.keys())
+ missing_keys = expected_keys.difference(actual_keys)
+ if missing_keys:
+ raise RuntimeError(
+ "Error in vvp-config.yaml file: "
+ "Required field missing in category. "
+ "Missing: {} "
+ "Categories: {}".format(",".join(missing_keys), category)
+ )
+
+
+class ValidatorApp:
+ VERBOSITY_LEVELS = {"Less": "", "Standard (-v)": "-v", "More (-vv)": "-vv"}
+
+ def __init__(self, config: Config = None):
+ """Constructs the GUI element of the Validation Tool"""
+ self.task = None
+ self.config = config or Config()
+
+ self._root = Tk()
+ self._root.title(self.config.app_name)
+ self._root.protocol("WM_DELETE_WINDOW", self.shutdown)
+
+ main_window = PanedWindow(self._root)
+ main_window.pack(fill=BOTH, expand=1)
+
+ control_panel = PanedWindow(
+ main_window, orient=HORIZONTAL, sashpad=4, sashrelief=RAISED
+ )
+ actions = Frame(control_panel)
+ control_panel.add(actions)
+ control_panel.paneconfigure(actions, minsize=250)
+
+ # profile start
+ number_of_categories = len(self.config.category_names)
+ category_frame = LabelFrame(actions, text="Additional Validation Categories:")
+ category_frame.grid(row=1, column=1, columnspan=3, pady=5, sticky="we")
+
+ self.categories = []
+
+ for x in range(0, number_of_categories):
+ category_name = self.config.category_names[x]
+ category_value = IntVar(value=0)
+ category_value._name = "category_{}".format(category_name.replace(" ", "_"))
+ category_value.set(self.config.get_category_value(category_value._name))
+ self.categories.append(category_value)
+ category_checkbox = Checkbutton(
+ category_frame, text=category_name, variable=self.categories[x]
+ )
+ ToolTip(category_checkbox, self.config.get_description(category_name))
+ category_checkbox.grid(row=x + 1, column=1, columnspan=2, sticky="w")
+
+ settings_frame = LabelFrame(actions, text="Settings")
+ settings_frame.grid(row=3, column=1, columnspan=3, pady=10, sticky="we")
+ verbosity_label = Label(settings_frame, text="Verbosity:")
+ verbosity_label.grid(row=1, column=1, sticky=W)
+ self.verbosity = StringVar(self._root, name="verbosity")
+ self.verbosity.set(self.config.default_verbosity(self.VERBOSITY_LEVELS))
+ verbosity_menu = OptionMenu(
+ settings_frame, self.verbosity, *tuple(self.VERBOSITY_LEVELS.keys())
+ )
+ verbosity_menu.config(width=25)
+ verbosity_menu.grid(row=1, column=2, columnspan=3, sticky=E, pady=5)
+
+ report_format_label = Label(settings_frame, text="Report Format:")
+ report_format_label.grid(row=2, column=1, sticky=W)
+ self.report_format = StringVar(self._root, name="report_format")
+ self.report_format.set(self.config.default_report_format)
+ report_format_menu = OptionMenu(
+ settings_frame, self.report_format, *self.config.report_formats
+ )
+ report_format_menu.config(width=25)
+ report_format_menu.grid(row=2, column=2, columnspan=3, sticky=E, pady=5)
+
+ input_format_label = Label(settings_frame, text="Input Format:")
+ input_format_label.grid(row=3, column=1, sticky=W)
+ self.input_format = StringVar(self._root, name="input_format")
+ self.input_format.set(self.config.default_input_format)
+ input_format_menu = OptionMenu(
+ settings_frame, self.input_format, *self.config.input_formats
+ )
+ input_format_menu.config(width=25)
+ input_format_menu.grid(row=3, column=2, columnspan=3, sticky=E, pady=5)
+
+ self.halt_on_failure = BooleanVar(self._root, name="halt_on_failure")
+ self.halt_on_failure.set(self.config.default_halt_on_failure)
+ halt_on_failure_label = Label(settings_frame, text="Halt on Basic Failures:")
+ halt_on_failure_label.grid(row=4, column=1, sticky=E, pady=5)
+ halt_checkbox = Checkbutton(
+ settings_frame, offvalue=False, onvalue=True, variable=self.halt_on_failure
+ )
+ halt_checkbox.grid(row=4, column=2, columnspan=2, sticky=W, pady=5)
+
+ directory_label = Label(actions, text="Template Location:")
+ directory_label.grid(row=4, column=1, pady=5, sticky=W)
+ self.template_source = StringVar(self._root, name="template_source")
+ directory_entry = Entry(actions, width=40, textvariable=self.template_source)
+ directory_entry.grid(row=4, column=2, pady=5, sticky=W)
+ directory_browse = Button(actions, text="...", command=self.ask_template_source)
+ directory_browse.grid(row=4, column=3, pady=5, sticky=W)
+
+ validate = Button(actions, text="Validate Templates", command=self.validate)
+ validate.grid(row=5, column=1, columnspan=2, pady=5)
+
+ self.result_panel = Frame(actions)
+ # We'll add these labels now, and then make them visible when the run completes
+ self.completion_label = Label(self.result_panel, text="Validation Complete!")
+ self.result_label = Label(
+ self.result_panel, text="View Report", fg="blue", cursor="hand2"
+ )
+ self.underline(self.result_label)
+ self.result_label.bind("<Button-1>", self.open_report)
+ self.result_panel.grid(row=6, column=1, columnspan=2)
+ control_panel.pack(fill=BOTH, expand=1)
+
+ main_window.add(control_panel)
+
+ self.log_panel = ScrolledText(main_window, wrap=WORD, width=120, height=20)
+ self.log_panel.configure(font=font.Font(family="Courier New", size="11"))
+ self.log_panel.pack(fill=BOTH, expand=1)
+
+ main_window.add(self.log_panel)
+
+ # Briefly add the completion and result labels so the window size includes
+ # room for them
+ self.completion_label.pack()
+ self.result_label.pack() # Show report link
+ self._root.after_idle(
+ lambda: (
+ self.completion_label.pack_forget(),
+ self.result_label.pack_forget(),
+ )
+ )
+
+ self.config.watch(
+ *self.categories,
+ self.verbosity,
+ self.input_format,
+ self.report_format,
+ self.halt_on_failure,
+ )
+ self.schedule(self.execute_pollers)
+
+ def ask_template_source(self):
+ if self.input_format.get() == "ZIP File":
+ template_source = filedialog.askopenfilename(
+ title="Select Archive",
+ filetypes=(("ZIP Files", "*.zip"), ("All Files", "*")),
+ )
+ else:
+ template_source = filedialog.askdirectory()
+ self.template_source.set(template_source)
+
+ def validate(self):
+ """Run the pytest validations in a background process"""
+ if not self.delete_prior_report():
+ return
+
+ if not self.template_source.get():
+ self.ask_template_source()
+
+ template_dir = self.resolve_template_dir()
+
+ if template_dir:
+ self.kill_background_task()
+ self.clear_log()
+ self.completion_label.pack_forget()
+ self.result_label.pack_forget()
+ self.task = multiprocessing.Process(
+ target=run_pytest,
+ args=(
+ template_dir,
+ self.config.log_file,
+ self.config.status_queue,
+ self.categories_list(),
+ self.VERBOSITY_LEVELS[self.verbosity.get()],
+ self.report_format.get().lower(),
+ self.halt_on_failure.get(),
+ self.template_source.get(),
+ ),
+ )
+ self.task.daemon = True
+ self.task.start()
+
+ @property
+ def title(self):
+ """Returns the text displayed in the title bar of the application"""
+ return self._root.title()
+
+ def execute_pollers(self):
+ """Call all methods that require periodic execution, and re-schedule
+ their execution for the next polling interval"""
+ try:
+ self.poll_log_file()
+ self.poll_status_queue()
+ self.poll_command_queue()
+ finally:
+ self.schedule(self.execute_pollers)
+
+ @staticmethod
+ def _drain_queue(q):
+ """Yields values from the queue until empty"""
+ while True:
+ try:
+ yield q.get(block=False)
+ except queue.Empty:
+ break
+
+ def poll_command_queue(self):
+ """Picks up command strings from the commmand queue, and
+ dispatches it for execution. Only SHUTDOWN is supported
+ currently"""
+ for command in self._drain_queue(self.config.command_queue):
+ if command == "SHUTDOWN":
+ self.shutdown()
+
+ def poll_status_queue(self):
+ """Checks for completion of the job, and then displays the View Report link
+ if it was successful or writes the exception to the ``log_panel`` if
+ it fails."""
+ for is_success, e in self._drain_queue(self.config.status_queue):
+ if is_success:
+ self.completion_label.pack()
+ self.result_label.pack() # Show report link
+ else:
+ self.log_panel.insert(END, str(e))
+
+ def poll_log_file(self):
+ """Reads captured stdout and stderr from the log queue and writes it to the
+ log panel."""
+ for line in self._drain_queue(self.config.log_queue):
+ self.log_panel.insert(END, line)
+ self.log_panel.see(END)
+
+ def schedule(self, func: Callable):
+ """Schedule the callable ``func`` to be executed according to
+ the polling_frequency"""
+ self._root.after(self.config.polling_frequency, func)
+
+ def clear_log(self):
+ """Removes all log entries from teh log panel"""
+ self.log_panel.delete("1.0", END)
+
+ def delete_prior_report(self) -> bool:
+ """Attempts to delete the current report, and pops up a warning message
+ to the user if it can't be deleted. This will force the user to
+ close the report before re-running the validation. Returns True if
+ the file was deleted or did not exist, or False otherwise"""
+ if not os.path.exists(self.report_file_path):
+ return True
+
+ try:
+ os.remove(self.report_file_path)
+ return True
+ except OSError as e:
+ messagebox.showerror(
+ "Error",
+ "Please close or rename the open report file before re-validating",
+ )
+ return False
+
+ @property
+ def report_file_path(self):
+ ext_mapping = {"csv": "csv", "html": "html", "excel": "xlsx"}
+ ext = ext_mapping.get(self.report_format.get().lower())
+ return os.path.join(PATH, OUT_DIR, "report.{}".format(ext))
+
+ def open_report(self, event):
+ """Open the report in the user's default browser"""
+ webbrowser.open_new("file://{}".format(self.report_file_path))
+
+ def start(self):
+ """Start the event loop of the application. This method does not return"""
+ self._root.mainloop()
+
+ @staticmethod
+ def underline(label):
+ """Apply underline format to an existing label"""
+ f = font.Font(label, label.cget("font"))
+ f.configure(underline=True)
+ label.configure(font=f)
+
+ def kill_background_task(self):
+ if self.task and self.task.is_alive():
+ self.task.terminate()
+ for _ in self._drain_queue(self.config.log_queue):
+ pass
+
+ def shutdown(self):
+ """Shutdown the application"""
+ self.kill_background_task()
+ self._root.destroy()
+
+ def check_template_source_is_valid(self):
+ """Verifies the value of template source exists and of valid type based
+ on input setting"""
+ if not self.template_source.get():
+ return False
+ template_path = Path(self.template_source.get())
+
+ if not template_path.exists():
+ messagebox.showerror(
+ "Error",
+ "Input does not exist. Please provide a valid file or directory.",
+ )
+ return False
+
+ if self.input_format.get() == "ZIP File":
+ if zipfile.is_zipfile(template_path):
+ return True
+ else:
+ messagebox.showerror(
+ "Error", "Expected ZIP file, but input is not a valid ZIP file"
+ )
+ return False
+ else:
+ if template_path.is_dir():
+ return True
+ else:
+ messagebox.showerror(
+ "Error", "Expected directory, but input is not a directory"
+ )
+ return False
+
+ def resolve_template_dir(self) -> str:
+ """Extracts the zip file to a temporary directory if needed, otherwise
+ returns the directory supplied to template source. Returns empty string
+ if the template source isn't valid"""
+ if not self.check_template_source_is_valid():
+ return ""
+ if self.input_format.get() == "ZIP File":
+ temp_dir = tempfile.mkdtemp()
+ archive = zipfile.ZipFile(self.template_source.get())
+ archive.extractall(path=temp_dir)
+ return temp_dir
+ else:
+ return self.template_source.get()
+
+ def categories_list(self) -> list:
+ categories = []
+ selected_categories = self.categories
+ for x in range(0, len(selected_categories)):
+ if selected_categories[x].get():
+ category = self.config.category_names[x]
+ categories.append(self.config.get_category(category))
+ return categories
+
+
+if __name__ == "__main__":
+ multiprocessing.freeze_support() # needed for PyInstaller to work
+ ValidatorApp().start()