tools/check_sql_modules.py

#!/usr/bin/env python3
# Copyright (C) 2022 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file 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.

# This tool checks that every SQL object created without prefix
# 'internal_' is documented with proper schema.

import argparse
import os
import sys

ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(os.path.join(ROOT_DIR))

from python.generators.stdlib_docs.parse import parse_file_to_dict


def main():
  parser = argparse.ArgumentParser()
  parser.add_argument(
      '--stdlib-sources',
      default=os.path.join(ROOT_DIR, "src", "trace_processor", "stdlib"))
  args = parser.parse_args()
  errors = []
  for root, _, files in os.walk(args.stdlib_sources, topdown=True):
    for f in files:
      path = os.path.join(root, f)
      if not path.endswith(".sql"):
        continue
      with open(path, 'r') as f:
        sql = f.read()

      res = parse_file_to_dict(path, sql)
      errors += res if isinstance(res, list) else []

      # Ban the use of LIKE in non-comment lines.
      lines = [l.strip() for l in sql.split('\n')]
      for line in lines:
        if line.startswith('--'):
          continue

        if 'like' in line.casefold():
          errors.append('LIKE is banned in trace processor metrics. '
                        'Prefer GLOB instead.')
          errors.append('Offending file: %s' % path)

      # Ban the use of CREATE_FUNCTION.
      for line in lines:
        if line.startswith('--'):
          continue

        if 'create_function' in line.casefold():
          errors.append('CREATE_FUNCTION is deprecated in trace processor. '
                        'Prefer CREATE PERFETTO FUNCTION instead.')
          errors.append('Offending file: %s' % path)

  sys.stderr.write("\n".join(errors))
  sys.stderr.write("\n")
  return 0 if not errors else 1


if __name__ == "__main__":
  sys.exit(main())