api/controller/api_unittest.py

# -*- coding: utf-8 -*-
# Copyright 2019 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""API controller tests."""

from __future__ import print_function

import os

from chromite.api import api_config
from chromite.api import router
from chromite.api.controller import api as api_controller
from chromite.api.gen.chromite.api import api_pb2
from chromite.lib import constants
from chromite.lib import cros_test_lib


class CompileProtoTest(cros_test_lib.RunCommandTestCase,
                       api_config.ApiConfigMixin):
  """CompileProto tests."""

  def setUp(self):
    self.request = api_pb2.CompileProtoRequest()
    self.response = api_pb2.CompileProtoResponse()

  def testCompileProto(self):
    """Quick CompileProto functional check."""
    self.rc.SetDefaultCmdResult(stdout=' M foo/bar.py')
    expected = [os.path.join(constants.CHROMITE_DIR, 'foo/bar.py')]

    api_controller.CompileProto(self.request, self.response, self.api_config)
    returned = [f.path for f in self.response.modified_files]

    self.assertCountEqual(expected, returned)
    self.assertTrue(all(f in returned for f in expected))
    self.assertTrue(all(f in expected for f in returned))

  def testValidateOnly(self):
    """Verify validate only calls do not execute logic."""
    api_controller.CompileProto(self.request, self.response,
                                self.validate_only_config)

    self.assertFalse(self.rc.call_count)

  def testMockSuccess(self):
    """Verify mock success calls do not execute logic."""
    api_controller.CompileProto(self.request, self.response,
                                self.mock_call_config)
    self.assertTrue(len(self.response.modified_files))
    self.assertFalse(self.rc.call_count)


class GetMethodsTest(cros_test_lib.MockTestCase, api_config.ApiConfigMixin):
  """GetMethods tests."""

  def setUp(self):
    self.request = api_pb2.MethodGetRequest()
    self.response = api_pb2.MethodGetResponse()

  def testGetMethods(self):
    """Simple GetMethods sanity check."""
    methods = ['foo', 'bar']
    self.PatchObject(router.Router, 'ListMethods', return_value=methods)

    api_controller.GetMethods(self.request, self.response, self.api_config)

    self.assertCountEqual(methods, [m.method for m in self.response.methods])

  def testValidateOnly(self):
    """Sanity check validate only calls only validate."""
    patch = self.PatchObject(router.Router, 'ListMethods')

    api_controller.GetMethods(self.request, self.response,
                              self.validate_only_config)

    patch.assert_not_called()


class GetVersionTest(cros_test_lib.MockTestCase, api_config.ApiConfigMixin):
  """GetVersion tests."""

  def setUp(self):
    self.PatchObject(api_controller, 'VERSION_MAJOR', new=1)
    self.PatchObject(api_controller, 'VERSION_MINOR', new=2)
    self.PatchObject(api_controller, 'VERSION_BUG', new=3)

    self.request = api_pb2.VersionGetRequest()
    self.response = api_pb2.VersionGetResponse()

  def testGetVersion(self):
    """Simple GetVersion sanity check."""
    api_controller.GetVersion(self.request, self.response, self.api_config)

    self.assertEqual(self.response.version.major, 1)
    self.assertEqual(self.response.version.minor, 2)
    self.assertEqual(self.response.version.bug, 3)

  def testValidateOnly(self):
    """Sanity check validate only calls only validate."""
    api_controller.GetVersion(self.request, self.response,
                              self.validate_only_config)

    self.assertFalse(self.response.version.major)
    self.assertFalse(self.response.version.minor)
    self.assertFalse(self.response.version.bug)