framework/replay/programs/query.py

   1 # coding=utf-8
   2 #
   3 # Copyright (c) 2019 Collabora Ltd
   4 # Copyright © 2020 Valve Corporation.
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a
   7 # copy of this software and associated documentation files (the "Software"),
   8 # to deal in the Software without restriction, including without limitation
   9 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10 # and/or sell copies of the Software, and to permit persons to whom the
  11 # Software is furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included
  14 # in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20 # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22 # OTHER DEALINGS IN THE SOFTWARE.
  23 #
  24 # SPDX-License-Identifier: MIT
  25
  26 import argparse
  27
  28 from framework import exceptions
  29 from framework.replay import query_traces_yaml as qty
  30
  31 from . import parsers
  32
  33 __all__ = ['query']
  34
  35
  36 def _traces_db_download_url(args):
  37     y = qty.load_yaml(args.yaml_file)
  38
  39     url = qty.download_url(y) or ""
  40
  41     print(url)
  42
  43
  44 def _traces(args):
  45     y = qty.load_yaml(args.yaml_file)
  46
  47     t_list = qty.traces(y,
  48                         trace_extensions=args.trace_extensions,
  49                         device_name=args.device_name,
  50                         checksum=args.checksum)
  51
  52     if args.checksum:
  53         print('\n'.join(((t['path'] + '\n' + t['checksum'])
  54                          for t in t_list)))
  55     else:
  56         print('\n'.join((t['path'] for t in t_list)))
  57
  58
  59 def _checksum(args):
  60     y = qty.load_yaml(args.yaml_file)
  61
  62     traces = y['traces']
  63     try:
  64         trace = next(t for t in traces if t['path'] == args.file_path)
  65     except StopIteration:
  66         print("")
  67         return
  68
  69     print(qty.trace_checksum(trace, args.device_name))
  70
  71
  72 @exceptions.handler
  73 def query(input_):
  74     """ Parser for replayer query command """
  75     try:
  76         parser = argparse.ArgumentParser(parents=[parsers.YAML])
  77         # The "required" keyword is only available since python >= 3.7
  78         subparsers = parser.add_subparsers(dest='command', required=True)
  79     except TypeError:
  80         parser = argparse.ArgumentParser(parents=[parsers.YAML])
  81         # Add a destination due to
  82         # https://github.com/python/cpython/pull/3027#issuecomment-330910633
  83         subparsers = parser.add_subparsers(dest='command')
  84
  85     parser_checksum = subparsers.add_parser(
  86         'checksum',
  87         parents=[parsers.DEVICE],
  88         help=('Outputs, if available, the checksum that a specific device '
  89               'should produce for a specified trace file.'))
  90     parser_checksum.add_argument(
  91         'file_path',
  92         help=('the path to a trace file.'))
  93     parser_checksum.set_defaults(func=_checksum)
  94
  95     parser_traces = subparsers.add_parser(
  96         'traces',
  97         parents=[parsers.DEVICE],
  98         help=('Outputs the trace files filtered by the optional arguments.'))
  99     parser_traces.add_argument(
 100         '-t', '--trace-extensions',
 101         required=False,
 102         default=None,
 103         help=('a comma separated list of trace extensions to look for '
 104               'in recursive dir walks (e.g. ".trace,.rdc"). '
 105               'If none are provide, all supported extensions '
 106               'are used by default'))
 107     parser_traces.add_argument(
 108         '-c', '--checksum',
 109         action='store_true',
 110         help='whether to print the checksum below every trace')
 111     parser_traces.set_defaults(func=_traces)
 112
 113     parser_traces_db_download_url = subparsers.add_parser(
 114         'traces_db_download_url',
 115         help=('Outputs, if available, the download URL.'))
 116     parser_traces_db_download_url.set_defaults(func=_traces_db_download_url)
 117
 118     args = parser.parse_args(input_)
 119
 120     args.func(args)