1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
|
"""Command line interface to schema-salad."""
from __future__ import absolute_import, print_function
import argparse
import itertools
import logging
import os
import re
import sys
from typing import (Any, Dict, List, Mapping, MutableSequence, Pattern, Tuple,
Union, cast)
import pkg_resources # part of setuptools
from rdflib.parser import Parser
from rdflib.plugin import register
from ruamel.yaml.comments import CommentedMap
import six
from six.moves import urllib
from typing_extensions import Text # pylint: disable=unused-import
# move to a regular typing import when Python 3.3-3.6 is no longer supported
from . import codegen, jsonld_context, schema, validate
from .ref_resolver import Loader, file_uri
from .sourceline import strip_dup_lineno
from .utils import json_dumps
from .avro.schema import SchemaParseException
register('json-ld', Parser, 'rdflib_jsonld.parser', 'JsonLDParser')
_logger = logging.getLogger("salad")
def printrdf(workflow, # type: str
wf, # type: Union[List[Dict[Text, Any]], Dict[Text, Any]]
ctx, # type: Dict[Text, Any]
sr # type: str
):
# type: (...) -> None
g = jsonld_context.makerdf(workflow, wf, ctx)
print(g.serialize(format=sr, encoding='utf-8').decode('utf-8')) # type: ignore
def regex_chunk(lines, regex):
# type: (List[str], Pattern[str]) -> List[List[str]]
lst = list(itertools.dropwhile(lambda x: not regex.match(x), lines))
arr = []
while lst:
ret = [lst[0]]+list(itertools.takewhile(lambda x: not regex.match(x),
lst[1:]))
arr.append(ret)
lst = list(itertools.dropwhile(lambda x: not regex.match(x),
lst[1:]))
return arr
def chunk_messages(message): # type: (str) -> List[Tuple[int, str]]
file_regex = re.compile(r'^(.+:\d+:\d+:)(\s+)(.+)$')
item_regex = re.compile(r'^\s*\*\s+')
arr = []
for chun in regex_chunk(message.splitlines(), file_regex):
fst = chun[0]
mat = file_regex.match(fst)
if mat:
place = mat.group(1)
indent = len(mat.group(2))
lst = [mat.group(3)]+chun[1:]
if [x for x in lst if item_regex.match(x)]:
for item in regex_chunk(lst, item_regex):
msg = re.sub(item_regex, '', "\n".join(item))
arr.append((indent, place+' '+re.sub(
r'[\n\s]+', ' ', msg)))
else:
msg = re.sub(item_regex, '', "\n".join(lst))
arr.append((indent, place+' '+re.sub(
r'[\n\s]+', ' ', msg)))
return arr
def to_one_line_messages(message): # type: (str) -> str
ret = []
max_elem = (0, '')
for (indent, msg) in chunk_messages(message):
if indent > max_elem[0]:
max_elem = (indent, msg)
else:
ret.append(max_elem[1])
max_elem = (indent, msg)
ret.append(max_elem[1])
return "\n".join(ret)
def reformat_yaml_exception_message(message): # type: (str) -> str
line_regex = re.compile(r'^\s+in "(.+)", line (\d+), column (\d+)$')
fname_regex = re.compile(r'^file://'+re.escape(os.getcwd())+'/')
msgs = message.splitlines()
ret = []
if len(msgs) == 3:
msgs = msgs[1:]
nblanks = 0
elif len(msgs) == 4:
c_msg = msgs[0]
match = line_regex.match(msgs[1])
if match:
c_file, c_line, c_column = match.groups()
c_file = re.sub(fname_regex, '', c_file)
ret.append("%s:%s:%s: %s" % (c_file, c_line, c_column, c_msg))
msgs = msgs[2:]
nblanks = 2
p_msg = msgs[0]
match = line_regex.match(msgs[1])
if match:
p_file, p_line, p_column = match.groups()
p_file = re.sub(fname_regex, '', p_file)
ret.append("%s:%s:%s:%s %s" % (p_file, p_line, p_column, ' '*nblanks, p_msg))
return "\n".join(ret)
def main(argsl=None): # type: (List[str]) -> int
if argsl is None:
argsl = sys.argv[1:]
parser = argparse.ArgumentParser()
parser.add_argument("--rdf-serializer",
help="Output RDF serialization format used by --print-rdf (one of turtle (default), n3, nt, xml)",
default="turtle")
parser.add_argument("--skip-schemas", action="store_true", default=False, help="If specified, ignore $schemas sections.")
parser.add_argument("--strict-foreign-properties", action="store_true", help="Strict checking of foreign properties",
default=False)
exgroup = parser.add_mutually_exclusive_group()
exgroup.add_argument("--print-jsonld-context", action="store_true",
help="Print JSON-LD context for schema")
exgroup.add_argument(
"--print-rdfs", action="store_true", help="Print RDF schema")
exgroup.add_argument("--print-avro", action="store_true",
help="Print Avro schema")
exgroup.add_argument("--print-rdf", action="store_true",
help="Print corresponding RDF graph for document")
exgroup.add_argument("--print-pre", action="store_true",
help="Print document after preprocessing")
exgroup.add_argument(
"--print-index", action="store_true", help="Print node index")
exgroup.add_argument("--print-metadata",
action="store_true", help="Print document metadata")
exgroup.add_argument("--print-inheritance-dot",
action="store_true", help="Print graphviz file of inheritance")
exgroup.add_argument("--print-fieldrefs-dot",
action="store_true", help="Print graphviz file of field refs")
exgroup.add_argument("--codegen", type=str, metavar="language", help="Generate classes in target language, currently supported: python")
exgroup.add_argument("--print-oneline", action="store_true",
help="Print each error message in oneline")
exgroup = parser.add_mutually_exclusive_group()
exgroup.add_argument("--strict", action="store_true", help="Strict validation (unrecognized or out of place fields are error)",
default=True, dest="strict")
exgroup.add_argument("--non-strict", action="store_false", help="Lenient validation (ignore unrecognized fields)",
default=True, dest="strict")
exgroup = parser.add_mutually_exclusive_group()
exgroup.add_argument("--verbose", action="store_true",
help="Default logging")
exgroup.add_argument("--quiet", action="store_true",
help="Only print warnings and errors.")
exgroup.add_argument("--debug", action="store_true",
help="Print even more logging")
parser.add_argument("schema", type=str, nargs="?", default=None)
parser.add_argument("document", type=str, nargs="?", default=None)
parser.add_argument("--version", "-v", action="store_true",
help="Print version", default=None)
args = parser.parse_args(argsl)
if args.version is None and args.schema is None:
print('%s: error: too few arguments' % sys.argv[0])
return 1
if args.quiet:
_logger.setLevel(logging.WARN)
if args.debug:
_logger.setLevel(logging.DEBUG)
pkg = pkg_resources.require("schema_salad")
if pkg:
if args.version:
print("%s Current version: %s" % (sys.argv[0], pkg[0].version))
return 0
else:
_logger.info("%s Current version: %s", sys.argv[0], pkg[0].version)
# Get the metaschema to validate the schema
metaschema_names, metaschema_doc, metaschema_loader = schema.get_metaschema()
# Load schema document and resolve refs
schema_uri = args.schema
if not (urllib.parse.urlparse(schema_uri)[0] and urllib.parse.urlparse(schema_uri)[0] in [u'http', u'https', u'file']):
schema_uri = file_uri(os.path.abspath(schema_uri))
schema_raw_doc = metaschema_loader.fetch(schema_uri)
try:
schema_doc, schema_metadata = metaschema_loader.resolve_all(
schema_raw_doc, schema_uri)
except (validate.ValidationException) as e:
_logger.error("Schema `%s` failed link checking:\n%s",
args.schema, e, exc_info=(True if args.debug else False))
_logger.debug("Index is %s", list(metaschema_loader.idx.keys()))
_logger.debug("Vocabulary is %s", list(metaschema_loader.vocab.keys()))
return 1
except (RuntimeError) as e:
_logger.error("Schema `%s` read error:\n%s",
args.schema, e, exc_info=(True if args.debug else False))
return 1
# Optionally print the schema after ref resolution
if not args.document and args.print_pre:
print(json_dumps(schema_doc, indent=4))
return 0
if not args.document and args.print_index:
print(json_dumps(list(metaschema_loader.idx.keys()), indent=4))
return 0
# Validate the schema document against the metaschema
try:
schema.validate_doc(metaschema_names, schema_doc,
metaschema_loader, args.strict)
except validate.ValidationException as e:
_logger.error("While validating schema `%s`:\n%s",
args.schema, str(e))
return 1
# Get the json-ld context and RDFS representation from the schema
metactx = schema.collect_namespaces(schema_metadata)
if "$base" in schema_metadata:
metactx["@base"] = schema_metadata["$base"]
if schema_doc is not None:
(schema_ctx, rdfs) = jsonld_context.salad_to_jsonld_context(
schema_doc, metactx)
else:
raise Exception("schema_doc is None??")
# Create the loader that will be used to load the target document.
document_loader = Loader(schema_ctx, skip_schemas=args.skip_schemas)
if args.codegen:
codegen.codegen(args.codegen, cast(List[Dict[Text, Any]], schema_doc),
schema_metadata, document_loader)
return 0
# Make the Avro validation that will be used to validate the target
# document
if isinstance(schema_doc, MutableSequence):
avsc_obj = schema.make_avro(schema_doc, document_loader)
try:
avsc_names = schema.make_avro_schema_from_avro(avsc_obj)
except SchemaParseException as err:
_logger.error("Schema `%s` error:\n%s", args.schema, err,
exc_info=(
(type(err), err, None) if args.debug else None))
if args.print_avro:
print(json_dumps(avsc_obj, indent=4))
return 1
else:
_logger.error("Schema `%s` must be a list.", args.schema)
return 1
# Optionally print Avro-compatible schema from schema
if args.print_avro:
print(json_dumps(avsc_obj, indent=4))
return 0
# Optionally print the json-ld context from the schema
if args.print_jsonld_context:
j = {"@context": schema_ctx}
print(json_dumps(j, indent=4, sort_keys=True))
return 0
# Optionally print the RDFS graph from the schema
if args.print_rdfs:
print(rdfs.serialize(format=args.rdf_serializer).decode('utf-8')) # type: ignore
return 0
if args.print_metadata and not args.document:
print(json_dumps(schema_metadata, indent=4))
return 0
if args.print_inheritance_dot:
schema.print_inheritance(schema_doc, sys.stdout)
return 0
if args.print_fieldrefs_dot:
schema.print_fieldrefs(schema_doc, document_loader, sys.stdout)
return 0
# If no document specified, all done.
if not args.document:
print("Schema `%s` is valid" % args.schema)
return 0
# Load target document and resolve refs
try:
uri = args.document
if not urllib.parse.urlparse(uri)[0]:
doc = "file://" + os.path.abspath(uri)
document, doc_metadata = document_loader.resolve_ref(uri, strict_foreign_properties=args.strict_foreign_properties)
except validate.ValidationException as e:
msg = strip_dup_lineno(six.text_type(e))
msg = to_one_line_messages(str(msg)) if args.print_oneline else msg
_logger.error("Document `%s` failed validation:\n%s",
args.document, msg, exc_info=args.debug)
return 1
except RuntimeError as e:
msg = strip_dup_lineno(six.text_type(e))
msg = reformat_yaml_exception_message(str(msg))
msg = to_one_line_messages(msg) if args.print_oneline else msg
_logger.error("Document `%s` failed validation:\n%s",
args.document, msg, exc_info=args.debug)
return 1
# Optionally print the document after ref resolution
if args.print_pre:
print(json_dumps(document, indent=4))
return 0
if args.print_index:
print(json_dumps(list(document_loader.idx.keys()), indent=4))
return 0
# Validate the user document against the schema
try:
schema.validate_doc(avsc_names, document,
document_loader, args.strict,
strict_foreign_properties=args.strict_foreign_properties)
except validate.ValidationException as e:
msg = to_one_line_messages(str(e)) if args.print_oneline else str(e)
_logger.error("While validating document `%s`:\n%s" %
(args.document, msg))
return 1
# Optionally convert the document to RDF
if args.print_rdf:
if isinstance(document, (Mapping, MutableSequence)):
printrdf(args.document, document, schema_ctx, args.rdf_serializer)
return 0
else:
print("Document must be a dictionary or list.")
return 1
if args.print_metadata:
print(json_dumps(doc_metadata, indent=4))
return 0
print("Document `%s` is valid" % args.document)
return 0
if __name__ == "__main__":
sys.exit(main(sys.argv[1:]))
|