| # -*- 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. |
| |
| """Unittests for workspace stages.""" |
| |
| from __future__ import print_function |
| |
| import mock |
| import os |
| |
| from chromite.cbuildbot.builders import workspace_builders_unittest |
| from chromite.cbuildbot import manifest_version |
| from chromite.cbuildbot.stages import generic_stages_unittest |
| from chromite.cbuildbot.stages import workspace_stages |
| from chromite.lib import constants |
| |
| # pylint: disable=too-many-ancestors |
| # pylint: disable=protected-access |
| |
| |
| class WorkspaceStageBase( |
| generic_stages_unittest.RunCommandAbstractStageTestCase): |
| """Base class for test suites covering workspace stages.""" |
| |
| # Default version for tests. |
| OLD_VERSION = '1.2.3' |
| |
| # Version newer than all "limits" in workspace_stages. |
| MODERN_VERSION = '11000.0.0' |
| |
| def setUp(self): |
| self.workspace = os.path.join(self.tempdir, 'workspace') |
| |
| self.from_repo_mock = self.PatchObject( |
| manifest_version.VersionInfo, 'from_repo') |
| self.SetWorkspaceVersion(self.OLD_VERSION) |
| |
| self.manifest_versions = os.path.join( |
| self.build_root, 'manifest-versions') |
| self.manifest_versions_int = os.path.join( |
| self.build_root, 'manifest-versions-internal') |
| |
| def SetWorkspaceVersion(self, version): |
| """Change the "version" of the workspace.""" |
| self.from_repo_mock.return_value = manifest_version.VersionInfo(version) |
| |
| def ConstructStage(self): |
| """Returns an instance of the stage to be tested. |
| |
| Note: Must be implemented in subclasses. |
| """ |
| raise NotImplementedError(self, "ConstructStage: Implement in your test") |
| |
| |
| class WorkspaceStageBaseTest(WorkspaceStageBase): |
| """Test the WorkspaceStageBase.""" |
| |
| def ConstructStage(self): |
| return workspace_stages.WorkspaceStageBase( |
| self._run, self.buildstore, build_root=self.workspace) |
| |
| def testBuildRoots(self): |
| """Tests that various properties are correctly set.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| stage = self.ConstructStage() |
| |
| # Verify buildroot directories. |
| self.assertEqual(self.build_root, stage._orig_root) |
| self.assertEqual(self.workspace, stage._build_root) |
| |
| # Verify repo creation. |
| repo = stage.GetWorkspaceRepo() |
| self.assertEqual(repo.directory, self.workspace) |
| |
| # Verify manifest-versions directories. |
| self.assertEqual( |
| self.manifest_versions, |
| stage.ext_manifest_versions_path) |
| self.assertEqual( |
| self.manifest_versions_int, |
| stage.int_manifest_versions_path) |
| |
| def testVersionInfo(self): |
| """Tests GetWorkspaceVersionInfo.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| stage = self.ConstructStage() |
| |
| stage.GetWorkspaceVersionInfo() |
| |
| self.assertEqual(self.from_repo_mock.call_args_list, [ |
| mock.call(self.workspace), |
| ]) |
| |
| def testAfterLimit(self): |
| """Tests AfterLimit.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| stage = self.ConstructStage() |
| |
| # 1.2.3 |
| self.SetWorkspaceVersion(self.OLD_VERSION) |
| |
| LIMITS_BEFORE_OLD = ('1.0.0', '1.0.5', '1.2.2') |
| LIMITS_AFTER_OLD = ('1.2.3', '1.2.4', '2.0.0') |
| |
| # The workspace is after these limits. |
| for l in LIMITS_BEFORE_OLD: |
| self.assertTrue(stage.AfterLimit(l)) |
| |
| # The workspace is before these limits. |
| for l in LIMITS_AFTER_OLD: |
| self.assertFalse(stage.AfterLimit(l)) |
| |
| # 11000.0.0 |
| self.SetWorkspaceVersion(self.MODERN_VERSION) |
| |
| # The workspace is after ALL of these limits. |
| for l in LIMITS_BEFORE_OLD + LIMITS_AFTER_OLD: |
| self.assertTrue(stage.AfterLimit(l)) |
| |
| |
| class SyncStageTest(WorkspaceStageBase): |
| """Test the SyncStage.""" |
| |
| def ConstructStage(self, **kwargs): |
| return workspace_stages.SyncStage( |
| self._run, self.buildstore, **kwargs) |
| |
| def testDefaults(self): |
| """Tests sync command used by default.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| self.RunStage(build_root='/root') |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled([ |
| os.path.join(constants.CHROMITE_DIR, 'scripts', 'repo_sync_manifest'), |
| '--repo-root', '/root', |
| '--manifest-versions-int', self.manifest_versions_int, |
| '--manifest-versions-ext', self.manifest_versions, |
| ]) |
| |
| def testBranch(self): |
| """Tests sync command used for branch.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| self.RunStage(build_root='/root', branch='branch') |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled([ |
| os.path.join(constants.CHROMITE_DIR, 'scripts', 'repo_sync_manifest'), |
| '--repo-root', '/root', |
| '--manifest-versions-int', self.manifest_versions_int, |
| '--manifest-versions-ext', self.manifest_versions, |
| '--branch', 'branch', |
| ]) |
| |
| def testVersion(self): |
| """Tests sync command used for version.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| self.RunStage(build_root='/root', version='version') |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled([ |
| os.path.join(constants.CHROMITE_DIR, 'scripts', 'repo_sync_manifest'), |
| '--repo-root', '/root', |
| '--manifest-versions-int', self.manifest_versions_int, |
| '--manifest-versions-ext', self.manifest_versions, |
| '--version', 'version', |
| ]) |
| |
| def testPatches(self): |
| """Tests sync command used with patches.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| patchA = mock.Mock() |
| patchA.url = 'urlA' |
| patchA.gerrit_number_str = '1' |
| |
| patchB = mock.Mock() |
| patchB.url = 'urlB' |
| patchB.gerrit_number_str = '2' |
| |
| self.RunStage(build_root='/root', patch_pool=[patchA, patchB]) |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled([ |
| os.path.join(constants.CHROMITE_DIR, 'scripts', 'repo_sync_manifest'), |
| '--repo-root', '/root', |
| '--manifest-versions-int', self.manifest_versions_int, |
| '--manifest-versions-ext', self.manifest_versions, |
| '--gerrit-patches', '1', |
| '--gerrit-patches', '2', |
| ]) |
| |
| |
| class WorkspaceSyncStageTest(WorkspaceStageBase): |
| """Test the WorkspaceSyncStage.""" |
| |
| def setUp(self): |
| self.sync_stage_mock = self.PatchObject( |
| workspace_stages, 'SyncStage') |
| |
| def ConstructStage(self): |
| return workspace_stages.WorkspaceSyncStage( |
| self._run, self.buildstore, build_root=self.workspace) |
| |
| def SyncCallToPathNumbers(self, mock_call): |
| """Extract the patch_pool from a mock call, and convert to gerrit int.""" |
| return [p.gerrit_number_str for p in mock_call[1]['patch_pool']] |
| |
| def testBasic(self): |
| """Test invoking child syncs in standard case.""" |
| self._Prepare( |
| 'buildspec', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig()) |
| |
| self.RunStage() |
| |
| self.assertEqual(self.sync_stage_mock.call_args_list, [ |
| mock.call(self._run, self.buildstore, |
| patch_pool=mock.ANY, |
| suffix=' [Infra]', |
| external=True, |
| branch='master', |
| build_root=self.build_root), |
| |
| mock.call(self._run, self.buildstore, |
| patch_pool=mock.ANY, |
| suffix=' [test-branch]', |
| external=True, |
| branch='test-branch', |
| version=None, |
| build_root=self.workspace), |
| ]) |
| |
| self.assertEqual( |
| self.SyncCallToPathNumbers(self.sync_stage_mock.call_args_list[0]), |
| []) |
| |
| self.assertEqual( |
| self.SyncCallToPathNumbers(self.sync_stage_mock.call_args_list[1]), |
| []) |
| |
| # TODO(dgarrett): Enable. Failing in _Prepare, and I don't understand why. |
| def notestPatches(self): |
| """Test invoking child syncs with patches to apply.""" |
| |
| self._Prepare( |
| cmd_args=[ |
| '-r', self.build_root, '--buildbot', '--noprebuilts', |
| '--branch', self.TARGET_MANIFEST_BRANCH, |
| '-g', '1', '-g', '2', |
| 'buildspec', |
| ], |
| site_config=workspace_builders_unittest.CreateMockSiteConfig(), |
| ) |
| |
| self.RunStage() |
| |
| self.assertEqual(self.sync_stage_mock.call_args_list, [ |
| mock.call(self._run, self.buildstore, |
| patch_pool=mock.ANY, |
| suffix=' [Infra]', |
| external=True, |
| branch='master', |
| build_root=self.build_root), |
| |
| mock.call(self._run, self.buildstore, |
| patch_pool=mock.ANY, |
| suffix=' [test-branch]', |
| external=True, |
| branch='test-branch', |
| version=None, |
| build_root=self.workspace), |
| ]) |
| |
| self.assertEqual( |
| self.SyncCallToPathNumbers(self.sync_stage_mock.call_args_list[0]), |
| []) |
| |
| self.assertEqual( |
| self.SyncCallToPathNumbers(self.sync_stage_mock.call_args_list[1]), |
| []) |
| |
| |
| # TODO(dgarret): Test WorkspaceSyncChromeStage, |
| # TODO(dgarret): Test WorkspaceUprevAndPublishStage |
| # TODO(dgarret): Test WorkspacePublishBuildspecStage |
| # TODO(dgarret): Test WorkspaceScheduleChildrenStage |
| # TODO(dgarret): Test WorkspaceInitSDKStage |
| # TODO(dgarret): Test WorkspaceSetupBoardStage |
| |
| |
| class WorkspaceBuildPackagesStageTest(WorkspaceStageBase): |
| """Test the WorkspaceBuildPackagesStage.""" |
| |
| def ConstructStage(self): |
| return workspace_stages.WorkspaceBuildPackagesStage( |
| self._run, self.buildstore, build_root=self.workspace, board='board') |
| |
| def testFirmwareBuildPackagesOld(self): |
| """Test building firmware for an old workspace version.""" |
| self._Prepare( |
| 'test-firmwarebranch', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig(), |
| extra_cmd_args=['--cache-dir', '/cache']) |
| |
| self.RunStage() |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled( |
| [ |
| './build_packages', |
| '--board=board', |
| '--accept_licenses=@CHROMEOS', |
| '--skip_chroot_upgrade', |
| '--nousepkg', |
| '--reuse_pkgs_from_local_boards', |
| 'virtual/chromeos-firmware', |
| ], |
| chroot_args=['--cache-dir', '/cache'], |
| enter_chroot=True, |
| cwd=self.workspace, |
| ) |
| |
| def testFirmwareBuildPackagesModern(self): |
| """Test building firmware for a modern workspace version.""" |
| self.SetWorkspaceVersion(self.MODERN_VERSION) |
| |
| self._Prepare( |
| 'test-firmwarebranch', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig(), |
| extra_cmd_args=['--cache-dir', '/cache']) |
| |
| self.RunStage() |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled( |
| [ |
| './build_packages', |
| '--board=board', |
| '--accept_licenses=@CHROMEOS', |
| '--skip_chroot_upgrade', |
| '--withdebugsymbols', |
| '--nousepkg', |
| '--reuse_pkgs_from_local_boards', |
| 'virtual/chromeos-firmware', |
| ], |
| chroot_args=['--cache-dir', '/cache'], |
| enter_chroot=True, |
| cwd=self.workspace, |
| ) |
| |
| def testFactoryBuildPackages(self): |
| """Test building factory for an old workspace version.""" |
| self._Prepare( |
| 'test-factorybranch', |
| site_config=workspace_builders_unittest.CreateMockSiteConfig(), |
| extra_cmd_args=['--cache-dir', '/cache']) |
| |
| self.RunStage() |
| |
| self.assertEqual(self.rc.call_count, 1) |
| self.rc.assertCommandCalled( |
| [ |
| './build_packages', |
| '--board=board', |
| '--accept_licenses=@CHROMEOS', |
| '--skip_chroot_upgrade', |
| '--nousepkg', |
| '--reuse_pkgs_from_local_boards', |
| 'virtual/target-os', |
| 'virtual/target-os-dev', |
| 'virtual/target-os-test', |
| 'virtual/target-os-factory', |
| 'virtual/target-os-factory-shim', |
| 'chromeos-base/autotest-all', |
| ], |
| chroot_args=['--cache-dir', '/cache'], |
| enter_chroot=True, |
| cwd=self.workspace, |
| ) |
