File: //lib/google-cloud-sdk/lib/googlecloudsdk/command_lib/run/traffic_printer.py
# -*- coding: utf-8 -*- #
# Copyright 2020 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.
"""Traffic-specific printer and functions for generating traffic formats."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.api_lib.run import traffic_pair
from googlecloudsdk.core.console import console_attr
from googlecloudsdk.core.resource import custom_printer_base as cp
TRAFFIC_PRINTER_FORMAT = 'traffic'
def _TransformTrafficPair(pair):
"""Transforms a single TrafficTargetPair into a marker class structure."""
console = console_attr.GetConsoleAttr()
return (pair.displayPercent, console.Emphasize(pair.displayRevisionId),
pair.displayTags, cp.Lines(pair.urls))
def _TransformTrafficPairs(traffic_pairs, service_url):
"""Transforms a List[TrafficTargetPair] into a marker class structure."""
traffic_section = cp.Section(
[cp.Table(_TransformTrafficPair(p) for p in traffic_pairs)])
return cp.Table([('Traffic:', service_url, traffic_section)])
def TransformTraffic(service):
"""Transforms a service's traffic into a marker class structure to print.
Generates the custom printing format for a service's traffic using the marker
classes defined in custom_printer_base.
Args:
service: A Service object.
Returns:
A custom printer marker object describing the traffic print format.
"""
traffic_pairs = traffic_pair.GetTrafficTargetPairs(
service.spec_traffic, service.status_traffic, service.is_managed,
service.status.latestReadyRevisionName)
return _TransformTrafficPairs(traffic_pairs, service.status.url)
class TrafficPrinter(cp.CustomPrinterBase):
"""Prints a service's traffic in a custom human-readable format."""
def Print(self, resources, single=False, intermediate=False):
"""Overrides ResourcePrinter.Print to set single=True."""
# The update-traffic command returns a List[TrafficTargetPair] as its
# result. In order to print the custom human-readable format, this printer
# needs to process all records in the result at once (to compute column
# widths). By default, ResourcePrinter interprets a List[*] as a list of
# separate records and passes the contents of the list to this printer
# one-by-one. Setting single=True forces ResourcePrinter to treat the
# result as one record and pass the entire list to this printer in one call.
super(TrafficPrinter, self).Print(resources, True, intermediate)
def Transform(self, record):
"""Transforms a List[TrafficTargetPair] into a marker class format."""
if record:
service_url = record[0].serviceUrl
else:
service_url = ''
return cp.Section([_TransformTrafficPairs(record, service_url)],
max_column_width=60)