ambari-server/src/test/python/TestServerUtils.py

#!/usr/bin/env python3
"""
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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

os.environ["ROOT"] = ""

from mock.mock import patch, MagicMock
from unittest import TestCase
import distro
import platform
import socket
import ssl

from ambari_commons import os_utils

os_utils.search_file = MagicMock(return_value="/tmp/ambari.properties")
import shutil

project_dir = os.path.join(
  os.path.abspath(os.path.dirname(__file__)), os.path.normpath("../../../../")
)
shutil.copyfile(
  project_dir + "/ambari-server/conf/unix/ambari.properties", "/tmp/ambari.properties"
)

with patch.object(
  distro,
  "linux_distribution",
  return_value=MagicMock(return_value=("Redhat", "6.4", "Final")),
):
  with patch("os.path.isdir", return_value=MagicMock(return_value=True)):
    with patch("os.access", return_value=MagicMock(return_value=True)):
      with patch.object(
        os_utils,
        "parse_log4j_file",
        return_value={"ambari.log.dir": "/var/log/ambari-server"},
      ):
        from ambari_server.serverUtils import (
          get_ambari_server_api_base,
          get_ambari_admin_username_password_pair,
          is_api_ssl_enabled,
          get_ssl_context,
        )
        from ambari_server.serverConfiguration import (
          CLIENT_API_PORT,
          CLIENT_API_PORT_PROPERTY,
          SSL_API,
          DEFAULT_SSL_API_PORT,
          SSL_API_PORT,
        )


@patch.object(
  distro, "linux_distribution", new=MagicMock(return_value=("Redhat", "6.4", "Final"))
)
class TestServerUtils(TestCase):
  def test_get_ambari_server_api_base(self):
    # Test case of using http protocol
    properties = FakeProperties({SSL_API: "false", CLIENT_API_PORT_PROPERTY: None})
    result = get_ambari_server_api_base(properties)
    self.assertEqual(result, "http://127.0.0.1:8080/api/v1/")

    # Test case of using http protocol and custom port
    properties = FakeProperties({SSL_API: "false", CLIENT_API_PORT_PROPERTY: "8033"})
    result = get_ambari_server_api_base(properties)
    self.assertEqual(result, "http://127.0.0.1:8033/api/v1/")

    # Test case of using https protocol (and ssl port)
    fqdn = socket.getfqdn()
    self.assertTrue(len(fqdn) > 0)

    properties = FakeProperties(
      {SSL_API: "true", SSL_API_PORT: "8443", CLIENT_API_PORT_PROPERTY: None}
    )
    result = get_ambari_server_api_base(properties)
    self.assertEqual(result, f"https://{fqdn}:8443/api/v1/")

  def test_get_ambari_admin_credentials_from_cli_options(self):
    user_name = "admin"
    password = "s#perS3cr3tP4ssw0d!"
    options = MagicMock()
    options.ambari_admin_username = user_name
    options.ambari_admin_password = password
    user, pw = get_ambari_admin_username_password_pair(options)
    self.assertEqual(user, user_name)
    self.assertEqual(pw, password)

  @patch("ambari_server.serverUtils.get_validated_string_input")
  def test_get_ambari_admin_credentials_from_user_input(
    self, get_validated_string_input_mock
  ):
    user_name = "admin"
    password = "s#perS3cr3tP4ssw0d!"
    options = MagicMock()
    options.ambari_admin_username = None
    options.ambari_admin_password = None

    def valid_input_side_effect(*args, **kwargs):
      return user_name if "Ambari Admin login" in args[0] else password

    get_validated_string_input_mock.side_effect = valid_input_side_effect

    user, pw = get_ambari_admin_username_password_pair(options)
    self.assertEqual(user, user_name)
    self.assertEqual(pw, password)

  def test_is_api_ssl_enabled(self):
    properties = FakeProperties({SSL_API: "true"})
    self.assertTrue(is_api_ssl_enabled(properties))

    properties = FakeProperties({SSL_API: "false"})
    self.assertFalse(is_api_ssl_enabled(properties))

    properties = FakeProperties({SSL_API: None})
    self.assertFalse(is_api_ssl_enabled(properties))

  def test_get_ssl_context(self):
    properties = FakeProperties({SSL_API: "true"})
    context = get_ssl_context(properties)
    if hasattr(ssl, "SSLContext"):
      self.assertIsNotNone(context)
    else:
      self.assertIsNone(context)

    context = get_ssl_context(properties, ssl.PROTOCOL_TLSv1)
    if hasattr(ssl, "SSLContext"):
      self.assertIsNotNone(context)
      self.assertEqual(ssl.PROTOCOL_TLSv1, context.protocol)
    else:
      self.assertIsNone(context)

    properties = FakeProperties({SSL_API: "false"})
    context = get_ssl_context(properties)
    self.assertIsNone(context)


class FakeProperties(object):
  def __init__(self, prop_map):
    self.prop_map = prop_map

  def get_property(self, prop_name):
    return self.prop_map[prop_name]