app_dart/test/request_handlers/dart_internal_subscription_test.dart - mirrors/cocoon - Git at Google

 // Copyright 2023 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 import 'dart:convert';

 import 'package:buildbucket/buildbucket_pb.dart' as bbv2;
 import 'package:cocoon_service/cocoon_service.dart';
 import 'package:cocoon_service/src/model/appengine/commit.dart';
 import 'package:cocoon_service/src/model/appengine/task.dart';
 import 'package:cocoon_service/src/model/firestore/task.dart' as firestore;
 import 'package:cocoon_service/src/model/luci/pubsub_message_v2.dart';
 import 'package:cocoon_service/src/service/datastore.dart';
 import 'package:fixnum/fixnum.dart';
 import 'package:gcloud/db.dart';
 import 'package:googleapis/firestore/v1.dart' hide Status;
 import 'package:mockito/mockito.dart';
 import 'package:test/test.dart';

 import '../src/datastore/fake_config.dart';
 import '../src/request_handling/fake_authentication.dart';
 import '../src/request_handling/fake_http.dart';
 import '../src/request_handling/subscription_v2_tester.dart';
 import '../src/utilities/entity_generators.dart';
 import '../src/utilities/mocks.dart';

 void main() {
   // Omit the timestamps for expect purposes.
   const String buildJson = '''
 {
   "id": "8766855135863637953",
   "builder": {
     "project": "dart-internal",
     "bucket": "flutter",
     "builder": "Linux packaging_release_builder"
   },
   "number": 123456,
   "status": "SUCCESS",
   "input": {
     "gitilesCommit": {
       "project": "flutter/flutter",
       "id": "HASH12345",
       "ref": "refs/heads/test-branch"
     }
   }
 }
 ''';

   const String buildMessageJson = '''
 {
   "build": {
     "id": "8766855135863637953",
     "builder": {
       "project": "dart-internal",
       "bucket": "flutter",
       "builder": "Linux packaging_release_builder"
     },
     "number": 123456,
     "status": "SUCCESS",
     "input": {
       "gitilesCommit": {
         "project": "flutter/flutter",
         "id": "HASH12345",
         "ref": "refs/heads/test-branch"
       }
     }
   }
 }
 ''';

   late DartInternalSubscription handler;
   late FakeConfig config;
   late FakeHttpRequest request;
   late MockBuildBucketV2Client buildBucketV2Client;
   late SubscriptionV2Tester tester;
   late MockFirestoreService mockFirestoreService;
   late Commit commit;

   // ignore: unused_local_variable
   const String project = 'dart-internal';
   const String bucket = 'flutter';
   const String builder = 'Linux packaging_release_builder';
   const int buildNumber = 123456;
   // ignore: unused_local_variable
   final Int64 buildId = Int64(8766855135863637953);
   const String fakeHash = 'HASH12345';
   const String fakeBranch = 'test-branch';

   setUp(() async {
     mockFirestoreService = MockFirestoreService();
     config = FakeConfig(firestoreService: mockFirestoreService);
     buildBucketV2Client = MockBuildBucketV2Client();
     handler = DartInternalSubscription(
       cache: CacheService(inMemory: true),
       config: config,
       authProvider: FakeAuthenticationProvider(),
       buildBucketV2Client: buildBucketV2Client,
       datastoreProvider: (DatastoreDB db) => DatastoreService(config.db, 5),
     );
     request = FakeHttpRequest();

     tester = SubscriptionV2Tester(
       request: request,
     );

     commit = generateCommit(
       1,
       sha: fakeHash,
       branch: fakeBranch,
       owner: 'flutter',
       repo: 'flutter',
       timestamp: 0,
     );

     // final bbv2.PubSubCallBack pubSubCallBackTest = bbv2.PubSubCallBack();
     // pubSubCallBackTest.mergeFromProto3Json(jsonDecode(message));
     final bbv2.Build build = bbv2.Build().createEmptyInstance();
     build.mergeFromProto3Json(jsonDecode(buildJson) as Map<String, dynamic>);

     const PushMessageV2 pushMessageV2 = PushMessageV2(data: buildJson, messageId: '798274983');
     tester.message = pushMessageV2;

     when(
       buildBucketV2Client.getBuild(
         any,
         buildBucketUri: 'https://cr-buildbucket.appspot.com/prpc/buildbucket.v2.Builds',
       ),
     ).thenAnswer((_) => Future<bbv2.Build>.value(build));

     final List<Commit> datastoreCommit = <Commit>[commit];
     await config.db.commit(inserts: datastoreCommit);
   });

   test('creates a new task successfully', () async {
     when(
       mockFirestoreService.batchWriteDocuments(
         captureAny,
         captureAny,
       ),
     ).thenAnswer((Invocation invocation) {
       return Future<BatchWriteResponse>.value(BatchWriteResponse());
     });
     tester.message = const PushMessageV2(data: buildMessageJson);

     await tester.post(handler);

     verify(
       buildBucketV2Client.getBuild(any),
     ).called(1);

     // This is used for testing to pull the data out of the "datastore" so that
     // we can verify what was saved.
     late Task taskInDb;
     late Commit commitInDb;
     config.db.values.forEach((k, v) {
       if (v is Task && v.buildNumberList == buildNumber.toString()) {
         taskInDb = v;
       }
       if (v is Commit) {
         commitInDb = v;
       }
     });

     // Ensure the task has the correct parent and commit key
     expect(
       commitInDb.id,
       equals(taskInDb.commitKey?.id),
     );

     expect(
       commitInDb.id,
       equals(taskInDb.parentKey?.id),
     );

     // Ensure the task in the db is exactly what we expect
     final Task expectedTask = Task(
       attempts: 1,
       buildNumber: buildNumber,
       buildNumberList: buildNumber.toString(),
       builderName: builder,
       commitKey: commitInDb.key,
       luciBucket: bucket,
       name: builder,
       stageName: 'dart-internal',
       status: 'Succeeded',
       key: commit.key.append(Task),
       timeoutInMinutes: 0,
       reason: '',
       requiredCapabilities: [],
       reservedForAgentId: '',
     );

     expect(
       taskInDb.toString(),
       equals(expectedTask.toString()),
     );

     final List<dynamic> captured = verify(mockFirestoreService.batchWriteDocuments(captureAny, captureAny)).captured;
     expect(captured.length, 2);
     final BatchWriteRequest batchWriteRequest = captured[0] as BatchWriteRequest;
     expect(batchWriteRequest.writes!.length, 1);
     final firestore.Task insertedTaskDocument =
         firestore.Task.fromDocument(taskDocument: batchWriteRequest.writes![0].update!);
     expect(insertedTaskDocument.taskName, expectedTask.name);
   });

   test('updates an existing task successfully', () async {
     when(
       mockFirestoreService.batchWriteDocuments(
         captureAny,
         captureAny,
       ),
     ).thenAnswer((Invocation invocation) {
       return Future<BatchWriteResponse>.value(BatchWriteResponse());
     });
     const int existingTaskId = 123;
     final Task fakeTask = Task(
       attempts: 1,
       buildNumber: existingTaskId,
       buildNumberList: existingTaskId.toString(),
       builderName: builder,
       commitKey: commit.key,
       luciBucket: bucket,
       name: builder,
       stageName: 'dart-internal',
       status: 'Succeeded',
       key: commit.key.append(Task),
       timeoutInMinutes: 0,
       reason: '',
       requiredCapabilities: [],
       reservedForAgentId: '',
     );
     final List<Task> datastoreCommit = <Task>[fakeTask];
     await config.db.commit(inserts: datastoreCommit);

     const PushMessageV2 pushMessageV2 = PushMessageV2(data: buildMessageJson, messageId: '798274983');
     tester.message = pushMessageV2;

     await tester.post(handler);

     verify(
       buildBucketV2Client.getBuild(any),
     ).called(1);

     // This is used for testing to pull the data out of the "datastore" so that
     // we can verify what was saved.
     final String expectedBuilderList = '${existingTaskId.toString()},${buildNumber.toString()}';
     late Task taskInDb;
     late Commit commitInDb;
     config.db.values.forEach((k, v) {
       if (v is Task && v.buildNumberList == expectedBuilderList) {
         taskInDb = v;
       }
       if (v is Commit) {
         commitInDb = v;
       }
     });

     // Ensure the task has the correct parent and commit key
     expect(
       commitInDb.id,
       equals(taskInDb.commitKey?.id),
     );

     expect(
       commitInDb.id,
       equals(taskInDb.parentKey?.id),
     );

     // Ensure the task in the db is exactly what we expect
     final Task expectedTask = Task(
       attempts: 2,
       buildNumber: buildNumber,
       buildNumberList: expectedBuilderList,
       builderName: builder,
       commitKey: commitInDb.key,
       luciBucket: bucket,
       name: builder,
       stageName: 'dart-internal',
       status: 'Succeeded',
       key: commit.key.append(Task),
       timeoutInMinutes: 0,
       reason: '',
       requiredCapabilities: [],
       reservedForAgentId: '',
     );

     expect(
       taskInDb.toString(),
       equals(expectedTask.toString()),
     );

     final List<dynamic> captured = verify(mockFirestoreService.batchWriteDocuments(captureAny, captureAny)).captured;
     expect(captured.length, 2);
     final BatchWriteRequest batchWriteRequest = captured[0] as BatchWriteRequest;
     expect(batchWriteRequest.writes!.length, 1);
     final firestore.Task insertedTaskDocument =
         firestore.Task.fromDocument(taskDocument: batchWriteRequest.writes![0].update!);
     expect(insertedTaskDocument.status, expectedTask.status);
   });

   test('ignores message with empty build data', () async {
     tester.message = const PushMessageV2();
     expect(await tester.post(handler), equals(Body.empty));
   });

   // // TODO create a construction method for this to simplify testing.
   test('ignores message not from flutter bucket', () async {
     const String dartMessage = '''
 {
   "build": {
     "id": "8766855135863637953",
     "builder": {
       "project": "dart-internal",
       "bucket": "dart",
       "builder": "Linux packaging_release_builder"
     },
     "number": 123456,
     "status": "SUCCESS",
     "input": {
       "gitilesCommit": {
         "project":"flutter/flutter",
         "id":"HASH12345",
         "ref":"refs/heads/test-branch"
       }
     }
   }
 }
 ''';

     const PushMessageV2 pushMessageV2 = PushMessageV2(data: dartMessage, messageId: '798274983');
     tester.message = pushMessageV2;
     expect(await tester.post(handler), equals(Body.empty));
   });

   test('ignores message not from dart-internal project', () async {
     const String unsupportedProjectMessage = '''
 {
   "build": {
     "id": "8766855135863637953",
     "builder": {
       "project": "unsupported-project",
       "bucket": "dart",
       "builder": "Linux packaging_release_builder"
     },
     "number": 123456,
     "status": "SUCCESS",
     "input": {
       "gitilesCommit": {
         "project": "flutter/flutter",
         "id": "HASH12345",
         "ref": "refs/heads/test-branch"
       }
     }
   }
 }
 ''';

     const PushMessageV2 pushMessageV2 = PushMessageV2(data: unsupportedProjectMessage, messageId: '798274983');
     tester.message = pushMessageV2;
     expect(await tester.post(handler), equals(Body.empty));
   });

   test('ignores message not from an accepted builder', () async {
     const String unknownBuilderMessage = '''
 {
   "build": {
     "id": "8766855135863637953",
     "builder": {
       "project": "dart-internal",
       "bucket": "dart",
       "builder": "different builder"
     },
     "number": 123456,
     "status": "SUCCESS",
     "input": {
       "gitilesCommit": {
         "project": "flutter/flutter",
         "id": "HASH12345",
         "ref": "refs/heads/test-branch"
       }
     }
   }
 }
 ''';

     const PushMessageV2 pushMessageV2 = PushMessageV2(data: unknownBuilderMessage, messageId: '798274983');
     tester.message = pushMessageV2;
     expect(await tester.post(handler), equals(Body.empty));
   });
 }
	// Copyright 2023 The Flutter Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	import 'dart:convert';

	import 'package:buildbucket/buildbucket_pb.dart' as bbv2;
	import 'package:cocoon_service/cocoon_service.dart';
	import 'package:cocoon_service/src/model/appengine/commit.dart';
	import 'package:cocoon_service/src/model/appengine/task.dart';
	import 'package:cocoon_service/src/model/firestore/task.dart' as firestore;
	import 'package:cocoon_service/src/model/luci/pubsub_message_v2.dart';
	import 'package:cocoon_service/src/service/datastore.dart';
	import 'package:fixnum/fixnum.dart';
	import 'package:gcloud/db.dart';
	import 'package:googleapis/firestore/v1.dart' hide Status;
	import 'package:mockito/mockito.dart';
	import 'package:test/test.dart';

	import '../src/datastore/fake_config.dart';
	import '../src/request_handling/fake_authentication.dart';
	import '../src/request_handling/fake_http.dart';
	import '../src/request_handling/subscription_v2_tester.dart';
	import '../src/utilities/entity_generators.dart';
	import '../src/utilities/mocks.dart';

	void main() {
	// Omit the timestamps for expect purposes.
	const String buildJson = '''
	{
	"id": "8766855135863637953",
	"builder": {
	"project": "dart-internal",
	"bucket": "flutter",
	"builder": "Linux packaging_release_builder"
	},
	"number": 123456,
	"status": "SUCCESS",
	"input": {
	"gitilesCommit": {
	"project": "flutter/flutter",
	"id": "HASH12345",
	"ref": "refs/heads/test-branch"
	}
	}
	}
	''';

	const String buildMessageJson = '''
	{
	"build": {
	"id": "8766855135863637953",
	"builder": {
	"project": "dart-internal",
	"bucket": "flutter",
	"builder": "Linux packaging_release_builder"
	},
	"number": 123456,
	"status": "SUCCESS",
	"input": {
	"gitilesCommit": {
	"project": "flutter/flutter",
	"id": "HASH12345",
	"ref": "refs/heads/test-branch"
	}
	}
	}
	}
	''';

	late DartInternalSubscription handler;
	late FakeConfig config;
	late FakeHttpRequest request;
	late MockBuildBucketV2Client buildBucketV2Client;
	late SubscriptionV2Tester tester;
	late MockFirestoreService mockFirestoreService;
	late Commit commit;

	// ignore: unused_local_variable
	const String project = 'dart-internal';
	const String bucket = 'flutter';
	const String builder = 'Linux packaging_release_builder';
	const int buildNumber = 123456;
	// ignore: unused_local_variable
	final Int64 buildId = Int64(8766855135863637953);
	const String fakeHash = 'HASH12345';
	const String fakeBranch = 'test-branch';

	setUp(() async {
	mockFirestoreService = MockFirestoreService();
	config = FakeConfig(firestoreService: mockFirestoreService);
	buildBucketV2Client = MockBuildBucketV2Client();
	handler = DartInternalSubscription(
	cache: CacheService(inMemory: true),
	config: config,
	authProvider: FakeAuthenticationProvider(),
	buildBucketV2Client: buildBucketV2Client,
	datastoreProvider: (DatastoreDB db) => DatastoreService(config.db, 5),
	);
	request = FakeHttpRequest();

	tester = SubscriptionV2Tester(
	request: request,
	);

	commit = generateCommit(
	1,
	sha: fakeHash,
	branch: fakeBranch,
	owner: 'flutter',
	repo: 'flutter',
	timestamp: 0,
	);

	// final bbv2.PubSubCallBack pubSubCallBackTest = bbv2.PubSubCallBack();
	// pubSubCallBackTest.mergeFromProto3Json(jsonDecode(message));
	final bbv2.Build build = bbv2.Build().createEmptyInstance();
	build.mergeFromProto3Json(jsonDecode(buildJson) as Map<String, dynamic>);

	const PushMessageV2 pushMessageV2 = PushMessageV2(data: buildJson, messageId: '798274983');
	tester.message = pushMessageV2;

	when(
	buildBucketV2Client.getBuild(
	any,
	buildBucketUri: 'https://cr-buildbucket.appspot.com/prpc/buildbucket.v2.Builds',
	),
	).thenAnswer((_) => Future<bbv2.Build>.value(build));

	final List<Commit> datastoreCommit = <Commit>[commit];
	await config.db.commit(inserts: datastoreCommit);
	});

	test('creates a new task successfully', () async {
	when(
	mockFirestoreService.batchWriteDocuments(
	captureAny,
	captureAny,
	),
	).thenAnswer((Invocation invocation) {
	return Future<BatchWriteResponse>.value(BatchWriteResponse());
	});
	tester.message = const PushMessageV2(data: buildMessageJson);

	await tester.post(handler);

	verify(
	buildBucketV2Client.getBuild(any),
	).called(1);

	// This is used for testing to pull the data out of the "datastore" so that
	// we can verify what was saved.
	late Task taskInDb;
	late Commit commitInDb;
	config.db.values.forEach((k, v) {
	if (v is Task && v.buildNumberList == buildNumber.toString()) {
	taskInDb = v;
	}
	if (v is Commit) {
	commitInDb = v;
	}
	});

	// Ensure the task has the correct parent and commit key
	expect(
	commitInDb.id,
	equals(taskInDb.commitKey?.id),
	);

	expect(
	commitInDb.id,
	equals(taskInDb.parentKey?.id),
	);

	// Ensure the task in the db is exactly what we expect
	final Task expectedTask = Task(
	attempts: 1,
	buildNumber: buildNumber,
	buildNumberList: buildNumber.toString(),
	builderName: builder,
	commitKey: commitInDb.key,
	luciBucket: bucket,
	name: builder,
	stageName: 'dart-internal',
	status: 'Succeeded',
	key: commit.key.append(Task),
	timeoutInMinutes: 0,
	reason: '',
	requiredCapabilities: [],
	reservedForAgentId: '',
	);

	expect(
	taskInDb.toString(),
	equals(expectedTask.toString()),
	);

	final List<dynamic> captured = verify(mockFirestoreService.batchWriteDocuments(captureAny, captureAny)).captured;
	expect(captured.length, 2);
	final BatchWriteRequest batchWriteRequest = captured[0] as BatchWriteRequest;
	expect(batchWriteRequest.writes!.length, 1);
	final firestore.Task insertedTaskDocument =
	firestore.Task.fromDocument(taskDocument: batchWriteRequest.writes![0].update!);
	expect(insertedTaskDocument.taskName, expectedTask.name);
	});

	test('updates an existing task successfully', () async {
	when(
	mockFirestoreService.batchWriteDocuments(
	captureAny,
	captureAny,
	),
	).thenAnswer((Invocation invocation) {
	return Future<BatchWriteResponse>.value(BatchWriteResponse());
	});
	const int existingTaskId = 123;
	final Task fakeTask = Task(
	attempts: 1,
	buildNumber: existingTaskId,
	buildNumberList: existingTaskId.toString(),
	builderName: builder,
	commitKey: commit.key,
	luciBucket: bucket,
	name: builder,
	stageName: 'dart-internal',
	status: 'Succeeded',
	key: commit.key.append(Task),
	timeoutInMinutes: 0,
	reason: '',
	requiredCapabilities: [],
	reservedForAgentId: '',
	);
	final List<Task> datastoreCommit = <Task>[fakeTask];
	await config.db.commit(inserts: datastoreCommit);

	const PushMessageV2 pushMessageV2 = PushMessageV2(data: buildMessageJson, messageId: '798274983');
	tester.message = pushMessageV2;

	await tester.post(handler);

	verify(
	buildBucketV2Client.getBuild(any),
	).called(1);

	// This is used for testing to pull the data out of the "datastore" so that
	// we can verify what was saved.
	final String expectedBuilderList = '${existingTaskId.toString()},${buildNumber.toString()}';
	late Task taskInDb;
	late Commit commitInDb;
	config.db.values.forEach((k, v) {
	if (v is Task && v.buildNumberList == expectedBuilderList) {
	taskInDb = v;
	}
	if (v is Commit) {
	commitInDb = v;
	}
	});

	// Ensure the task has the correct parent and commit key
	expect(
	commitInDb.id,
	equals(taskInDb.commitKey?.id),
	);

	expect(
	commitInDb.id,
	equals(taskInDb.parentKey?.id),
	);

	// Ensure the task in the db is exactly what we expect
	final Task expectedTask = Task(
	attempts: 2,
	buildNumber: buildNumber,
	buildNumberList: expectedBuilderList,
	builderName: builder,
	commitKey: commitInDb.key,
	luciBucket: bucket,
	name: builder,
	stageName: 'dart-internal',
	status: 'Succeeded',
	key: commit.key.append(Task),
	timeoutInMinutes: 0,
	reason: '',
	requiredCapabilities: [],
	reservedForAgentId: '',
	);

	expect(
	taskInDb.toString(),
	equals(expectedTask.toString()),
	);

	final List<dynamic> captured = verify(mockFirestoreService.batchWriteDocuments(captureAny, captureAny)).captured;
	expect(captured.length, 2);
	final BatchWriteRequest batchWriteRequest = captured[0] as BatchWriteRequest;
	expect(batchWriteRequest.writes!.length, 1);
	final firestore.Task insertedTaskDocument =
	firestore.Task.fromDocument(taskDocument: batchWriteRequest.writes![0].update!);
	expect(insertedTaskDocument.status, expectedTask.status);
	});

	test('ignores message with empty build data', () async {
	tester.message = const PushMessageV2();
	expect(await tester.post(handler), equals(Body.empty));
	});

	// // TODO create a construction method for this to simplify testing.
	test('ignores message not from flutter bucket', () async {
	const String dartMessage = '''
	{
	"build": {
	"id": "8766855135863637953",
	"builder": {
	"project": "dart-internal",
	"bucket": "dart",
	"builder": "Linux packaging_release_builder"
	},
	"number": 123456,
	"status": "SUCCESS",
	"input": {
	"gitilesCommit": {
	"project":"flutter/flutter",
	"id":"HASH12345",
	"ref":"refs/heads/test-branch"
	}
	}
	}
	}
	''';

	const PushMessageV2 pushMessageV2 = PushMessageV2(data: dartMessage, messageId: '798274983');
	tester.message = pushMessageV2;
	expect(await tester.post(handler), equals(Body.empty));
	});

	test('ignores message not from dart-internal project', () async {
	const String unsupportedProjectMessage = '''
	{
	"build": {
	"id": "8766855135863637953",
	"builder": {
	"project": "unsupported-project",
	"bucket": "dart",
	"builder": "Linux packaging_release_builder"
	},
	"number": 123456,
	"status": "SUCCESS",
	"input": {
	"gitilesCommit": {
	"project": "flutter/flutter",
	"id": "HASH12345",
	"ref": "refs/heads/test-branch"
	}
	}
	}
	}
	''';

	const PushMessageV2 pushMessageV2 = PushMessageV2(data: unsupportedProjectMessage, messageId: '798274983');
	tester.message = pushMessageV2;
	expect(await tester.post(handler), equals(Body.empty));
	});

	test('ignores message not from an accepted builder', () async {
	const String unknownBuilderMessage = '''
	{
	"build": {
	"id": "8766855135863637953",
	"builder": {
	"project": "dart-internal",
	"bucket": "dart",
	"builder": "different builder"
	},
	"number": 123456,
	"status": "SUCCESS",
	"input": {
	"gitilesCommit": {
	"project": "flutter/flutter",
	"id": "HASH12345",
	"ref": "refs/heads/test-branch"
	}
	}
	}
	}
	''';

	const PushMessageV2 pushMessageV2 = PushMessageV2(data: unknownBuilderMessage, messageId: '798274983');
	tester.message = pushMessageV2;
	expect(await tester.post(handler), equals(Body.empty));
	});
	}