From 37faa8a19ae432db09fc0ae724540189fc57cee9 Mon Sep 17 00:00:00 2001
From: Luis Araujo <luis.araujo@collabora.co.uk>
Date: Thu, 15 Nov 2018 16:49:57 +0800
Subject: [PATCH] Keep the test case data format private in the module

Keep the test case data format private in the parser module.

Signed-off-by: Luis Araujo <luis.araujo@collabora.co.uk>
---
 renderer/make_page.py |  4 ++--
 renderer/parser.py    | 11 +++++++----
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/renderer/make_page.py b/renderer/make_page.py
index 299d217..8469146 100755
--- a/renderer/make_page.py
+++ b/renderer/make_page.py
@@ -10,7 +10,7 @@ import shutil
 from jinja2 import Environment, FileSystemLoader
 from argparse import ArgumentParser
 
-from parser import parse_format, test_case_format
+from parser import parse_format
 
 TEMPLATE_DIR="."
 
@@ -143,7 +143,7 @@ def generate_test_case(tc_file, directory):
 
     # Parse file to detect any syntax error.
     print("Parsing file", tc_file)
-    parse_format(tc_data, test_case_format)
+    parse_format(tc_data)
 
     env = Environment(loader=FileSystemLoader([TEMPLATE_DIR]))
     # Get template from environment and render it.
diff --git a/renderer/parser.py b/renderer/parser.py
index 71b323f..83f2587 100644
--- a/renderer/parser.py
+++ b/renderer/parser.py
@@ -7,7 +7,7 @@
 import sys
 import yaml
 
-
+# This structure defines the test case YAML file format.
 test_case_format = {
     'metadata' : (True, {
         'name' : (True, ""),
@@ -35,7 +35,7 @@ test_case_format = {
     'parse' : (False, {})
 }
 
-def parse_format(test_case, test_case_format):
+def _parse_format(test_case, test_case_format):
     for tagf, valuestr in test_case_format.items():
         mandatory, valuef = valuestr
         value = test_case.get(tagf)
@@ -63,14 +63,17 @@ def parse_format(test_case, test_case_format):
             sys.exit(1)
 
         if type(value) == dict:
-            parse_format(value, valuef)
+            _parse_format(value, valuef)
 
     return True
 
+def parse_format(test_case):
+    return _parse_format(test_case, test_case_format)
+
 
 if '__main__' == __name__:
     testcase = sys.argv[1]
     with open(testcase) as test_case:
         test_case_data = yaml.safe_load(test_case)
 
-    parse_format(test_case_data, test_case_format)
+    parse_format(test_case_data)
-- 
GitLab