marketplace/deployer_util/validate_app_resource.py

#!/usr/bin/env python3
#
# Copyright 2019 Google LLC
#
# 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.

from argparse import ArgumentParser
import json

from yaml_util import load_resources_yaml
from resources import find_application_resource
import schema_values_common

_PROG_HELP = """
Extract the Application resource from the input manifests and validate
its correctness, such as Marketplace partner and solution ID annotations,
application version and its declared value in the schema.
"""


def main():
  parser = ArgumentParser(description=_PROG_HELP)
  schema_values_common.add_to_argument_parser(parser)
  parser.add_argument(
      '--manifests',
      required=True,
      help='The yaml file containing all resources')
  args = parser.parse_args()

  schema = schema_values_common.load_schema(args)
  resources = load_resources_yaml(args.manifests)

  app = find_application_resource(resources)
  mp_deploy_info = app.get('metadata', {}).get(
      'annotations', {}).get('marketplace.cloud.google.com/deploy-info')
  if not mp_deploy_info:
    raise Exception('Application resource is missing '
                    '"marketplace.cloud.google.com/deploy-info" annotation')
  validate_deploy_info_annotation(mp_deploy_info, schema)

  version = app.get('spec', {}).get('descriptor', {}).get('version')
  if not version or not isinstance(version, str):
    raise Exception(
        'Application resource must have a valid spec.descriptor.version value')
  if schema.is_v2():
    published_version = schema.x_google_marketplace.published_version
    if version != published_version:
      raise Exception(
          'Application resource\'s spec.descriptor.version "{}" does not match '
          'schema.yaml\'s publishedVersion "{}"'.format(version,
                                                        published_version))


def validate_deploy_info_annotation(content, schema=None):
  try:
    parsed = json.loads(content)
    if 'partner_id' not in parsed:
      raise Exception('marketplace.cloud.google.com/deploy-info annotation '
                      'on the Application resource must contain a partner_id')
    if 'product_id' not in parsed:
      raise Exception('marketplace.cloud.google.com/deploy-info annotation '
                      'on the Application resource must contain a product_id')
    if (schema and schema.x_google_marketplace and
        schema.x_google_marketplace.partner_id):
      if (parsed['partner_id'] != schema.x_google_marketplace.partner_id or
          parsed['product_id'] != schema.x_google_marketplace.solution_id):
        raise Exception('Partner or solution ID values in the schema and the '
                        'Application resource are not consistent')
  except ValueError:
    raise Exception(
        'marketplace.cloud.google.com/deploy-info annotation on the '
        'Application resource must be valid JSON')


if __name__ == "__main__":
  main()