Build API: Refactor Router functionality into an api module.
BUG=None
TEST=run_tests
Change-Id: I082cebbd0caf3ff8704d00532eb5078045d60e1a
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/chromite/+/1669826
Tested-by: Alex Klein <saklein@chromium.org>
Auto-Submit: Alex Klein <saklein@chromium.org>
Reviewed-by: Evan Hernandez <evanhernandez@chromium.org>
Commit-Queue: Alex Klein <saklein@chromium.org>
diff --git a/api/router_unittest.py b/api/router_unittest.py
new file mode 100644
index 0000000..4de44a7
--- /dev/null
+++ b/api/router_unittest.py
@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+# Copyright 2018 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.
+
+"""Tests for the build_api script covering the base Build API functionality."""
+
+from __future__ import print_function
+
+import os
+
+from chromite.api import router
+from chromite.api.gen.chromite.api import build_api_test_pb2
+from chromite.lib import cros_build_lib
+from chromite.lib import cros_test_lib
+from chromite.lib import osutils
+
+
+class RouterTest(cros_test_lib.RunCommandTempDirTestCase):
+ """Test Router functionality."""
+ _INPUT_JSON_TEMPLATE = '{"id":"Input ID", "chroot":{"path": "%s"}}'
+
+ def setUp(self):
+ self.router = router.Router()
+ self.router.Register(build_api_test_pb2)
+
+ self.input_file = os.path.join(self.tempdir, 'input.json')
+ self.output_file = os.path.join(self.tempdir, 'output.json')
+
+ self.chroot_dir = os.path.join(self.tempdir, 'chroot')
+ chroot_tmp = os.path.join(self.chroot_dir, 'tmp')
+ # Make the tmp dir for the re-exec inside chroot input/output files.
+ osutils.SafeMakedirs(chroot_tmp)
+
+ osutils.WriteFile(self.input_file,
+ self._INPUT_JSON_TEMPLATE % self.chroot_dir)
+
+ def testInputOutputMethod(self):
+ """Test input/output handling."""
+ def impl(input_msg, output_msg):
+ self.assertIsInstance(input_msg, build_api_test_pb2.TestRequestMessage)
+ self.assertIsInstance(output_msg, build_api_test_pb2.TestResultMessage)
+
+ self.PatchObject(self.router, '_GetMethod', return_value=impl)
+
+ self.router.Route('chromite.api.TestApiService', 'InputOutputMethod',
+ self.input_file, self.output_file)
+
+ def testRenameMethod(self):
+ """Test implementation name config."""
+ def _GetMethod(_, method_name):
+ self.assertEqual('CorrectName', method_name)
+ return lambda x, y: None
+
+ self.PatchObject(self.router, '_GetMethod', side_effect=_GetMethod)
+
+ self.router.Route('chromite.api.TestApiService', 'RenamedMethod',
+ self.input_file, self.output_file)
+
+ def _mock_callable(self, expect_called):
+ """Helper to create the implementation mock to test chroot assertions.
+
+ Args:
+ expect_called (bool): Whether the implementation should be called.
+ When False, an assertion will fail if it is called.
+
+ Returns:
+ callable - The implementation.
+ """
+ def impl(_input_msg, _output_msg):
+ self.assertTrue(expect_called,
+ 'The implementation should not have been called.')
+
+ return impl
+
+ def testInsideServiceInsideMethodInsideChroot(self):
+ """Test inside/inside/inside works correctly."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=True))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=True)
+ self.router.Route('chromite.api.InsideChrootApiService',
+ 'InsideServiceInsideMethod', self.input_file,
+ self.output_file)
+
+ def testInsideServiceOutsideMethodOutsideChroot(self):
+ """Test the outside method override works as expected."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=True))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=False)
+ self.router.Route('chromite.api.InsideChrootApiService',
+ 'InsideServiceOutsideMethod', self.input_file,
+ self.output_file)
+
+ def testInsideServiceInsideMethodOutsideChroot(self):
+ """Test calling an inside method from outside the chroot."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=False))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=False)
+ self.rc.return_value = cros_build_lib.CommandResult(returncode=0)
+
+ service = 'chromite.api.InsideChrootApiService'
+ method = 'InsideServiceInsideMethod'
+ service_method = '%s/%s' % (service, method)
+ self.router.Route(service, method, self.input_file, self.output_file)
+
+ self.assertCommandContains(['build_api', service_method], enter_chroot=True)
+
+ def testInsideServiceOutsideMethodInsideChroot(self):
+ """Test inside chroot for outside method raises an error."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=False))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=True)
+ with self.assertRaises(cros_build_lib.DieSystemExit):
+ self.router.Route('chromite.api.InsideChrootApiService',
+ 'InsideServiceOutsideMethod', self.input_file,
+ self.output_file)
+
+ def testOutsideServiceOutsideMethodOutsideChroot(self):
+ """Test outside/outside/outside works correctly."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=True))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=False)
+ self.router.Route('chromite.api.OutsideChrootApiService',
+ 'OutsideServiceOutsideMethod', self.input_file,
+ self.output_file)
+
+ def testOutsideServiceInsideMethodInsideChroot(self):
+ """Test the inside method assertion override works properly."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=True))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=True)
+ self.router.Route('chromite.api.OutsideChrootApiService',
+ 'OutsideServiceInsideMethod', self.input_file,
+ self.output_file)
+
+ def testOutsideServiceInsideMethodOutsideChroot(self):
+ """Test calling an inside override method from outside the chroot."""
+ self.PatchObject(self.router, '_GetMethod',
+ return_value=self._mock_callable(expect_called=False))
+ self.PatchObject(cros_build_lib, 'IsInsideChroot', return_value=False)
+ self.rc.return_value = cros_build_lib.CommandResult(returncode=0)
+
+ service = 'chromite.api.OutsideChrootApiService'
+ method = 'OutsideServiceInsideMethod'
+ service_method = '%s/%s' % (service, method)
+ self.router.Route(service, method, self.input_file, self.output_file)
+
+ self.assertCommandContains(['build_api', service_method], enter_chroot=True)