HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/lib/googlecloudsdk/api_lib/compute/partner_metadata_utils.py
# -*- coding: utf-8 -*- #
# Copyright 2023 Google LLC. All Rights Reserved.
#
# 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.

"""utilities function for partner metadata."""

from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals

import json

from apitools.base.py import encoding
from apitools.base.py import extra_types
from googlecloudsdk.api_lib.compute import exceptions
from googlecloudsdk.api_lib.util import apis as core_apis
from googlecloudsdk.calliope import arg_parsers

alpha_message = core_apis.GetMessagesModule('compute', 'alpha')
beta_message = core_apis.GetMessagesModule('compute', 'beta')


class NullValueInAddPartnerMetadataException(exceptions.Error):
  """Null values not allowed in add-partner-metadata."""


def AddPartnerMetadataArgs(parser):
  """Adds --metadata and --metadata-from-file flags."""
  parser.add_argument(
      '--partner-metadata',
      type=arg_parsers.ArgDict(),
      help=(
          'Partner metadata specifying namespace and its entries. The entries'
          ' can be key-value pairs or in json format.'
      ),
      default={},
      metavar='NAMESPACE/KEY=VALUE',
      action=arg_parsers.UpdateAction,
  )
  parser.add_argument(
      '--partner-metadata-from-file',
      type=arg_parsers.FileContents(),
      help=(
          'Path to a local json file containing partner metadata.'
      ),
      metavar='LOCAL_FILE_PATH',
  )


def CreatePartnerMetadataDict(args):
  """create partner metadata from the given args.

  Args:
    args: args containing partner-metadata or partner-metadata-from-file flags

  Returns:
    python dict contains partner metadata from given args.
  """
  return _CreatePartnerMetadataDict(
      args.partner_metadata, args.partner_metadata_from_file
  )


def _CreatePartnerMetadataDict(
    partner_metadata, partner_metadata_from_file=None
):
  """create partner metadata from the given args.

  Args:
    partner_metadata: partner metadata dictionary.
    partner_metadata_from_file: partner metadata file content.

  Returns:
    python dict contains partner metadata from given args.
  """
  partner_metadata_file = {}
  if partner_metadata_from_file:
    partner_metadata_file = json.loads(partner_metadata_from_file)
  partner_metadata_dict = {}
  for key in partner_metadata_file.keys():
    if 'entries' in partner_metadata_file[key]:
      partner_metadata_dict[key] = partner_metadata_file[key]
    else:
      partner_metadata_dict[key] = {'entries': partner_metadata_file[key]}
  for key, value in partner_metadata.items():
    namespace, *entries = key.split('/')
    if namespace not in partner_metadata_dict:
      partner_metadata_dict[namespace] = {'entries': {}}
    partner_metadata = partner_metadata_dict[namespace]
    if entries:
      for entry in entries[:-1]:
        partner_metadata[entry] = (
            partner_metadata[entry] if entry in partner_metadata else {}
        )
        partner_metadata = partner_metadata[entry]
      partner_metadata[entries[-1]] = json.loads(value)
    else:
      partner_metadata_dict[namespace] = json.loads(value)
  return partner_metadata_dict


def ValidatePartnerMetadata(partner_metadata):
  for key in partner_metadata.keys():
    if partner_metadata[key] is None:
      raise NullValueInAddPartnerMetadataException(
          'Null values are not allowed in partner metadata.'
      )
    if isinstance(partner_metadata[key], dict):
      ValidatePartnerMetadata(partner_metadata[key])


def ConvertStructuredEntries(
    structured_entries, compute_messages=alpha_message
):
  """Convert structured entries dictionary to message.

  Args:
    structured_entries: dictionary represents partner metadata structuredEntries
    compute_messages: compute messages object

  Returns:
    StructuredEntries message

  """
  structured_entries_message = compute_messages.StructuredEntries()
  if structured_entries is None or 'entries' not in structured_entries:
    return structured_entries_message
  if structured_entries['entries'] is None:
    structured_entries_message.entries = None
    return structured_entries_message
  structured_entries_message.entries = (
      compute_messages.StructuredEntries.EntriesValue()
  )
  for key, value in structured_entries['entries'].items():
    structured_entries_message.entries.additionalProperties.append(
        compute_messages.StructuredEntries.EntriesValue.AdditionalProperty(
            key=key, value=encoding.DictToMessage(value, extra_types.JsonValue)
        )
    )
  return structured_entries_message


def ConvertPartnerMetadataDictToMessage(
    partner_metadata_dict, compute_messages=alpha_message
):
  """Convert partner metadata dictionary to message.

  Args:
    partner_metadata_dict: dictionary represents partner metadata
    compute_messages: compute messages object

  Returns:
    partnerMetadata message

  """
  partner_metadata_message = (
      compute_messages.PartnerMetadata.PartnerMetadataValue()
  )
  for namespace, structured_entries in partner_metadata_dict.items():
    partner_metadata_message.additionalProperties.append(
        compute_messages.PartnerMetadata.PartnerMetadataValue.AdditionalProperty(
            key=namespace,
            value=ConvertStructuredEntries(structured_entries, compute_messages)
        )
    )
  return partner_metadata_message


def ConvertStructuredEntriesToJson(structured_entries_message):
  structured_entries_dict = {'entries': {}}
  for (
      structured_entry
  ) in structured_entries_message.entries.additionalProperties:
    structured_entries_dict['entries'][structured_entry.key] = (
        encoding.MessageToDict(structured_entry.value)
    )
  return json.dumps(structured_entries_dict)


def _AddEncodingForStructuredEntriesMessage(messages):
  """Add encoding for StructuredEntries message to convert it to json string.

  Args:
    messages: message represntantion of compute api.
  """
  def EncodeStructuredEntries(structured_entries_message):
    if structured_entries_message.entries is None:
      return 'null'
    return ConvertStructuredEntriesToJson(structured_entries_message)

  def DecodeStructuredEntries(structured_entries):
    structured_entries_dict = json.loads(structured_entries)
    return ConvertStructuredEntries(structured_entries_dict, messages)

  if hasattr(messages, 'StructuredEntries'):
    encoding.RegisterCustomMessageCodec(
        encoder=EncodeStructuredEntries, decoder=DecodeStructuredEntries
    )(messages.StructuredEntries)

_AddEncodingForStructuredEntriesMessage(alpha_message)
_AddEncodingForStructuredEntriesMessage(beta_message)