| # -*- coding: utf-8 -*- |
| # Copyright 2016 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. |
| |
| """Unit tests for buildbucket_lib""" |
| |
| from __future__ import print_function |
| |
| import json |
| import mock |
| |
| from chromite.lib import auth |
| from chromite.lib import buildbucket_lib |
| from chromite.lib import constants |
| from chromite.lib import cros_test_lib |
| from chromite.lib import metadata_lib |
| |
| class BuildbucketClientTest(cros_test_lib.MockTestCase): |
| """Tests for BuildbucketClient.""" |
| |
| def setUp(self): |
| self.mock_http = mock.MagicMock() |
| self.PatchObject(auth, 'AuthorizedHttp', return_value=self.mock_http) |
| self.success_response = {'status': 200} |
| |
| self.PatchObject(buildbucket_lib.BuildbucketClient, |
| '_GetHost', |
| return_value=buildbucket_lib.BUILDBUCKET_TEST_HOST) |
| self.client = buildbucket_lib.BuildbucketClient(mock.Mock(), None) |
| |
| def testPutBuildRequest(self): |
| """Test PutBuildRequest.""" |
| buildbucket_id = 'test_buildbucket_id' |
| content = json.dumps({ |
| 'build': { |
| 'id': buildbucket_id |
| } |
| }) |
| self.mock_http.request.return_value = (self.success_response, content) |
| |
| body = json.dumps({ |
| 'bucket': 'test-bucket', |
| }) |
| |
| result_content = self.client.PutBuildRequest(body, False) |
| self.assertEqual(buildbucket_lib.GetBuildId(result_content), buildbucket_id) |
| |
| # Test dryrun |
| result_content_2 = self.client.PutBuildRequest(body, True) |
| self.assertIsNone(result_content_2) |
| |
| def testGetBuildRequest(self): |
| """Test GetBuildRequest.""" |
| buildbucket_id = 'test_buildbucket_id' |
| complete_status = 'COMPLETED' |
| content = json.dumps({ |
| 'build': { |
| 'id': buildbucket_id, |
| 'status': complete_status |
| } |
| }) |
| self.mock_http.request.return_value = (self.success_response, content) |
| result_content = self.client.GetBuildRequest( |
| buildbucket_id, False) |
| self.assertEqual(buildbucket_lib.GetBuildStatus(result_content), |
| complete_status) |
| |
| # Test dryrun |
| result_content_2 = self.client.GetBuildRequest( |
| buildbucket_id, True) |
| self.assertIsNone(result_content_2) |
| |
| def testCancelBuildRequest(self): |
| """Test CancelBuild.""" |
| buildbucket_id = 'test_buildbucket_id' |
| result = 'CANCELED' |
| content = json.dumps({ |
| 'build':{ |
| 'id': buildbucket_id, |
| 'result': result |
| } |
| }) |
| self.mock_http.request.return_value = (self.success_response, content) |
| result_content = self.client.CancelBuildRequest( |
| buildbucket_id, False) |
| self.assertEqual(buildbucket_lib.GetBuildResult(result_content), result) |
| |
| # Test dryrun |
| result_content_2 = self.client.CancelBuildRequest( |
| buildbucket_id, True) |
| self.assertIsNone(result_content_2) |
| |
| def testCancelBatchBuildsRequest(self): |
| """Test CancelBatchBuilds.""" |
| buildbucket_id_1 = 'test_buildbucket_id_1' |
| buildbucket_id_2 = 'test_buildbucket_id_2' |
| status = 'COMPLETED' |
| result = 'CANCELED' |
| error_reason = 'BUILD_IS_COMPLETED' |
| content = json.dumps({ |
| 'results':[{ |
| 'build_id': buildbucket_id_1, |
| 'build': { |
| 'status': status, |
| 'result': result, |
| } |
| }, { |
| 'build_id': buildbucket_id_2, |
| 'error': { |
| 'message': "Cannot cancel a completed build", |
| 'reason': error_reason, |
| } |
| }] |
| }) |
| self.mock_http.request.return_value = (self.success_response, content) |
| result_content = self.client.CancelBatchBuildsRequest( |
| [buildbucket_id_1, buildbucket_id_2], False) |
| |
| result_map = buildbucket_lib.GetResultMap(result_content) |
| self.assertIsNotNone(buildbucket_lib.GetNestedAttr( |
| result_map[buildbucket_id_1], ['build'])) |
| self.assertIsNotNone(buildbucket_lib.GetNestedAttr( |
| result_map[buildbucket_id_2], ['error'])) |
| self.assertEqual(buildbucket_lib.GetBuildStatus( |
| result_map[buildbucket_id_1]), status) |
| self.assertEqual(buildbucket_lib.GetErrorReason( |
| result_map[buildbucket_id_2]), error_reason) |
| |
| # Test dryrun |
| result_content_2 = self.client.CancelBatchBuildsRequest( |
| [buildbucket_id_1, buildbucket_id_2], True) |
| self.assertIsNone(result_content_2) |
| |
| def testRetryBuildRequest(self): |
| """Test RetryBuild.""" |
| buildbucket_id = '001' |
| buildbucket_id_2 = '002' |
| |
| content = json.dumps({ |
| 'build':{ |
| 'status': 'SCHEDULED', |
| 'id': buildbucket_id_2, |
| 'retry_of': buildbucket_id |
| } |
| }) |
| |
| self.mock_http.request.return_value = (self.success_response, content) |
| result_content = self.client.RetryBuildRequest( |
| buildbucket_id, False) |
| self.assertEqual(buildbucket_lib.GetBuildId(result_content), |
| buildbucket_id_2) |
| |
| reason = 'BUILD_NOT_FOUND' |
| message = 'Build 001 not found' |
| content = json.dumps({ |
| 'error': { |
| 'message': message, |
| 'reason': reason |
| } |
| }) |
| |
| self.mock_http.request.return_value = (self.success_response, content) |
| result_content = self.client.RetryBuildRequest( |
| buildbucket_id, False) |
| self.assertEqual(buildbucket_lib.GetErrorReason(result_content), |
| reason) |
| self.assertEqual(buildbucket_lib.GetErrorMessage(result_content), |
| message) |
| |
| # Test dryrun |
| result_content = self.client.RetryBuildRequest( |
| buildbucket_id, True) |
| self.assertIsNone(result_content) |
| |
| def testSearchBuildsRequest(self): |
| """Test SearchBuilds.""" |
| buildbucket_id_1 = 'test_buildbucket_id_1' |
| buildbucket_id_2 = 'test_buildbucket_id_2' |
| |
| content = json.dumps({ |
| 'kind': 'kind', |
| 'etag': 'etag', |
| 'builds': [{ |
| 'bucket': 'master.chromiumios.tryserver', |
| 'status': 'COMPLETED', |
| 'id': buildbucket_id_1, |
| 'tags':[ |
| 'bot_id:build265-m2', |
| 'build_type:tryjob',] |
| }, { |
| 'bucket': 'master.chromiumios.tryserver', |
| 'status': 'COMPLETED', |
| 'id': buildbucket_id_2, |
| 'tags':[ |
| 'bot_id:build265-m2', |
| 'build_type:tryjob'] |
| }], |
| }) |
| |
| self.mock_http.request.return_value = (self.success_response, content) |
| result_content = self.client.SearchBuildsRequest( |
| False, |
| buckets=[constants.INTERNAL_SWARMING_BUILDBUCKET_BUCKET,], |
| tags=['build_type:tryjob', 'bot_id:build265-m2'], |
| status=constants.BUILDBUCKET_BUILDER_STATUS_COMPLETED, |
| start_cursor='start_cursor', |
| max_builds=10) |
| |
| build_ids = buildbucket_lib.GetBuildIds(result_content) |
| self.assertTrue(buildbucket_id_1 in build_ids and |
| buildbucket_id_2 in build_ids) |
| |
| # Test dryrun |
| result_content_2 = self.client.SearchBuildsRequest( |
| True, |
| buckets=[constants.INTERNAL_SWARMING_BUILDBUCKET_BUCKET, |
| constants.CHROMEOS_BUILDBUCKET_BUCKET,], |
| tags=['build_type:tryjob'], |
| max_builds=100) |
| self.assertEqual(result_content_2, None) |
| |
| def _MockSearchContent(self, *args, **kwargs): |
| """Mock searched content.""" |
| dryrun = args[0] |
| if dryrun: |
| return |
| |
| next_cursor = kwargs.get('next_cursor', 'next_cursor') |
| max_builds = kwargs.get('max_builds', 0) |
| builds = [{'status': 'COMPLETE', 'id': str(i)} |
| for i in range(max_builds)] |
| content_dict = { |
| 'kind': 'kind', |
| 'etag': 'etag', |
| 'builds': builds |
| } |
| |
| if next_cursor: |
| content_dict.update({'next_cursor': next_cursor}) |
| |
| return content_dict |
| |
| def _MockSearchContentWithCursor(self, *args, **kwargs): |
| """Mock searched content with next_cursor.""" |
| kwargs.setdefault('next_cursor', 'next_cursor') |
| return self._MockSearchContent(*args, **kwargs) |
| |
| def _SearchAllBuildsWithCursor(self, limit): |
| """Test for SearchAllBuildsWithCursor.""" |
| self.PatchObject(buildbucket_lib.BuildbucketClient, |
| 'SearchBuildsRequest', |
| side_effect=self._MockSearchContentWithCursor) |
| |
| return self.client.SearchAllBuilds( |
| False, |
| limit=limit, |
| buckets=[constants.INTERNAL_SWARMING_BUILDBUCKET_BUCKET,], |
| tags=['build_type:tryjob', 'bot_id:build265-m2'], |
| status=constants.BUILDBUCKET_BUILDER_STATUS_COMPLETED) |
| |
| def testSearchAllBuildsWithCursor(self): |
| """Test SearchAllBuilds with next_cursor.""" |
| |
| for limit in (1, 2, 5, 100, 101, 150, 200): |
| all_builds = self._SearchAllBuildsWithCursor(limit) |
| self.assertEqual(len(all_builds), limit) |
| |
| def testSearchAllBuildsWithoutCursor(self): |
| """Test SearchAllBuilds without next_cursor.""" |
| self.PatchObject(buildbucket_lib.BuildbucketClient, |
| 'SearchBuildsRequest', |
| side_effect=self._MockSearchContent) |
| |
| all_builds = self.client.SearchAllBuilds(False, limit=2) |
| self.assertEqual(len(all_builds), 2) |
| |
| max_builds = 5 |
| builds = [{'status': 'COMPLETE', 'id': str(i)} |
| for i in range(max_builds)] |
| content_dict = { |
| 'kind': 'kind', |
| 'etag': 'etag', |
| 'builds': builds |
| } |
| self.PatchObject(buildbucket_lib.BuildbucketClient, |
| 'SearchBuildsRequest', return_value=content_dict) |
| |
| all_builds = self.client.SearchAllBuilds(False) |
| self.assertEqual(len(all_builds), max_builds) |
| |
| all_builds = self.client.SearchAllBuilds(False, limit=50) |
| self.assertEqual(len(all_builds), max_builds) |
| |
| |
| class GetAttributeTest(cros_test_lib.MockTestCase): |
| """Test cases for getting attributes.""" |
| |
| def testGetNestedAttr(self): |
| """Test GetNestedAttr.""" |
| buildbucket_id_1 = 'test_buildbucket_id_1' |
| buildbucket_id_2 = 'test_buildbucket_id_2' |
| content = { |
| 'kind': 'kind', |
| 'etag': 'etag', |
| 'builds': [{ |
| 'bucket': 'master.chromiumios.tryserver', |
| 'status': 'COMPLETED', |
| 'id': buildbucket_id_1, |
| }, { |
| 'bucket': 'master.chromiumios.tryserver', |
| 'status': 'COMPLETED', |
| 'id': buildbucket_id_2, |
| }], |
| 'result': { |
| 'status': 'COMPLETED' |
| } |
| } |
| |
| etag = buildbucket_lib.GetNestedAttr( |
| content, ['etag'], default='default_etag') |
| self.assertEqual(etag, 'etag') |
| |
| status = buildbucket_lib.GetNestedAttr( |
| content, ['result', 'status']) |
| self.assertEqual('COMPLETED', status) |
| |
| test_attr = buildbucket_lib.GetNestedAttr( |
| content, ['test_attr'], default='default_test_attr') |
| self.assertEqual(test_attr, 'default_test_attr') |
| |
| test_etag_attr = buildbucket_lib.GetNestedAttr( |
| content, ['etag', 'test_attr'], default='default_etag_test_attr') |
| self.assertEqual(test_etag_attr, 'default_etag_test_attr') |
| |
| build_ids = buildbucket_lib.ExtractBuildIds( |
| buildbucket_lib.GetNestedAttr(content, ['builds'], default=[])) |
| self.assertTrue(buildbucket_id_1 in build_ids and |
| buildbucket_id_2 in build_ids) |
| |
| build_ids = buildbucket_lib.GetBuildIds(content) |
| self.assertTrue(buildbucket_id_1 in build_ids and |
| buildbucket_id_2 in build_ids) |
| |
| content = { |
| 'results':[{ |
| 'build_id': buildbucket_id_1, |
| 'error': { |
| 'message': "Cannot cancel a completed build", |
| 'reason': 'error_reason', |
| } |
| }] |
| } |
| results = buildbucket_lib.GetNestedAttr( |
| content, ['results'], default=[]) |
| |
| for r in results: |
| reason = buildbucket_lib.GetErrorReason(r) |
| self.assertEqual(reason, 'error_reason') |
| |
| def testGetBuildTag(self): |
| """Test GetbuildTag.""" |
| content = { |
| 'build': { |
| 'bucket': 'master.chromeos', |
| 'status': 'COMPLETED', |
| 'id': 'bb_id', |
| 'tags': [ |
| 'build_type:paladin', |
| 'buildset:buildset_1', |
| 'buildset:buildset_2', |
| 'master_config:'] |
| } |
| } |
| tags = buildbucket_lib.GetBuildTags(content, 'build_type') |
| self.assertItemsEqual(tags, ['paladin']) |
| |
| tags = buildbucket_lib.GetBuildTags(content, 'buildset') |
| self.assertItemsEqual(tags, ['buildset_1', 'buildset_2']) |
| |
| tags = buildbucket_lib.GetBuildTags(content, 'master_config') |
| self.assertItemsEqual(tags, ['']) |
| |
| |
| class BuildbucketLibTest(cros_test_lib.MockTestCase): |
| """Test methods in buildbucket_lib.""" |
| |
| def testGetScheduledBuildDict(self): |
| """test GetScheduledBuildDict.""" |
| config_name_1 = 'config_name_1' |
| config_name_2 = 'config_name_2' |
| config_name_3 = 'config_name_3' |
| id_1 = 'id_1' |
| id_2 = 'id_2' |
| id_3 = 'id_3' |
| |
| slave_list = [(config_name_1, id_1, 1), |
| (config_name_2, id_2, 2), |
| (config_name_3, id_3, 3)] |
| build_dict = buildbucket_lib.GetScheduledBuildDict(slave_list) |
| self.assertEqual(len(build_dict), 3) |
| self.assertEqual(build_dict[config_name_1].buildbucket_id, id_1) |
| self.assertEqual(build_dict[config_name_2].buildbucket_id, id_2) |
| self.assertEqual(build_dict[config_name_3].buildbucket_id, id_3) |
| self.assertEqual(build_dict[config_name_1].retry, 0) |
| self.assertEqual(build_dict[config_name_2].retry, 0) |
| self.assertEqual(build_dict[config_name_3].retry, 0) |
| self.assertEqual(build_dict[config_name_1].created_ts, 1) |
| self.assertEqual(build_dict[config_name_2].created_ts, 2) |
| self.assertEqual(build_dict[config_name_3].created_ts, 3) |
| |
| |
| slave_list = [(config_name_1, id_1, 1), |
| (config_name_2, id_2, 2), |
| (config_name_1, id_3, 3)] |
| build_dict = buildbucket_lib.GetScheduledBuildDict(slave_list) |
| self.assertEqual(len(build_dict), 2) |
| self.assertEqual(build_dict[config_name_1].buildbucket_id, id_3) |
| self.assertEqual(build_dict[config_name_2].buildbucket_id, id_2) |
| self.assertEqual(build_dict[config_name_1].retry, 1) |
| self.assertEqual(build_dict[config_name_2].retry, 0) |
| self.assertEqual(build_dict[config_name_1].created_ts, 3) |
| self.assertEqual(build_dict[config_name_2].created_ts, 2) |
| |
| slave_list = [(config_name_1, id_1, 3), |
| (config_name_2, id_2, 2), |
| (config_name_1, id_3, 1)] |
| build_dict = buildbucket_lib.GetScheduledBuildDict(slave_list) |
| self.assertEqual(len(build_dict), 2) |
| self.assertEqual(build_dict[config_name_1].buildbucket_id, id_1) |
| self.assertEqual(build_dict[config_name_2].buildbucket_id, id_2) |
| self.assertEqual(build_dict[config_name_1].retry, 1) |
| self.assertEqual(build_dict[config_name_2].retry, 0) |
| self.assertEqual(build_dict[config_name_1].created_ts, 3) |
| self.assertEqual(build_dict[config_name_2].created_ts, 2) |
| |
| build_dict = buildbucket_lib.GetScheduledBuildDict([]) |
| self.assertEqual(build_dict, {}) |
| |
| build_dict = buildbucket_lib.GetScheduledBuildDict(None) |
| self.assertEqual(build_dict, {}) |
| |
| def testGetBuildInfoDict(self): |
| """Test GetBuildInfoDict with metadata and config.""" |
| metadata = metadata_lib.CBuildbotMetadata() |
| slaves = [('config_1', 'bb_id_1', 0), |
| ('config_1', 'bb_id_2', 1), |
| ('config_2', 'bb_id_3', 2)] |
| metadata.ExtendKeyListWithList( |
| constants.METADATA_SCHEDULED_IMPORTANT_SLAVES, slaves) |
| |
| buildbucket_info_dict = buildbucket_lib.GetBuildInfoDict(metadata) |
| self.assertEqual(len(buildbucket_info_dict), 2) |
| self.assertEqual( |
| buildbucket_info_dict['config_1'], |
| buildbucket_lib.BuildbucketInfo('bb_id_2', 1, 1, None, None, None)) |
| self.assertEqual( |
| buildbucket_info_dict['config_2'], |
| buildbucket_lib.BuildbucketInfo('bb_id_3', 0, 2, None, None, None)) |
| |
| buildbucket_info_dict_with_experimental = ( |
| buildbucket_lib.GetBuildInfoDict(metadata, exclude_experimental=False)) |
| self.assertEqual(len(buildbucket_info_dict), 2) |
| self.assertEqual( |
| buildbucket_info_dict_with_experimental['config_1'], |
| buildbucket_lib.BuildbucketInfo('bb_id_2', 1, 1, None, None, None)) |
| self.assertEqual( |
| buildbucket_info_dict_with_experimental['config_2'], |
| buildbucket_lib.BuildbucketInfo('bb_id_3', 0, 2, None, None, None)) |
| |
| metadata.UpdateWithDict({ |
| constants.METADATA_EXPERIMENTAL_BUILDERS: ['config_2'] |
| }) |
| buildbucket_info_dict = buildbucket_lib.GetBuildInfoDict(metadata) |
| self.assertEqual(len(buildbucket_info_dict), 1) |
| self.assertEqual( |
| buildbucket_info_dict['config_1'], |
| buildbucket_lib.BuildbucketInfo('bb_id_2', 1, 1, None, None, None)) |
| |
| buildbucket_info_dict_with_experimental = ( |
| buildbucket_lib.GetBuildInfoDict(metadata, exclude_experimental=False)) |
| self.assertEqual(len(buildbucket_info_dict_with_experimental), 2) |
| self.assertEqual( |
| buildbucket_info_dict_with_experimental['config_1'], |
| buildbucket_lib.BuildbucketInfo('bb_id_2', 1, 1, None, None, None)) |
| self.assertEqual( |
| buildbucket_info_dict_with_experimental['config_2'], |
| buildbucket_lib.BuildbucketInfo('bb_id_3', 0, 2, None, None, None)) |
| |
| def testGetBuildbucketIds(self): |
| """Test GetBuildbucketIds with metadata and config.""" |
| metadata = metadata_lib.CBuildbotMetadata() |
| slaves = [('config_1', 'bb_id_1', 0), |
| ('config_1', 'bb_id_2', 1), |
| ('config_2', 'bb_id_3', 2)] |
| metadata.ExtendKeyListWithList( |
| constants.METADATA_SCHEDULED_IMPORTANT_SLAVES, slaves) |
| |
| buildbucket_ids = buildbucket_lib.GetBuildbucketIds(metadata) |
| self.assertTrue('bb_id_2' in buildbucket_ids) |
| self.assertTrue('bb_id_3' in buildbucket_ids) |
| |
| |
| |
| class BuildbucketLibNetworkTest(cros_test_lib.MockTestCase): |
| """Network tests for methods in buildbucket_lib.""" |
| |
| def getTestClient(self): |
| """Create a buildbucket client which is safe for network tests.""" |
| return buildbucket_lib.BuildbucketClient( |
| auth.GetAccessToken, buildbucket_lib.BUILDBUCKET_TEST_HOST, |
| service_account_json=buildbucket_lib.GetServiceAccount( |
| constants.CHROMEOS_SERVICE_ACCOUNT)) |
| |
| def getProdClient(self): |
| """Create a buildbucket client which is safe for RO network tests.""" |
| return buildbucket_lib.BuildbucketClient( |
| auth.GetAccessToken, buildbucket_lib.BUILDBUCKET_HOST, |
| service_account_json=buildbucket_lib.GetServiceAccount( |
| constants.CHROMEOS_SERVICE_ACCOUNT)) |
| |
| @cros_test_lib.NetworkTest() |
| def testSearchAndExtractBotIds(self): |
| buildbucket_client = self.getProdClient() |
| self.assertTrue(buildbucket_client) |
| |
| previous_builds = buildbucket_client.SearchAllBuilds( |
| False, |
| buckets=constants.ACTIVE_BUCKETS, |
| limit=10, |
| tags=['cbb_config:success-build', |
| 'cbb_branch:master'], |
| status=constants.BUILDBUCKET_BUILDER_STATUS_COMPLETED) |
| |
| self.assertEqual(len(previous_builds), 10) |
| |
| # This test would fail, if the search results included buildbot builds. |
| for b in previous_builds: |
| self.assertTrue(buildbucket_lib.GetResultDetails(b)) |
| self.assertTrue(buildbucket_lib.GetBotId(b).startswith('swarm-cros')) |
