depot_tools/metadata/dependency_metadata.py

#!/usr/bin/env python3
# Copyright 2023 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from collections import defaultdict
import os
import sys
from typing import Dict, List, Set, Tuple

_THIS_DIR = os.path.abspath(os.path.dirname(__file__))
# The repo's root directory.
_ROOT_DIR = os.path.abspath(os.path.join(_THIS_DIR, ".."))

# Add the repo's root directory for clearer imports.
sys.path.insert(0, _ROOT_DIR)

import metadata.fields.field_types as field_types
import metadata.fields.custom.license
import metadata.fields.custom.version
import metadata.fields.known as known_fields
import metadata.fields.util as util
import metadata.validation_result as vr


class DependencyMetadata:
  """The metadata for a single dependency."""

  # Fields that are always required.
  _MANDATORY_FIELDS = {
      known_fields.NAME,
      known_fields.URL,
      known_fields.VERSION,
      known_fields.LICENSE,
      known_fields.SECURITY_CRITICAL,
      known_fields.SHIPPED,
  }

  def __init__(self):
    # The record of all entries added, including repeated fields.
    self._entries: List[Tuple[str, str]] = []

    # The current value of each field.
    self._metadata: Dict[field_types.MetadataField, str] = {}

    # The record of how many times a field entry was added.
    self._occurrences: Dict[field_types.MetadataField, int] = defaultdict(int)

  def add_entry(self, field_name: str, field_value: str):
    value = field_value.strip()
    self._entries.append((field_name, value))

    field = known_fields.get_field(field_name)
    if field:
      self._metadata[field] = value
      self._occurrences[field] += 1

  def has_entries(self) -> bool:
    return len(self._entries) > 0

  def get_entries(self) -> List[Tuple[str, str]]:
    return list(self._entries)

  def _assess_required_fields(self) -> Set[field_types.MetadataField]:
    """Returns the set of required fields, based on the current metadata."""
    required = set(self._MANDATORY_FIELDS)

    # The date and revision are required if the version has not been specified.
    version_value = self._metadata.get(known_fields.VERSION)
    if (version_value is None
        or metadata.fields.custom.version.is_unknown(version_value)):
      required.add(known_fields.DATE)
      required.add(known_fields.REVISION)

    # Assume the dependency is shipped if not specified.
    shipped_value = self._metadata.get(known_fields.SHIPPED)
    is_shipped = (shipped_value is None
                  or util.infer_as_boolean(shipped_value, default=True))

    if is_shipped:
      # A license file is required if the dependency is shipped.
      required.add(known_fields.LICENSE_FILE)

      # License compatibility with Android must be set if the package is shipped
      # and the license is not in the allowlist.
      has_allowlisted = False
      license_value = self._metadata.get(known_fields.LICENSE)
      if license_value:
        licenses = metadata.fields.custom.license.process_license_value(
            license_value,
            atomic_delimiter=known_fields.LICENSE.VALUE_DELIMITER)
        for _, allowed in licenses:
          if allowed:
            has_allowlisted = True
            break

      if not has_allowlisted:
        required.add(known_fields.LICENSE_ANDROID_COMPATIBLE)

    return required

  def validate(self, source_file_dir: str,
               repo_root_dir: str) -> List[vr.ValidationResult]:
    """Validates all the metadata.

    Args:
      source_file_dir: the directory of the file that the metadata is from.
      repo_root_dir: the repository's root directory.

    Returns: the metadata's validation results.
    """
    results = []

    # Check for duplicate fields.
    repeated_field_info = [
        f"{field.get_name()} ({count})"
        for field, count in self._occurrences.items() if count > 1
    ]
    if repeated_field_info:
      repeated = ", ".join(repeated_field_info)
      error = vr.ValidationError(reason="There is a repeated field.",
                                 additional=[
                                     f"Repeated fields: {repeated}",
                                 ])
      results.append(error)

    # Check required fields are present.
    required_fields = self._assess_required_fields()
    for field in required_fields:
      if field not in self._metadata:
        field_name = field.get_name()
        error = vr.ValidationError(
            reason=f"Required field '{field_name}' is missing.")
        results.append(error)

    # Validate values for all present fields.
    for field, value in self._metadata.items():
      field_result = field.validate(value)
      if field_result:
        field_result.set_tag(tag="field", value=field.get_name())
        results.append(field_result)

    # Check existence of the license file(s) on disk.
    license_file_value = self._metadata.get(known_fields.LICENSE_FILE)
    if license_file_value is not None:
      result = known_fields.LICENSE_FILE.validate_on_disk(
          value=license_file_value,
          source_file_dir=source_file_dir,
          repo_root_dir=repo_root_dir,
      )
      if result:
        result.set_tag(tag="field", value=known_fields.LICENSE_FILE.get_name())
        results.append(result)

    return results