support_add_comment.py

#!/usr/bin/env python3

# Copyright 2022 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.

import os
import slack
import requests
import logging
from datetime import datetime
from get_parent import get_parent
from case_not_found import case_not_found
from googleapiclient.discovery import build_from_document

logger = logging.getLogger(__name__)


def support_add_comment(channel_id, case, comment, user_id, user_name):
    """
    Add a comment to a Google Cloud support case.

    Parameters
    ----------
    channel_id : str
        unique string used to idenify a Slack channel. Used to send messages to the channel
    case : str
        unique id of the case
    comment : str
        comment to be added to the case
    user_id : str
        the Slack user_id of the user who submitted the request. Used to send ephemeral
        messages to the user
    user_name : str
        Slack user_name of the user that ran the command. Appended to the end of the
        comment to identify who submitted submitted it, otherwise all comments will
        show as coming from the case creator
    """
    API_KEY = os.environ.get('API_KEY')
    MAX_RETRIES = 3

    # Get our discovery doc and build our service
    r = requests.get('https://cloudsupport.googleapis.com/$discovery/rest'
                     '?key={}&labels=V2_TRUSTED_TESTER&version=v2beta'.format(API_KEY))
    r.raise_for_status()
    support_service = build_from_document(r.json())

    client = slack.WebClient(token=os.environ.get('SLACK_TOKEN'))
    client.chat_postEphemeral(
        channel=channel_id,
        user=user_id,
        text="Your request is processing ...")
    parent = get_parent(case)

    if parent == 'Case not found':
        case_not_found(channel_id, user_id, case)
    else:
        req_body = {
            "body": (comment + '\n*Comment submitted by {} via Google Cloud Support'
                     ' Slack bot*'.format(user_name))
        }
        req = support_service.cases().comments().create(parent=parent, body=req_body)
        try:
            req.execute(num_retries=MAX_RETRIES)
        except BrokenPipeError as e:
            error_message = str(e) + ' : {}'.format(datetime.now())
            logger.error(error_message)
            client.chat_postEphemeral(
                channel=channel_id,
                user=user_id,
                text="Your comment may not have posted. Please try again later.")
        else:
            client.chat_postEphemeral(
                channel=channel_id,
                user=user_id,
                text=f"You added a new comment on case {case}: {comment}")


if __name__ == "__main__":
    channel_id = os.environ.get('TEST_CHANNEL_ID')
    case = 'xxxxxxxx'
    comment = "This is a test comment created by the Google Cloud Support Slackbot"
    user_id = os.environ.get('TEST_USER_ID')
    user_name = os.environ.get('TEST_USER_NAME')
    support_add_comment(channel_id, case, comment, user_id, user_name)
    case = os.environ.get('TEST_CASE')
    support_add_comment(channel_id, case, comment, user_id, user_name)